宛先サーバー設定の作成
Last update: Tue Oct 31 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
宛先サーバーの作成は、Destination SDK で独自の宛先を作成する最初の手順です。宛先サーバーには、サーバーおよびテンプレート仕様、メッセージ形式、ファイル形式オプション(ファイルベースの宛先用)のための設定オプションが含まれます。
このページでは、/authoring/destination-servers
API エンドポイントを使用して、独自の宛先サーバーを作成するために使用できる API リクエストおよびペイロードの例を示します。
このエンドポイントを通じて設定できる機能について詳しくは、以下の記事を参照してください。
Destination SDK でサポートされているすべてのパラメーター名および値は、大文字と小文字が区別 されます。大文字と小文字を区別することに関するエラーを避けるために、ドキュメントに示すように、パラメーター名および値を正確に使用してください。
宛先サーバー API 操作の概要 get-started
続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報(必要な宛先オーサリング権限および必要なヘッダーの取得方法など)を確認してください。
宛先サーバー設定の作成 create
/authoring/destination-servers
エンドポイントに POST
リクエストを行うことで、新しい宛先サーバー設定を作成できます。
API エンドポイント:platform.adobe.io/data/core/activation/authoring/destination-servers
API 形式
POST /authoring/destination-servers
作成する宛先タイプに応じて、タイプが多少異なる宛先サーバー設定する必要があります。
静的スキーマの宛先サーバーの作成 static-destination-servers
静的スキーマを使用する宛先については、以下の各タブで宛先サーバーの例を参照してください。
以下のサンプルペイロードには、各宛先サーバータイプでサポートされているすべてのパラメーターが含まれます。リクエストにすべてのパラメーターを含める必要はありません。ペイロードは、必要に基づいてカスタマイズできます。
以下の各タブを選択して、対応する API リクエストを表示します。
リアルタイム(ストリーミング)
リアルタイム(ストリーミング)宛先サーバーの作成
リアルタイム(ストリーミング)API ベースの統合を設定する場合、以下に示すものに類似したリアルタイム(ストリーミング)宛先サーバーを作成する必要があります。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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":"POST",
"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"
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
name |
文字列 |
必須。 サーバーのわかりやすい名前を表し、アドビにのみ表示されます。この名前は、パートナーや顧客には表示されません。例えば Moviestar destination server です。 |
destinationServerType |
文字列 |
必須。 リアルタイム(ストリーミング)宛先用に URL_BASED に設定します。 |
urlBasedDestination.url.templatingStrategy |
文字列 |
必須。
- 以下の
value フィールドの URL をアドビが変換する必要がある場合は、PEBBLE_V1 を使用します。https://api.moviestar.com/data/{{customerData.region}}/items のようなエンドポイントがある場合は、このオプションを使用します(region 部分は、顧客間で異なる可能性があります)。この場合、region を[宛先設定]の顧客データフィールドとして設定する必要もあります(…/destination-configuration/create-destination-configuration.md.
- アドビ側での変換が不要な場合(例えば、
https://api.moviestar.com/data/items のようなエンドポイントがある場合)は、NONE を使用します。
|
urlBasedDestination.url.value |
文字列 |
必須。 Experience Platform が接続する API エンドポイントのアドレスを入力します。 |
httpTemplate.httpMethod |
文字列 |
必須。 サーバーへの呼び出しでアドビが使用するメソッド。オプションは、GET 、PUT 、POST 、DELETE 、PATCH です。 |
httpTemplate.requestBody.templatingStrategy |
文字列 |
必須。 PEBBLE_V1 を使用します。 |
httpTemplate.requestBody.value |
文字列 |
必須。 この文字列は、Platform 顧客のデータをサービスが想定する形式に変換する、文字エスケープバージョンです。
|
httpTemplate.contentType |
文字列 |
必須。 サーバーが受け入れるコンテンツタイプ。この値は application/json である可能性が高いです。 |
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
Amazon S3
Amazon S3 宛先サーバーの作成
ファイルベースの Amazon S3 宛先を設定する場合、以下に示すものに類似した Amazon S3 宛先サーバーを作成する必要があります。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
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 |
なし |
これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
SFTP
SFTP 宛先サーバーの作成
ファイルベースの SFTP 宛先を設定する場合、以下に示すものに類似した SFTP 宛先サーバーを作成する必要があります。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 9-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
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 |
なし |
これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
Azure Data Lake Storage
Azure Data Lake Storage 宛先サーバーの作成
ファイルベースの Azure Data Lake Storage 宛先を設定する場合、以下に示すものに類似した Azure Data Lake Storage 宛先サーバーを作成する必要があります。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
name |
文字列 |
宛先接続の名前。 |
destinationServerType |
文字列 |
この値は、宛先プラットフォームに応じて設定します。Azure Data Lake Storage の宛先の場合、これを FILE_BASED_ADLS_GEN2 に設定します。 |
fileBasedAdlsGen2Destination.path.templatingStrategy |
文字列 |
必須。 PEBBLE_V1 を使用します。 |
fileBasedAdlsGen2Destination.path.value |
文字列 |
書き出したファイルをホストする保存先フォルダーのパス。 |
fileConfigurations |
なし |
これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
Azure Blob Storage
Azure Blob Storage 宛先サーバーの作成
ファイルベースの Azure Blob Storage 宛先を設定する場合、以下に示すものに類似した Azure Blob Storage 宛先サーバーを作成する必要があります。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
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 |
なし |
これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
データランディングゾーン(DLZ)
Data Landing Zone (DLZ) 宛先サーバーの作成
ファイルベースの Data Landing Zone (DLZ) 宛先を設定する場合、以下に示すものに類似した Data Landing Zone (DLZ) 宛先サーバーを作成する必要があります。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
name |
文字列 |
宛先接続の名前。 |
destinationServerType |
文字列 |
この値は、宛先プラットフォームに応じて設定します。Data Landing Zone の宛先の場合、これを FILE_BASED_DLZ に設定します。 |
fileBasedDlzDestination.path.templatingStrategy |
文字列 |
必須。PEBBLE_V1 を使用します。 |
fileBasedDlzDestination.path.value |
文字列 |
書き出したファイルをホストする保存先フォルダーのパス。 |
fileConfigurations |
なし |
これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
Google Cloud Storage
Google Cloud Storage 宛先サーバーの作成
ファイルベースの Google Cloud Storage 宛先を設定する場合、以下に示すものに類似した Google Cloud Storage 宛先サーバーを作成する必要があります。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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": ""
}
}
}
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
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 |
なし |
これらの設定の設定方法について詳しくは、ファイル形式設定を参照してください。 |
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
動的スキーマの宛先サーバーの作成 dynamic-schema-servers
動的スキーマを使用すると、サポートされているターゲット属性を動的に取得し、独自の API に基づいてスキーマを生成できます。動的スキーマを設定する前に、動的スキーマの宛先サーバーを設定する必要があります。
動的スキーマを使用する宛先については、以下のタブで宛先サーバーの例を参照してください。
以下のサンプルペイロードには、動的スキーマサーバーに必要なすべてのパラメーターが含まれています。
動的スキーマサーバー
動的スキーマサーバーの作成
独自の API エンドポイントからそのプロファイルスキーマを取得する宛先を設定する場合、以下に示すものに類似した動的スキーマサーバーを作成する必要があります。静的スキーマとは対照的に、動的スキーマは、profileFields
配列を使用しません。代わりに、動的スキーマは、スキーマ設定を取得する独自の API に接続する、動的スキーマサーバーを使用します。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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":"Dynamic Schema Server",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://YOUR_API_ENDPOINT/"
}
},
"httpTemplate":{
"httpMethod":"GET"
},
"responseFields":[
{
"templatingStrategy":"PEBBLE_V1",
"value":"{\n \"type\":\"object\",\n \"title\": \"Contact Schema\",\n \"properties\": {\n {% for setDefinition in response.body.items %}\n \"{{setDefinition.key}}\": {\n \"title\" : \"{{setDefinition.name.value}}\",\n \"type\" : \"object\",\n \"properties\": {\n {% for attribute in setDefinition.attributes %}\n \"{{attribute.key}}\": {\n \"title\" : \"{{attribute.name.value}}\",\n \"type\" : \"string\"\n }\n {% if not loop.last %},{%endif%}\n {% endfor %}\n }\n }\n {% if not loop.last %},{%endif%}\n {% endfor %}\n }\n}",
"name":"schema"
}
]
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
name |
文字列 |
必須。 動的スキーマサーバーのわかりやすい名前を表し、アドビにのみ表示されます。 |
destinationServerType |
文字列 |
必須。 動的スキーマサーバーには、URL_BASED に設定します。 |
urlBasedDestination.url.templatingStrategy |
文字列 |
必須。
- 以下の
value フィールドの URL をアドビが変換する必要がある場合は、PEBBLE_V1 を使用します。https://api.moviestar.com/data/{{customerData.region}}/items のようなエンドポイントがある場合は、このオプションを使用します。
- アドビ側での変換が不要な場合(例えば、
https://api.moviestar.com/data/items のようなエンドポイントがある場合)は、NONE を使用します。
|
urlBasedDestination.url.value |
文字列 |
必須。 Experience Platform が接続する必要がある API エンドポイントのアドレスを入力して、アクティベーションワークフローのマッピング手順でターゲットフィールドとして設定するスキーマフィールドを取得します。 |
httpTemplate.httpMethod |
文字列 |
必須。 サーバーへの呼び出しでアドビが使用するメソッド。動的スキーマサーバーには、GET を使用します。 |
responseFields.templatingStrategy |
文字列 |
必須。 PEBBLE_V1 を使用します。 |
responseFields.value |
文字列 |
必須。 この文字列は、パートナー API から受信した応答を Platform UI に表示されるパートナースキーマに変換する、文字がエスケープされた変換テンプレートです。
|
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
動的ドロップダウンの宛先サーバーの作成 dynamic-dropdown-servers
用途 動的ドロップダウン :独自の API に基づいて、ドロップダウンの顧客データフィールドを動的に取得し、設定します。 例えば、宛先接続に使用する既存のユーザーアカウントのリストを取得できます。
動的ドロップダウン顧客データフィールドを設定する前に、動的ドロップダウンの宛先サーバーを設定する必要があります。
ドロップダウンセレクターに表示される値を API から動的に取得する場合に使用する宛先サーバーの例の下にある「 」タブのを参照してください。
以下のサンプルペイロードには、動的スキーマサーバーに必要なすべてのパラメーターが含まれています。
動的ドロップダウンサーバー
動的ドロップダウンサーバーの作成
独自の API エンドポイントからドロップダウン顧客データフィールドの値を取得する宛先を設定する際に、次に示すような動的ドロップダウンサーバーを作成する必要があります。
accordion |
リクエスト |
code language-shell |
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destination-servers \
-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":"Server for dynamic dropdown",
"destinationServerType":"URL_BASED",
"urlBasedDestination":{
"url":{
"templatingStrategy":"PEBBLE_V1",
"value":"https://api.moviestar.com/data/{{customerData.users}}/items"
}
},
"httpTemplate":{
"httpMethod":"GET",
"headers":[
{
"header":"Authorization",
"value":{
"templatingStrategy":"PEBBLE_V1",
"value":"My Bearer Token"
}
},
{
"header":"x-integration",
"value":{
"templatingStrategy":"PEBBLE_V1",
"value":"{{customerData.integrationId}}"
}
},
{
"header":"Accept",
"value":{
"templatingStrategy":"NONE",
"value":"application/json"
}
}
]
},
"responseFields":[
{
"templatingStrategy":"PEBBLE_V1",
"value":"{% set list = [] %} {% for record in response.body %} {% set list = list|merge([{'name' : record.name, 'value' : record.id }]) %} {% endfor %}{{ {'list': list} | toJson | raw }}",
"name":"list"
}
]
}
|
table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 7-row-3 8-row-3 layout-auto |
|
|
パラメーター |
タイプ |
説明 |
name |
文字列 |
必須。 動的ドロップダウンサーバーのわかりやすい名前を表します。Adobeにのみ表示されます。 |
destinationServerType |
文字列 |
必須。 をに設定します。 URL_BASED 動的なドロップダウンサーバーの場合。 |
urlBasedDestination.url.templatingStrategy |
文字列 |
必須。
- 以下の
value フィールドの URL をアドビが変換する必要がある場合は、PEBBLE_V1 を使用します。https://api.moviestar.com/data/{{customerData.region}}/items のようなエンドポイントがある場合は、このオプションを使用します。
- アドビ側での変換が不要な場合(例えば、
https://api.moviestar.com/data/items のようなエンドポイントがある場合)は、NONE を使用します。
|
urlBasedDestination.url.value |
文字列 |
必須。 Experience Platformが接続する API エンドポイントのアドレスを入力し、ドロップダウン値を取得します。 |
httpTemplate.httpMethod |
文字列 |
必須。 サーバーへの呼び出しでアドビが使用するメソッド。動的なドロップダウンサーバーの場合は、 GET . |
httpTemplate.headers |
オブジェクト |
Optiona.l 動的ドロップダウンサーバーへの接続に必要なヘッダーを含めます。 |
responseFields.templatingStrategy |
文字列 |
必須。 PEBBLE_V1 を使用します。 |
responseFields.value |
文字列 |
必須。 この文字列は、API から受け取った応答を Platform UI に表示される値に変換する、文字エスケープされた変換テンプレートです。
|
|
accordion |
応答 |
応答が成功すると、HTTP ステータス 200 が、新しく作成された宛先サーバー設定の詳細と共に返されます。 |
API エラー処理 error-handling
Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。
次の手順 next-steps
このドキュメントでは、Destination SDK /authoring/destination-servers
API エンドポイントを使用した、新しい宛先サーバーの作成方法を確認しました。
このエンドポイントでできることについて詳しくは、以下の記事を参照してください。
このエンドポイントが宛先オーサリングプロセスのどこに適合するかを把握するには、以下の記事を参照してください。