Documentation Guide du développeur de Target

adobe.target.getOffers() - at.js 2.x

Dernière mise à jour : 20 juillet 2024

Rubriques :

Créé pour :

Développeur

Cette fonction permet de récupérer plusieurs offres en transmettant plusieurs mbox. De plus, plusieurs offres peuvent être extraites pour toutes les vues des activités actives.

REMARQUE

Cette fonction a été introduite avec at.js 2.x. Cette fonction n’est pas disponible pour at.js version 1.x.

Clé	Type	Obligatoire ?	Description
`consumerId`	Chaîne	Non	La valeur par défaut est la mbox globale du client si elle n’est pas fournie. Cette clé est utilisée pour générer l’ID de données supplémentaire (SDID) utilisé pour l’intégration A4T. Lors de l’utilisation de `getOffers()`, chaque appel génère un nouveau SDID. Si vous disposez de plusieurs requêtes de mbox sur la même page et que vous souhaitez conserver le SDID (afin qu’il corresponde au SDID de target-global-mbox et au SDID Adobe Analytics), utilisez le paramètre `consumerId` . Si `getOffers()` comprend trois mbox (nommées "mbox1", "mbox2" et "mbox3"), incluez : `consumerId: "mbox1, mbox2, mbox3"` dans l’appel `getOffers()`.
`decisioningMethod`	Chaîne	Non	"côté serveur", "sur appareil", "hybride"
`request`	Objet	Oui	Consultez les requêtes ci-dessous.
`timeout`	Nombre	Non	Délai d’attente de requête. Si cette valeur n’est pas spécifiée, c’est le délai d’attente par défaut d’at.js qui sera utilisé.

Demande

REMARQUE

Pour plus d’informations sur les types acceptables pour tous les champs répertoriés ci-dessous, consultez la documentation de l’API de diffusion .

