ストリーミングセグメント化を使用したほぼリアルタイムでのイベント評価

メモ

次のドキュメントでは、API を使用したストリーミングセグメント化の使用方法について説明します。 UI を使用したストリーミングセグメント化の使用について詳しくは、 ストリーミングセグメント化 UI ガイド.

でのストリーミングセグメント化 Adobe Experience Platform では、データの充実性に重点を置きながら、ほぼリアルタイムでセグメント化をおこなうことができます。 ストリーミングセグメント化を使用すると、ストリーミングデータがにランディングされるとセグメント認定がおこなわれるようになりました。 Platformを使用することで、セグメント化ジョブのスケジュールおよび実行の必要性を軽減できます。 この機能を使用すると、ほとんどのセグメントルールを、 Platformと同じです。つまり、セグメントメンバーシップは、スケジュールされたセグメント化ジョブを実行せずに最新の状態に保たれます。

メモ

ストリーミングによるセグメント化は、Platform にストリーミングされるデータを評価する場合にのみ使用できます。 つまり、バッチ取り込みで取り込まれたデータは、ストリーミングのセグメント化によって評価されず、夜間にスケジュールされたセグメント化ジョブと共に評価されます。

概要

この開発者ガイドでは、 Adobe Experience Platform ストリーミングセグメント化に関連するサービス。 このチュートリアルを開始する前に、次のサービスのドキュメントを確認してください。

  • Real-time Customer Profile:複数のソースからの集計データに基づいて、統合された消費者プロファイルをリアルタイムで提供します。
  • Segmentation:セグメントやオーディエンスを Real-time Customer Profile データ。
  • Experience Data Model (XDM):顧客体験データを編成する際に Platform に使用される標準化されたフレームワーク。

以下の節では、への呼び出しを正しくおこなうために知っておく必要がある追加情報を示します。 Platform API

API 呼び出し例の読み取り

この開発者ガイドは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。これには、パス、必須ヘッダー、適切にフォーマットされたリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。

必須ヘッダーの値の収集

Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されています。Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。

  • x-sandbox-name: {SANDBOX_NAME}
メモ

Platform のサンドボックスについて詳しくは、サンドボックスの概要に関するドキュメントを参照してください。

ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、以下のような追加ヘッダーが必要です。

  • Content-Type: application/json

特定のリクエストを完了するには、追加のヘッダーが必要な場合があります。このドキュメントの各例では、正しいヘッダーが表示されます。必要なヘッダーがすべて含まれるように、リクエスト例に特に注意してください。

ストリーミングセグメント化が有効なクエリタイプ

メモ

ストリーミングセグメント化を機能させるには、組織でスケジュールに沿ったセグメント化を有効にする必要があります。 スケジュールに沿ったセグメント化を有効にする方法については、 スケジュール済みセグメント化セクションを有効化

ストリーミングセグメント化を使用してセグメントを評価するには、クエリを次のガイドラインに従う必要があります。

クエリタイプ 詳細
単一イベント 時間制限のない単一の受信イベントを参照するセグメント定義。
相対時間枠内の単一イベント 単一の受信イベントを参照するセグメント定義。
時間枠を含む単一イベント 時間枠を持つ単一の受信イベントを参照するセグメント定義。
プロファイルのみ プロファイル属性のみを参照するセグメント定義。
プロファイル属性を持つ単一のイベント 時間制限のない単一の受信イベントを参照するセグメント定義、1 つ以上のプロファイル属性。 注意: クエリは、イベントの発生時に即座に評価されます。 ただし、プロファイルイベントの場合は、組み込まれるまで 24 時間待つ必要があります。
相対時間枠内のプロファイル属性を持つ単一イベント 1 つの受信イベントと 1 つ以上のプロファイル属性を参照するセグメント定義。
セグメントのセグメント 1 つ以上のバッチセグメントまたはストリーミングセグメントを含むセグメント定義。 注意: セグメントのセグメントが使用される場合、プロファイルの不適格が発生します 24 時間ごと.
プロファイル属性を持つ複数のイベント 複数のイベントを参照する任意のセグメント定義 過去 24 時間以内に (オプションで)1 つ以上のプロファイル属性を持ちます。

