このページでは、/authoring/destinations
API エンドポイントを使用して、既存の宛先設定を更新するために使用できる API リクエストおよびペイロードの例を示します。
製品化された宛先や公開されている宛先に対する更新操作は、公開 API を使用してアドビレビュー用に更新を送信した後でのみ、表示されます。
宛先設定の機能について詳しくは、以下の記事を参照してください。
Destination SDK でサポートされているすべてのパラメーター名および値は、大文字と小文字が区別されます。大文字と小文字を区別することに関するエラーを避けるために、ドキュメントに示すように、パラメーター名および値を正確に使用してください。
続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報(必要な宛先オーサリング権限および必要なヘッダーの取得方法など)を確認してください。
更新されたペイロードで /authoring/destinations
エンドポイントに PUT
リクエストを行うことで、既存の宛先設定を更新できます。
API エンドポイント:platform.adobe.io/data/core/activation/authoring/destinations
既存の宛先設定およびその関連する {INSTANCE_ID}
を取得するには、宛先設定の取得に関する記事を参照してください。
API 形式
PUT /authoring/destinations/{INSTANCE_ID}
パラメーター | 説明 |
---|---|
{INSTANCE_ID} |
更新する宛先設定の ID。既存の宛先設定およびその関連する {INSTANCE_ID} を取得するには、宛先設定の取得を参照してください。 |
以下のリクエストは、この例で作成した宛先を別の 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
}
}'
応答が成功すると、HTTP ステータス 200 が、更新された宛先設定の詳細と共に返されます。
Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。
このドキュメントでは、Destination SDK /authoring/destinations
API エンドポイントを使用した、宛先設定の更新方法を確認しました。
このエンドポイントでできることについて詳しくは、以下の記事を参照してください。