プレビューと推定エンドポイント

セグメント定義の作成時に、Adobe Experience Platform内の推定ツールとプレビューツールを使用して概要レベルの情報を表示し、期待するオーディエンスを確実に特定することができます。

  • プレビューは、セグメント定義に適格なプロファイルのページ分割リストを表示するので、結果を予想と比較できます。

  • 見積 は、推定オーディエンスサイズ、信頼区間、エラーの標準偏差など、セグメント定義の統計情報を提供します。

メモ

特定の名前空間内のプロファイルフラグメントと結合プロファイルの合計数、またはプロファイルデータストア全体など、リアルタイム顧客プロファイルデータに関連する類似の指標にアクセスするには、 プロファイルプレビュー(サンプルステータスのプレビュー)エンドポイントガイド(プロファイル API 開発者ガイドの一部)

はじめに

このガイドで使用する エンドポイントは、Adobe Experience Platform Segmentation ServiceAPI の一部です。続行する前に、 入門ガイド を参照してください。

推定の生成方法

レコードのプロファイルストアへの取り込みがプロファイルの合計数の 5%以上増加または減少すると、サンプリングジョブがトリガーされ、カウントが更新されます。 データサンプリングがトリガーされる方法は、取り込み方法に応じて異なります。

  • バッチ取り込み: バッチ取り込みの場合、バッチをプロファイルストアに正常に取り込んでから 15 分以内に、5%の増減しきい値に達した場合は、ジョブが実行されてカウントが更新されます。
  • ストリーミング取り込み: ストリーミングデータワークフローの場合は、5%の増減しきい値を満たしているかどうかを判断するために、1 時間ごとにチェックが行われます。 存在する場合は、ジョブが自動的にトリガーされ、カウントが更新されます。

スキャンのサンプルサイズは、プロファイルストア内のエンティティの総数によって異なります。 これらのサンプルサイズを次の表に示します。

プロファイルストア内のエンティティ数 サンプルサイズ
100 万未満 フルデータセット
100 万~2000 万 100 万
2000 万以上 全体の 5%
メモ

推定の実行には通常、10 ~ 15 秒かかります。最初は大まかな推定で、読み取るレコードが増えるにつれて精度が向上します。

プレビューの新規作成

新しいプレビューを作成するには、/preview エンドポイントに POST リクエストを送信します。

メモ

プレビュージョブの作成時に、見積ジョブが自動的に作成されます。 これらの 2 つのジョブは同じ ID を共有します。

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"
    }'
プロパティ 説明
predicateExpression データのクエリに使用する PQL 式です。
predicateType の下にあるクエリ式の述語タイプ。 predicateExpression. 現在、このプロパティに使用できる値は次のみです: pql/text.
predicateModel の名前 Experience Data Model (XDM) プロファイルデータの基になるスキーマクラス。
graphType クラスターの取得元のグラフタイプです。 サポートされている値は次のとおりです。 none (ID のステッチを実行しない)および pdg (は、プライベートの ID グラフに基づいて ID ステッチを実行します)。

応答

成功時の応答は、HTTP ステータス 201(Created)と共に、新しく作成されたプレビューの詳細を返します。

{
    "state": "NEW",
    "previewQueryId": "e890068b-f5ca-4a8f-a6b5-af87ff0caac3",
    "previewQueryStatus": "NEW",
    "previewId": "MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow",
    "previewExecutionId": 0
}
プロパティ 説明
state プレビュージョブの現在の状態です。最初に作成した場合は、「NEW」状態になります。 その後、処理が完了するまで「RUNNING」状態になり、完了した時点で「RESULT_READY」または「FAILED」になります。
previewId プレビュージョブの ID。推定またはプレビューを表示する際に参照目的で使用されます(次の節を参照)。

特定のプレビューの結果の取得

特定のプレビューに関する詳細な情報を取得するには、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 エンティティ ID のリストと、その関連 ID。 提供されたリンクは、 プロファイルアクセス API エンドポイント.

特定の見積ジョブの結果の取得

プレビュージョブを作成したら、そのジョブを使用できます previewId/estimate endpoint :推定オーディエンスサイズ、信頼区間、エラーの標準偏差など、セグメント定義に関する統計情報を表示します。

API 形式

GET /estimate/{PREVIEW_ID}
パラメーター 説明
{PREVIEW_ID} 見積ジョブは、プレビュージョブが作成された場合にのみトリガーされ、2 つのジョブは参照用に同じ 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"
    }
}
プロパティ 説明
estimatedNamespaceDistribution ID 名前空間で分類された、セグメント内のプロファイル数を示すオブジェクトの配列。 1 つのプロファイルが複数の名前空間に関連付けられている可能性があるので、名前空間別のプロファイルの合計数(名前空間ごとに表示される値を加算)は、プロファイル数指標より多くなる場合があります。 例えば、顧客が複数のチャネルでブランドとやり取りする場合、複数の名前空間がその個々の顧客に関連付けられます。
state プレビュージョブの現在の状態です。処理が完了するまで、状態は「RUNNING」になり、完了した時点で「RESULT_READY」または「FAILED」になります。
_links.preview 次の場合に state が「RESULT_READY」の場合、このフィールドには推定を表示する URL が表示されます。

次の手順

このガイドを読んだ後、Segmentation API を使用してプレビューと推定を操作する方法をより深く理解する必要があります。 特定の名前空間内のプロファイルフラグメントと結合プロファイルの合計数、またはプロファイルデータストア全体など、リアルタイム顧客プロファイルデータに関連する指標にアクセスする方法については、 プロファイルプレビュー (/previewsamplestatus) エンドポイントガイド.

このページ