セグメント定義は次のようになります。 not は、次のシナリオでストリーミングセグメント化に対して有効になります。

  • セグメント定義には、Adobe Audience Manager(AAM) のセグメントまたは特性が含まれます。
  • セグメント定義には複数のエンティティ(複数エンティティクエリ)が含まれます。

ストリーミングセグメント化をおこなう場合は、次のガイドラインに従ってください。

クエリタイプ ガイドライン
単一イベントクエリ ルックバックウィンドウに制限はありません。
イベント履歴を含むクエリ
  • ルックバックウィンドウは次の条件に制限されています。 1 日.
  • 厳密な時間順序条件 必須 イベント間に存在する。
  • 少なくとも 1 つの否定イベントを持つクエリがサポートされています。 ただし、イベント全体 できません 否定です。

セグメント定義を変更して、ストリーミングセグメント化の条件を満たさなくした場合、セグメント定義は自動的に「ストリーミング」から「バッチ」に切り替わります。

また、セグメントの選定解除は、セグメントの選定と同様に、リアルタイムで発生します。 その結果、オーディエンスがセグメントの対象にならなくなった場合、そのオーディエンスはただちに無資格になります。 例えば、セグメント定義で「過去 3 時間に赤い靴を購入したすべてのユーザー」という要求が表示された場合、3 時間後に、最初にセグメント定義で認定されたすべてのプロファイルが無効になります。

ストリーミングセグメント化が有効なすべてのセグメントを取得

IMS 組織内でストリーミングセグメント化が有効になっているすべてのセグメントのリストを取得するには、GETリクエストを /segment/definitions endpoint.

API 形式

ストリーミングが対応セグメントを取得するには、リクエストパスに evaluationInfo.continuous.enabled=true クエリパラメーターを含める必要があります。

GET /segment/definitions?evaluationInfo.continuous.enabled=true

リクエスト

curl -X GET \
  'https://platform.adobe.io/data/core/ups/segment/definitions?evaluationInfo.continuous.enabled=true' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

正常な応答は、ストリーミングセグメント化対応 IMS 組織内セグメントの配列を返します。

{
    "segments": [
        {
            "id": "15063cb-2da8-4851-a2e2-bf59ddd2f004",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 30,
            "imsOrgId": "{IMS_ORG_ID}",
            "sandbox": {
                "sandboxId": "",
                "sandboxName": "",
                "type": "production",
                "default": true
            },
            "name": " People who are NOT on their homepage ",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = false"
            },
            "evaluationInfo": {
                "batch": {
                    "enabled": false
                },
                "continuous": {
                    "enabled": true
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "creationTime": 1572029711000,
            "updateEpoch": 1572029712000,
            "updateTime": 1572029712000
        },
        {
            "id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 30,
            "imsOrgId": "{IMS_ORG_ID}",
            "sandbox": {
                "sandboxId": "",
                "sandboxName": "",
                "type": "production",
                "default": true
            },
            "name": "Homepage_continuous",
            "description": "People who are on their homepage - continuous",
            "expression": {
                "type": "PQL",
                "format": "pql/text",
                "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
            },
            "evaluationInfo": {
                "batch": {
                    "enabled": true
                },
                "continuous": {
                    "enabled": true
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "creationTime": 1572021085000,
            "updateEpoch": 1572021086000,
            "updateTime": 1572021086000
        }
    ],
    "page": {
        "totalCount": 2,
        "totalPages": 1,
        "sortField": "creationTime",
        "sort": "desc",
        "pageSize": 2,
        "limit": 100
    },
    "link": {}
}

ストリーミング対応セグメントの作成

セグメントが 上記のストリーミングセグメントタイプ.

API 形式

POST /segment/definitions

リクエスト

curl -X POST \
  https://platform.adobe.io/data/core/ups/segment/definitions \
  -H 'Authorization: Bearer {ACCESS_TOKEN}'  \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 30,
    "name": "Homepage_continuous",
    "description": "People who are on their homepage - continuous",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
    }
}'
メモ

これは、標準の「セグメントの作成」リクエストです。 セグメント定義の作成の詳細については、 セグメントの作成.

応答

正常な応答は、新たに作成されたストリーミング対応セグメント定義の詳細を返します。

{
    "id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "ttlInDays": 30,
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "{SANDBOX_ID}",
        "sandboxName": "{SANDBOX_NAME}",
        "type": "production",
        "default": true
    },
    "name": "Homepage_continuous",
    "description": "People who are on their homepage - continuous",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "select var1 from xEvent where var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = true"
    },
    "evaluationInfo": {
        "batch": {
            "enabled": false
        },
        "continuous": {
            "enabled": true,
                   },
        "synchronous": {
            "enabled": false
        }
    },
    "creationTime": 1572021085000,
    "updateEpoch": 1572021086000,
    "updateTime": 1572021086000
}

