このページでは、/authoring/destination-servers
API エンドポイントを使用して、既存の宛先サーバー設定を更新するために使用できる API リクエストおよびペイロードの例を示します。
製品化された宛先や公開されている宛先に対する更新操作は、公開 API を使用してアドビレビュー用に更新を送信した後でのみ、表示されます。
このエンドポイントを通じて設定できる機能について詳しくは、以下の記事を参照してください。
Destination SDK でサポートされているすべてのパラメーター名および値は、大文字と小文字が区別されます。大文字と小文字を区別することに関するエラーを避けるために、ドキュメントに示すように、パラメーター名および値を正確に使用してください。
続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報(必要な宛先オーサリング権限および必要なヘッダーの取得方法など)を確認してください。
更新されたペイロードで /authoring/destination-servers
エンドポイントに PUT
リクエストを行うことで、既存の宛先サーバー設定を更新できます。
API エンドポイント:platform.adobe.io/data/core/activation/authoring/destination-servers
既存の宛先サーバー設定およびその関連する {INSTANCE_ID}
を取得するには、宛先サーバー設定の取得に関する記事を参照してください。
API 形式
PUT /authoring/destination-servers/{INSTANCE_ID}
パラメーター | 説明 |
---|---|
{INSTANCE_ID} |
更新する宛先サーバー設定の ID。既存の宛先サーバー設定およびその関連する {INSTANCE_ID} を取得するには、宛先サーバー設定の取得を参照してください。 |
以下のリクエストは、ペイロードで提供されるパラメーター設定に基づいて、既存の宛先サーバー設定を更新します。
以下の各タブを選択して、対応するペイロードを表示します。
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers\{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":"Moviestar destination server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.region}}/items"
}
},
"httpTemplate":{
"httpMethod":"PUT",
"requestBody":{
"templatingStrategy":"PEBBLE_V1",
"value":"{ \"attributes\": [ {% for ns in [\"external_id\", \"yourdestination_id\"] %} {% if input.profile.identityMap[ns] is not empty and first_namespace_encountered %} , {% endif %} {% set first_namespace_encountered = true %} {% for identity in input.profile.identityMap[ns]%} { \"{{ ns }}\": \"{{ identity.id }}\" {% if input.profile.segmentMembership.ups is not empty %} , \"AEPSegments\": { \"add\": [ {% for segment in input.profile.segmentMembership.ups %} {% if segment.value.status == \"realized\" or segment.value.status == \"existing\" %} {% if added_segment_found %} , {% endif %} {% set added_segment_found = true %} \"{{ destination.segmentAliases[segment.key] }}\" {% endif %} {% endfor %} ], \"remove\": [ {% for segment in input.profile.segmentMembership.ups %} {% if segment.value.status == \"exited\" %} {% if removed_segment_found %} , {% endif %} {% set removed_segment_found = true %} \"{{ destination.segmentAliases[segment.key] }}\" {% endif %} {% endfor %} ] } {% set removed_segment_found = false %} {% set added_segment_found = false %} {% endif %} {% if input.profile.attributes is not empty %} , {% endif %} {% for attribute in input.profile.attributes %} \"{{ attribute.key }}\": {% if attribute.value is empty %} null {% else %} \"{{ attribute.value.value }}\" {% endif %} {% if not loop.last%} , {% endif %} {% endfor %} } {% if not loop.last %} , {% endif %} {% endfor %} {% endfor %} ] }"
},
"contentType":"application/json"
}
}
パラメーター | タイプ | 説明 |
---|---|---|
name |
文字列 | 必須。 サーバーのわかりやすい名前を表し、アドビにのみ表示されます。この名前は、パートナーや顧客には表示されません。例えば Moviestar destination server です。 |
destinationServerType |
文字列 | 必須。リアルタイム(ストリーミング)宛先用に URL_BASED に設定します。 |
urlBasedDestination.url.templatingStrategy |
文字列 | 必須。
|
urlBasedDestination.url.value |
文字列 | 必須。 Experience Platform が接続する API エンドポイントのアドレスを入力します。 |
httpTemplate.httpMethod |
文字列 | 必須。 サーバーへの呼び出しでアドビが使用するメソッド。オプションは、GET 、PUT 、PUT 、DELETE 、PATCH です。 |
httpTemplate.requestBody.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
httpTemplate.requestBody.value |
文字列 | 必須。 この文字列は、Platform 顧客のデータをサービスが想定する形式に変換する、文字エスケープバージョンです。
|
httpTemplate.contentType |
文字列 | 必須。 サーバーが受け入れるコンテンツタイプ。この値は application/json である可能性が高いです。 |
応答が成功すると、HTTP ステータス 200 が、更新された宛先サーバー設定の詳細と共に返されます。
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers\{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": "S3 destination",
"destinationServerType": "FILE_BASED_S3",
"fileBasedS3Destination": {
"bucket": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.bucket}}"
},
"path": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.path}}"
}
},
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
}
}
}
パラメーター | タイプ | 説明 |
---|---|---|
name |
文字列 | 宛先接続の名前。 |
destinationServerType |
文字列 | この値は、宛先プラットフォームに応じて設定します。Amazon S3 の場合は、これを FILE_BASED_S3 に設定します。 |
fileBasedS3Destination.bucket.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
fileBasedS3Destination.bucket.value |
文字列 | この宛先が使用する Amazon S3 バケット名。 |
fileBasedS3Destination.path.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
fileBasedS3Destination.path.value |
文字列 | 書き出したファイルをホストする保存先フォルダーのパス。 |
fileConfigurations |
なし | これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
応答が成功すると、HTTP ステータス 200 が、更新された宛先サーバー設定の詳細と共に返されます。
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{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":"File-based SFTP destination server",
"destinationServerType":"FILE_BASED_SFTP",
"fileBasedSFTPDestination":{
"rootDirectory":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.rootDirectory}}"
},
"port": 22,
"encryptionMode" : "PGP"
},
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
}
}
}
パラメーター | タイプ | 説明 |
---|---|---|
name |
文字列 | 宛先接続の名前。 |
destinationServerType |
文字列 | この値は、宛先プラットフォームに応じて設定します。SFTP の宛先の場合、これを FILE_BASED_SFTP に設定します。 |
fileBasedSFTPDestination.rootDirectory.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
fileBasedSFTPDestination.rootDirectory.value |
文字列 | 宛先ストレージのルートディレクトリ。 |
fileBasedSFTPDestination.hostName.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
fileBasedSFTPDestination.hostName.value |
文字列 | 宛先ストレージのホスト名。 |
port |
整数 | SFTP ファイルサーバーのポート。 |
encryptionMode |
文字列 | ファイルの暗号化を使用するかどうかを示します。サポートされている値:
|
fileConfigurations |
なし | これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
応答が成功すると、HTTP ステータス 200 が、更新された宛先サーバー設定の詳細と共に返されます。
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{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":"ADLS destination server",
"destinationServerType":"FILE_BASED_ADLS_GEN2",
"fileBasedAdlsGen2Destination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
},
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
}
}
}
パラメーター | タイプ | 説明 |
---|---|---|
name |
文字列 | 宛先接続の名前。 |
destinationServerType |
文字列 | この値は、宛先プラットフォームに応じて設定します。Azure Data Lake Storage の宛先の場合、これを FILE_BASED_ADLS_GEN2 に設定します。 |
fileBasedAdlsGen2Destination.path.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
fileBasedAdlsGen2Destination.path.value |
文字列 | 書き出したファイルをホストする保存先フォルダーのパス。 |
fileConfigurations |
なし | これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
応答が成功すると、HTTP ステータス 200 が、更新された宛先サーバー設定の詳細と共に返されます。
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{INSTANCE_D} \
-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":"Blob destination server",
"destinationServerType":"FILE_BASED_AZURE_BLOB",
"fileBasedAzureBlobDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"container":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.container}}"
}
},
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
}
}
}
パラメーター | タイプ | 説明 |
---|---|---|
name |
文字列 | 宛先接続の名前。 |
destinationServerType |
文字列 | この値は、宛先プラットフォームに応じて設定します。Azure Blob Storage の宛先の場合、これを FILE_BASED_AZURE_BLOB に設定します。 |
fileBasedAzureBlobDestination.path.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
fileBasedAzureBlobDestination.path.value |
文字列 | 書き出したファイルをホストする保存先フォルダーのパス。 |
fileBasedAzureBlobDestination.container.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
fileBasedAzureBlobDestination.container.value |
文字列 | この宛先で使用される Azure Blob Storage コンテナ名。 |
fileConfigurations |
なし | これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
応答が成功すると、HTTP ステータス 200 が、更新された宛先サーバー設定の詳細と共に返されます。
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{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":"DLZ destination server",
"destinationServerType":"FILE_BASED_DLZ",
"fileBasedDlzDestination":{
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
},
"useCase": "Your use case"
},
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
}
}
}
パラメーター | タイプ | 説明 |
---|---|---|
name |
文字列 | 宛先接続の名前。 |
destinationServerType |
文字列 | この値は、宛先プラットフォームに応じて設定します。Data Landing Zone の宛先の場合、これを FILE_BASED_DLZ に設定します。 |
fileBasedDlzDestination.path.templatingStrategy |
文字列 | 必須。PEBBLE_V1 を使用します。 |
fileBasedDlzDestination.path.value |
文字列 | 書き出したファイルをホストする保存先フォルダーのパス。 |
fileConfigurations |
なし | これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
応答が成功すると、HTTP ステータス 200 が、更新された宛先サーバー設定の詳細と共に返されます。
curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers/{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":"Google Cloud Storage Server",
"destinationServerType":"FILE_BASED_GOOGLE_CLOUD",
"fileBasedGoogleCloudStorageDestination":{
"bucket":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.bucket}}"
},
"path":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.path}}"
}
},
"fileConfigurations": {
"compression": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.compression}}"
},
"fileType": {
"templatingStrategy": "PEBBLE_V1",
"value": "{{customerData.fileType}}"
},
"csvOptions": {
"quote": {
"templatingStrategy": "NONE",
"value": "\""
},
"quoteAll": {
"templatingStrategy": "NONE",
"value": "false"
},
"escape": {
"templatingStrategy": "NONE",
"value": "\\"
},
"escapeQuotes": {
"templatingStrategy": "NONE",
"value": "true"
},
"header": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreLeadingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"ignoreTrailingWhiteSpace": {
"templatingStrategy": "NONE",
"value": "true"
},
"nullValue": {
"templatingStrategy": "NONE",
"value": ""
},
"dateFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd"
},
"timestampFormat": {
"templatingStrategy": "NONE",
"value": "yyyy-MM-dd'T':mm:ss[.SSS][XXX]"
},
"charToEscapeQuoteEscaping": {
"templatingStrategy": "NONE",
"value": "\\"
},
"emptyValue": {
"templatingStrategy": "NONE",
"value": ""
}
}
}
}
パラメーター | タイプ | 説明 |
---|---|---|
name |
文字列 | 宛先接続の名前。 |
destinationServerType |
文字列 | この値は、宛先プラットフォームに応じて設定します。Google Cloud Storage の宛先の場合、これを FILE_BASED_GOOGLE_CLOUD に設定します。 |
fileBasedGoogleCloudStorageDestination.bucket.templatingStrategy |
文字列 | 必須。PEBBLE_V1 を使用します。 |
fileBasedGoogleCloudStorageDestination.bucket.value |
文字列 | この宛先が使用する Google Cloud Storage バケット名。 |
fileBasedGoogleCloudStorageDestination.path.templatingStrategy |
文字列 | 必須。 PEBBLE_V1 を使用します。 |
fileBasedGoogleCloudStorageDestination.path.value |
文字列 | 書き出したファイルをホストする保存先フォルダーのパス。 |
fileConfigurations |
なし | これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
応答が成功すると、HTTP ステータス 200 が、更新された宛先サーバー設定の詳細と共に返されます。
Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。
このドキュメントでは、Destination SDK /authoring/destination-servers
API エンドポイントを使用した、宛先サーバー設定の更新方法を確認しました。
このエンドポイントでできることについて詳しくは、以下の記事を参照してください。