バッチセグメンテーションガイド

バッチセグメンテーションとは、プロファイルデータを一度に移動して、対応するオーディエンスを作成できるセグメント化評価方法です。

バッチセグメント化を使用すると、詳細でリッチなオーディエンスを作成し、セグメンテーションジョブを実行して、このデータを下流サービスに反映するタイミングを決定できます。

対象となるクエリタイプ query-types

すべてのクエリは、バッチセグメント化の対象となります。

オーディエンスを作成 create-audience

セグメント化サービス APIまたはUIのAudience Portalを使用して、バッチセグメント化を使用して評価されるオーディエンスを作成できます。

セグメント サービス API

API 形式

code language-http
POST /segment/definitions

リクエスト

accordion
バッチセグメント化が有効になっているセグメント定義を作成するためのサンプルリクエスト
code language-shell
curl -X POST https://platform.adobe.io/data/core/ups/segment/definitions
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '{
        "name": "People in the USA",
        "description: "An audience that looks for people who live in the USA",
        "expression": {
            "type": "PQL",
            "format": "pql/text",
            "value": "homeAddress.country = \"US\""
        },
        "evaluationInfo": {
            "batch": {
                "enabled": true
            },
            "continuous": {
                "enabled": false
            },
            "synchronous": {
                "enabled": false
            }
        },
        "schema": {
            "name": "_xdm.context.profile"
        }
     }'

応答

リクエストが成功した場合は、新しく作成したセグメント定義の詳細と HTTP ステータス 200 が返されます。

accordion
セグメント定義を作成する際の応答のサンプル。
code language-json
{
    "id": "4afe34ae-8c98-4513-8a1d-67ccaa54bc05",
    "schema": {
        "name": "_xdm.context.profile"
    },
    "profileInstanceId": "ups",
    "imsOrgId": "{ORG_ID}",
    "sandbox": {
        "sandboxId": "28e74200-e3de-11e9-8f5d-7f27416c5f0d",
        "sandboxName": "prod",
        "type": "production",
        "default": true
    },
    "name": "People in the USA",
    "description": "An audience that looks for people who live in the USA",
    "expression": {
        "type": "PQL",
        "format": "pql/text",
        "value": "homeAddress.country = \"US\""
    },
    "evaluationInfo": {
        "batch": {
            "enabled": true
        },
        "continuous": {
            "enabled": false
        },
        "synchronous": {
            "enabled": false
        }
    },
    "dataGovernancePolicy": {
        "excludeOptOut": true
    },
    "creationTime": 0,
    "updateEpoch": 1579292094,
    "updateTime": 1579292094000
}

このエンドポイントの使用について詳しくは、​ セグメント定義エンドポイントガイド ​を参照してください。

オーディエンスポータル

オーディエンスポータルで、Create audience​を選択します。

​ オーディエンスポータルで「オーディエンスを作成」ボタンが強調表示されます。

ポップオーバーが表示されます。 Build rules​を選択してセグメントビルダーに入ります。

​ オーディエンスを作成ポップオーバーで「ルールを作成」ボタンが強調表示されます。

セグメント定義を作成したら、Batch​を​ Evaluation method ​として選択します。

​ セグメント定義が表示されます。 評価タイプが強調表示され、ストリーミングセグメント化を使用してセグメント定義を評価できることを示します。

セグメント定義の作成について詳しくは、セグメントビルダーガイドを参照してください。

オーディエンスの取得 retrieve-audiences

セグメント化サービス APIまたはUIのオーディエンスポータルを使用して、バッチセグメント化を使用して評価されたすべてのオーディエンスを取得できます。

セグメント サービス API

/segment/definitions エンドポイントにGET リクエストを行うことで、組織内のバッチセグメント化を使用して評価されたすべてのセグメント定義のリストを取得します。

API 形式

バッチセグメント化を使用して評価されたセグメント定義を取得するには、クエリパラメーターevaluationInfo.batch.enabled=trueをリクエストパスに含める必要があります。

code language-http
GET /segment/definitions?evaluationInfo.batch.enabled=true

リクエスト

accordion
バッチ対応のすべてのセグメント定義を一覧表示するサンプルリクエスト
code language-shell
curl -X GET \
  'https://platform.adobe.io/data/core/ups/segment/definitions?evaluationInfo.batch.enabled=true' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

応答が成功すると、バッチセグメント化を使用して評価された組織内のセグメント定義の配列を含むHTTP ステータス 200が返されます。

accordion
組織内のすべてのバッチセグメント化評価セグメント定義のリストを含むサンプル応答
code language-json
{
    "segments": [
        {
            "id": "15063cb-2da8-4851-a2e2-bf59ddd2f004",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 30,
            "imsOrgId": "{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": true
                },
                "continuous": {
                    "enabled": false
                },
                "synchronous": {
                    "enabled": false
                }
            },
            "creationTime": 1572029711000,
            "updateEpoch": 1572029712000,
            "updateTime": 1572029712000
        },
        {
            "id": "f15063cb-2da8-4851-a2e2-bf59ddd2f004",
            "schema": {
                "name": "_xdm.context.profile"
            },
            "ttlInDays": 30,
            "imsOrgId": "{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": {}
}

返されるセグメント定義について詳しくは、セグメント定義エンドポイントガイドを参照してください。

オーディエンスポータル

オーディエンスポータルのフィルターを使用すると、組織内でバッチセグメント化が有効になっているすべてのオーディエンスを取得できます。 ​ フィルターアイコン ​ アイコンを選択して、フィルターのリストを表示します。

​ フィルターアイコンがオーディエンスポータルで強調表示されます。

使用可能なフィルター内で、Update frequency​に移動し、「Batch」を選択します。 このフィルターを使用すると、バッチセグメンテーションを使用して評価された、組織内のすべてのオーディエンスが表示されます。

​ バッチ更新頻度が選択され、バッチセグメント化を使用して評価された組織内のすべてのオーディエンスが表示されます。

Experience Platformでのオーディエンスの表示について詳しくは、​ オーディエンスポータルガイド ​を参照してください。

次の手順

このガイドでは、Adobe Experience Platformでバッチセグメント化を使用して評価できるセグメント定義を作成する方法について説明します。

Experience Platform ユーザーインターフェイスの使用について詳しくは、​ セグメント化ユーザーガイド ​を参照してください。

バッチセグメンテーションに関するよくある質問については、FAQ🔗の「 バッチセグメンテーション」の節をご覧ください。

recommendation-more-help
experience-platform-help-segmentation