スケジュールされた評価の有効化

ストリーミング評価が有効になったら、ベースラインを作成する必要があります(ベースラインの作成後、セグメントは常に最新の状態になります)。システムが自動的にベースライン化を実行するには、まず、スケジュールされた評価(スケジュールされたセグメント化とも呼ばれます)を有効にする必要があります。 スケジュールに沿ったセグメント化を使用すると、IMS 組織は定期的なスケジュールに従って、セグメントを評価する書き出しジョブを自動的に実行できます。

メモ

の結合ポリシーが最大 5 個あるサンドボックスに対して、スケジュールされた評価を有効にすることができます。 XDM Individual Profile. 組織に対する結合ポリシーが 6 つ以上ある場合 XDM Individual Profile 単一のサンドボックス環境内では、スケジュールされた評価を使用できません。

スケジュールの作成

/config/schedules エンドポイントに対して POST リクエストを実行することにより、スケジュールを作成し、スケジュールをトリガーする必要がある特定の時間を指定することができます。

API 形式

POST /config/schedules

リクエスト

次のリクエストは、ペイロードで提供された仕様に基づいて新しいスケジュールを作成します。

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/schedules \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '{
        "name": "{SCHEDULE_NAME}",
        "type": "batch_segmentation",
        "properties": {
            "segments": ["*"]
        },
        "schedule": "0 0 1 * * ?",
        "state": "inactive"
        }'
プロパティ 説明
name (必須)​スケジュールの名前。文字列である必要があります。
type (必須)​文字列形式のジョブタイプ。サポートされているタイプは batch_segmentationexport です。
properties (必須)​スケジュールに関連する追加のプロパティを含むオブジェクト。
properties.segments typebatch_segmentation と等しい場合は必須)["*"] を使用すると、すべてのセグメントが含まれます。
schedule (必須)​ジョブスケジュールを含む文字列。ジョブは 1 日に 1 回のみ実行するようにスケジュールできます。つまり、24 時間の間に 2 回以上実行するようにジョブをスケジュールすることはできません。例 (0 0 1 * * ?) は、ジョブが毎日 1 時にトリガーされることを意味します。:00:00 UTC です。 詳しくは、CRON 式形式のドキュメントを参照してください。
state (オプション)​スケジュールの状態を含む文字列。使用可能な値は activeinactive です。デフォルト値は inactive です。IMS 組織で作成できるスケジュールは 1 つだけです。スケジュールを更新する手順は、このチュートリアルの後半で説明します。

応答

成功した応答は、新しく作成したスケジュールの詳細を返します。

