サンプルステータスエンドポイントのプレビュー(プロファイルプレビュー)
Adobe Experience Platformなら、複数のソースから顧客データを取り込み、個々の顧客一人ひとりに対して堅牢な統合プロファイルを構築できます。 データがExperience Platformに取り込まれると、サンプルジョブが実行され、プロファイル数およびその他のリアルタイム顧客プロファイルデータ関連の指標が更新されます。
このサンプルジョブの結果は、Real-Time Customer Profile APIの一部である/previewsamplestatus エンドポイントを使用して表示できます。 このエンドポイントは、データセットとID名前空間の両方によるプロファイル配布のリストを作成したり、組織のプロファイルストアの構成を可視化するために複数のレポートを生成したりするためにも使用できます。 このガイドでは、/previewsamplestatus API エンドポイントを使用してこれらの指標を表示するために必要な手順について説明します。
はじめに
このガイドで使用する API エンドポイントは、Real-Time Customer Profile API の一部です。先に進む前に、はじめる前にのガイドを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API の呼び出しを成功させるのに必要なヘッダーに関する重要な情報を確認してください。
プロファイルフラグメントと結合プロファイル
このガイドでは、「プロファイルフラグメント」と「結合プロファイル」の両方について説明します。 先に進む前に、これらの用語の違いを理解することが重要です。
個々の顧客プロファイルは、その顧客に対する単一のビューを形成するように結合された複数のプロファイルフラグメントで構成されます。たとえば、顧客が複数のチャネルをまたいで企業とやり取りする場合、その顧客に関連する複数のプロファイルフラグメントが、複数のデータセットに表示される可能性があります。
プロファイルフラグメントがExperience Platformに取り込まれると、その顧客の単一のプロファイルを作成するために、(結合ポリシーに基づいて)結合されます。 したがって、プロファイルフラグメントの総数は、各プロファイルが複数のフラグメントで構成されているので、結合されたプロファイルの総数よりも常に高くなる可能性があります。
Experience Platform内でのプロファイルとその役割について詳しくは、 リアルタイム顧客プロファイルの概要を参照してください。
サンプルジョブのトリガー方法
リアルタイム顧客プロファイルに対して有効になっているデータがExperience Platformに取り込まれると、プロファイルデータストア内に保存されます。 プロファイルストアにレコードを取り込むと、合計プロファイル数が3%以上増加または減少すると、サンプリングジョブがトリガーされて数が更新されます。 サンプルがトリガーされる方法は、使用する取り込みのタイプによって異なります。
- ストリーミングデータワークフローの場合、3%の増減しきい値が満たされているかどうかを判断するために、時間単位でチェックが行われます。 が設定されている場合、サンプルジョブは自動的にトリガーされ、カウントが更新されます。
- バッチ取り込みの場合、プロファイルストアにバッチを正常に取り込んでから15分以内に、3%の増減しきい値を満たした場合、ジョブが実行され、カウントが更新されます。 Profile APIを使用すると、成功した最新のサンプルジョブをプレビューしたり、データセット別およびID名前空間別にプロファイル配布を一覧表示したりできます。
プロファイル数と名前空間指標によるプロファイルも、Experience Platform UIのProfiles セクション内で使用できます。 UIを使用してプロファイルデータにアクセスする方法について詳しくは、Profile UI ガイド を参照してください。
最後のサンプルステータスを表示 view-last-sample-status
/previewsamplestatus エンドポイントに対してGET リクエストを行うことで、自社に対して実行された最後に成功したサンプルジョブの詳細を確認できます。 このレポートには、サンプル内のプロファイルの合計数、プロファイル数メトリック、または組織がExperience Platform内に保持するプロファイルの合計数が含まれます。
プロファイル数は、プロファイルフラグメントを結合して個々の顧客ごとに単一のプロファイルを形成した後に生成されます。 つまり、プロファイルフラグメントが結合されると、すべて同じ個人に関連しているため、「1」プロファイルのカウントが返されます。
プロファイル数には、属性(レコードデータ)を持つプロファイルと、Adobe Analytics プロファイルなどの時系列(イベント)データのみを含むプロファイルの両方も含まれます。 サンプルジョブは、プロファイルデータが取り込まれると、Experience Platform内の最新のプロファイルの合計数を提供するために定期的に更新されます。
API 形式
GET /previewsamplestatus
リクエスト
| code language-shell |
|---|
|
応答
応答が成功すると、HTTP ステータス 200が返され、組織で実行された最後に成功したサンプルジョブの詳細が含まれます。
| note note |
|---|
| NOTE |
この応答の例では、numRowsToReadとtotalRowsは互いに等しくなります。 Experience Platformに自社が保有するプロファイルの数によっては、このケースが考えられます。 ただし、一般に、これら2つの数値は異なり、numRowsToReadはプロファイルの総数(totalRows)のサブセットとしてサンプルを表すため、小さい数値です。 |
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 | |
|---|---|
| プロパティ | 説明 |
numRowsToRead |
サンプル内の結合プロファイルの合計数。 |
sampleJobRunning |
サンプルジョブの処理中にtrueを返すブール値。 バッチファイルがアップロードされたときから、実際にプロファイルストアに追加されたときまで発生する待ち時間の透明性を提供します。 |
docCount |
データベース内のドキュメントの合計数。 |
totalFragmentCount |
プロファイルストア内のプロファイルフラグメントの合計数。 |
lastSuccessfulBatchTimestamp |
最後に成功したバッチ取り込みタイムスタンプ。 |
streamingDriven |
このフィールドは非推奨(廃止予定)であり、応答に対する意味が含まれていません。 |
totalRows |
Experience Platformで結合されたプロファイルの合計数。プロファイル数とも呼ばれます。 |
lastBatchId |
最後のバッチ取得ID。 |
status |
最後のサンプルのステータス。 |
samplingRatio |
結合されたプロファイル (numRowsToRead)と結合されたプロファイルの合計(totalRows)の比率(小数点形式の割合)。 |
mergeStrategy |
サンプルで使用されるマージ戦略。 |
lastSampledTimestamp |
最後に成功したサンプルタイムスタンプ。 |
データセット別プロファイル分布のリスト
GET リクエストを/previewsamplestatus/report/dataset エンドポイントに行うことで、データセット別のプロファイルの配布を確認できます。
API 形式
GET /previewsamplestatus/report/dataset
GET /previewsamplestatus/report/dataset?{QUERY_PARAMETERS}
datedate=2024-12-31リクエスト
次のリクエストは、date パラメーターを使用して、指定された日付の最新レポートを返します。
| code language-shell |
|---|
|
応答
応答が成功すると、HTTP ステータス 200が返され、データセット オブジェクトのリストを含むdata配列が含まれます。
| note note |
|---|
| NOTE |
| 次に示す応答は、3つのデータセットを示すために切り捨てられています。 |
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 | |
|---|---|
| プロパティ | 説明 |
sampleCount |
このデータセット IDを持つ結合されたプロファイルのサンプルの合計数です。 |
samplePercentage |
結合されたプロファイルの合計サンプル数に対する割合としてのsampleCount (numRowsToRead最後のサンプルステータス で返される値)は、小数点形式で表されます。 |
fullIDsCount |
このデータセット IDを持つ結合プロファイルの合計数。 |
fullIDsPercentage |
結合されたプロファイルの合計数に対する割合(fullIDsCount最後のサンプルステータス totalRowsで返される値)のは、小数点形式で表されます。 |
name |
データセットの作成時に指定された、データセットの名前。 |
description |
データセットの作成時に提供されるデータセットの説明。 |
value |
データセットのID。 |
streamingIngestionEnabled |
データセットがストリーミング取り込みに対して有効になっているかどうか。 |
createdUser |
データセットを作成したユーザーのユーザーID。 |
reportTimestamp |
レポートのタイムスタンプ。 リクエスト中にdate パラメーターが指定された場合、返されたレポートは、指定された日付のものです。 date パラメーターが指定されていない場合は、最新のレポートが返されます。 |
ID名前空間によるプロファイル配布のリスト
/previewsamplestatus/report/namespace エンドポイントに対してGET リクエストを実行し、プロファイルストア内のすべての結合プロファイルのID名前空間による分類を確認できます。 これには、Adobeが提供する標準IDと、企業が定義したカスタム IDの両方が含まれます。
ID名前空間は、Adobe Experience Platform Identity Serviceの重要なコンポーネントであり、顧客データが関連するコンテキストの指標として機能します。 詳しくは、ID名前空間の概要を参照してください。
API 形式
GET /previewsamplestatus/report/namespace
GET /previewsamplestatus/report/namespace?{QUERY_PARAMETERS}
dateYYYY-MM-DD。date=2025-6-20リクエスト
次のリクエストはdate パラメーターを指定せず、最新のレポートを返します。
| code language-shell |
|---|
|
応答
応答が成功すると、HTTP ステータス 200が返され、各名前空間の詳細を含む個々のオブジェクトを含むdata配列が含まれます。 表示される応答は、4つの名前空間を示すように切り捨てられています。
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
|---|---|
| プロパティ | 説明 |
sampleCount |
名前空間内の結合されたプロファイルのサンプルの合計数です。 |
samplePercentage |
サンプリングされた結合プロファイルの割合としてのsampleCount (numRowsToRead最後のサンプルステータス で返される値)は、小数点形式で表されます。 |
reportTimestamp |
レポートのタイムスタンプ。 リクエスト中にdate パラメーターが指定された場合、返されたレポートは、指定された日付のものです。 date パラメーターが指定されていない場合は、最新のレポートが返されます。 |
fullIDsFragmentCount |
名前空間内のプロファイルフラグメントの合計数。 |
fullIDsCount |
名前空間内の結合されたプロファイルの合計数です。 |
fullIDsPercentage |
統合されたプロファイルの合計に対する割合(fullIDsCount最後のサンプルステータス totalRowsで返される値)であるは、小数点形式で表されます。 |
code |
名前空間のcodeです。 これは、Adobe Experience Platform Identity Service APIを使用して名前空間を操作する場合に見つかり、Experience Platform UIではIdentity symbolとも呼ばれます。 詳しくは、ID名前空間の概要を参照してください。 |
value |
名前空間のid値。 これは、ID サービス APIを使用して名前空間を操作する際に見つかります。 |
データセット統計のリスト dataset-stats
GET リクエストを/previewsamplestatus/report/dataset_stats エンドポイントに送信することで、データセットに関する統計情報を提供するレポートを生成できます。
API 形式
GET /previewsamplestatus/report/dataset_stats
リクエスト
| code language-shell |
|---|
|
応答
応答が成功すると、データセットの統計に関する情報を含むHTTP ステータス 200が返されます。
| note note |
|---|
| NOTE |
| 次の応答は、3つのデータセットを示すために切り捨てられました。 |
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 | |
|---|---|
| プロパティ | 説明 |
120days |
120日間のデータ有効期限の後にデータセットに残るレコードの数。 |
14days |
14日間のデータ有効期限の後にデータセットに残るレコードの数。 |
30days |
30日間のデータ有効期限の後にデータセットに残るレコードの数。 |
365days |
365日のデータ有効期限の後にデータセットに残るレコードの数。 |
60days |
60日間のデータ有効期限の後にデータセットに残るレコードの数。 |
7days |
7日間のデータ有効期限の後にデータセットに残るレコードの数。 |
90days |
90日間のデータ有効期限の後にデータセットに残るレコードの数。 |
datasetId |
データセットのID。 |
datasetType |
データセットの種類。 この値はProfilesまたはExperienceEventsのいずれかです。 |
percentEvents |
データセット内にあるエクスペリエンスイベントレコードの割合。 |
percentProfiles |
データセット内にあるプロファイルレコードの割合。 |
profileFragments |
データセットに存在するプロファイルフラグメントの合計数。 |
records |
データセットに取り込まれたプロファイルレコードの合計数。 |
totalProfiles |
データセットに取り込まれたプロファイルの合計数です。 |
次の手順
プロファイルストアでサンプルデータをプレビューし、そのデータに関する複数のレポートを実行する方法を理解したので、Segmentation Service APIの推定エンドポイントとプレビューエンドポイントを使用して、セグメント定義に関する概要レベルの情報を表示することもできます。 この情報は、想定されるオーディエンスを確実に分離するのに役立ちます。 セグメント化APIを使用したプレビューと見積もりの操作について詳しくは、 エンドポイントのプレビューと見積もりガイド を参照してください。