Nom du champ	Obligatoire ?	Limites	Description
request > id	Non		Un de `tntId`, `thirdPartyId`ou `marketingCloudVisitorId` est obligatoire.
Request > id > thirdPartyId	Non	Taille maximale = 128.
Request > experienceCloud	Non
Request > experienceCloud > analytics	Non		Intégration d’Adobe Analytics
Request > experienceCloud > analytics > logging	Non	Les éléments suivants doivent être implémentés sur la page : Service d’identification des visiteurs Appmeasurement.js	Les valeurs suivantes sont prises en charge : client_side : lorsqu’il est spécifié, une charge d’analyse est renvoyée à l’appelant qui doit être utilisé pour l’envoi à Adobe Analytics via l’appel Data Insertion API. server_side : il s’agit de la valeur par défaut où le serveur principal Target et Analytics utilisera le SDID pour assembler les appels à des fins de création de rapports.
Request > prefetch	Non
Request > prefetch > views	Non	Nombre maximum 50. Nom non vide. Longueur de nom `<=` 128. Longueur de valeur `<=` 5000. Le nom ne doit pas commencer par "profile". Noms non autorisés : "orderId", "orderTotal", "productPurchasedId".	Transmettez les paramètres à utiliser pour récupérer les vues pertinentes dans les activités actives.
Request > prefetch > views > profileParameters	Non	Le maximum compte 50. Nom non vide. Longueur de nom `<=` 128. Longueur de valeur `<=` 5000. Accepte uniquement les valeurs de chaîne. Le nom ne doit pas commencer par "profile".	Transmettez les paramètres de profil à utiliser pour récupérer les vues pertinentes dans les activités actives.
Request > prefetch > views > product	Non
Request > prefetch > views > product -> id	Non	Non vide. taille maximale = 128.	Transmettez les ID de produit à utiliser pour récupérer les vues pertinentes dans les activités actives.
Request > prefetch > views > product > categoryId	Non	Non vide. taille maximale = 128.	Transmettre les identifiants des catégories de produits à utiliser pour récupérer les vues pertinentes dans les activités.
Request > prefetch > views > order	Non
Request > prefetch > views > order > id	Non	Longueur maximale = 250.	Transmettez les ID de commande à utiliser pour récupérer les vues pertinentes dans les activités actives.
Request > prefetch > views > order > total	Non	Total `>=` 0.	Transmettez les totaux de la commande afin qu’ils soient utilisés pour récupérer les vues pertinentes dans les activités courantes.
Request > prefetch > views > order > purchasedProductIds	Non	Aucune valeur vide. Longueur maximale de chaque valeur de 50. Concaténé et séparé par une virgule. Longueur totale des ID de produit `<=` 250.	Transmettez les ID de produit achetés à utiliser pour récupérer les vues pertinentes dans les activités actives.
Request > execute	Non
Request > execute > pageLoad	Non
Request > execute > pageLoad parameters	Non	Nombre maximum 50. Nom non vide. Longueur de nom `<=` 128. Longueur de valeur `<=` 5000. Accepte uniquement les valeurs de chaîne. Le nom ne doit pas commencer par "profile". Noms non autorisés : "orderId", "orderTotal", "productPurchasedId".	Récupérez les offres avec des paramètres spécifiés lors du chargement de la page.
Request > execute > pageLoad profileParameters	Non	Nombre maximum 50. Nom non vide. Longueur de nom `<=` 128. Longueur de la valeur `<=`256. Le nom ne doit pas commencer par "profile". Accepte uniquement les valeurs de chaîne.	Récupérez les offres avec des paramètres de profil spécifiés lors du chargement de la page.
Request > execute > pageLoad product	Non
Request > execute > pageLoad product -> id	Non	Non vide. Taille maximale = 128.	Récupérez les offres avec des ID de produit spécifiés lors du chargement de la page.
Request > execute > pageLoad product > categoryId	Non	Non vide. Taille maximale = 128.	Récupérez les offres avec des identifiants de catégorie de produits spécifiés lors du chargement de la page.
Request > execute > pageLoad order	Non
Request > execute > pageLoad order > id	Non	Longueur maximale = 250.	Récupérez les offres avec des ID de commande spécifiés lors du chargement de la page.
Request > execute > pageLoad order > total	Non	`>=` 0.	Récupérez les offres avec des totaux de commande spécifiés lors du chargement de la page.
Request > execute > pageLoad order > purchasedProductIds	Non	Aucune valeur vide. Longueur maximale de chaque valeur de 50. Concaténé et séparé par une virgule. Longueur totale des ID de produit `<=` 250.	Récupérez les offres avec des ID de produit achetés, spécifiés lors du chargement de la page.
Request > execute > mboxes	Non	Taille maximale = 50. Aucun élément nul.
Request > execute > mboxes>mbox	Oui	Non vide. Aucun suffixe "-clicked". Taille maximale = 250. Caractères autorisés : `'-, ./=:;&!@#$%^&*()+	?~[]{}'`
Request > execute > mboxes>mbox>index	Oui	Non nul. Unique. `>=` 0.	Notez que l’index ne représente pas l’ordre dans lequel les mbox seront traitées. Comme dans une page web comportant plusieurs mbox régionales, l’ordre dans lequel ils seront traités ne peut pas être spécifié.
Request > execute > mboxes > mbox > parameters	Non	Nombre maximal = 50. Nom non vide. Longueur de nom `<=` 128. Accepte uniquement les valeurs de chaîne. Longueur de valeur `<=` 5000. Le nom ne doit pas commencer par "profile". Noms non autorisés : "orderId", "orderTotal", "productPurchasedId".	Récupérez les offres pour une mbox donnée avec les paramètres spécifiés.
Request > execute > mboxes>mbox>profileParameters	Non	Nombre maximal = 50. Nom non vide. Longueur de nom `<=` 128. Accepte uniquement les valeurs de chaîne. Longueur de la valeur `<=`256. Le nom ne doit pas commencer par "profile".	Récupérez les offres pour une mbox donnée avec les paramètres de profil spécifiés.
Request > execute > mboxes>mbox > product	Non
Request > execute > mboxes > mbox > product > id	Non	Non vide. Taille maximale = 128.	Récupérez les offres pour une mbox donnée avec les ID de produit spécifiés.
Request > execute > mboxes > mbox > product > categoryId	Non	Non vide. Taille maximale = 128.	Récupérez les offres pour une mbox donnée avec les identifiants de catégorie de produits spécifiés.
Request > execute > mboxes > mbox > order	Non
Request > execute > mboxes>mbox > order > id	Non	Longueur maximale = 250.	Récupérez les offres pour une mbox donnée avec les ID de commande spécifiés.
Request > execute > mboxes > mbox > order > total	Non	`>=` 0.	Récupérez les offres pour une mbox donnée avec les totaux de commande spécifiés.
Request > execute > mboxes > mbox > order > purchasedProductIds	Non	Aucune valeur vide. Longueur maximale de chaque valeur = 50. Concaténé et séparé par une virgule. Longueur totale des ID de produit `<=` 250.	Récupérez les offres pour une mbox donnée avec l’ordre spécifié des ID de produit achetés.

Appel de getOffers() pour toutes les vues

adobe.target.getOffers({
    request: {
      prefetch: {
        views: [{}]
    }
  }
});

Appelez getOffers() pour prendre une décision sur l’appareil

adobe.target.getOffers({

  decisioningMethod:"on-device",
  request: {
    execute: {
      mboxes: [
        {
          index: 0,
          name: "homepage"
        }
      ]
    }
 }
});

Appel de getOffers() pour récupérer les dernières vues avec les paramètres transmis et les paramètres de profil

adobe.target.getOffers({
  request: {
    "prefetch": {
      "views": [
        {
          "parameters": {
            "ad": "1"
          },
          "profileParameters": {
            "age": 23
          }
        }
      ]
    }
  }
});

