Opérations de l’API Destinations endpoint

IMPORTANT

Point de terminaison de l’API: platform.adobe.io/data/core/activation/authoring/destinations

Cette page répertorie et décrit toutes les opérations d’API que vous pouvez effectuer à l’aide du point de terminaison de l’API /authoring/destinations. Pour une description des fonctionnalités prises en charge par ce point de terminaison, consultez la section configuration de destination.

Prise en main des opérations d’API de destination

Avant de poursuivre, consultez le guide de prise en main pour obtenir des informations importantes à connaître afin d’effectuer avec succès des appels vers l’API, notamment sur la manière d’obtenir l’autorisation de création de destination requise et les en-têtes requis.

Création d’une configuration pour une destination

Vous pouvez créer une configuration de destination en envoyant une requête de POST au point de terminaison /authoring/destinations.

Format d’API

POST /authoring/destinations

Requête

La requête suivante crée une configuration de destination configurée par les paramètres fournis dans la payload. La payload ci-dessous inclut tous les paramètres acceptés par le point de terminaison /authoring/destinations. Notez que vous n’avez pas à ajouter tous les paramètres à l’appel et que le modèle est personnalisable, conformément aux exigences de votre API.

curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "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":"https://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
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "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 que l’Adobe utilisera dans le catalogue des destinations Experience Platform pour votre carte de destination. 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.
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.
customerAuthenticationConfigurations.authType Chaîne Les valeurs acceptées sont OAUTH2, BEARER.
customerDataFields.name Chaîne Attribuez un nom au champ personnalisé que vous introduisez.
customerDataFields.type Chaîne Indique le type de champ personnalisé que vous introduisez. Les valeurs acceptées sont string, object, integer
customerDataFields.title Chaîne Indique le nom du champ, tel qu’il est affiché par les clients dans l’interface utilisateur de l’Experience Platform.
customerDataFields.description Chaîne Fournissez une description du champ personnalisé.
customerDataFields.isRequired Booléen Indique si ce champ est requis dans le workflow de configuration de destination.
customerDataFields.enum Chaîne Rend le champ personnalisé sous forme de menu déroulant et répertorie les options disponibles pour l’utilisateur.
customerDataFields.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.
uiAttributes.documentationLink Chaîne Fait référence à la page de documentation du catalogue des destinations pour votre destination. Utilisez https://www.adobe.com/go/destinations-YOURDESTINATION-en, où YOURDESTINATION est le nom de votre destination. Pour une destination appelée Moviestar, vous utiliseriez https://www.adobe.com/go/destinations-moviestar-en.
uiAttributes.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.
uiAttributes.connectionType Chaîne Server-to-server est actuellement la seule option disponible.
uiAttributes.frequency Chaîne Streaming est actuellement la seule option disponible.
identityNamespaces.externalId.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 de nos partenaires.
identityNamespaces.externalId.acceptsCustomNamespaces Booléen Indique si les clients peuvent configurer des espaces de noms personnalisés dans votre destination.
identityNamespaces.externalId.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. C’est là que vous fournissez la transformation à appliquer (par exemple, transformez l’email en minuscules, puis en hachage).
identityNamespaces.externalId.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é.
Lorsque vous utilisez acceptedGlobalNamespaces, vous pouvez utiliser "requiredTransformation":"sha256(lower($))" pour hacher des adresses électroniques ou des numéros de téléphone en minuscules.
destinationDelivery.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.
destinationDelivery.destinationServerId Chaîne instanceId du modèle de serveur de destination utilisé pour cette destination.
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é.
segmentMappingConfig.mapUserInput Booléen Contrôle si l’ID de mappage de segments dans le workflow d’activation de destination est saisi par l’utilisateur.
segmentMappingConfig.mapExperiencePlatformSegmentId Booléen Contrôle si l’identifiant de mappage de segments dans le workflow d’activation de destination est l’identifiant de segment Experience Platform.
segmentMappingConfig.mapExperiencePlatformSegmentName Booléen Contrôle si l’identifiant de mappage de segments dans le workflow d’activation de destination est le nom du segment Experience Platform.
segmentMappingConfig.audienceTemplateId Booléen instanceId du modèle de métadonnées d’audience utilisé pour cette destination.
schemaConfig.profileFields Tableau Lorsque vous ajoutez des profileFields prédéfinis comme indiqué dans la configuration ci-dessus, les utilisateurs auront la possibilité de mapper les attributs Experience Platform aux attributs prédéfinis du côté de votre destination.
schemaConfig.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.
schemaConfig.segmentRequired Booléen Utilisez toujours segmentRequired:true.
schemaConfig.identityRequired Booléen Utilisez true si vous souhaitez que les utilisateurs puissent mapper les espaces de noms d’identité de l’Experience Platform à votre schéma souhaité.
aggregation.aggregationType - Sélectionnez BEST_EFFORT ou CONFIGURABLE_AGGREGATION. L’exemple de configuration ci-dessus inclut l’agrégation BEST_EFFORT. Pour un exemple de CONFIGURABLE_AGGREGATION, reportez-vous à l’exemple de configuration dans le document configuration de destination . Les paramètres relatifs à l'agrégation configurable sont présentés ci-dessous dans ce tableau.
aggregation.bestEffortAggregation.maxUsersPerRequest Entier Experience Platform peut agréger plusieurs profils exportés en un seul appel HTTP. Indiquez le nombre maximal de profils que votre point de terminaison doit recevoir dans un seul appel HTTP. Notez qu’il s’agit d’une agrégation du meilleur effort. Par exemple, si vous spécifiez la valeur 100, Platform peut envoyer n’importe quel nombre de profils inférieur à 100 lors d’un appel.
Si votre serveur n’accepte pas plusieurs utilisateurs par demande, définissez cette valeur sur 1.
aggregation.bestEffortAggregation.splitUserById Booléen Utilisez cet indicateur si l’appel à la destination doit être divisé par l’identité. Définissez cet indicateur sur true si votre serveur n’accepte qu’une seule identité par appel, pour un espace de noms donné.
aggregation.configurableAggregation.splitUserById Booléen Voir paramètre dans l’exemple de configuration ici. Utilisez cet indicateur si l’appel à la destination doit être divisé par l’identité. Définissez cet indicateur sur true si votre serveur n’accepte qu’une seule identité par appel, pour un espace de noms donné.
aggregation.configurableAggregation.maxBatchAgeInSecs Entier Valeur maximale : 3600. Voir paramètre dans l’exemple de configuration ici. Avec maxNumEventsInBatch, cela détermine la durée pendant laquelle l’Experience Platform doit attendre d’envoyer un appel API à votre point de terminaison.
Par exemple, si vous utilisez la valeur maximale pour les deux paramètres, Experience Platform patiente 3 600 secondes OU jusqu’à ce qu’il y ait 10 000 profils qualifiés avant d’effectuer l’appel API, selon ce qui se produit en premier.
aggregation.configurableAggregation.maxNumEventsInBatch Entier Valeur maximale : 10000. Voir paramètre dans l’exemple de configuration ici. Voir maxBatchAgeInSecs ci-dessus.
aggregation.configurableAggregation.aggregationKey Booléen Voir paramètre dans l’exemple de configuration ici. Permet d'agréger les profils exportés mappés à la destination en fonction des paramètres ci-dessous :
  • identifiant de segment
  • état du segment
  • namespace d’identité
