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

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

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

はじめに

このチュートリアルでは、プロファイル対応データセットの管理に関わるいくつかの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 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。

必須ヘッダーの値の収集

Platform API を呼び出すには、まず認証チュートリアルを完了する必要があります。次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。

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

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

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

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

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

メモ

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

プロファイルに対して有効なデータセットを作成するには、 /dataSets endpoint.

API 形式

POST /dataSets

リクエスト

次を含めることで: unifiedProfile および unifiedIdentity under tags リクエスト本文では、データセットは、 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: {ORG_ID}' \
  -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 の ID Profile — データセットの基となる有効なスキーマ。
{TENANT_ID} 内の名前空間 Schema Registry :IMS 組織に属するリソースを含みます。 詳しくは、 TENANT_ID セクション Schema Registry 開発者ガイドを参照してください。

応答

正常に完了すると、新しく作成されたデータセットの 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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

応答

{
    "5b020a27e7040801dedbf46e": {
        "name": "Commission Program Events DataSet",
        "imsOrg": "{ORG_ID}",
        "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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -d '[
        { "op": "add", "path": "/tags/unifiedProfile", "value": ["enabled:true"] },
        { "op": "add", "path": "/tags/unifiedIdentity", "value": ["enabled:true"] }
      ]'

リクエスト本文には、 path を 2 種類のタグに追加します。 unifiedProfile および 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 API にアクセスすると、データセットに読み込まれるバッチデータを取得できます。 目的のエンティティを取得できない場合は、データセットが有効になっていない可能性があります。 Real-time Customer Profile. データセットが有効になっていることを確認した後、ソースデータの形式と識別子が期待通りに動作することを確認します。を使用する方法の詳細な手順については、 Real-time Customer Profile アクセスする API Profile データについては、 エンティティエンドポイントガイド( 別名「Profile Access" API.

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

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

このページ