APIのデータセットの設定 Profile と Identity Service 使用

This tutorial covers the process of enabling a dataset for use in Real-time Customer Profile and Identity Service, broken down into the following steps:

  1. Enable a dataset for use in Real-time Customer Profile, using one of two options:
  2. データセットへのデータの取り込み
  3. リアルタイム顧客プロファイルによるデータ取り込みの確認
  4. ID サービスによるデータ取り込みの確認

はじめに

This tutorial requires a working understanding of the various Adobe Experience Platform services involved in managing Profile-enabled datasets. Before beginning this tutorial, please review the documentation for these related Platform services:

  • リアルタイム顧客プロファイル:複数のソースからの集計データに基づいて、統合されたリアルタイムの消費者プロファイルを提供します。
  • IDサービス:取り込ま Real-time Customer Profile れる異なるデータソースのIDをブリッジ化することで有効に Platformします。
  • カタログサービス:および用のデータセットの作成と設定を可能にするRESTful API Real-time Customer Profile で Identity Serviceす。
  • Experience Data Model (XDM):顧客体験データを Platform 整理する際に使用される標準化されたフレームワーク。

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

API 呼び出し例の読み取り

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

必須ヘッダーの値の収集

In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

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

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

  • Content-Type: application/json

All resources in Experience Platform are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in. For more information on sandboxes in Platform, see the sandbox overview documentation.

  • x-sandbox-name: {SANDBOX_NAME}

有効にするデータセットの作成( Profile および Identity

You can enable a dataset for Real-time Customer Profile and Identity Service immediately upon creation or at any point after the dataset has been created. 作成済みのデータセットを有効にする場合は、このドキュメントの後半の手順に従って、既存のデータセットを設定します。新しいデータセットを作成するには、リアルタイム顧客プロファイルが有効となっている既存の XDM スキーマの ID を知っておく必要があります。プロファイルが有効なスキーマを参照または作成する方法について詳しくは、スキーマレジストリ API を使用したスキーマの作成に関するチュートリアルを参照してください。次の Catalog APIの呼び出しは、およびのデータセットを有効に Profile し Identity Serviceます。

API 形式

POST /dataSets

リクエスト

By including unifiedProfile and unifiedIdentity under tags in the request body, the dataset will be immediately enabled for Profile and Identity Service, respectively. これらのタグの値は、"enabled:true" 文字列を含む配列である必要があります。

curl -X POST \
  https://platform.adobe.io/data/foundation/catalog/dataSets \
  -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 '{
    "fileDescription" : {
    "persisted": true,
        "containerFormat": "parquet",
        "format": "parquet"
    },
    "fields":[],
    "schemaRef" : {
        "id": "https://ns.adobe.com/{TENANT_ID}/schemas/31670881463308a46f7d2cb09762715",
        "contentType": "application/vnd.adobe.xed-full-notext+json; version=1"
    },
    "tags" : {
       "unifiedProfile": ["enabled:true"],
       "unifiedIdentity": ["enabled:true"]
    }
  }'
プロパティ 説明
schemaRef.id The ID of the Profile-enabled schema upon which the dataset will be based.
{TENANT_ID} The namespace within the Schema Registry which contains resources belonging to your IMS Organization. See the TENANT_ID section of the Schema Registry developer guide for more information.

応答

正常に完了すると、新しく作成されたデータセットの ID を含む配列が、"@/dataSets/{DATASET_ID}"の形式で表示されます。データセットの作成と有効化が完了したら、データのアップロード手順に進んでください。

[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

既存のデータセットの設定

以下の手順では、 Real-time Customer Profile およびに対して以前に作成したデータセットを有効にする方法について説明 Identity Serviceします。 既にプロファイル対応データセットを作成している場合は、データの取り込み手順に進んでください。

データセットが有効かどうかを確認します。

Using the Catalog API, you can inspect an existing dataset to determine whether it is enabled for use in Real-time Customer Profile and Identity Service. 次の呼び出しは、データセットの詳細を ID によって取得します。

API 形式

GET /dataSets/{DATASET_ID}
パラメーター 説明
{DATASET_ID} 調査するデータセットの ID。

リクエスト

curl -X GET \
  'https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e' \
  -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}'

応答