aggregation.configurableAggregation.aggregationKey.includeSegmentId Booléen Voir paramètre dans l’exemple de configuration ici. Définissez cette variable sur true si vous souhaitez regrouper les profils exportés vers votre destination par identifiant de segment.
aggregation.configurableAggregation.aggregationKey.includeSegmentStatus Booléen Voir paramètre dans l’exemple de configuration ici. Vous devez définir includeSegmentId:true et includeSegmentStatus:true si vous souhaitez regrouper les profils exportés vers votre destination par identifiant de segment ET état du segment.
aggregation.configurableAggregation.aggregationKey.includeIdentity Booléen Voir paramètre dans l’exemple de configuration ici. Définissez cette variable sur true si vous souhaitez regrouper les profils exportés vers votre destination par espace de noms d’identité.
aggregation.configurableAggregation.aggregationKey.oneIdentityPerGroup Booléen Voir paramètre dans l’exemple de configuration ici. Utilisez ce paramètre pour indiquer si vous souhaitez que les profils exportés soient agrégés en groupes d’une seule identité (GAID, IDFA, numéros de téléphone, email, etc.).
aggregation.configurableAggregation.aggregationKey.groups Chaîne Voir paramètre dans l’exemple de configuration ici. Créez des listes de groupes d’identités si vous souhaitez regrouper les profils exportés vers votre destination par groupes d’espaces de noms d’identité. Par exemple, vous pouvez combiner des profils qui contiennent les identifiants mobiles IDFA et GAID dans un appel vers votre destination et des emails dans un autre en utilisant la configuration de l’exemple.

