Prévisualisation des Campagnes API Web Personalization – Dynamic Yield Base de Connaissance

Cet article explique comment prévisualiser les campagnes d'API côté serveur. Pour prévisualiser les campagnes de personnalisation de sites (telles qu'Overlay ou Dynamic Content), consultez l'article Prévisualisation des campagnes Script-based Personalization

Vous pouvez prévisualiser les campagnes et les variations des expériences de personnalisation de votre site comme si elles avaient été publiées sur votre site. Il existe deux manières de prévisualiser qui vous aident à tester et à visualiser tous les aspects de vos campagnes :

Prévisualiser une variation : afficher une variation, peu importe que vous répondiez aux conditions de ciblage. Dans ce mode, le code de la variation est simplement injecté dans la page. Ceci est utile pour l'assurance qualité du code ainsi que l'apparence et la sensation procurées par la variation.
Prévisualiser une campagne : visualisez-la exactement comme le ferait un visiteur sur votre site. Cela signifie que vous ne verrez la campagne que si vous répondez aux conditions de ciblage et aux paramètres de fréquence. Vous verrez l'expérience avec la priorité la plus élevée (pour laquelle vous êtes ciblé), et des variations vous seront proposées selon l'allocation. Comme cela inclut les expériences de brouillon, vous pouvez vérifier les expériences et les campagnes avant de les proposer à vos visiteurs.

Prévisualisation des variations

Vous pouvez prévisualiser les variations même si elles n'ont pas été enregistrées.

Lors de la modification ou de la création d'une variation, cliquez sur Preview On Site (Prévisualisation sur le site).
Entrez l'URL du site sur lequel vous souhaitez prévisualiser la variation.

Un nouvel onglet s'ouvre et affiche la prévisualisation.

Notez que la variation est affichée, que vous correspondiez ou non aux conditions de ciblage de l'expérience. Cependant, les conditions de déclenchement de la campagne doit être satisfaites (par exemple, une superposition déclenchée au bout de 30 secondes). Si la condition de déclenchement n'est pas remplie, un message apparaît, expliquant pourquoi aucune variation n'a été présentée.

Prévisualisation des campagnes

Passez la souris sur la campagne d'API que vous souhaitez prévisualiser, puis cliquez sur l'icône Preview (Prévisualisation).
Effectuez l’une des opérations suivantes :
- Entrez l'URL de prévisualisation (si elle ne s'y trouve pas déjà) et cliquez sur Preview (Prévisualisation). La page s'ouvre en mode prévisualisation.
- Envoyez l'URL de prévisualisation par e-mail à vos collègues afin qu'ils puissent prévisualiser la campagne sans accéder à la console Experience OS.
  Remarque : les prévisualisations des variations représentent un instantané du code de variation au moment où le lien d'aperçu est généré. Les liens restent actifs pendant 45 jours.

Notez que lorsque vous prévisualisez une campagne, tous les ciblages, déclencheurs et fréquences sont pris en compte avant de la diffuser.

Le mode de prévisualisation reste actif jusqu'à ce que vous fermiez l'onglet.

Activation du mode de prévisualisation

Pour prévisualiser les campagnes d'API, votre application doit demander le mode de prévisualisation. Il s'agit d'une modification ponctuelle apportée par votre développeur. Ensuite, la prévisualisation des variations et des campagnes ne nécessite plus aucun effort de développement.

Lorsque vous cliquez sur Preview (Prévisualisation) pour une campagne ou une variation de la console Experience OS, le site Web s'ouvre avec le paramètre d'URL dyApiPreview=[token]. Par exemple :
http://acme.com/dyApiPreview=5f30be92-dbd3-4053-904b-f83cd885574b

En tant que développeur, ajoutez la logique suivante : si le paramètre d'URL dyAPIPreview existe dans l'URL actuelle, incluez le token de prévisualisation dans la demande d'API sous le preview.ids[].

Choisissez Request Body (Corps de la demande) — Preview Mode (Mode prévisualisation)

{ 
"user": {"dyid": "1679843083476146043", 
“dyid_server”: "1679843083476146043" }, 
"session":{"dy": "a2719b4d6c4709128bf5f57a3bf3"}, 
"selector": { 
  "names": ["PDP Top Banner", "PDP Recs"],
  “preview”: {
  "ids": [“PREVIEW TOKEN”] // C'est ici que vous injectez le token d'aperçu à partir du paramètre d'URL
  }
  },
"context": { 
  "page": { "type":"HOMEPAGE", "location":"https://shop.biz/", "locale":"en_US" 
  }, 
  "device": { "userAgent":"Mozilla/5.0 (X11; Linux x86_64) Chrome/56.0.29", "ip":"54.100.200.255"} 
}, 
}

