Configuration de la destination

Présentation

Cette configuration vous permet d’indiquer des informations essentielles telles que votre nom de destination, votre catégorie, votre description, etc. Les paramètres de cette configuration déterminent également comment les utilisateurs Experience Platform s’authentifient pour votre destination, comment ils apparaissent dans l’interface utilisateur Experience Platform et les identités qui peuvent être exportées vers votre destination.

Cette configuration connecte également les autres configurations requises pour que votre destination fonctionne (métadonnées de serveur de destination et d’audience) à celle-ci. Découvrez comment vous pouvez référencer les deux configurations dans une section plus loin sous.

Vous pouvez configurer les fonctionnalités décrites dans ce document à l’aide du point de terminaison de l’API /authoring/destinations. Lisez Opérations de point d’entrée de l’API Destinations pour obtenir la liste complète des opérations que vous pouvez effectuer sur le point d’entrée.

Exemple de configuration

Vous trouverez ci-dessous un exemple de configuration d’une destination fictive, Moviestar, qui comporte des points de terminaison dans quatre endroits sur le globe. La destination appartient à la catégorie des destinations mobiles. Les sections ci-dessous présentent la manière dont cette configuration est créée.

{
   "name":"Moviestar",
   "description":"Moviestar is a fictional destination, used for this example.",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"BEARER"
      }
   ],
   "customerDataFields":[
      {
         "name":"endpointsInstance",
         "type":"string",
         "title":"Select Endpoint",
         "description":"Moviestar manages several instances across the globe for REST endpoints that our customers are provisioned for. Select your endpoint in the dropdown list.",
         "isRequired":true,
         "enum":[
            "US",
            "EU",
            "APAC",
            "NZ"
         ]
      },
      {
         "name":"customerID",
         "type":"string",
         "title":"Moviestar Customer ID",
         "description":"Your customer ID in the Moviestar destination (e.g. abcdef).",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$"
      }
   ],
   "uiAttributes":{
      "documentationLink":"http://www.adobe.com/go/destinations-moviestar-en",
      "category":"mobile",
      "connectionType":"Server-to-server",
      "frequency":"Streaming"
   },
   "identityNamespaces":{
      "external_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "Email":{
               
            }
         }
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      }
   },
   "schemaConfig":{
      "profileRequired":false,
      "segmentRequired":true,
      "identityRequired":true
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "aggregation":{
      "aggregationType":"CONFIGURABLE_AGGREGATION",
      "configurableAggregation":{
         "splitUserById":true,
         "maxBatchAgeInSecs":0,
         "maxNumEventsInBatch":0,
         "aggregationKey":{
            "includeSegmentId":true,
            "includeSegmentStatus":true,
            "includeIdentity":true,
            "oneIdentityPerGroup":false,
            "groups":[
               {
                  "namespaces":[
                     "IDFA",
                     "GAID"
                  ]
               },
               {
                  "namespaces":[
                     "EMAIL"
                  ]
               }
            ]
         }
      }
   },
   "backfillHistoricalProfileData":true
}
Paramètre Type Description
name Chaîne Indique le titre de votre destination dans le catalogue des Experience Platform.
description Chaîne Fournissez une description de votre carte de destination dans le catalogue des destinations Experience Platform. Ne vise pas plus de 4 à 5 phrases.
status Chaîne Indique l’état du cycle de vie de la carte de destination. Les valeurs acceptées sont TEST, PUBLISHED et DELETED. Utilisez TEST lorsque vous configurez votre destination pour la première fois.

Configurations de l’authentification du client

Cette section de la configuration des destinations génère la page Configurer une nouvelle destination dans l’interface utilisateur de l’Experience Platform, où les utilisateurs se connectent Experience Platform aux comptes qu’ils ont avec votre destination. Selon l’option d’authentification que vous indiquez dans le champ authType , la page Experience Platform est générée pour les utilisateurs comme suit :

Authentification du porteur