Réponse

Une réponse réussie renvoie un état HTTP 200 avec les détails de la configuration de destination que vous venez de créer.

Liste des configurations de destination

Vous pouvez récupérer une liste de toutes les configurations de destination pour votre organisation IMS en envoyant une requête GET au point de terminaison /authoring/destinations .

Format d’API

GET /authoring/destinations

Requête

La requête suivante récupère la liste des configurations de destination auxquelles vous avez accès, en fonction de la configuration de l’organisation IMS et de l’environnement de test.

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

La réponse suivante renvoie un état HTTP 200 avec une liste des configurations de destination auxquelles vous avez accès, en fonction de l’identifiant de l’organisation IMS et du nom de l’environnement de test que vous avez utilisés. Un instanceId correspond au modèle pour une destination. La réponse est tronquée pour la concision.

{
   "items":[
      {
         "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
         "createdDate":"2020-10-28T06:14:09.784471Z",
         "lastModifiedDate":"2021-06-28T06:14:09.784471Z",
         "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
         "sandboxName":"prod",
         "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
         "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":"https://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
            }
         },
         "segmentMappingConfig":{
            "mapExperiencePlatformSegmentName":false,
            "mapExperiencePlatformSegmentId":false,
            "mapUserInput":false,
            "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
         },
         "schemaConfig":{
            "profileFields":[
               {
                  "name":"a_custom_attribute",
                  "title":"a_custom_attribute",
                  "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
                  "type":"string",
                  "isRequired":false,
                  "readOnly":false,
                  "hidden":false
               }
            ],
            "profileRequired":true,
            "segmentRequired":true,
            "identityRequired":true
         },
         "aggregation":{
            "aggregationType":"BEST_EFFORT",
            "bestEffortAggregation":{
               "maxUsersPerRequest":10,
               "splitUserById":false
            }
         },
         "destinationDelivery":[
            {
               "authenticationRule":"CUSTOMER_AUTHENTICATION",
               "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
            }
         ],
         "destConfigId":"410631b8-f6b3-4b7c-82da-7998aa3f327c",
         "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 que l’Adobe utilisera dans le catalogue des destinations Experience Platform pour votre carte de destination. 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.
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.
customerAuthenticationConfigurations.authType Chaîne Les valeurs acceptées sont OAUTH2, BEARER.
customerDataFields.name Chaîne Attribuez un nom au champ personnalisé que vous introduisez.
customerDataFields.type Chaîne Indique le type de champ personnalisé que vous introduisez. Les valeurs acceptées sont string, object, integer
customerDataFields.title Chaîne Indique le nom du champ, tel qu’il est affiché par les clients dans l’interface utilisateur de l’Experience Platform.
customerDataFields.description Chaîne Fournissez une description du champ personnalisé.
customerDataFields.isRequired Booléen Indique si ce champ est requis dans le workflow de configuration de destination.
customerDataFields.enum Chaîne Rend le champ personnalisé sous forme de menu déroulant et répertorie les options disponibles pour l’utilisateur.
customerDataFields.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.
uiAttributes.documentationLink Chaîne Fait référence à la page de documentation du catalogue des destinations pour votre destination. Utilisez https://www.adobe.com/go/destinations-YOURDESTINATION-en, où YOURDESTINATION est le nom de votre destination. Pour une destination appelée Moviestar, vous utiliseriez https://www.adobe.com/go/destinations-moviestar-en
uiAttributes.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
uiAttributes.connectionType Chaîne Server-to-server est actuellement la seule option disponible.
uiAttributes.frequency Chaîne Streaming est actuellement la seule option disponible.
identityNamespaces.externalId.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 de nos partenaires.
identityNamespaces.externalId.acceptsCustomNamespaces Booléen Indique si les clients peuvent configurer des espaces de noms personnalisés dans votre destination. En savoir plus sur les espaces de noms personnalisés dans Adobe Experience Platform.
identityNamespaces.externalId.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. C’est là que vous fournissez la transformation à appliquer (par exemple, transformez l’email en minuscules, puis en hachage).
identityNamespaces.externalId.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é.
destinationDelivery.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.
destinationDelivery.destinationServerId Chaîne instanceId du modèle de serveur de destination utilisé pour cette destination.
destConfigId Chaîne Ce champ est généré automatiquement et ne nécessite pas votre saisie.
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é.
segmentMappingConfig.mapUserInput Booléen Contrôle si l’ID de mappage de segments dans le workflow d’activation de destination est saisi par l’utilisateur.
segmentMappingConfig.mapExperiencePlatformSegmentId Booléen Contrôle si l’identifiant de mappage de segments dans le workflow d’activation de destination est l’identifiant de segment Experience Platform.
segmentMappingConfig.mapExperiencePlatformSegmentName Booléen Contrôle si l’identifiant de mappage de segments dans le workflow d’activation de destination est le nom du segment Experience Platform.
segmentMappingConfig.audienceTemplateId Booléen instanceId du modèle de métadonnées d’audience utilisé pour cette destination. Pour configurer un modèle de métadonnées d’audience, consultez la référence de l’API de métadonnées d’audience.

Mettre à jour une configuration de destination existante

Vous pouvez mettre à jour une configuration de destination existante en envoyant une requête de PUT au point de terminaison /authoring/destinations et en fournissant l’ID d’instance de la configuration de destination que vous souhaitez mettre à jour. Dans le corps de l’appel, fournissez la configuration de destination mise à jour.

Format d’API

PUT /authoring/destinations/{INSTANCE_ID}
Paramètre Description
{INSTANCE_ID} L’identifiant de la configuration de destination que vous souhaitez mettre à jour.

Requête

La requête suivante met à jour une configuration de destination existante, configurée par les paramètres fournis dans la payload. Dans l’exemple d’appel ci-dessous, nous mettons à jour la configuration créée précédemment afin d’accepter désormais les identifiants GAID, IDFA et des e-mails hachés comme espaces de noms d’identité.

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
   "createdDate":"2020-10-28T06:14:09.784471Z",
   "lastModifiedDate":"2021-04-28T06:14:09.784471Z",
   "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
   "sandboxName":"prod",
   "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
   "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":"https://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
      },
      "gaid":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "GAID":{
               
            }
         }
      },
      "idfa":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "IDFA":{
               
            }
         }
      },
      "email_lc_sha256":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "transformation":"sha256(lower($))",
         "acceptedGlobalNamespaces":{
            "Email":{
               "requiredTransformation":"sha256(lower($))"
            },
            "Email_LC_SHA256":{
               
            }
         }
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}

