サンプルプロファイルを使用したストリーミング宛先のテスト template-api-operations
https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/このページでは、宛先が正しく設定されているかどうかをテストしたり、設定された宛先に対するデータフローの整合性を検証したりするために、/authoring/testing/destinationInstance/ API エンドポイントを使用して実行できるすべての API 操作を一覧表示し、説明しています。このエンドポイントでサポートされる機能については、宛先設定のテストを参照してください。
呼び出しにプロファイルを追加してもしなくても、エンドポイントをテストするためのリクエストを行います。リクエスト時に任意のプロファイルを送信しない場合、アドビでは、ユーザーのためにこれらを内部で生成して、リクエストに追加します。
サンプルプロファイル生成 API を使用して、宛先テスト API に対するリクエストで使用するためのプロファイルを作成できます。
宛先インスタンス ID の取得方法 get-destination-instance-id
- この API を使用するには、Experience Platform UI に既存の宛先への接続がある必要があります。詳しくは、宛先への接続および宛先に対するプロファイルとオーディエンスのアクティブ化を参照してください。
- 宛先への接続を確立したら、宛先との接続を参照する際に、このエンドポイントへの API 呼び出しで使用する必要がある、宛先インスタンス ID を取得します。
宛先テスト API 操作の概要 get-started
続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報（必要な宛先オーサリング権限および必要なヘッダーの取得方法など）を確認してください。
呼び出しにプロファイルを追加しないで宛先設定をテスト test-without-adding-profiles
authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID} エンドポイントに対して POST リクエストを行い、テストしている宛先の宛先インスタンス ID を指定することで、宛先設定をテストできます。
API 形式
POST authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}
{DESTINATION_INSTANCE_ID}リクエスト
以下のリクエストは、宛先の REST API エンドポイントを呼び出します。リクエストは、{DESTINATION_INSTANCE_ID} クエリパラメーターで設定されます。
curl --location --request POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/49966037-32cd-4457-a105-2cbf9c01826a' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
応答
応答が成功すると、HTTP ステータス 200 が、宛先の REST API エンドポイントからの API 応答と共に返されます。
{
"results":[
{
"aggregationKey":{
"destinationInstanceId":"string",
"segmentId":"string",
"segmentStatus":"realized",
"identityNamespaces":[
[
"email",
"phone"
]
]
},
"httpCalls":[
{
"traceId":"a06fec2d-a886-4219-8975-4e4b7ed26539",
"request":{
"body":"{ \"attributes\": [ { \"external_id\": \"external_id-h29Fq\" , \"AdobeExperiencePlatformSegments\": { \"add\": [ \"Nirvana fans\" , \"RHCP fans\" ], \"remove\": [ ] } , \"key\": \"string\" } ] }",
"headers":[
{
"Content-Type":"application/json"
}
],
"method":"POST",
"uri":"https://api.moviestar.com/users/track"
},
"response":{
"body":"{\"status\": \"success\"}",
"code":"200",
"headers":[
{
"Connection":"keep-alive"
},
{
"Content-Type":"application/json"
},
{
"Server":"nginx"
},
{
"Vary":"Origin,Accept-Encoding"
},
{
"transfer-encoding":"chunked"
}
]
}
}
]
}
],
"inputProfiles":[
{
"segmentMembership":{
"ups":{
"03fb9938-8537-4b4c-87f9-9c4d413a0ee5":{
"lastQualificationTime":"2021-06-17T12:25:12.872039Z",
"status":"realized"
},
"27e05542-d6a3-46c7-9c8e-d59d50229530":{
"lastQualificationTime":"2021-06-17T12:25:12.872042Z",
"status":"realized"
}
}
},
"personalEmail":{
"address":"john.smith@abc.com"
},
"identityMap":{
"ECID":[
{
"id":"ECID-vlnt6"
}
]
},
"person":{
"name":{
"firstName":"string"
}
}
}
]
}
aggregationKeytraceIdresults.httpCalls.requestresults.httpCalls.responseinputProfiles呼び出しにプロファイルを追加して宛先設定をテスト test-with-added-profiles
authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID} エンドポイントに対して POST リクエストを行い、テストしている宛先の宛先インスタンス ID を指定することで、宛先設定をテストできます。
API 形式
POST authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}
{DESTINATION_INSTANCE_ID}リクエスト
以下のリクエストは、宛先の REST API エンドポイントを呼び出します。リクエストは、ペイロードで提供されるパラメーターおよび {DESTINATION_INSTANCE_ID} クエリパラメーターによって設定されます。
curl --location --request POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/49966037-32cd-4457-a105-2cbf9c01826a' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--data-raw '{
"profiles":[
{
"segmentMembership":{
"ups":{
"374a9a6c-c719-4cdb-a660-155a2838e6d6":{
"lastQualificationTime":"2021-05-13T12:16:27.248585Z",
"status":"realized"
},
"896f8776-9498-47b4-b994-51cb3f61c2c5":{
"lastQualificationTime":"2021-05-13T12:16:27.248605Z",
"status":"realized"
}
}
},
"identityMap":{
"ECID":[
{
"id":"ECID-Z3i2t"
}
],
"external_id":[
{
"id":"external_id-h29Fq"
}
]
},
"attributes":{
"firstName":{
"value":"John"
}
}
}
]
}'
応答
応答が成功すると、HTTP ステータス 200 が、宛先の REST API エンドポイントからの API 応答と共に返されます。
{
"results":[
{
"aggregationKey":{
"destinationInstanceId":"string",
"segmentId":"string",
"segmentStatus":"realized",
"identityNamespaces":[
[
"email",
"phone"
]
]
},
"httpCalls":[
{
"traceId":"a06fec2d-a886-4219-8975-4e4b7ed26539",
"request":{
"body":"{ \"attributes\": [ { \"external_id\": \"external_id-h29Fq\" , \"AdobeExperiencePlatformSegments\": { \"add\": [ \"Nirvana fans\" , \"RHCP fans\" ], \"remove\": [ ] } , \"key\": \"string\" } ] }",
"headers":[
{
"Content-Type":"application/json"
}
],
"method":"POST",
"uri":"https://api.moviestar.com/users/track"
},
"response":{
"body":"{\"status\": \"success\"}",
"code":"200",
"headers":[
{
"Connection":"keep-alive"
},
{
"Content-Type":"application/json"
},
{
"Server":"nginx"
},
{
"Vary":"Origin,Accept-Encoding"
},
{
"transfer-encoding":"chunked"
}
]
}
}
]
}
],
"inputProfiles":[
{
"segmentMembership":{
"ups":{
"374a9a6c-c719-4cdb-a660-155a2838e6d6":{
"lastQualificationTime":"2021-05-13T12:16:27.248585Z",
"status":"realized"
},
"896f8776-9498-47b4-b994-51cb3f61c2c5":{
"lastQualificationTime":"2021-05-13T12:16:27.248605Z",
"status":"realized"
}
}
},
"identityMap":{
"ECID":[
{
"id":"ECID-Z3i2t"
}
],
"external_id":[
{
"id":"external_id-h29Fq"
}
]
},
"attributes":{
"firstName":{
"value":"John"
}
}
}
]
}
API エラー処理 api-error-handling
Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。
次の手順
このドキュメントでは、宛先のテスト方法を確認しました。これで、アドビセルフサービスドキュメントプロセスを使用して、宛先用のドキュメントページを作成できるようになりました。