Mise à jour d’une configuration de destination
- Rubriques :
- Destinations
Créé pour :
- Administration
- Utilisateur ou utilisatrice
Cette page illustre la requête d’API et la payload que vous pouvez utiliser pour mettre à jour une configuration de destination existante à l’aide du point d’entrée /authoring/destinations
de l’API.
Pour une description détaillée des fonctionnalités de configuration de la destination, consultez les articles suivants :
- Configuration de l’authentification du client
- Autorisation OAuth2
- Champs de données client
- Attributs de l’interface utilisateur
- Configuration du schéma
- Configuration de l’espace de noms d’identité
- Diffusion de destination
- Configuration des métadonnées d’audience
- Configuration des métadonnées d’audience
- Politique d’agrégation
- Configuration par lots
- Qualifications des profils historiques
Prise en main des opérations dʼAPI de configuration de destinations
Avant de poursuivre, consultez le guide de prise en main pour obtenir des informations importantes à connaître avant d’effectuer des appels vers l’API, notamment sur la manière d’obtenir l’autorisation de création de la destination et les en-têtes obligatoires.
Mise à jour d’une configuration de destination
Vous pouvez mettre à jour une configuration de destination existante en effectuant une requête PUT
au point d’entrée /authoring/destinations
avec la payload mise à jour.
platform.adobe.io/data/core/activation/authoring/destinations
Pour obtenir une configuration de destination existante et son {INSTANCE_ID}
correspondant, consultez l’article sur la récupération d’une configuration de destination.
Format d’API
PUT /authoring/destinations/{INSTANCE_ID}
{INSTANCE_ID}
{INSTANCE_ID}
correspondant, consultez la section Récupération d’une configuration de destination.La requête suivante met à jour la destination que nous avons créée dans cet exemple avec différentes options filenameConfig
.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations/{INSTANCE_ID} \
-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"
}
],
"customerEncryptionConfigurations":[
],
"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":"File type",
"description":"Select the exported file type.",
"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",
"ONCE"
],
"defaultFrequency":"DAILY",
"defaultStartTime":"00:00",
"filenameConfig":{
"allowedFilenameAppendOptions":[
"SEGMENT_NAME",
"DESTINATION_INSTANCE_NAME",
"ORGANIZATION_NAME",
"SANDBOX_NAME",
"DATETIME",
"CUSTOM_TEXT"
],
"defaultFilenameAppendOptions":[
"DATETIME"
],
"defaultFilename":"%DESTINATION%_%SEGMENT_ID%_%DESTINATION_INSTANCE_ID%,"
},
"backfillHistoricalProfileData":true
}
}'
Gestion des erreurs d’API
Les points d’entrée de l’API Destination SDK suivent les principes généraux des messages d’erreur de l’API Experience Platform. Consultez les 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
Vous êtes arrivé au bout de ce document. À présent, vous savez comment mettre à jour une configuration de destination avec le point d’entrée /authoring/destinations
Destination SDK de l’API.
Pour en savoir plus sur les fonctionnalités offertes par ce point d’entrée, consultez les articles suivants :