ストリーミング宛先テスト API

Destination SDK の一部として、アドビは、宛先の設定およびテストを支援するためのデベロッパーツールを提供しています。このページでは、宛先設定のテスト方法を説明します。メッセージ変換テンプレートの作成方法について詳しくは、メッセージ変換テンプレートの作成とテストを参照してください。

宛先が正しく設定されているかどうかをテストしたり、設定された宛先へのデータフローの整合性を検証したり ​するには、宛先テストツール ​を使用します。このツールでは、REST API エンドポイントにメッセージを送信することで、宛先設定をテストできます。

以下の図に、宛先のテストが Destination SDK の宛先設定ワークフローにどのように適合するかを示します。

宛先テスト手順が宛先設定ワークフローのどこに適合するかを示すグラフィック

宛先テストツール - 目的と前提条件 destination-testing-tool

宛先テストツールを使用して、サーバー設定で指定されたパートナーのエンドポイントにメッセージを送信することで、宛先サーバー設定をテストします。

ツールを使用する前に、以下を確認します。

このツールを使用すると、宛先の設定後に、以下が可能です。

  • 宛先が正しく設定されているかどうかをテストする。
  • 設定された宛先へのデータフローの整合性を検証する。

使用方法 how-to-use

NOTE
完全な API リファレンスドキュメントについては、宛先テスト API 操作を参照してください。

リクエスト時にプロファイルを追加してもしなくても、宛先テスト API エンドポイントへの呼び出しを行うことができます。

リクエスト時に任意のプロファイルを追加しない場合、アドビでは、ユーザーのためにこれらを内部で生成して、リクエストに追加します。プロファイルを生成してこのリクエストで使用したい場合は、サンプルプロファイル生成 API リファレンスを参照してください。API リファレンスに示すように、ソース XDM スキーマに基づいてプロファイルを生成する必要があります。ソーススキーマは、使用している sandbox の結合スキーマであることに注意してください。

応答には、宛先リクエスト処理の結果が含まれます。リクエストには、3 つの主要セクションが含まれます。

NOTE
アドビは、複数のリクエストと応答のペアを生成する可能性があります。例えば、maxUsersPerRequest 値が 7 の宛先に 10 個のプロファイルを送信する場合、7 個のプロファイルを含む 1 つのリクエストと 3 個のプロファイルを含む別のリクエストになります。

本文にプロファイルパラメーターを含むリクエストのサンプル

curl --location --request POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/3e0ac39c-ef14-4101-9fd9-cf0909814510' \
--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":{
            "Email":[
               {
                  "id":"Email-iIyJc"
               }
            ],
            "IDFA":[
               {
                  "id":"IDFA-viPAW"
               }
            ],
            "GAID":[
               {
                  "id":"GAID-Bc6LE"
               }
            ],
            "Email_LC_SHA256":[
               {
                  "id":"Email_LC_SHA256-gEOdj"
               }
            ]
         },
         "attributes":{
            "key":{
               "value":"string"
            }
         }
      }
   ]
}'

本文にプロファイルパラメーターを含まないリクエストのサンプル

curl --location --request POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/3e0ac39c-ef14-4101-9fd9-cf0909814510' \
--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 ''

応答のサンプル

results.httpCalls パラメーターのコンテンツは、お使いの REST 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":{
            "Email":[
               {
                  "id":"Email-iIyJc"
               }
            ],
            "IDFA":[
               {
                  "id":"IDFA-viPAW"
               }
            ],
            "GAID":[
               {
                  "id":"GAID-Bc6LE"
               }
            ],
            "Email_LC_SHA256":[
               {
                  "id":"Email_LC_SHA256-gEOdj"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"string"
            }
         }
      }
   ]
}

リクエストおよび応答パラメーターについて詳しくは、宛先テスト API 操作を参照してください。

次の手順

宛先をテストして正しく設定されていることを確認したら、宛先公開 API を使用して設定をレビュー用にアドビに送信します。

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6