ソーススキーマに基づくサンプルプロファイルの生成

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
宛先

作成対象：

管理者
ユーザー

ファイルベースの宛先をテストする最初の手順は、/sample-profiles エンドポイントを使用して、既存のソーススキーマに基づいてサンプルプロファイルを生成することです。

サンプルプロファイルは、プロファイルの JSON 構造を理解するのに役立ちます。また、これをデフォルトとして、独自のプロファイルデータでカスタマイズすることで、より詳細に宛先をテストできます。

はじめに getting-started

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

前提条件 prerequisites

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

Destination SDK で作成した既存のファイルベースの宛先があり、宛先カタログで確認できる。
Experience Platform UI で、宛先に対して少なくとも 1 つのアクティベーションフローを作成している。/sample-profiles エンドポイントは、アクティベーションフローでしたソーススキーマに基づいてプロファイルを作成します。アクティベーションフローの作成方法について詳しくは、アクティベーションチュートリアルを参照してください。
API リクエストを成功させるには、テストする宛先インスタンスに対応する宛先インスタンス ID が必要です。Platform UI で宛先との接続を参照する際に、URL から、API 呼び出しで使用する必要がある宛先インスタンス ID を取得します。

宛先テスト用のサンプルプロファイルの生成 generate-sample-profiles

テストしたい宛先の宛先インスタンス ID を使用して /sample-profiles エンドポイントに対して GET リクエストを行うことで、ソーススキーマに基づいてサンプルプロファイルを生成できます。

API 形式

GET /authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={NUMBER_OF_GENERATED_PROFILES}

クエリパラメーター

説明

destinationInstanceId

サンプルプロファイルを生成する宛先インスタンスの ID。この ID の取得方法について詳しくは、前提条件の節を参照してください。

count

オプション。生成するサンプルプロファイルの数。このパラメーターは、1 - 1000 の値を取ることができます。このプロパティが定義されていない場合は、API が 1 つのサンプルプロファイルを生成します。

リクエスト

以下のリクエストは、対応する destinationInstanceId を持つ宛先インスタンスで定義されたソーススキーマに基づいて、サンプルプロファイルを生成します。

curl -X GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}' \
 -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}' \

応答

応答が成功すると、HTTP ステータス 200 が、指定された数のサンプルプロファイル（ソース XDM スキーマに対応するオーディエンスメンバーシップ、ID およびプロファイル属性を含む）と共に返されます。

NOTE

応答は、宛先インスタンスで使用されたオーディエンスメンバーシップ、ID およびプロファイル属性のみを返します。ソーススキーマに他のフィールドがあっても、それらは無視されます。

[
   {
      "segmentMembership":{
         "ups":{
            "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
               "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
               "status":"realized"
            },
            "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
               "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
               "status":"realized"
            }
         }
      },
      "personalEmail":{
         "address":"john.smith@abc.com"
      },
      "identityMap":{
         "crmid":[
            {
               "id":"crmid-P1A7l"
            }
         ]
      },
      "person":{
         "name":{
            "firstName":"string",
            "lastName":"string"
         }
      }
   }
]

UI から API 応答のフィールドへのマッピングを示す画像。