Appel de getOffers() pour récupérer les mbox avec des paramètres et des paramètres de profil transmis.

adobe.target.getOffers({
  request: {
    execute: {
      mboxes: [
        {
          index: 0,
          name: "first-mbox"
        },
        {
          index: 1,
          name: "second-mbox",
          parameters: {
            a: 1
          },
          profileParameters: {
            b: 2
          }
        }
      ]
    }
  }
});

Appelez getOffers() pour récupérer la charge utile d’analyse du côté client.

adobe.target.getOffers({
      request: {
        experienceCloud: {
          analytics: {
            logging: "client_side"
          }
        },
        prefetch: {
          mboxes: [{
            index: 0,
            name: "a1-serverside-xt"
          }]
        }
      }
    })
    .then(console.log)

Réponse :

{
  "prefetch": {
    "mboxes": [{
      "index": 0,
      "name": "a1-serverside-xt",
      "options": [{
        "content": "<img src=\"http://s7d2.scene7.com/is/image/TargetAdobeTargetMobile/L4242-xt-usa?tm=1490025518668&fit=constrain&hei=491&wid=980&fmt=png-alpha\"/>",
        "type": "html",
        "eventToken": "n/K05qdH0MxsiyH4gX05/2qipfsIHvVzTQxHolz2IpSCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q==",
        "responseTokens": {
          "profile.memberlevel": "0",
          "geo.city": "bucharest",
          "activity.id": "167169",
          "experience.name": "USA Experience",
          "geo.country": "romania"
        }
      }],
      "analytics": {
        "payload": {
          "pe": "tnt",
          "tnta": "167169:0:0|0|100,167169:0:0|2|100,167169:0:0|1|100"
        }
      }
    }]
  }
}

La payload peut ensuite être transmise à Adobe Analytics via l’ API d’insertion de données.

Récupération et rendu des données de plusieurs mbox via getOffers() et applyOffers()

at.js 2.x vous permet de récupérer plusieurs mbox via l’getOffers()API. Vous pouvez également récupérer des données pour plusieurs mbox, puis utiliser applyOffers() pour effectuer le rendu des données à différents emplacements identifiés par un sélecteur CSS.

L’exemple suivant illustre une page HTML simple avec at.js 2.x implémentée :

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>at.js 2.x, multiple selectors and multiple mboxes</title>
  <script src="at.js"></script>
</head>
<body>
  <div id="container1">Default content 1</div>

  <div id="container2">Default content 2</div>

  <div id="container3">Default content 3</div>
</body>
</html>

Supposons que vous ayez trois conteneurs que vous souhaitez modifier via le contenu reçu Target. Vous pouvez créer une requête unique pour trois mbox dans lesquelles chaque mbox comporte du contenu à rendre dans le conteneur correspondant.

Le code de requête et de rendu peut ressembler à l’exemple suivant :

adobe.target.getOffers({
  request: {
    prefetch: {
      mboxes: [
        {
          index: 0,
          name: "mbox1"
        },
        {
          index: 1,
          name: "mbox2"
        },
        {
          index: 2,
          name: "mbox3"
        }
      ]
    }
  }
})
.then(response => {
  // get all mboxes from response
  const mboxes = response.prefetch.mboxes;
  let count = 1;

  mboxes.forEach(el => {
    adobe.target.applyOffers({
      selector: "#container" + count,
      response: {
        prefetch: {
          mboxes: [el]
        }
      }
    });

    count += 1;
  });
});

Dans la section request > prefetch > mboxes, il existe trois mbox différentes. Si la requête a réussi, vous recevez la réponse pour chaque mbox de response > prefetch > mboxes. Après avoir reçu les réponses et les emplacements à utiliser pour le rendu, vous pouvez invoquer applyOffers() pour obtenir le rendu du contenu récupéré dans Target. Dans cet exemple, nous avons le mappage suivant :

mbox1 > Sélecteur CSS #container1
mbox2 > Sélecteur CSS #container2
mbox3 > Sélecteur CSS #container3

Cet exemple utilise la variable count pour construire les sélecteurs CSS. Dans un scénario réel, vous pouvez utiliser un mappage différent entre le sélecteur CSS et la mbox.

Notez que cet exemple utilise prefetch > mboxes, mais vous pouvez également utiliser execute > mboxes. Vérifiez que si vous utilisez la prérécupération dans getOffers(), vous devez également utiliser la prérécupération dans l’appel de applyOffers().

Appelez getOffers() pour effectuer un événement pageLoad

L’exemple suivant montre comment effectuer un événement pageLoad à l’aide de getOffers() avec at.js 2.x

adobe.target.getOffers({
    request: {
        execute: {
            pageLoad: {
                parameters: {}
            }
        }
    }
});

recommendation-more-help