Show Menu
トピック×

エンドポイントのプレビューと予測

As you develop your segment definition, you can use the estimate and preview tools within Adobe Experience Platform to view summary-level information to help ensure you are isolating the expected audience. プレビューは、セグメント定義に適格なプロファイルのページ分割リストを表示するので、結果を予想と比較できます。 予測は 、予測されるオーディエンスサイズ、信頼区間、誤差の標準偏差など、セグメント定義の統計情報を提供します。

はじめに

The endpoints used in this guide are part of the Adobe Experience Platform Segmentation Service API. Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including required headers and how to read example API calls.

推定の生成方法

データサンプリングがトリガされる方法は、取り込み方法によって異なります。
バッチ取り込みの場合、プロファイルストアは15分ごとに自動的にスキャンされ、最後のサンプリングジョブが実行されてから新しいバッチが正常に取り込まれたかどうかを確認します。 その場合、プロファイルストアがスキャンされ、レコード数に少なくとも5%の変更があったかどうかが確認されます。 これらの条件が満たされると、新しいサンプリングジョブがトリガされます。
ストリーミング取り込みの場合、プロファイルストアは1時間ごとに自動的にスキャンされ、レコード数に少なくとも5%の変更があったかどうかが確認されます。 この条件が満たされると、新しいサンプリングジョブがトリガされます。
スキャンのサンプルサイズは、プロファイルストアのエンティティの全体数によって異なります。 これらのサンプルサイズを次の表に示します。
プロファイルストア内のエンティティ数
サンプルサイズ
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: {IMS_ORG}' \
 -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"
    }'

プロパティ
説明
predicateExpression
データのクエリに使用する PQL 式です。
predicateType
の下にあるクエリ式の述語の種類 predicateExpression です。 現在、このプロパティに指定できる値は pql/text です。
predicateModel
The name of the Experience Data Model (XDM) schema the profile data is based on.
応答
成功時の応答は、HTTP ステータス 201(Created)と共に、新しく作成されたプレビューの詳細を返します。
{
    "state": "NEW",
    "previewQueryId": "e890068b-f5ca-4a8f-a6b5-af87ff0caac3",
    "previewQueryStatus": "NEW",
    "previewId": "MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow",
    "previewExecutionId": 0
}

プロパティ
説明
state
プレビュージョブの現在の状態です。最初に作成されたときは、「NEW」状態になります。 次に、処理が完了するまで「実行中」の状態になり、その時点で「RESULT_READY」または「FAILED」になります。
previewId
次の節で説明するように、予測またはプレビューを表示する際に参照用に使用されるプレビュージョブのID。

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

You can retrieve detailed information about a specific preview by making a GET request to the /preview endpoint and providing the preview ID in the request path.
API 形式
GET /preview/{PREVIEW_ID}

パラメーター
説明
{PREVIEW_ID}
The previewId value of the preview you want to retrieve.
リクエスト
curl -X GET https://platform.adobe.io/data/core/ups/preview/MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -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 へのGETリクエストのパスで使用して、予測されるオーディエンスサイズ、信頼区間、および表示標準偏差など、セグメント定義に関する統計情報を取得できます。
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: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

応答
成功した応答は、見積ジョブの詳細を含む HTTP ステータス 200 を返します。
{
    "estimatedSize": 0,
    "numRowsToRead": 1,
    "state": "RESULT_READY",
    "profilesReadSoFar": 1,
    "standardError": 0,
    "error": {
        "description": "",
        "traceback": ""
    },
    "profilesMatchedSoFar": 0,
    "totalRows": 1,
    "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"
    }
}

プロパティ
説明
state
プレビュージョブの現在の状態です。処理が完了するまでは「RUNNING」で、完了した時点で「RESULT_READY」または「FAILED」になります。
_links.preview
プレビュージョブの現在の状態が「RESULT_READY」の場合、この属性は推定を表示するための URL を提供します。

次の手順

このガイドを読むと、プレビューと予測の使い方に関する理解が深まります。 その他の Segmentation Service APIエンドポイントについて詳しくは、 Segmentation Service開発者ガイドの概要を参照してください