詳細なアクティベーション結果の表示 view-test-results

概要 overview

このページでは、/testing/destinationInstance API エンドポイントを使用して、ファイルベースの宛先テスト結果の完全な詳細を表示する方法について説明します。

既に宛先をテスト済みで、有効な API 応答を受信している場合、宛先は正しく機能しています。

アクティベーションフローに関するさらに詳細な情報を確認したい場合は、後述するように、宛先テストエンドポイント応答から results プロパティを使用できます。

NOTE
この API エンドポイントは、データフローを監視するためのフローサービス API を使用する際に取得するのと同じ結果を返します。

はじめに getting-started

続行する前に、「はじめる前に」を参照し、API の呼び出しを正常に行うために必要となる重要な情報(必要な宛先オーサリング権限および必要なヘッダーの取得方法など)を確認してください。

前提条件 prerequisites

/testing/destinationInstance エンドポイントを使用する前に、以下の条件を満たしていることを確認してください。

  • Destination SDK で作成した既存のファイルベースの宛先があり、宛先カタログで確認できる。

  • Experience Platform UI で、宛先に対して少なくとも 1 つのアクティベーションフローを作成している。

  • API リクエストを成功させるには、テストする宛先インスタンスに対応する宛先インスタンス ID が必要です。Platform UI で宛先との接続を参照する際に、URL から、API 呼び出しで使用する必要がある宛先インスタンス ID を取得します。

    URL から宛先インスタンス ID を取得する方法を示す UI 画像。

  • 以前に宛先設定をテスト済みで、results プロパティを含む、有効な API 応答を受信している。この results 値を使用して、より詳細に宛先をテストします。

詳細な宛先テスト結果の表示 test-activation-results

宛先設定を検証したら、authoring/testing/destinationInstance/ エンドポイントに対して GET リクエストを行い、テストしている宛先の宛先インスタンス ID とアクティブ化されたオーディエンスのフロー実行 ID を指定することで、詳細なアクティベーション結果を表示できます。

宛先テスト呼び出しの応答で返される results プロパティに、使用する必要がある完全な API URL を見つけることができます。

API 形式

GET /authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}/results?flowRunIds=id1,id2
パスパラメーター
説明
{DESTINATION_INSTANCE_ID}
サンプルプロファイルを生成する宛先インスタンスの ID。この ID の取得方法について詳しくは、前提条件の節を参照してください。
クエリ文字列パラメーター
説明
flowRunIds
アクティブ化されたオーディエンスに対応するフロー実行 ID。宛先テスト呼び出しの応答で返される results プロパティに、フロー実行 ID を見つけることができます。

リクエスト

curl -X GET 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=30d34875-e7ba-4520-ab6e-5705e01dfb16,86c00ad7-443c-459a-855d-0e8cbee43c4f,12305c58-42a9-4230-8fad-1661ee49cb70' \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

応答

応答には、アクティベーションフローの完全な詳細が含まれます。データフローを監視するためのフローサービス API を呼び出すことで、同じ応答を取得できます。

{
   "items":[
      {
         "id":"18efd5d2-40ae-4f5c-afd1-37a39a45183a",
         "flowId":"a02071ad-f3a4-496c-a2b1-468812301d5d",
         "flowSpec":{
            "id":"25473b67-0801-418a-ab49-ed74ebf88137",
            "version":"1.0"
         },
         "metrics":{
            "durationSummary":{
               "startedAtUTC":1646652235124,
               "completedAtUTC":1646652270439
            },
            "latencySummary":null,
            "sizeSummary":{
               "inputBytes":122,
               "outputBytes":122
            },
            "recordSummary":{
               "inputRecordCount":1,
               "outputRecordCount":1,
               "createdRecordCount":1,
               "skippedRecordCount":0,
               "sourceSummaries":[
                  {
                     "id":"76e4b969-9700-4557-8330-0a8390afbdde",
                     "entitySummaries":[
                        {
                           "inputRecordCount":1,
                           "skippedRecordCount":0,
                           "id":"segment:4326c566-f81c-4ab0-8a80-9e741a5d0b1f"
                        }
                     ]
                  }
               ],
               "targetSummaries":[
                  {
                     "id":"b43607b6-0dca-43b3-a0bc-ecdea4fa6aa9",
                     "entitySummaries":[
                        {
                           "outputRecordCount":1,
                           "createdRecordCount":1,
                           "id":"segment:4326c566-f81c-4ab0-8a80-9e741a5d0b1f"
                        }
                     ]
                  }
               ]
            },
            "fileSummary":{
               "inputFileCount":1,
               "outputFileCount":1
            },
            "statusSummary":{
               "status":"success"
            }
         },
         "activities":[
            {
               "id":"c4f238e3-7334-4933-8b56-64d7ea43ea54",
               "name":"Activation Batch XdmProcessor Activity",
               "updatedAtUTC":0,
               "durationSummary":{
                  "startedAtUTC":1646652235124,
                  "completedAtUTC":1646652255157
               },
               "latencySummary":{

               },
               "sizeSummary":{
                  "inputBytes":122,
                  "outputBytes":122
               },
               "recordSummary":{
                  "inputRecordCount":1,
                  "outputRecordCount":1,
                  "createdRecordCount":1,
                  "skippedRecordCount":0
               },
               "fileSummary":{
                  "inputFileCount":1,
                  "outputFileCount":1
               },
               "statusSummary":{
                  "status":"success",
                  "extensions":{
                     "incremental.batchId":"",
                     "snapshot.batchId":"",
                     "snapshot.datasetId":"",
                     "incremental.datasetId":""
                  }
               },
               "sourceInfo":null,
               "targetInfo":null
            },
            {
               "id":"51d82b36-6b8f-11eb-9439-0242ac130002",
               "name":"Activation Batch Publisher Activity",
               "updatedAtUTC":0,
               "durationSummary":{
                  "startedAtUTC":1646652270326,
                  "completedAtUTC":1646652270439
               },
               "latencySummary":{

               },
               "sizeSummary":{
                  "outputBytes":122
               },
               "recordSummary":{
                  "inputRecordCount":1,
                  "outputRecordCount":1,
                  "createdRecordCount":1,
                  "skippedRecordCount":0
               },
               "fileSummary":{
                  "outputFileCount":1
               },
               "statusSummary":{
                  "status":"success",
                  "extensions":{

                  }
               },
               "sourceInfo":null,
               "targetInfo":null
            }
         ],
         "predecessors":null
      }
   ],
   "_links":{

   }
}

API エラー処理 api-error-handling

Destination SDK API エンドポイントは、一般的な Experience Platform API エラーメッセージの原則に従います。Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。

次の手順

このドキュメントでは、ファイルベースの宛先設定をテストして、アクティベーション結果の完全な詳細を表示する方法を確認しました。

公開されている宛先を作成している場合、これで、レビュー用にアドビに宛先設定を送信できるようになりました。

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