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

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

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

はじめに

このチュートリアルでは、Profileが有効なデータセットの管理に関わる様々なAdobe Experience Platformのサービスについて、十分に理解しておく必要があります。 このチュートリアルを開始する前に、関連する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 呼び出しのドキュメントで使用されている規則については、Experience Platform トラブルシューテングガイドのサンプル API 呼び出しの読み方に関する節を参照してください。

必須ヘッダーの値の収集

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: application/json

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

  • x-sandbox-name: {SANDBOX_NAME}

ProfileとIdentityに対して有効にするデータセットの作成

データセットの作成直後、またはデータセットの作成後いつでも、Real-time Customer ProfileとIdentity Serviceのデータセットを有効にできます。 作成済みのデータセットを有効にする場合は、このドキュメントの後半の手順に従って、既存のデータセットを設定します。新しいデータセットを作成するには、リアルタイム顧客プロファイルが有効となっている既存の XDM スキーマの ID を知っておく必要があります。プロファイルが有効なスキーマを参照または作成する方法について詳しくは、スキーマレジストリ API を使用したスキーマの作成に関するチュートリアルを参照してください。次のCatalog APIの呼び出しは、ProfileとIdentity Serviceのデータセットを有効にします。

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 '{
    "fileDescription" : {
        "persisted": true
    },
    "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",
        "fileDescription": {
            "persisted": true
        },
        "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' \
  -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"
]

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

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

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

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

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

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

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

このページ