Création d’une configuration de destination

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: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "name":"Amazon S3 destination with predefined CSV formatting options",
   "description":"Amazon S3 destination with predefined CSV formatting options",
   "status":"TEST",
   "customerAuthenticationConfigurations":[
      {
         "authType":"S3"
      }
   ],
   "customerDataFields":[
      {
         "name":"bucket",
         "title":"Enter the name of your Amazon S3 bucket",
         "description":"Amazon S3 bucket name",
         "type":"string",
         "isRequired":true,
         "readOnly":false,
         "hidden":false
      },
      {
         "name":"path",
         "title":"Enter the path to your S3 bucket folder",
         "description":"Enter the path to your S3 bucket folder",
         "type":"string",
         "isRequired":true,
         "pattern":"^[A-Za-z]+$",
         "readOnly":false,
         "hidden":false
      },
      {
         "name":"compression",
         "title":"Compression format",
         "description":"Select the desired file compression format.",
         "type":"string",
         "isRequired":true,
         "readOnly":false,
         "enum":[
            "SNAPPY",
            "GZIP",
            "DEFLATE",
            "NONE"
         ]
      },
      {
         "name":"fileType",
         "title":"Select a fileType",
         "description":"Select fileType",
         "type":"string",
         "isRequired":true,
         "readOnly":false,
         "hidden":false,
         "enum":[
            "csv",
            "json",
            "parquet"
         ],
         "default":"csv"
      }
   ],
   "uiAttributes":{
      "documentationLink":"https://www.adobe.com/go/destinations-amazon-s3-en",
      "category":"cloudStorage",
      "icon":{
         "key":"amazonS3"
      },
      "connectionType":"S3",
      "frequency":"Batch"
   },
   "destinationDelivery":[
      {
         "deliveryMatchers":[
            {
               "type":"SOURCE",
               "value":[
                  "batch"
               ]
            }
         ],
         "authenticationRule":"CUSTOMER_AUTHENTICATION",
         "destinationServerId":"{{destinationServerId}}"
      }
   ],
   "schemaConfig":{
      "profileRequired":true,
      "segmentRequired":true,
      "identityRequired":true
   },
   "batchConfig":{
      "allowMandatoryFieldSelection":true,
      "allowDedupeKeyFieldSelection":true,
      "defaultExportMode":"DAILY_FULL_EXPORT",
      "allowedExportMode":[
         "DAILY_FULL_EXPORT",
         "FIRST_FULL_THEN_INCREMENTAL"
      ],
      "allowedScheduleFrequency":[
         "DAILY",
         "EVERY_3_HOURS",
         "EVERY_6_HOURS",
         "EVERY_8_HOURS",
         "EVERY_12_HOURS",
         "ONCE"
      ],
      "defaultFrequency":"DAILY",
      "defaultStartTime":"00:00",
      "filenameConfig":{
         "allowedFilenameAppendOptions":[
            "SEGMENT_NAME",
            "DESTINATION_INSTANCE_ID",
            "DESTINATION_INSTANCE_NAME",
            "ORGANIZATION_NAME",
            "SANDBOX_NAME",
            "DATETIME",
            "CUSTOM_TEXT"
         ],
         "defaultFilenameAppendOptions":[
            "DATETIME"
         ],
         "defaultFilename":"%DESTINATION%_%SEGMENT_ID%"
      },
      "backfillHistoricalProfileData":true
   }
}'