{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{IMS_ORG}",
        "tags": {
            "adobe/pqs/table": [
                "unifiedprofileingestiontesteventsdataset"
            ],
            "unifiedProfile": [
                "enabled:true"
            ],
            "unifiedIdentity": [
                "enabled:true"
            ]
        },
        "lastBatchId": "6dcd9128a1c84e6aa5177641165e18e4",
        "lastBatchStatus": "success",
        "dule": {},
        "statsCache": {
            "startDate": null,
            "endDate": null
        },
        "namespace": "ACP",
        "state": "DRAFT",
        "version": "1.0.1",
        "created": 1536536917382,
        "updated": 1539793978215,
        "createdClient": "{CLIENT_CREATED}",
        "createdUser": "{CREATED_BY}",
        "updatedUser": "{CREATED_BY}",
        "viewId": "5b020a27e7040801dedbf46f",
        "status": "enabled",
        "fileDescription": {
            "persisted": true,
            "containerFormat": "parquet",
            "format": "parquet"
        },
        "transforms": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/transforms",
        "files": "@/dataSets/5b020a27e7040801dedbf46e/views/5b020a27e7040801dedbf46f/files",
        "schema": "@/xdms/context/experienceevent",
        "schemaMetadata": {
            "primaryKey": [],
            "delta": [],
            "dule": [],
            "gdpr": []
        },
        "schemaRef": {
            "id": "https://ns.adobe.com/xdm/context/experienceevent",
            "contentType": "application/vnd.adobe.xed+json"
        }
    }
}

プロパティ tags の下で、unifiedProfileunifiedIdentity が値 enabled:true と共に存在することを確認できます。したがって、 Real-time Customer ProfileIdentity Service とは、それぞれこのデータセットに対して有効になります。

データセットの有効化

If the existing dataset has not been enabled for Profile or Identity Service, you can enable it by making a PATCH request using the dataset ID.

API 形式

PATCH /dataSets/{DATASET_ID}
パラメーター 説明
{DATASET_ID} 更新するデータセットの ID。

リクエスト

curl -X PATCH \
  https://platform.adobe.io/data/foundation/catalog/dataSets/5b020a27e7040801dedbf46e \
  -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 '{
    "tags" : {
        "unifiedProfile": ["enabled:true"],
        "unifiedIdentity": ["enabled:true"]
    }
  }'

リクエスト本文には、2 つのサブプロパティ("unifiedProfile" および "unifiedIdentity")を含む tags プロパティが含まれます。これらのサブプロパティの値は、"enabled:true" 文字列を含む配列です。

応答 PATCH リクエストが成功すると、HTTP ステータス 200(OK)と、更新されたデータセットの ID を含む配列が返されます。この ID は、PATCH リクエストで送信された ID と一致する必要があります。"unifiedProfile" タグと "unifiedIdentity" タグが追加され、データセットがプロファイルおよび ID サービスで使用できるようになりました。

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

データセットへのデータの取り込み

とは、XDMデータ Real-time Customer Profile がデータセットに取り込まれる際に、その両方を Identity Service 利用します。 データセットにデータをアップロードする手順については、API を使用したデータセットの作成に関するチュートリアルを参照してください。When planning what data to send to your Profile-enabled dataset, consider the following best practices:

  • オーディエンスセグメント条件として使用するデータを含めます。
  • ID グラフを最大化するために、プロファイルデータから確認できる識別子をできるだけ多く含めます。This allows Identity Service to stitch identities across datasets more effectively.

データ取り込みの確認 Real-time Customer Profile

初めて新しいデータセットにデータをアップロードする際、または新しい ETL やデータソースが関与するプロセスの一部として、データが期待どおりにアップロードされたかどうかを慎重に確認することをお勧めします。Using the Real-time Customer Profile Access API, you can retrieve batch data as it gets loaded into a dataset. If you are unable to retrieve any of the entities you expect, your dataset may not be enabled for Real-time Customer Profile. データセットが有効になっていることを確認した後、ソースデータの形式と識別子が期待通りに動作することを確認します。APIを使用して Real-time Customer Profile データにアクセスする方法について詳しくは、「 Profile API」とも呼ばれる エンティティのエンドポイントガイド Profile Access に従ってください。

ID サービスによるデータ取り込みの確認

複数の ID を含むデータフラグメントを取り込むと、プライベート ID グラフにリンクが作成されます。ID グラフと ID データへのアクセスの詳細については、ID サービスの概要を参照してください。

このページ