Récupération d’une configuration de destination spécifique

Vous pouvez récupérer des informations détaillées sur une configuration de destination spécifique en envoyant une requête GET au point de terminaison /authoring/destinations et en fournissant l’ID d’instance de la configuration de destination que vous souhaitez récupérer.

Format d’API

GET /authoring/destinations/{INSTANCE_ID}
Paramètre Description
{INSTANCE_ID} L’identifiant de la configuration de destination que vous souhaitez récupérer.

Requête

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec des informations détaillées sur la configuration de destination spécifiée.

{
   "instanceId":"b0780cb5-2bb7-4409-bf2c-c625ca818588",
   "createdDate":"2020-10-28T06:14:09.784471Z",
   "lastModifiedDate":"2021-06-04T06:14:09.784471Z",
   "imsOrg":"AC3428435BF324E90A49402A@AdobeOrg",
   "sandboxName":"prod",
   "sandboxId":"r5g6660-c5da-11e9-93d4-6d5fc3a66a8e",
   "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":"https://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
      },
      "gaid":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "GAID":{
               
            }
         }
      },
      "idfa":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "acceptedGlobalNamespaces":{
            "IDFA":{
               
            }
         }
      },
      "email_lc_sha256":{
         "acceptsAttributes":true,
         "acceptsCustomNamespaces":true,
         "transformation":"sha256(lower($))",
         "acceptedGlobalNamespaces":{
            "Email":{
               "requiredTransformation":"sha256(lower($))"
            },
            "Email_LC_SHA256":{
               
            }
         }
      }
   },
   "segmentMappingConfig":{
      "mapExperiencePlatformSegmentName":false,
      "mapExperiencePlatformSegmentId":false,
      "mapUserInput":false,
      "audienceTemplateId":"cbf90a70-96b4-437b-86be-522fbdaabe9c"
   },
   "schemaConfig":{
      "profileFields":[
         {
            "name":"a_custom_attribute",
            "title":"a_custom_attribute",
            "description":"This is a fixed attribute on your destination side that customers can map profile attributes to. For example, the phoneNumber value in Experience Platform could be phoneNo on your side.",
            "type":"string",
            "isRequired":false,
            "readOnly":false,
            "hidden":false
         }
      ],
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "aggregation":{
      "aggregationType":"BEST_EFFORT",
      "bestEffortAggregation":{
         "maxUsersPerRequest":10,
         "splitUserById":false
      }
   },
   "destinationDelivery":[
      {
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"9c77000a-4559-40ae-9119-a04324a3ecd4"
      }
   ],
   "backfillHistoricalProfileData":true
}

