エッジのセグメント化(ベータ版)

メモ

次のドキュメントでは、API を使用してエッジのセグメント化を実行する方法を説明します。 UI を使用してエッジセグメント化を実行する方法については、 エッジセグメント化 UI ガイド. また、エッジセグメント化は現在ベータ版です。 ドキュメントと機能は変更される場合があります。

エッジのセグメント化は、エッジ上でAdobe Experience Platformで瞬時にセグメントを評価する機能で、同じページや次のページのパーソナライゼーションの使用例を可能にします。

はじめに

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

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

任意のExperience PlatformAPI エンドポイントを正しく呼び出すには、 Platform API の概要 必要なヘッダーとサンプル API 呼び出しの読み取り方法について説明します。

エッジセグメント化のクエリタイプ

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

クエリタイプ 詳細
単一イベント 時間制限のない単一の受信イベントを参照するセグメント定義。 買い物かごに項目を追加した担当者。
プロファイルを参照する単一イベント 時間制限のない 1 つ以上のプロファイル属性と 1 つの受信イベントを参照するセグメント定義。 ホームページを訪問した米国在住の人。
プロファイル属性を持つ否定された単一イベント 否定された単一の受信イベントと 1 つ以上のプロファイル属性を参照するセグメント定義 米国に住み、 not ホームページにアクセスしました。
24 時間以内の単一イベント 24 時間以内の単一の受信イベントを参照するセグメント定義。 過去 24 時間にホームページを訪問した人。
24 時間以内のプロファイル属性を持つ単一のイベント 1 つ以上のプロファイル属性と、24 時間以内の無効にされた単一の受信イベントを参照するセグメント定義。 過去 24 時間にホームページを訪問した米国に住む人。
24 時間以内のプロファイル属性を持つ、無効化された単一イベント 1 つ以上のプロファイル属性と、24 時間以内の無効にされた単一の受信イベントを参照するセグメント定義。 米国に住み、 not 過去 24 時間にホームページにアクセスした。
24 時間以内の頻度イベント 24 時間の期間内に特定の回数だけ発生したイベントを参照するセグメント定義。 ホームページを訪問した人 少なくとも 過去 24 時間で 5 回
24 時間の時間枠内にプロファイル属性を持つ頻度イベント 1 つ以上のプロファイル属性と、24 時間の期間内に一定の回数だけ発生したイベントを参照するセグメント定義。 ホームページを訪問した米国出身の人 少なくとも 過去 24 時間で 5 回
24 時間以内のプロファイルを含む無効な頻度イベント 1 つ以上のプロファイル属性と、24 時間の期間内に特定の回数だけ発生する無効なイベントを参照するセグメント定義。 ホームページを訪問していない人 詳細 過去 24 時間で 5 回以上
24 時間以内に複数の受信ヒット 24 時間以内に発生した複数のイベントを参照するセグメント定義。 ホームページを訪問した人 または 過去 24 時間以内にチェックアウトページにアクセスしました。
24 時間の期間内にプロファイルを持つ複数のイベント 24 時間以内に発生する 1 つ以上のプロファイル属性と複数のイベントを参照するセグメント定義。 ホームページを訪問した米国出身の人 および 過去 24 時間以内にチェックアウトページにアクセスしました。

また、 必須 エッジ上でアクティブな結合ポリシーに結び付けられている。 結合ポリシーの詳細については、 結合ポリシーガイド.

エッジセグメント化で有効なすべてのセグメントの取得

IMS 組織内のエッジセグメント化で有効になっているすべてのセグメントのリストを取得するには、にGETリクエストを実行します。 /segment/definitions endpoint.

API 形式

エッジセグメント化が有効なセグメントを取得するには、クエリパラメーターを含める必要があります evaluationInfo.synchronous.enabled=true リクエストパス内で使用します。

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

リクエスト

curl -X GET \
  'https://platform.adobe.io/data/core/ups/segment/definitions?evaluationInfo.synchronous.enabled=true' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -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": false
                },
                "synchronous": {
                    "enabled": true
                }
            },
            "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": false
                },
                "continuous": {
                    "enabled": false
                },
                "synchronous": {
                    "enabled": true
                }
            },
            "creationTime": 1572021085000,
            "updateEpoch": 1572021086000,
            "updateTime": 1572021086000
        }
    ],
    "page": {
        "totalCount": 2,
        "totalPages": 1,
        "sortField": "creationTime",
        "sort": "desc",
        "pageSize": 2,
        "limit": 100
    },
    "link": {}
}

エッジセグメント化が有効なセグメントの作成

エッジセグメント化を有効にするセグメントを作成するには、 /segment/definitions 次のいずれかと一致するエンドポイント 上記のエッジセグメントクエリタイプ.

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": "chain(xEvent, timestamp, [X: WHAT(var1._experience.analytics.endUser.firstWeb.webPageDetails.isHomePage = "true")])"
    },
    "evaluationInfo": {
        "batch": {
            "enabled": false
        },
        "continuous": {
            "enabled": false
        },
        "synchronous": {
            "enabled": true
        }
    },
    "creationTime": 1572021085000,
    "updateEpoch": 1572021086000,
    "updateTime": 1572021086000
}

次の手順

エッジセグメント化が有効なセグメントの作成方法がわかったので、それらを使用して、同じページと次のページのパーソナライゼーションの使用例を有効にできます。

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

このページ