Utiliser Destination SDK pour configurer une destination de diffusion en continu

Présentation

Cette page décrit comment utiliser les informations dans la section Options de configuration de Destination SDK et dans d’autres documents de référence sur les fonctionnalités et l’API Destination SDK pour configurer une destination de diffusion en continu. Les étapes sont présentées dans l’ordre séquentiel ci-dessous.

Conditions préalables

Avant dʼeffectuer les étapes illustrées ci-dessous, consultez la page Prise en main de Destination SDK pour plus d’informations sur l’obtention des informations d’authentification Adobe I/O nécessaires et d’autres conditions préalables requises pour utiliser les API Destination SDK.

Étapes à suivre pour utiliser les options de configuration de Destination SDK afin de configurer votre destination.

Étapes illustrées d’utilisation des points d’entrée de Destination SDK

Étape 1 : créer une configuration de serveur et de modèle

Commencez par créer une configuration de serveur et de modèle à l’aide du point d’entrée /destinations-server (Consultez la section Référence d’API). Pour plus d’informations sur la configuration du serveur et du modèle, consultez la rubrique Spécifications du serveur et du modèle dans la section de référence.

Retrouvez ci-dessous un exemple de configuration. Notez que le modèle de transformation du message dans le paramètre requestBody.value est abordé à l’étape 3, Créer un modèle de transformation.

POST platform.adobe.io/data/core/activation/authoring/destination-servers

{
   "name":"Moviestar destination server",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"https://api.moviestar.com/data/{{customerData.region}}/items"
      }
   },
   "httpTemplate":{
      "httpMethod":"POST",
      "requestBody":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"insert after you create a template in step 3"
      },
      "contentType":"application/json"
   }
}

Étape 2 : créer une configuration de destination

Vous trouverez ci-dessous un exemple de configuration d’un modèle de destination, créé à l’aide du point d’entrée d’API /destinations. Pour plus d’informations sur cette configuration, consultez la section Configuration de la destination.

Pour connecter la configuration du serveur et du modèle de l’étape 1 à cette configuration de destination, ajoutez l’ID d’instance de la configuration de serveur et de modèle en tant que destinationServerId ici.

IMPORTANT

Pour créer une destination correctement configurée, vous devez ajouter au moins une identité cible dans identityNamespaces, comme illustré ci-dessous. Si aucune identité cible n’est configurée, les utilisateurs ne pourront pas aller plus loin que l’Étape de mappage du workflow d’activation.

POST platform.adobe.io/data/core/activation/authoring/destinations

{
   "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":""
      }
   ],
   "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
      },
      "another_id":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "aggregation":{
      "aggregationType":"CONFIGURABLE_AGGREGATION",
      "configurableAggregation":{
         "aggregationPolicyId":null,
         "aggregationKey":{
            "includeSegmentId":true,
            "includeSegmentStatus":true,
            "includeIdentity":true,
            "oneIdentityPerGroup":true,
            "groups":null
         },
         "splitUserById":true,
         "maxBatchAgeInSecs":2400,
         "maxNumEventsInBatch":5000
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ]
}

Étape 3 : créer un modèle de transformation de message : utilisez un langage de modèle pour spécifier le format de sortie du message

En fonction des payloads pris en charge par votre destination, vous devez créer un modèle qui transforme le format des données exportées à partir du format XDM d’Adobe dans un format pris en charge par votre destination. Consultez les exemples de modèles dans la section Utiliser une langue de modèle pour les transformations d’identité, d’attributs et d’appartenance aux segments et utilisez l’outil de création de modèles fourni par Adobe.

Une fois que vous avez conçu un modèle de transformation de messages qui vous convient, ajoutez-le à la configuration de serveur et de modèle que vous avez créée à l’étape 1.

Étape 4 : créer une configuration de métadonnées d’audience

Pour certaines destinations, Destination SDK exige que vous configuriez des métadonnées d’audience afin de créer, mettre à jour ou supprimer des audiences par programmation dans votre destination. Pour plus d’informations sur le moment et la manière d’effectuer cette configuration, consultez la section Gestion des métadonnées d’audience.

Si vous utilisez une configuration de métadonnées d’audience, vous devez la connecter à la configuration de destination créée à l’étape 2. Ajoutez l’ID d’instance de votre configuration de métadonnées d’audience à votre configuration de destination en tant que audienceTemplateId.

Étape 5 : configurer l’authentification

Selon que vous spécifiez "authenticationRule": "CUSTOMER_AUTHENTICATION" ou "authenticationRule": "PLATFORM_AUTHENTICATION" dans la configuration de destination ci-dessus, vous pouvez configurer l’authentification pour votre destination à l’aide du point d’entrée /destination ou /credentials.

  • Cas le plus courant : si vous avez sélectionné "authenticationRule": "CUSTOMER_AUTHENTICATION" dans la configuration de destination et que votre destination prend en charge la méthode d’authentification OAuth 2, consultez la section Authentification OAuth 2.
  • Si vous avez sélectionné "authenticationRule": "PLATFORM_AUTHENTICATION", consultez la section Configuration de l’authentification.

Étape 6 : tester votre destination

Une fois votre destination configurée à l’aide des points d’entrée de configuration dans les étapes précédentes, vous pouvez utiliser l’outil de test des destinations afin de tester l’intégration entre Adobe Experience Platform et votre destination.

Dans le cadre du processus de test de votre destination, vous devez utiliser l’interface utilisateur d’Experience Platform pour créer des segments que vous activerez vers votre destination. Pour plus d’informations sur la création de segments dans Experience Platform, consultez les deux ressources ci-dessous :

Étape 7 : publier votre destination

REMARQUE

Cette étape n’est pas requise si vous créez une destination privée à des fins personnelles et que vous ne souhaitez pas la publier dans le catalogue de destinations pour que d’autres clients puissent l’utiliser.

Une fois votre destination configurée et testée, utilisez l’API de publication de destination afin d’envoyer votre configuration à Adobe pour révision.

Étape 8 : documenter votre destination

REMARQUE

Cette étape n’est pas requise si vous créez une destination privée à des fins personnelles et que vous ne souhaitez pas la publier dans le catalogue de destinations pour que d’autres clients puissent l’utiliser.

Si vous êtes un fournisseur de logiciels indépendant (ISV) ou un intégrateur de système (SI) créant une intégration personnalisée, utilisez le processus de documentation en libre-service pour créer une page de documentation du produit pour votre destination dans le Catalogue des destinations Experience Platform.

Sur cette page