Suppression d’une configuration de destination spécifique

Vous pouvez supprimer la configuration de destination spécifiée en effectuant une requête de DELETE sur le point de terminaison /authoring/destinations et en fournissant l’identifiant de la configuration de destination que vous souhaitez supprimer dans le chemin d’accès de la requête.

Format d’API

DELETE /authoring/destinations/{INSTANCE_ID}
Paramètre Description
{INSTANCE_ID} id de la configuration de destination que vous souhaitez supprimer.

Requête

curl -X DELETE https://platform.adobe.io/data/core/activation/authoring/destinations/b0780cb5-2bb7-4409-bf2c-c625ca818588 \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

Réponse

Une réponse réussie renvoie un état HTTP 200 avec une réponse HTTP vide.

Gestion des erreurs d’API

Les points d’entrée de l’API du SDK de destination suivent les principes généraux des messages d’erreur de l’API Experience Platform. Reportez-vous aux sections Codes d’état d’API et erreurs d’en-tête de requête dans le guide de dépannage de Platform.

Étapes suivantes

Après avoir lu ce document, vous savez maintenant comment configurer votre destination à l’aide du point de terminaison de l’API /authoring/destinations. Lisez la section Comment utiliser le SDK de destination pour configurer votre destination afin de comprendre où cette étape correspond au processus de configuration de votre destination.

Sur cette page