エンドポイントのプレビューと見積もり
セグメント定義を作成する際には、Adobe Experience Platformの推定ツールとプレビューツールを使用して概要レベルの情報を表示し、期待するオーディエンスを確実に分離するのに役立ちます。
-
プレビュー セグメント定義の選定中のプロファイルのページ分割されたリストを提供し、結果を期待するものと比較できるようにします。
-
見積り 推定オーディエンスサイズ、信頼区間、エラー標準偏差など、セグメント定義に関する統計情報を提供します。
はじめに
このガイドで使用するエンドポイントは、 Adobe Experience Platform Segmentation Service API です。 続行する前に、を確認してください はじめる前に は、必要なヘッダーやサンプル API 呼び出しの読み取り方法など、API に対する呼び出しを正常に実行するために知っておく必要がある重要な情報です。
推定の生成方法
プロファイルストアへのレコードの取り込みが、合計プロファイル数を 5% 以上増加または減少させると、サンプリングジョブがトリガーされて数が更新されます。 データサンプリングをトリガーする方法は、取り込み方法によって異なります。
- バッチ取得： バッチ取り込みの場合、プロファイルストアにバッチを正常に取り込んでから 15 分以内に、5% の増減しきい値に達した場合は、ジョブを実行してカウントを更新します。
- ストリーミング取得： ストリーミングデータワークフローの場合は、5% の増加または減少のしきい値に達したかどうかを判断するために、1 時間ごとにチェックが行われます。 カウントされる場合は、カウントを更新するジョブが自動的にトリガーされます。
スキャンのサンプルサイズは、プロファイルストア内のエンティティの合計数によって異なります。 これらのサンプルサイズを次の表に示します。
プレビューの新規作成 create-preview
新しいプレビューを作成するには、/preview エンドポイントに POST リクエストを送信します。
API 形式
POST /preview
リクエスト
curl -X POST https://platform.adobe.io/data/core/ups/preview \
-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 '
{
"predicateExpression": "xEvent.metrics.commerce.abandons.value > 0",
"predicateType": "pql/text",
"predicateModel": "_xdm.context.profile",
"graphType": "none"
}'
predicateExpressionpredicateTypepredicateExpression. 現在、このプロパティに指定できる値はのみです。 pql/text.predicateModelgraphTypenone （ID ステッチを実行しない）と pdg （プライベート id グラフに基づいて id ステッチを実行します）。応答
成功時の応答は、HTTP ステータス 201（Created）と共に、新しく作成されたプレビューの詳細を返します。
{
"state": "NEW",
"previewQueryId": "e890068b-f5ca-4a8f-a6b5-af87ff0caac3",
"previewQueryStatus": "NEW",
"previewId": "MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow",
"previewExecutionId": 0
}
statepreviewId特定のプレビュー結果の取得 get-preview
特定のプレビューに関する詳細な情報を取得するには、にGETリクエストを行います。 /preview エンドポイントを使用し、リクエストパスでプレビュー ID を指定します。
API 形式
GET /preview/{PREVIEW_ID}
{PREVIEW_ID}previewId 取得するプレビューの値。リクエスト
curl -X GET https://platform.adobe.io/data/core/ups/preview/MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
成功時の応答は、HTTP ステータス 200 と共に、指定されたプレビューに関する詳細な情報を返します。
{
"results": [{
"XID_ADOBE-MARKETING-CLOUD-ID-1": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1",
"endCustomerIds": {
"XID_COOKIE_ID_1": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_1"
},
"XID_PROFILE_ID_1": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_1"
}
}
}
},
{
"XID_COOKIE-ID-2": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE-ID-2",
"endCustomerIds": {
"XID_COOKIE_ID_2-1": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_2-1"
},
"XID_PROFILE_ID_2": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_2"
}
}
},
"XID_ADOBE-MARKETING-CLOUD-ID-3": {
"_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1000"
}
}],
"state": "RESULT_READY",
"links": {
"_self": "https://platform.adobe.io/data/core/ups/preview?expression=<expr-1>&limit=1000",
"next": "",
"prev": ""
},
"page": {
"offset": 0,
"size": 3
}
}
results特定の見積ジョブの結果の取得 get-estimate
プレビュージョブを作成したら、そのジョブを使用できます previewId へのGETリクエストのパス内 /estimate 推定オーディエンスサイズ、信頼区間、エラー標準偏差など、セグメント定義に関する統計情報を表示するエンドポイント。
API 形式
GET /estimate/{PREVIEW_ID}
{PREVIEW_ID}previewId プレビュージョブの作成時に返される値。リクエスト
次のリクエストは、特定の見積ジョブの結果を取得します。
curl -X GET https://platform.adobe.io/data/core/ups/estimate/MDoyOjRhNDVlODUzLWFjOTEtNGJiNy1hNDI2LTE1MDkzN2I2YWY1Yzo0Mg \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
応答
成功した応答は、見積ジョブの詳細を含む HTTP ステータス 200 を返します。
{
"estimatedSize": 4275,
"numRowsToRead": 4275,
"estimatedNamespaceDistribution": [
{
"namespaceId": "4",
"profilesMatchedSoFar": 35
},
{
"namespaceId": "6",
"profilesMatchedSoFar": 4275
}
],
"state": "RESULT_READY",
"profilesReadSoFar": 4275,
"standardError": 0,
"error": {
"description": "",
"traceback": ""
},
"profilesMatchedSoFar": 4275,
"totalRows": 4275,
"confidenceInterval": "95%",
"_links": {
"preview": "https://platform.adobe.io/data/core/ups/preview/app-32be0328-3f31-4b64-8d84-acd0c4fbdad3/execution/0?previewQueryId=e890068b-f5ca-4a8f-a6b5-af87ff0caac3"
}
}
estimatedNamespaceDistributionstate_links.previewstate は「RESULT_READY」です。このフィールドには、見積りを表示する URL が表示されます。次の手順
このガイドを読むことで、Segmentation API を使用したプレビューと見積りの操作方法について、理解を深めることができました。 特定の名前空間内のプロファイルフラグメントの合計数や結合プロファイルの数、プロファイルデータストア全体など、リアルタイム顧客プロファイルデータに関連する指標にアクセスする方法については、 プロファイルプレビュー（/previewsamplestatus） エンドポイントガイド.