Paramètre	Type	Description
name	Chaîne	Indique le titre de votre destination dans le catalogue Experience Platform.
description	Chaîne	Fournissez une description qu’Adobe utilisera dans le catalogue des destinations Experience Platform pour votre carte de destination. N’utilisez pas plus de 4 à 5 phrases.
status	Chaîne	Indique le statut 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.authType	Chaîne	Indique la configuration utilisée pour authentifier les clients Experience Platform sur votre serveur de destination. Voir configuration de l'authentification du client pour plus d’informations sur les types d’authentification pris en charge.
customerDataFields.name	Chaîne	Attribuez un nom au champ personnalisé que vous introduisez. Voir Champs de données client pour plus d’informations sur ces paramètres.
customerDataFields.type	Chaîne	Indique le type de champ personnalisé que vous introduisez. Les valeurs acceptées sont les suivantes : string, object ou integer. Voir Champs de données client pour plus d’informations sur ces paramètres.
customerDataFields.title	Chaîne	Indique le nom du champ tel qu’il est affiché par les clients dans l’interface utilisateur d’Experience Platform. Voir Champs de données client pour plus d’informations sur ces paramètres.
customerDataFields.description	Chaîne	Fournissez une description du champ personnalisé. Voir Champs de données client pour plus d’informations sur ces paramètres.
customerDataFields.isRequired	Booléen	Indique si ce champ est requis dans le workflow de configuration de destination. Voir Champs de données client pour plus d’informations sur ces paramètres.
customerDataFields.enum	Chaîne	Rend le champ personnalisé sous forme de menu déroulant et répertorie les options disponibles pour l’utilisateur. Voir Champs de données client pour plus d’informations sur ces paramètres.
customerDataFields.default	Chaîne	Définit la valeur par défaut d’une liste enum.
customerDataFields.pattern	Chaîne	Impose un modèle pour le champ personnalisé, le cas échéant. Utilisez des expressions régulières pour appliquer un modèle. Par exemple, si vos identifiants de client n’incluent pas de chiffres ou de traits de soulignement, saisissez ^[A-Za-z]+$ dans ce champ. Voir Champs de données client pour plus d’informations sur ces paramètres.
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. Par exemple, pour une destination appelée Moviestar, procédez comme suit : https://www.adobe.com/go/destinations-moviestar-en. Notez que ce lien ne fonctionne qu’après que Adobe a défini votre destination et que la documentation a été publiée. Voir Attributs de l’interface utilisateur pour plus d’informations sur ces paramètres.
uiAttributes.category	Chaîne	Fait référence à la catégorie affectée à votre destination dans Adobe Experience Platform. Pour plus d’informations, consultez la section Catégories de destinations. 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. Voir Attributs de l’interface utilisateur pour plus d’informations sur ces paramètres.
uiAttributes.connectionType	Chaîne	Type de connexion en fonction de la destination. Valeurs prises en charge : Server-to-server Cloud storage Azure Blob Azure Data Lake Storage S3 SFTP DLZ
uiAttributes.frequency	Chaîne	Fait référence au type d’exportation des données pris en charge par la destination. Définissez sur . Streaming pour les intégrations basées sur des API, ou Batch lorsque vous exportez des fichiers vers vos destinations.
identityNamespaces.externalId.acceptsAttributes	Booléen	Indique si les clients peuvent mapper des attributs de profil standard à l’identité que vous configurez.
identityNamespaces.externalId.acceptsCustomNamespaces	Booléen	Indique si les clients peuvent mapper des identités appartenant à espaces de noms personnalisés à l’identité que vous configurez.
identityNamespaces.externalId.transformation	Chaîne	Non affiché dans l’exemple de configuration. Utilisé, par exemple, lorsque le client Platform dispose d’adresses e-mail simples en tant qu’attribut et que votre plateforme accepte les e-mails hachés uniquement. C’est ici que vous devez fournir la transformation à appliquer (transformer l’adresse e-mail en minuscules, puis la hacher, par exemple).
identityNamespaces.externalId.acceptedGlobalNamespaces	-	Indique : espaces de noms d’identité standard (par exemple, les clients IDFA) peuvent mapper l’identité que vous configurez. Lorsque vous utilisez acceptedGlobalNamespaces, vous pouvez employer "requiredTransformation":"sha256(lower($))" pour mettre en minuscules ou hacher des adresses e-mails ou des numéros de téléphone.
destinationDelivery.authenticationRule	Chaîne	Indique comment les clients Platform se connectent à votre destination. Les valeurs acceptées sont les suivantes : CUSTOMER_AUTHENTICATION, PLATFORM_AUTHENTICATION, NONE. Utilisez CUSTOMER_AUTHENTICATION si les clients Platform se connectent à votre système par le biais 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 Adobe et votre destination et que le client Platform n’a pas besoin de fournir d’informations d’authentification pour se connecter à votre destination. Dans ce cas, vous devez créer un objet d’identification à l’aide de la variable API des informations d’identification configuration. 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. Toujours définir cette variable sur true.
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 champs profileFields prédéfinis, comme illustré dans la configuration ci-dessus, les utilisateurs ont 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 d’Experience Platform aux attributs personnalisés du côté de votre destination, tel qu’indiqué 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 des espaces de noms d’identité d’Experience Platform au schéma souhaité.

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.