Lorsque vous configurez le type d’authentification du porteur, les utilisateurs doivent saisir le jeton du porteur qu’ils obtiennent de votre destination.

Rendu de l’interface utilisateur avec authentification du porteur

Authentification OAuth 2

Les utilisateurs sélectionnent Se connecter à la destination pour déclencher le flux d’authentification OAuth 2 vers votre destination, comme illustré dans l’exemple ci-dessous pour la destination Audiences personnalisées de Twitter. Pour plus d’informations sur la configuration de l’authentification OAuth 2 à votre point de terminaison de destination, consultez la page d’authentification dédiée du SDK de destination OAuth 2.

Rendu de l’interface utilisateur avec authentification OAuth 2

Paramètre Type Description
customerAuthenticationConfigurations Chaîne Indique la configuration utilisée pour authentifier les clients Experience Platform sur votre serveur. Voir authType ci-dessous pour connaître les valeurs acceptées.
authType Chaîne Les valeurs acceptées sont OAUTH2, BEARER.

Champs de données client

Cette section permet aux partenaires d’introduire des champs personnalisés. Dans l’exemple de configuration ci-dessus, customerDataFields exige que les utilisateurs sélectionnent un point de terminaison dans le flux d’authentification et indiquent leur ID de client avec la destination. La configuration se reflète dans le flux d’authentification comme illustré ci-dessous :

Flux d’authentification de champ personnalisé

Paramètre Type Description
name Chaîne Attribuez un nom au champ personnalisé que vous introduisez.
type Chaîne Indique le type de champ personnalisé que vous introduisez. Les valeurs acceptées sont string, object, integer.
title Chaîne Indique le nom du champ, tel qu’il est affiché par les clients dans l’interface utilisateur de l’Experience Platform.
description Chaîne Fournissez une description du champ personnalisé.
isRequired Booléen Indique si ce champ est requis dans le workflow de configuration de destination.
enum Chaîne Rend le champ personnalisé sous forme de menu déroulant et répertorie les options disponibles pour l’utilisateur.
pattern Chaîne Impose un modèle pour le champ personnalisé, si nécessaire. Utilisez des expressions régulières pour appliquer un modèle. Par exemple, si vos ID de client n’incluent pas de chiffres ou de traits de soulignement, saisissez ^[A-Za-z]+$ dans ce champ.

Attributs de l’interface utilisateur

Cette section fait référence aux éléments de l’interface utilisateur dans la configuration ci-dessus que l’Adobe doit utiliser pour votre destination dans l’interface utilisateur de Adobe Experience Platform. Voir ci-dessous :

Paramètre Type Description
documentationLink Chaîne Fait référence à la page de documentation du catalogue des destinations pour votre destination. Utilisez http://www.adobe.com/go/destinations-YOURDESTINATION-en, où YOURDESTINATION est le nom de votre destination. Pour une destination appelée Moviestar, vous utiliseriez http://www.adobe.com/go/destinations-moviestar-en
category Chaîne Fait référence à la catégorie affectée à votre destination dans Adobe Experience Platform. Pour plus d’informations, consultez Catégories de destination. Utilisez l’une des valeurs suivantes : adobeSolutions, advertising, analytics, cdp, cloudStorage, crm, customerSuccess, database, dmp, ecommerce, email, emailMarketing, enrichment, livechat, marketingAutomation, mobile, personalization, protocols, social, streaming, subscriptions, surveys, tagManagers, voc, warehouses, payments.
connectionType Chaîne Server-to-server est actuellement la seule option disponible.
frequency Chaîne Streaming est actuellement la seule option disponible.

Configuration du schéma dans l’étape de mappage

Activer l’étape de mappage

Utilisez les paramètres de schemaConfig pour activer l’étape de mappage du workflow d’activation de destination. En utilisant les paramètres décrits ci-dessous, vous pouvez déterminer si les utilisateurs Experience Platform peuvent mapper des attributs de profil et/ou des identités au schéma souhaité du côté de votre destination.

