プレビューサンプルのステータスエンドポイント(プロファイルプレビュー)
Adobe Experience Platformでは、複数のソースから顧客データを取り込み、個々の顧客ごとに堅牢で統一されたプロファイルを作成できます。 データが Platform に取り込まれると、サンプルジョブが実行されて、プロファイル数やその他のリアルタイム顧客プロファイルデータ関連指標が更新されます。
このサンプルジョブの結果は、リアルタイム顧客プロファイル API の一部である /previewsamplestatus
エンドポイントを使用して確認できます。 また、このエンドポイントを使用して、データセットと ID 名前空間の両方でプロファイル配布をリスト表示したり、複数のレポートを生成して組織のプロファイルストアの構成を可視化したりできます。 このガイドでは、/previewsamplestatus
API エンドポイントを使用してこれらの指標を表示するために必要な手順について説明します。
はじめに
このガイドで使用する API エンドポイントは、Real-Time Customer Profile API の一部です。先に進む前に、はじめる前にのガイドを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API の呼び出しを成功させるのに必要なヘッダーに関する重要な情報を確認してください。
プロファイルフラグメントと結合プロファイル
このガイドは、「プロファイルフラグメント」と「結合プロファイル」の両方を参照します。 続行する前に、これらの用語の違いを理解することが重要です。
個々の顧客プロファイルは、その顧客に対する単一のビューを形成する複数のプロファイルフラグメントで構成されます。例えば、顧客が複数のチャネルをまたいで自社のブランドとやり取りを行う場合、1 人の顧客に関連する複数のプロファイルフラグメントが複数のデータセットに表示される可能性があります。
プロファイルフラグメントが Platform に取り込まれると、その顧客用に単一のプロファイルを作成するために、(結合ポリシーに基づいて)結合されます。 したがって、各プロファイルは複数のフラグメントで構成され、プロファイルフラグメントの合計数は、結合されたプロファイルの合計数よりも常に多くなる可能性が高くなります。
プロファイルとそのExperience Platform内での役割について詳しくは、まず リアルタイム顧客プロファイルの概要をお読みください。
サンプルジョブがトリガーされる方法
リアルタイム顧客プロファイルに対して有効なデータは Platform に取り込まれるので、プロファイルデータストア内に保存されます。 プロファイルストアへのレコードの取り込みが、合計プロファイル数を 5% 以上増加または減少させると、サンプリングジョブがトリガーされて数が更新されます。 サンプルをトリガーする方法は、使用する取り込みのタイプによって異なります。
- ストリーミングデータワークフロー の場合は、5% の増加または減少しきい値に達したかどうかを判断するために、1 時間ごとにチェックが行われます。 サンプルジョブが自動的にトリガーされ、カウントが更新されます。
- バッチ取り込み の場合、プロファイルストアにバッチを正常に取り込んでから 15 分以内に、5% の増減しきい値に達した場合は、ジョブを実行してカウントを更新します。 プロファイル API を使用すると、最新の成功したサンプルジョブをプレビューできるほか、データセット別および ID 名前空間別のプロファイル配布をリストできます。
また、プロファイル数および名前空間別プロファイル指標は、Experience PlatformUI の プロファイル セクション内でも使用できます。 UI を使用してプロファイルデータにアクセスする方法について詳しくは、Profile UI ガイドを参照してください。
最後のサンプルステータスを表示 view-last-sample-status
/previewsamplestatus
エンドポイントに対してGETリクエストを実行し、組織で最後に実行され成功したサンプルジョブの詳細を表示できます。 これには、サンプル内のプロファイルの合計数や、プロファイル数指標、組織がExperience Platform内に持つプロファイルの合計数が含まれます。
プロファイル数は、プロファイルフラグメントを結合して個々の顧客の単一のプロファイルを形成した後に生成されます。 つまり、プロファイルフラグメントが結合されると、すべてが同じ個人に関連しているので、「1」のプロファイルのカウントが返されます。
プロファイル数には、属性(レコードデータ)を持つプロファイルと、Adobe Analytics プロファイルなどの時系列(イベント)データのみを含むプロファイルの両方も含まれます。 Platform 内に最新のプロファイルの合計数を提供するために、プロファイルデータが取り込まれると、サンプルジョブは定期的に更新されます。
API 形式
GET /previewsamplestatus
リクエスト
curl -X GET \
https://platform.adobe.io/data/core/ups/previewsamplestatus \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
応答
応答には、組織に対して実行され、最後に成功したサンプルジョブの詳細が含まれます。
numRowsToRead
と totalRows
は互いに等しくなります。 組織がExperience Platformに持っているプロファイルの数に応じて、このケースが当てはまります。 ただし、通常、これら 2 つの数値は異なります。numRowsToRead
れは、プロファイルの合計数(totalRows
)のサブセットとしてサンプルを表すので、小さい方の数値です。{
"numRowsToRead": "41003",
"sampleJobRunning": {
"status": true,
"submissionTimestamp": "2020-08-01 17:57:57.0"
},
"cosmosDocCount": "\"300803\"",
"totalFragmentCount": 47429,
"lastSuccessfulBatchTimestamp": "\"null\"",
"streamingDriven": "\"false\"",
"totalRows": "41003",
"lastBatchId": "\"null\"",
"status": "TASK_FINISHED",
"samplingRatio": 1.0,
"mergeStrategy": "timestampOrdered_auto",
"lastSampledTimestamp": "2020-08-01 17:57:57.0"
}
numRowsToRead
sampleJobRunning
true
を返すブール値です。 バッチファイルがアップロードされてからプロファイルストアに実際に追加されるまでの待ち時間に対して、透明性を提供します。cosmosDocCount
totalFragmentCount
lastSuccessfulBatchTimestamp
streamingDriven
totalRows
lastBatchId
status
samplingRatio
totalRows
)に対する、サンプリングされた結合プロファイル(numRowsToRead
)の割合(10 進数形式でパーセンテージで表されます)。mergeStrategy
lastSampledTimestamp
データセット別のプロファイル分布のリスト
データセット別のプロファイルの分布を確認するには、/previewsamplestatus/report/dataset
エンドポイントに対してGETリクエストを実行します。
API 形式
GET /previewsamplestatus/report/dataset
GET /previewsamplestatus/report/dataset?{QUERY_PARAMETERS}
date
date=2024-12-31
リクエスト
次のリクエストは、date
パラメーターを使用して、指定された日付の最新のレポートを返します。
curl -X GET \
https://platform.adobe.io/data/core/ups/previewsamplestatus/report/dataset?date=2020-08-01 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
応答
応答には、データセットオブジェクトのリストを含む data
配列が含まれます。 表示される応答は、3 つのデータセットを表示するために切り捨てられています。
{
"data": [
{
"sampleCount": 12577,
"samplePercentage": 0.306734,
"fullIDsCount": 20988,
"fullIDsPercentage": 0.511865,
"name": "CRM Profiles",
"description": "Profiles from the CRM.",
"value": "5f160106be34361915754b9c",
"streamingIngestionEnabled": "",
"createdUser": "{CREATED_USER}",
"reportTimestamp": "2020-08-01T17:57:58.697",
},
{
"sampleCount": 12938,
"samplePercentage": 0.315538,
"fullIDsCount": 21796,
"fullIDsPercentage": 0.531571,
"name": "AAM Authenticated Profiles",
"description": "This data set contains AAM authenticated profiles.",
"value": "5dc77ec6eed47f18a796ca90",
"streamingIngestionEnabled": "",
"createdUser": "{CREATED_USER}",
"reportTimestamp": "2020-08-01T17:57:58.697"
},
{
"sampleCount": 22725,
"samplePercentage": 0.554228,
"fullIDsCount": 41003,
"fullIDsPercentage": 1.0,
"name": "Loyalty Program Members",
"description": "Members of the loyalty program at all levels.",
"value": "5d0fda92274e55144d4de620",
"streamingIngestionEnabled": "",
"createdUser": "{CREATED_USER}",
"reportTimestamp": "2020-08-01T17:57:58.697"
}
],
"reportTimestamp": "2020-08-01T17:57:58.697"
}
sampleCount
samplePercentage
fullIDsCount
fullIDsPercentage
name
description
value
streamingIngestionEnabled
createdUser
reportTimestamp
date
パラメーターが指定された場合、返されるレポートは指定された日付のです。 date
パラメーターを指定しない場合は、最新のレポートが返されます。ID 名前空間別のプロファイル配分のリスト
/previewsamplestatus/report/namespace
エンドポイントに対してGETリクエストを実行し、プロファイルストア内のすべての結合済みプロファイルで ID 名前空間別の分類を表示できます。 これには、Adobeが提供する標準 ID と、組織が定義するカスタム ID の両方が含まれます。
ID 名前空間は、顧客データが関連するコンテキストのインジケーターとして機能するAdobe Experience Platform ID サービスの重要なコンポーネントです。 詳しくは、まず ID 名前空間の概要を読んでください。
API 形式
GET /previewsamplestatus/report/namespace
GET /previewsamplestatus/report/namespace?{QUERY_PARAMETERS}
date
date=2024-12-31
リクエスト
次のリクエストでは、date
パラメーターが指定されていないので、最新のレポートが返されます。
curl -X GET \
https://platform.adobe.io/data/core/ups/previewsamplestatus/report/namespace \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
応答
応答には data
配列が含まれ、個々のオブジェクトには各名前空間の詳細が含まれます。 表示された応答は、4 つの名前空間を表示するために切り捨てられました。
{
"data": [
{
"sampleCount": 12148,
"samplePercentage": 0.296271,
"reportTimestamp": "2020-08-01T17:57:58.697",
"fullIDsFragmentCount": 13141,
"fullIDsCount": 12631,
"fullIDsPercentage": 0.308051,
"code": "Email",
"value": "6"
},
{
"sampleCount": 6989,
"samplePercentage": 0.170451,
"reportTimestamp": "2020-08-01T17:57:58.697",
"fullIDsFragmentCount": 7543,
"fullIDsCount": 7042,
"fullIDsPercentage": 0.171744,
"code": "ECID",
"value": "4"
},
{
"sampleCount": 888,
"samplePercentage": 0.021657,
"reportTimestamp": "2020-08-01T17:57:58.697",
"fullIDsFragmentCount": 3801,
"fullIDsCount": 3206,
"fullIDsPercentage": 0.078189,
"code": "AAID",
"value": "10"
},
{
"sampleCount": 21809,
"samplePercentage": 0.531888,
"reportTimestamp": "2020-08-01T17:57:58.697",
"fullIDsFragmentCount": 27023,
"fullIDsCount": 21936,
"fullIDsPercentage": 0.534985,
"code": "Phone",
"value": "7"
}
],
"reportTimestamp": "2020-08-01T17:57:58.697"
}
sampleCount
samplePercentage
reportTimestamp
date
パラメーターが指定された場合、返されるレポートは指定された日付のです。 date
パラメーターを指定しない場合は、最新のレポートが返されます。fullIDsFragmentCount
fullIDsCount
fullIDsPercentage
code
code
。 これは、Adobe Experience Platform ID サービス API を使用して名前空間を操作する際に見つかりExperience PlatformUI では ID シンボル とも呼ばれます。 詳しくは、「ID 名前空間の概要」を参照してください。value
id
値。 これは、ID サービス API を使用して名前空間を操作する際に見つかります。データセットの重複レポートの生成
データセット重複レポートは、アドレス可能なオーディエンス(結合プロファイル)に最も寄与するデータセットを公開することで、組織のプロファイルストアの構成を可視化します。 このレポートは、データへのインサイトを提供するだけでなく、特定のデータセットの有効期限の設定など、ライセンスの使用を最適化するアクションを実行するのに役立ちます。
/previewsamplestatus/report/dataset/overlap
エンドポイントにデータセットリクエストを実行することで、GETセットの重複レポートを生成できます。
コマンドラインまたはPostman UI を使用してデータセット重複レポートを生成する手順については、 データセット重複レポートの生成チュートリアルを参照してください。
API 形式
GET /previewsamplestatus/report/dataset/overlap
GET /previewsamplestatus/report/dataset/overlap?{QUERY_PARAMETERS}
date
date=2024-12-31
リクエスト
次のリクエストは、date
パラメーターを使用して、指定された日付の最新のレポートを返します。
curl -X GET \
https://platform.adobe.io/data/core/ups/previewsamplestatus/report/dataset/overlap?date=2021-12-29 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
応答
リクエストが成功すると、HTTP ステータス 200 (OK)とデータセット重複レポートが返されます。
{
"data": {
"5d92921872831c163452edc8,5da7292579975918a851db57,5eb2cdc6fa3f9a18a7592a98": 123,
"5d92921872831c163452edc8,5eb2cdc6fa3f9a18a7592a98": 454412,
"5eeda0032af7bb19162172a7": 107
},
"reportTimestamp": "2021-12-29T19:55:31.147"
}
data
data
オブジェクトには、データセットとそれぞれのプロファイル数のコンマ区切りリストが含まれています。reportTimestamp
date
パラメーターが指定された場合、返されるレポートは指定された日付のです。 date
パラメーターを指定しない場合は、最新のレポートが返されます。データセット重複レポートの解釈
レポートの結果は、応答のデータセットとプロファイル数から解釈できます。 次のレポート data
オブジェクトの例について考えてみます。
"5d92921872831c163452edc8,5da7292579975918a851db57,5eb2cdc6fa3f9a18a7592a98": 123,
"5d92921872831c163452edc8,5eb2cdc6fa3f9a18a7592a98": 454412,
"5eeda0032af7bb19162172a7": 107
このレポートには、次の情報が表示されます。
5d92921872831c163452edc8
、5da7292579975918a851db57
、5eb2cdc6fa3f9a18a7592a98
のデータセットからのデータで構成される 123 のプロファイルがあります。5d92921872831c163452edc8
と5eb2cdc6fa3f9a18a7592a98
の 2 つのデータセットから得られるデータで構成されるプロファイルは 454,412 あります。- データセット
5eeda0032af7bb19162172a7
のデータのみで構成されるプロファイルは 107 個あります。 - 組織内には合計 454,642 のプロファイルがあります。
ID 名前空間の重複レポートの生成 identity-overlap-report
ID 名前空間の重複レポートは、アドレス可能なオーディエンス(結合プロファイル)に最も貢献する ID 名前空間を公開することで、組織のプロファイルストアの構成を可視化します。 これには、Adobeが提供する標準 ID 名前空間と、組織が定義するカスタム ID 名前空間の両方が含まれます。
/previewsamplestatus/report/namespace/overlap
エンドポイントにGETリクエストを実行することで、ID 名前空間の重複レポートを生成できます。
API 形式
GET /previewsamplestatus/report/namespace/overlap
GET /previewsamplestatus/report/namespace/overlap?{QUERY_PARAMETERS}
date
date=2024-12-31
リクエスト
次のリクエストは、date
パラメーターを使用して、指定された日付の最新のレポートを返します。
curl -X GET \
https://platform.adobe.io/data/core/ups/previewsamplestatus/report/namespace/overlap?date=2021-12-29 \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
応答
リクエストが成功すると、HTTP ステータス 200 (OK)と ID 名前空間の重複レポートが返されます。
{
"data": {
"Email,crmid,loyal": 2,
"ECID,Email,crmid": 7,
"ECID,Email,mobilenr": 12,
"AAID,ECID,loyal": 1,
"mobilenr": 25,
"AAID,ECID": 1508,
"ECID,crmid": 1,
"AAID,ECID,crmid": 2,
"Email,crmid": 328,
"CORE": 49,
"AAID": 446,
"crmid,loyal": 20988,
"Email": 10904,
"crmid": 249,
"ECID,Email": 74,
"Phone": 40,
"Email,Phone,loyal": 48,
"AAID,AVID,ECID": 85,
"Email,loyal": 1002,
"AAID,ECID,Email,Phone,crmid": 5,
"AAID,ECID,Email,crmid,loyal": 23,
"AAID,AVID,ECID,Email,crmid": 2,
"AVID": 3,
"AAID,ECID,Phone": 1,
"loyal": 43,
"ECID,Email,crmid,loyal": 6,
"AAID,ECID,Email,Phone,crmid,loyal": 1,
"AAID,ECID,Email": 2,
"AAID,ECID,Email,crmid": 142,
"AVID,ECID": 24,
"ECID": 6565
},
"reportTimestamp": "2021-12-29T16:55:03.624"
}
data
data
オブジェクトには、ID 名前空間コードとそれぞれのプロファイル数の一意の組み合わせを持つ、コンマ区切りのリストが含まれています。code
は、ID 名前空間名ごとの短い形式です。 各 code
の name
へのマッピングは、Adobe Experience Platform ID サービス API を使用して見つけることができます。 この code
は、Experience PlatformUI では ID シンボル とも呼ばれます。 詳しくは、「ID 名前空間の概要」を参照してください。reportTimestamp
date
パラメーターが指定された場合、返されるレポートは指定された日付のです。 date
パラメーターを指定しない場合は、最新のレポートが返されます。ID 名前空間の重複レポートの解釈
レポートの結果は、応答内の ID とプロファイル数から解釈できます。 各行の数値は、標準 ID 名前空間とカスタム ID 名前空間の正確な組み合わせで構成されるプロファイルの数を示します。
data
オブジェクトからの次の抜粋について考えてみます。
"AAID,ECID,Email,crmid": 142,
"AVID,ECID": 24,
"ECID": 6565
このレポートには、次の情報が表示されます。
AAID
、ECID
、Email
の標準 ID およびカスタムcrmid
ID 名前空間から構成される 142 のプロファイルがあります。AAID
とECID
の ID 名前空間で構成されるプロファイルが 24 あります。ECID
ID のみを含むプロファイルは 6,565 あります。
ステッチされていないプロファイルレポートの生成
ステッチされていないプロファイルレポートを通じて、組織のプロファイルストアの構成をさらに可視化できます。 「未ステッチ」プロファイルは、プロファイルフラグメントが 1 つのみ含まれるプロファイルです。 「不明」プロファイルは、ECID
や AAID
などの偽名 ID 名前空間に関連付けられているプロファイルです。 不明なプロファイルは非アクティブです。つまり、指定された期間、新しいイベントが追加されていません。 ステッチされていないプロファイル レポートは、7、30、60、90、120 日間のプロファイルの分類を提供します。
ステッチされていないプロファイルレポートを生成するには、/previewsamplestatus/report/unstitchedProfiles
エンドポイントにGETリクエストを実行します。
API 形式
GET /previewsamplestatus/report/unstitchedProfiles
リクエスト
次のリクエストは、ステッチされていないプロファイルレポートを返します。
curl -X GET \
https://platform.adobe.io/data/core/ups/previewsamplestatus/report/unstitchedProfiles \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
応答
リクエストが成功すると、HTTP ステータス 200 (OK)と、ステッチされていないプロファイルレポートが返されます。
"120days"
と「7days
」の期間のみを含むように切り捨てられています。 完全な未ステッチプロファイル レポートは、7 日、30 日、60 日、90 日および 120 日間のプロファイルの分類を提供します。{
"data": {
"totalNumberOfProfiles": 63606,
"totalNumberOfEvents": 130977,
"unstitchedProfiles": {
"120days": {
"countOfProfiles": 1644,
"eventsAssociated": 26824,
"nsDistribution": {
"Email": {
"countOfProfiles": 18,
"eventsAssociated": 95
},
"loyal": {
"countOfProfiles": 26,
"eventsAssociated": 71
},
"ECID": {
"countOfProfiles": 1600,
"eventsAssociated": 26658
}
}
},
"7days": {
"countOfProfiles": 1782,
"eventsAssociated": 29151,
"nsDistribution": {
"Email": {
"countOfProfiles": 19,
"eventsAssociated": 97
},
"ECID": {
"countOfProfiles": 1734,
"eventsAssociated": 28591
},
"loyal": {
"countOfProfiles": 29,
"eventsAssociated": 463
}
}
}
}
},
"reportTimestamp": "2025-08-25T22:14:55.186"
}
data
data
オブジェクトには、ステッチされていないプロファイルレポートに返された情報が含まれています。totalNumberOfProfiles
totalNumberOfEvents
unstitchedProfiles
countOfProfiles
eventsAssociated
nsDistribution
nsDistribution
オブジェクト内の各 ID 名前空間の合計 countOfProfiles
を合計すると、期間の countOfProfiles
と等しくなります。 名前空間ごとの eventsAssociated
と期間ごとの合計 eventsAssociated
についても同じことが当てはまります。reportTimestamp
ステッチされていないプロファイルレポートの解釈
レポートの結果は、組織がプロファイルストア内に持つ未ステッチおよび非アクティブのプロファイルの数に関するインサイトを提供できます。
data
オブジェクトからの次の抜粋について考えてみます。
"7days": {
"countOfProfiles": 1782,
"eventsAssociated": 29151,
"nsDistribution": {
"Email": {
"countOfProfiles": 19,
"eventsAssociated": 97
},
"ECID": {
"countOfProfiles": 1734,
"eventsAssociated": 28591
},
"loyal": {
"countOfProfiles": 29,
"eventsAssociated": 463
}
}
}
このレポートには、次の情報が表示されます。
- プロファイルフラグメントを 1 つだけ含み、過去 7 日間に新しいイベントがないプロファイルは 1,782 あります。
- ステッチされていないプロファイル 1,782 件に関連付けられている ExperienceEvents は 29,151 件です。
- ECID の ID 名前空間の 1 つのプロファイルフラグメントを含む 1,734 個の未ステッチプロファイルがあります。
- ECID の ID 名前空間の単一のプロファイルフラグメントを含む 1,734 個の未ステッチのプロファイルに関連付けられたイベントは 28,591 個あります。
次の手順
プロファイルストアのサンプルデータをプレビューする方法と、データに対して複数のレポートを実行する方法がわかったので、Segmentation Service API の推定エンドポイントとプレビューエンドポイントを使用して、セグメント定義に関する概要レベルの情報を表示することもできます。 この情報は、期待されるオーディエンスを確実に分離するのに役立ちます。 Segmentation API を使用したプレビューと予測の操作について詳しくは、 プレビューと予測エンドポイントガイドを参照してください。