Choisissez Response (Réponse) — Preview Mode (Mode prévisualisation)

{
"cookies": [ 
  {"name": "_dyid_server", "value": "16798430146043", "maxAge": "63072000"},
      {"name": "_dyjsession", "value": "a2719b4d6c470383f1bf3", "maxAge": "63072000"}
  ],
  "choices": [
  "id": 5,
  "name": "Bannière principale de la page d'accueil",
  "type": "DECISION",
  "decisionId": "aGVsbG8K",
  "isPreview": true,
  "variations": [
  {
  "id": 52,
  "payload": {
... 
"type": "CUSTOM_JSON",
"data": {
  "key1": "value1",
  "key2": "value2"
}

Choisissez Request Body (Corps de la demande) — Preview Mode (Mode prévisualisation) (implémentation d'API uniquement)

{
  "user": { "id": "yaexono4ohphania" },
  "session": { "custom": "iquahngaishe2koh" },
  "selector": { 
     "names": ["PDP Top Banner", "PDP Recs"],
     “preview”: {
        "ids": [“PREVIEW TOKEN”] // C'est ici que vous injectez le token de prévisualisation depuis le paramètre d'URL
     }
   },
   "context": { 
     // Le contexte habituel...
   }
}

Choisissez Response (Réponse) — Preview Mode (Mode prévisualisation) (implémentation d'API uniquement)

{
  "choices": [
  {
  "id": 551993,
  "name": "Bannière supérieure HP",
  "type": "DECISION",
  "variations": [
  {
  "id": 25863143,
  
"payload": {  "type": "CUSTOM_JSON",
  "data": {
  "image": "http://lorempixel.com/400/200/",
  "title": "Restez au top",
  "subtitle": "Donnez le ton de l'élégance",
  "cta": "Acheter maintenant",
  "link": ""
  }
  }
  }
  ],
  "decisionId": "l7QtNTg5MTkwODkyNDA4MTM1NDM3Oc4AEHLBpzk5MzA1ODQBkJHOAYqj56UzNjQzOQ=="
  }
  ],
  "isPreviewMode": true
}}

Remarques

La portée du token de prévisualisation s'applique à l'ensemble de la demande. Cela signifie qu'il « activera » tous les projets d'expériences des campagnes. Si vous souhaitez prévisualiser les projets à partir d'une seule campagne, séparez les demandes.
Les tokens de prévisualisation expirent au bout de deux semaines.
Un nouveau token de prévisualisation est généré à chaque fois que Preview (Prévisualisation) est cliqué.
Lorsque vous demandez le mode de prévisualisation pour plusieurs campagnes, vous obtiendrez la meilleure option (en fonction du ciblage auquel vous correspondez) de toutes les campagnes en cours d'exécution et à l'état de projet.
Si vous envoyez un token de prévisualisation non valide, vous recevrez un avertissement : La demande contient un PreviewID non valide
Si vous envoyez une demande sans token de prévisualisation (c'est-à-dire un appel de production en direct), seules les expériences en statut actif sont prises en compte. Les campagnes qui incluent uniquement des expériences à l'état de projet ou mises en pause renverront des choix vides.
Vous pouvez inclure plusieurs tokens d'aperçu dans un seul appel en les séparant avec une virgule. Ceci est utile si vous souhaitez prévisualiser plusieurs variations provenant de différentes campagnes en même temps. Si vous incluez plusieurs tokens, les tokens permettant de prévisualiser une variation ont la priorité sur ceux permettant de prévisualiser une campagne.
Notez la différence entre les tokens de prévisualisation au niveau des campagnes et ceux au niveau des variations : Un token de prévisualisation au niveau des campagnes renvoie le paramètre "isPreviewMode": true à la fin de la réponse, ce qui a pour effet que toutes les campagnes renvoyées sont affichées en mode prévisualisation.

Un token de prévisualisation au niveau des variations renvoie le paramètre "isPreview": true dans le paramètre "choices" de chaque variation séparément, si le token correspond à une variation.