Paramètre Type Description
profileFields Tableau Non affiché dans l’exemple de configuration ci-dessus. Lorsque vous ajoutez des attributs prédéfinis profileFields, les utilisateurs Experience Platform ont la possibilité de mapper les attributs de Platform aux attributs prédéfinis du côté de votre destination.
profileRequired Booléen Utilisez true si les utilisateurs doivent être en mesure de mapper les attributs de profil de l’Experience Platform aux attributs personnalisés du côté de votre destination, comme illustré dans l’exemple de configuration ci-dessus.
segmentRequired Booléen Utilisez toujours segmentRequired:true.
identityRequired Booléen Utilisez true si les utilisateurs doivent pouvoir mapper les espaces de noms d’identité de l’Experience Platform à votre schéma souhaité.

Identités et attributs

Les paramètres de cette section déterminent quelles identités votre destination accepte. Cette configuration renseigne également les identités et les attributs de la cible à l’étape de mappage de l’interface utilisateur de l’Experience Platform, où les utilisateurs mappent les identités et les attributs de leurs schémas XDM au schéma de votre destination.

Vous devez indiquer les Platform identités que les clients peuvent exporter vers votre destination. Voici quelques exemples : Experience Cloud ID, adresse électronique hachée, ID d’appareil (IDFA, GAID). Ces valeurs sont des Platform espaces de noms d’identité que les clients peuvent mapper aux espaces de noms d’identité de votre destination. Vous pouvez également indiquer si les clients peuvent mapper des espaces de noms personnalisés à des identités prises en charge par votre destination.

Les espaces de noms d’identité ne nécessitent pas de correspondance 1-à-1 entre Platform et votre destination.
Par exemple, les clients peuvent mapper un espace de noms Platform IDFA à un espace de noms IDFA à partir de votre destination, ou ils peuvent mapper le même Platform IDFA à un espace de noms Customer ID dans votre destination.

Pour en savoir plus, consultez la présentation de l’espace de noms d’identité.

Rendu des identités cibles dans l’interface utilisateur