{
    "id": "cd585edf-962d-420d-94ad-3be03e619ac2",
    "imsOrgId": "{IMS_ORG}",
    "sandbox": {
        "sandboxId": "e7e17720-c5bb-11e9-aafb-87c71c35cac8",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "{SCHEDULE_NAME}",
    "state": "inactive",
    "type": "batch_segmentation",
    "schedule": "0 0 1 * * ?",
    "properties": {
        "segments": [
            "*"
        ]
    },
    "createEpoch": 1568267948,
    "updateEpoch": 1568267948
}

スケジュールの有効化

デフォルトでは、作成(POST)リクエスト本文で state プロパティが active に設定されていない限り、スケジュールは作成時に非アクティブになります。/config/schedules エンドポイントに対して PATCH リクエストを実行し、パスにスケジュールの ID を含めることで、スケジュールを有効にする(stateactive に設定する)ことができます。

API 形式

POST /config/schedules/{SCHEDULE_ID}

リクエスト

次のリクエストでは、スケジュールの stateactive に更新するために、JSON パッチの形式を使用しています。

curl -X POST \
  https://platform.adobe.io/data/core/ups/config/schedules/cd585edf-962d-420d-94ad-3be03e619ac2 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        {
          "op": "add",
          "path": "/state",
          "value": "active"
        }
      ]'

応答

更新が成功すると、空の応答本文と HTTP ステータス 204(No Content)が返されます。

同じ操作を使用して、前のリクエストの「値」を「inactive」に置き換えることで、スケジュールを無効にできます。

次の手順

これで、新しいセグメントと既存のセグメントの両方を有効にし、スケジュールされたセグメント化を有効にしてベースラインを作成し、定期的な評価を実行できるようになりました。組織で、ストリーミング対応セグメントの作成を開始できます。

Adobe Experience Platform ユーザーインターフェイスを使用して同様のアクションを実行し、セグメントを操作する方法については、『セグメントビルダーユーザーガイド』を参照してください。

付録

次の節では、ストリーミングセグメント化に関するよくある質問を示します。

ストリーミングセグメント化の「不適格性」もリアルタイムで発生しますか。

ほとんどのインスタンスでは、ストリーミングセグメント化の非認定はリアルタイムで発生します。 ただし、セグメントのセグメントを使用するストリーミングセグメントでは、 not はリアルタイムで未認定で、24 時間後に不適格と見なされます。

ストリーミングセグメント化はどのデータで機能しますか?

ストリーミングセグメント化は、ストリーミングソースを使用して取り込まれたすべてのデータで機能します。 バッチベースのソースを使用して取り込まれたセグメントは、ストリーミングセグメント化の対象となっている場合でも、毎晩評価されます。

セグメントはバッチセグメント化またはストリーミングセグメント化としてどのように定義されますか。

セグメントは、クエリタイプとイベント履歴期間の組み合わせに基づいて、バッチまたはストリーミングによるセグメント化として定義されます。 ストリーミングセグメントとして評価されるセグメントのリストは、 ストリーミングセグメント化のクエリタイプの節.

ユーザーは、セグメントをバッチセグメント化またはストリーミングセグメント化として定義できますか?

現時点では、セグメントの評価に使用する方法はシステムによって自動的に決定されるので、ユーザーはセグメントの評価にバッチ取得とストリーミング取得のどちらを使用するかを定義できません。

セグメントの詳細セクション内で、「過去 X 日間」の下の数がゼロのままの間、「合計認定済み」セグメントの数が増加し続けるのはなぜですか?

合計認定セグメント数は、日別のセグメント化ジョブから取得されます。このジョブには、バッチセグメントとストリーミングセグメントの両方に適合するオーディエンスが含まれます。 この値は、バッチセグメントとストリーミングセグメントの両方で表示されます。

「過去 X 日間」の下の数 のみ には、ストリーミングセグメント化の条件を満たすオーディエンスが含まれます。 のみ は、データをシステムにストリーミングし、そのストリーミング定義にカウントする場合に増加します。 この値は のみ ストリーミングセグメント用に表示されます。 その結果、この値 may バッチセグメントの場合は 0 と表示されます。

その結果、「過去 X 日間」の下の数がゼロで、線グラフもゼロをレポートしている場合は、 not は、任意のプロファイルを、そのセグメントに適合するシステムにストリーミングしました。

このページ