Les campagnes API personnalisées vous permettent d’utiliser la puissance des tests A/B et de l’attribution automatique de Dynamic Yield, tout en contrôlant entièrement le rendu des campagnes sur votre site. Les variations de vos campagnes d’API personnalisées sont des fichiers JSON, de sorte que chaque appel se traduit par un fichier JSON que vous pouvez utiliser pour rendre un élément sur votre site.
Création de campagnes d’API personnalisées côté serveur
Étape 1 : Créer la campagne
- Dans Personnalisation web, cliquez sur Créer une campagne.
- Sélectionnez Code personnalisé d’API.
- Saisissez un nom et ajoutez des notes et des étiquettes (facultatif).
- Spécifiez le sélecteur d’API. Ce sélecteur est nécessaire pour les appels d’API de la campagne.
- Vous pouvez également spécifier un groupe de sélecteurs. En savoir plus sur les groupes de sélecteurs.
- Dans les paramètres avancés, il est possible de servir plusieurs variations par décision (par exemple, pour les variations de carrousel ou de grille).
- Cliquez sur Suivant.
Étape 2 : Créer des variations
- Sur l’écran Expérience, nommez votre expérience et choisissez de créer une nouvelle variation ou de copier une variation existante. Vous pouvez également choisir de gérer votre expérience en la synchronisant avec un flux de données.
- Si vous sélectionnez Nouvelle variation, l’écran des modèles apparaît. Cliquez sur celui que vous souhaitez utiliser, puis créez votre variation au format JSON.
- Si vous sélectionnez Copier à partir d’une autre expérience, votre liste d’expériences apparaît.
Sélectionnez l’expérience que vous souhaitez, puis Copier la variation (pour passer à l’étape d’attribution) ou Copier et modifier (pour modifier le JSON). - Si vous cliquez sur Synchroniser avec un flux de données, la liste des modèles apparaît. Sélectionnez un modèle, puis le flux avec lequel le synchroniser.
- Si vous sélectionnez Nouvelle variation, l’écran des modèles apparaît. Cliquez sur celui que vous souhaitez utiliser, puis créez votre variation au format JSON.
- Cliquez sur Enregistrer la variation.
- Répétez l’opération pour autant de variations que nécessaire.
Étape 3 : Configurer et enregistrer l’expérience
-
Attribution :
- Définissez l’allocation, la mesure principale et les paramètres avancés de l’expérience.
- Configurez la part de votre trafic à allouer à chaque variation et au groupe témoin.
- Cliquez sur Suivant.
-
Ciblage :
- Configurez les paramètres de ciblage de l’expérience pour déterminer quand, où et pour qui l’expérience sera affichée, puis cliquez sur Suivant.
-
Enregistrez, prévisualisez et publiez :
- Enregistrez votre expérience en tant que brouillon si vous souhaitez la prévisualiser et la modifier avant de la mettre en ligne. Lorsque vous êtes prêt, activez-la, puis enregistrez-la.
- Cliquez sur l’icône pour créer une expérience ciblée supplémentaire.
- Prévisualisation :
- Après avoir enregistré la campagne, vous pouvez prévisualiser les variations tout en les modifiant.
- Pour prévisualiser la campagne, accédez à votre liste de campagnes, survolez la campagne et cliquez sur l’icône de prévisualisation pour voir à quoi ressemblera la variation pour votre visiteur.
- Lorsque vous avez terminé, cliquez sur Publier.
Appeler une campagne personnalisée côté serveur
Dans votre code, vous utiliserez DYAP.choose() pour demander une variante d’une campagne.
Chemin d’accès
https://dy-api.com/v2/serve/user/choose
Méthode HTTP |
|
En-têtes |
|
Paramètres de Body |
|
Exemple de Node.JS
var request = require("request");
var options = {
method: 'POST',
url: 'https://dy-api.com/v2/serve/user/choose',
headers: {'content-type': 'application/json', 'dy-api-key': 'your-api-key'},
"body": {
"selector": {
"names": [
"test1"
]
},
"user": {
"id": "customUserId123"
},
"session": {
"custom": "myCustomSession345"
},
"context": {
"page": {
"type": "HOMEPAGE",
"location": "https://example.org",
"locale": "en_US",
"data":[]
},
"device": {
"userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
"ip": "54.100.200.255"
}
},
"options": {
"isImplicitPageview": false,
" returnAnalyticsMetadata": false
}}`
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
Pour plus de détails, consultez la référence de l’API.
Rapport sur l’engagement
Pour signaler les clics sur vos campagnes à Dynamic Yield, utilisez l’appel à l’API Reporting Engagement .
Pour plus de détails, consultez la référence de l’API.
Validation de votre implémentation
Consultez les données de journalisation de l’API pour connaître l’historique des appels d’API récents, leur statut, etc.