Paramètre Type Description
acceptsAttributes Booléen Indique si votre destination accepte les attributs de profil standard. En règle générale, ces attributs sont mis en évidence dans la documentation des partenaires.
acceptsCustomNamespaces Booléen Indique si les clients peuvent configurer des espaces de noms personnalisés dans votre destination.
allowedAttributesTransformation Chaîne Non affiché dans l’exemple de configuration. Utilisé, par exemple, lorsque le client Platform a des adresses électroniques ordinaires comme attribut et que votre plateforme n’accepte que des emails hachés. Dans cet objet, vous pouvez effectuer la transformation qui doit être appliquée (par exemple, transformer l'email en minuscules, puis en hachage). Pour obtenir un exemple, voir requiredTransformation dans la référence de l’API de configuration de destination.
acceptedGlobalNamespaces - Utilisé dans les cas où votre plateforme accepte des espaces de noms d’identité standard (IDFA, par exemple), afin que vous puissiez empêcher les utilisateurs de Platform de sélectionner uniquement ces espaces de noms d’identité.

Diffusion de destination

Paramètre Type Description
authenticationRule Chaîne Indique comment les clients Platform se connectent à votre destination. Les valeurs acceptées sont CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE.
  • Utilisez CUSTOMER_AUTHENTICATION si les clients Platform se connectent à votre système par l’intermédiaire d’un nom d’utilisateur et d’un mot de passe, d’un jeton porteur ou d’une autre méthode d’authentification. Par exemple, sélectionnez cette option si vous avez également sélectionné authType: OAUTH2 ou authType:BEARER dans customerAuthenticationConfigurations.
  • Utilisez PLATFORM_AUTHENTICATION s’il existe un système d’authentification global entre l’Adobe et votre destination et que le client Platform n’a pas besoin de fournir d’informations d’identification d’authentification pour se connecter à votre destination. Dans ce cas, vous devez créer un objet d’identification à l’aide de la configuration Credentials .
  • Utilisez NONE si aucune authentification n’est requise pour envoyer des données à votre plateforme de destination.
destinationServerId Chaîne instanceId de la configuration du serveur de destination utilisée pour cette destination.

Configuration du mappage de segments

Section de configuration du mappage de segments

Cette section de la configuration de destination concerne la manière dont les métadonnées de segment telles que les noms ou les identifiants doivent être partagées entre l’Experience Platform et votre destination.

Grâce à la section audienceTemplateId, cette section associe également cette configuration à la configuration des métadonnées d’audience.

Les paramètres affichés dans la configuration ci-dessus sont décrits dans la référence de l’API du point de terminaison des destinations.

Stratégie d’agrégation

Stratégie d’agrégation dans le modèle de configuration

Cette section vous permet de définir les stratégies d’agrégation que l’Experience Platform doit utiliser lors de l’exportation de données vers votre destination.

Une stratégie d’agrégation détermine la manière dont les profils exportés sont combinés dans les exportations de données. Les options disponibles sont les suivantes :

  • Agrégation des meilleurs efforts
  • Agrégation configurable (affichée dans la configuration ci-dessus)

Lisez la section sur à l’aide du modèle et des exemples de clés d’agrégation pour comprendre comment inclure la stratégie d’agrégation dans votre modèle de transformation de messages en fonction de la stratégie d’agrégation que vous avez sélectionnée.

Agrégation des meilleurs efforts

CONSEIL

Utilisez cette option si votre point de terminaison API accepte moins de 100 profils par appel d’API.

Cette option fonctionne mieux pour les destinations qui préfèrent moins de profils par requête et qui préfèrent recevoir plus de requêtes avec moins de données que de requêtes avec plus de données.

Utilisez le paramètre maxUsersPerRequest pour spécifier le nombre maximal de profils que votre destination peut prendre dans une requête.

Agrégation configurable

Cette option fonctionne mieux si vous préférez prendre des lots volumineux, avec des milliers de profils sur le même appel. Cette option permet également d'agréger les profils exportés en fonction de règles d'agrégation complexes.

Cette option vous permet d’effectuer les opérations suivantes :

  • Définissez la durée maximale et le nombre maximal de profils à agréger avant qu’un appel API ne soit effectué vers votre destination.
  • Agrégez les profils exportés mappés à la destination en fonction des éléments suivants :
    • Identifiant de segment;
    • État du segment ;
    • Identité ou groupes d’identités.

Pour obtenir des explications détaillées sur les paramètres d’agrégation, consultez la page de référence Opérations de point d’entrée de l’API Destinations, où chaque paramètre est décrit.

Qualifications des profils historiques

Vous pouvez utiliser le paramètre backfillHistoricalProfileData dans la configuration des destinations pour déterminer si les qualifications de profil historiques doivent être exportées vers votre destination.

Paramètre Type Description
backfillHistoricalProfileData Booléen Contrôle si les données de profil historiques sont exportées lorsque les segments sont activés vers la destination.
  • true: Platform envoie les profils utilisateur historiques qualifiés pour le segment avant l’activation du segment.
  • false: Platform inclut uniquement les profils utilisateur qui remplissent les critères pour le segment une fois le segment activé.

Comment cette configuration connecte toutes les informations nécessaires à votre destination

Certains de vos paramètres de destination doivent être configurés via le serveur de destination ou la configuration des métadonnées d’audience. La configuration de destination décrite ici connecte tous ces paramètres en référençant les deux autres configurations comme suit :

  • Utilisez destinationServerId pour référencer la configuration du serveur de destination et du modèle configurée pour votre destination.
  • Utilisez audienceMetadataId pour référencer la configuration des métadonnées d’audience configurée pour votre destination.

Sur cette page