Options de configuration
Lors de leur invocation, les widgets doivent être paramétrés avec un ensemble d'options de configuration. La plupart de ces options sont transverses à tous les widgets et sont listées ci-dessous.
Certains widgets ont aussi des options additionnelles qui leurs sont propres et sont documentées dans la section options spécifiques pour chacun des widgets.
Option resort
| Type | Nombre |
|---|---|
| Obligatoire | Oui |
L'option resort spécifie le code de la station pour laquelle vous souhaiter exécuter un widget. Cette option est obligatoire pour l'ensemble des widgets.
Note Vous pouvez trouvez votre code station en utilisant l'outil de configuration des widgets ou en requêtant le service suivant : https://services.msem.tech/api/public/resorts
Option lang
| Type | Chaîne de caractères |
|---|---|
| Obligatoire | Non |
| Par défaut | fr |
L'option lang spécifie le code de la langue dans laquelle afficher le widget. Ce code doit être le code ISO 639 de la langue sur 2 caractères (alpha-2).
Note La localisation n'a pour le moment été prise en charge que pour fr et en !
Option channel
| Type | Chaîne de caractères |
|---|---|
| Obligatoire | Oui |
L'option channel spécifie le canal sur lequel va s'exécuter le widget. Si nécessaire, ce code vous sera attribué lors de la phase d'intégration, une fois le contrat signé avec la plateforme.
Cette option est obligatoire pour l'ensemble des widgets.
Note Le canal influe sur la marque, au sein du widget et dans les mails envoyés aux clients. Il est aussi utilisé pour refléter les commissions définies au contrat.
Option facet
| Type | Nombre |
|---|---|
| Obligatoire | Non |
| Par défaut | 0 |
L'option facet spécifie si le widget s'exécute en mode "été" ou en mode "hiver". La valeur 0 signifie hiver et 1 signifie été.
Note La facette influe principalement sur les partenariats :
- pour hiver, on propose les marchands "hiver" et "été et hiver".
- pour été, on propose les marchands "été" et "été et hiver". Dans certains cas, la facette influe aussi sur les contenus (photos, descriptifs...)
Option preview
| Type | Booléen |
|---|---|
| Obligatoire | Non |
L'option preview spécifie si le widget s'exécute en mode "prévisualisation". Ce mode, utilisé pour les tests, permet d'accéder à l'offre des marchands même si celle-ci n'est pas finalisée.
Attention Cette option servant à des fins de test, vous devez être vigilants et ne PAS l'activer en production.
Par ailleurs, pour un test ponctuel, vous pouvez ajouter le paramètre preview=true dans l'URL de la page embarquant le widget.
Option switchSummerDate
| Type | Date (YYYY-MM-DD) |
|---|---|
| Obligatoire | Non |
Date de bascule automatique de la facette en mode été (l'année est ignorée)
Option switchWinterDate
| Type | Date (YYYY-MM-DD) |
|---|---|
| Obligatoire | Non |
Date de bascule automatique de la facette en mode hiver (l'année est ignorée)
Option analytics
| Type | Fonction |
|---|---|
| Obligatoire | Non |
L'option analytics permet de spécifier une fonction qui sera appelée à chaque événement. Vous pouvez vous en servir pour remonter de la donnée à votre outil d'analytics.
Cette fonction prend en paramètre un objet avec les propriétés suivantes :
- event : le type de l'événement
- ...data : les données de l'événement (dépendantes du type de l'événement)