API を使用した Profile および Identity Service のデータセットの有効化

このチュートリアルでは、Real-time Customer Profile と Identity Service で使用するデータセットを有効にするプロセスを、次の手順に分けて説明します。

  1. Real-time Customer Profile で使用するデータセットを有効にするには、次の 2 つのオプションのいずれかを使用します。
  2. データセットへのデータの取り込み
  3. リアルタイム顧客プロファイルによるデータ取り込みの確認
  4. ID サービスによるデータ取り込みの確認

はじめに

このチュートリアルでは、プロファイル対応データセットの管理に関わるAdobe Experience Platformの複数のサービスに関する十分な知識が必要です。 このチュートリアルを開始する前に、次の関連する DNL Platform サービスのドキュメントを確認してください。

  • Real-time Customer Profile:複数のソースからの集計データに基づいて、統合されたリアルタイムの顧客プロファイルを提供します。
  • Identity Service:に取り Real-time Customer Profile 込まれる様々なデータソースの ID を関連付けることで、を有効にし Platformます。
  • Catalog Service:データセットを作成し、および用に設定できる RESTful API Real-time Customer Profile で Identity Serviceす。
  • 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}

ペイロード (POST、PUT、PATCH) を含むすべてのリクエストには、追加の Content-Type ヘッダーが必要です。 必要に応じて、このヘッダーの正しい値がサンプルリクエストに表示されます。

Experience Platform のすべてのリソースは、特定の仮想サンドボックスに分離されています。Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定する x-sandbox-name ヘッダーが必要です。 Platform のサンドボックスについて詳しくは、サンドボックスの概要に関するドキュメントを参照してください。

プロファイルおよび ID 対応データセットの作成

リアルタイム顧客プロファイルおよび ID サービスのデータセットは、作成時、またはデータセットの作成後任意の時点で有効にできます。作成済みのデータセットを有効にする場合は、このドキュメントの後半の手順に従って、既存のデータセットを設定します。

メモ

新しいプロファイル対応データセットを作成するには、プロファイルに対して有効になっている既存の XDM スキーマの ID を把握しておく必要があります。 プロファイルが有効なスキーマを参照または作成する方法について詳しくは、スキーマレジストリ API を使用したスキーマの作成に関するチュートリアルを参照してください。

プロファイルに対して有効なデータセットを作成するには、/dataSets エンドポイントへのPOSTリクエストを使用します。

API 形式

POST /dataSets

リクエスト

リクエスト本文の tags の下に unifiedProfileunifiedIdentity を含めると、データセットは Profile と Identity Service に対して直ちに有効になります。 これらのタグの値は、"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 '{
    "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 データセットの基となる Profile 対応スキーマの ID。
{TENANT_ID} Schema Registry 内の名前空間。IMS 組織に属するリソースが含まれます。 詳しくは、Schema Registry 開発者ガイドの TENANT_ID の節を参照してください。

応答

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

[
    "@/dataSets/5b020a27e7040801dedbf46e"
] 

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

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

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

Catalog API を使用して、既存のデータセットを調べ、Real-time Customer Profile と 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",
        "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 Profile と Identity Service がそれぞれ有効になっています。

データセットの有効化

既存のデータセットが Profile または Identity Service に対して有効になっていない場合は、データセット ID を使用してPATCHリクエストを実行し、有効にすることができます。

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-patch+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": "/tags/unifiedProfile", "value": ["enabled:true"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] } 
      ]'

リクエスト本文には、pathunifiedProfile の 2 種類のタグ (unifiedIdentity) が含まれます。 それぞれの value は、文字列 enabled:true を含む配列です。

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

[
    "@/dataSets/5b020a27e7040801dedbf46e"
]

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

Real-time Customer Profile と Identity Service の両方が、データセットに取り込まれる際に XDM データを使用します。 データセットにデータをアップロードする手順については、API を使用したデータセットの作成に関するチュートリアルを参照してください。Profile 対応のデータセットに送信するデータを計画する際は、次のベストプラクティスを考慮してください。

  • セグメント化条件として使用するデータを含めます。
  • ID グラフを最大化するために、プロファイルデータから確認できる識別子をできるだけ多く含めます。これにより、Identity Service はデータセット間で ID をより効果的に結び付けることができます。

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

初めて新しいデータセットにデータをアップロードする際、または新しい ETL やデータソースが関与するプロセスの一部として、データが期待どおりにアップロードされたかどうかを慎重に確認することをお勧めします。Real-time Customer Profile Access API を使用すると、データセットに読み込まれるバッチデータを取得できます。 期待するエンティティを取得できない場合は、Real-time Customer Profile に対してデータセットが有効になっていない可能性があります。 データセットが有効になっていることを確認した後、ソースデータの形式と識別子が期待通りに動作することを確認します。Real-time Customer Profile API を使用して Profile データにアクセスする方法について詳しくは、『entities エンドポイントガイド 』(別名「Profile Access」 API)を参照してください。

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

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

このページ