Data Prep を使用した Real-Time Customer Profile への部分行の更新の送信
Data Prep でアップサートをストリーミングすると、Real-Time Customer Profile データに部分行の更新を送信しながら、単一の API リクエストで新しい ID リンクを作成および確立できます。
アップサートをストリーミングすると、データの形式を保持しながら、取り込み時にデータを Real-Time Customer Profile のPATCHリクエストに変換できます。 指定した入力に基づいて、1 つの API ペイロード Data Prep 送信し、そのデータをPATCHと Identity Service の両方の CREATE リクエスト Real-Time Customer Profile 変換できます。
このドキュメントでは、Data Prep でのアップサートのストリーミング方法について説明します。
はじめに
この概要では、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
- Data Prep:Data Prep を使用すると、データエンジニアは Experience Data Model （XDM）との間でデータのマッピング、変換、検証をおこなうことができます。
- Identity Service：デバイスやシステム間で ID を橋渡しすることで、個々の顧客とその行動をより確実に把握することができます。
- リアルタイム顧客プロファイル：複数のソースから集約されたデータに基づいて、統合された顧客プロファイルをリアルタイムに提供します。
- ソース：Experience Platform を使用すると、データを様々なソースから取得しながら、Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
Data Prep でのストリーミングアップサートの使用 streaming-upserts-in-data-prep
ストリーミングアップサートの高レベルなワークフロー
Data Prep でのアップサートのストリーミングは、次のように動作します。
-
最初に、データセットを作成し、Profile 用できるようにしておく必要があります。 詳しくは、 データセットの有効化 Profile に関するガイドを参照してください。
-
新しい ID をリンクする必要がある場合は、Profile しいデータセットとして 同じスキーマを持つ 追加のデータセットを作成する必要もあります。
-
データセットの準備が整ったら、受信リクエストを Profile のデータセットにマッピングするためのデータフローを作成する必要があります。
-
次に、必要なヘッダーを含めるように受信リクエストを更新する必要があります。 これらのヘッダーは、以下を定義します。
- Profile で実行する必要があるデータ操作：
create、merge、およびdelete。 - Identity Service で実行されるオプションの ID 操作：
create。
- Profile で実行する必要があるデータ操作：
ID データセットの設定
新しい ID をリンクする必要がある場合は、追加のデータセットを作成して、受信ペイロードに渡す必要があります。 ID データセットを作成する場合は、次の要件が満たされていることを確認する必要があります。
- ID データセットには、関連付けられたスキーマが Profile データセットとして必要です。 スキーマの不一致により、システム動作に一貫性がなくなる場合があります。
- ただし、ID データセットが Profile データセットと異なることを確認する必要があります。 データセットが同じ場合、データは更新されず、上書きされます。
- 初期データセットは Profile に対して有効にする必要がありますが、ID データセットは Profile に対して 有効にしない ください。 そうしないと、データは更新されずに上書きされてしまいます。 ただし、Identity Service に対しては、ID データセット 有効にする必要があります です。
ID データセットに関連付けられたスキーマの必須フィールド identity-dataset-required-fileds
スキーマに必須フィールドが含まれている場合、Identity Service が ID のみを受け取ることができるように、データセットの検証を抑制する必要があります。 disabled の値を acp_validationContext パラメーターに適用することで、検証を抑制できます。 以下の例を参照してください。
curl -X POST 'https://platform.adobe.io/data/foundation/catalog/dataSets/62257bef7a75461948ebcaaa' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"tags": {
"acp_validationContext": [
"disabled"
],
"unifiedProfile": [
"enabled:false"
],
"unifiedIdentity": [
"enabled:true"
]
}
}'
受信ペイロード構造
以下に、新しい ID リンクを確立する受信ペイロード構造の例を示します。
ID 設定を持つペイロード
{
"header": {
"flowId": "923e2ac3-3869-46ec-9e6f-7012c4e23f69",
"imsOrgId": "{ORG_ID}",
"datasetId": "621fc19ab33d941949af16c8",
"operations": {
"data": "create" (default)/"merge"/"delete",
"identity": "create",
"identityDatasetId": "621fc19ab33d941949af16d9"
}
}
... //The raw data attributes are included here as the key/value pairs of the "body" property.
}
flowIddatasetId パラメーターとして使用されます。imsOrgIddatasetIdoperationsoperations.dataoperations.identityoperations.identityDatasetIdサポートされる操作
Real-Time Customer Profile では、次の操作がサポートされています。
createmergedeleteIdentity Service では、次の操作がサポートされています。
createcreate が operations.identity の値として渡されると、Data Prep は Identity Service の XDM エンティティ作成リクエストを生成します。 ID が既に存在する場合、その ID は無視されます。 注意： operations.identity が create に設定されている場合は、identityDatasetId も指定する必要があります。 コンポーネントによって内部で生成された XDM エンティティ作成メッセージ Data Prep、このデータセット ID に対して生成されます。ID 設定のないペイロード
新しい ID をリンクする必要がない場合は、identity パラメーターと identityDatasetId パラメーターを操作で省略できます。 これにより、データは Real-Time Customer Profile にのみ送信され、Identity Service はスキップされます。 以下のペイロードの例を参照してください。
{
"header": {
"flowId": "923e2ac3-3869-46ec-9e6f-7012c4e23f69",
"imsOrgId": "{ORG_ID}",
"datasetId": "621fc19ab33d941949af16c8",
"operations": {
"data": "create"/"merge"/"delete",
}
}
... //The raw data attributes are included here as the key/value pairs of the "body" property.
}
プライマリ ID の動的な受け渡し
XDM を更新する場合は、スキーマが Profile に対して有効になっており、プライマリ ID が含まれている必要があります。 XDM スキーマのプライマリ ID は、次の 2 つの方法で指定できます。
- XDM スキーマのプライマリ ID として静的フィールドを指定します。
- ID フィールドの 1 つをプライマリ ID として、XDM スキーマの ID マップフィールドグループを使用して指定します。
静的フィールドを XDM スキーマのプライマリ ID フィールドとして指定します
次の例では、state、homePhone.number およびその他の属性が、それぞれ指定された値でアップサートされ、sampleEmail@gmail.com のプライマリ ID で Profile に入れられます。 次に、ストリーミング Data Prep コンポーネントによって XDM エンティティ更新メッセージが生成されます。 次に、XDM 更新メッセージ Real-Time Customer Profile プロファイルレコードをアップサートすることを確認します。
curl -X POST 'https://dcs.adobedc.net/collection/9aba816d350a69c4abbd283eb5818ec3583275ffce4880ffc482be5a9d810c4b' \
-H 'Content-Type: application/json' \
-H 'x-adobe-flow-id: d5262d48-0f47-4949-be6d-795f06933527' \
-d '{
"header": {
"flowId" : "d5262d48-0f47-4949-be6d-795f06933527",
"imsOrgId": "{ORG_ID}",
"datasetId": "62259f817f62d71947929a7b",
"operations": {
"data": "create"
}
},
{
"body": {
"homeAddress": {
"country": "US",
"state": "GA",
"region": "va7"
},
"homePhone": {
"number": "123.456.799"
},
"identityMap": {
"Email": [{
"id": "sampleEmail@gmail.com",
"primary": true
}]
},
"personalEmail": {
"address": "sampleEmail@gmail.com",
"primary": true
},
"personID": "346576345",
"_id": "346576345",
"timestamp": "2021-05-05T17:51:45.1880+02",
"workEmail": "sampleWorkEmail@gmail.com"
}
}'
ID フィールドの 1 つをプライマリ ID として、XDM スキーマの ID マップフィールドグループを使用して指定します
この例では、ヘッダーに、identity と identityDatasetId のプロパティを持つ operations 属性が含まれています。 これにより、データを Real-Time Customer Profile と結合したり、ID を Identity Service に渡したりすることもできます。
curl -X POST 'https://dcs.adobedc.net/collection/9aba816d350a69c4abbd283eb5818ec3583275ffce4880ffc482be5a9d810c4b' \
-H 'Content-Type: application/json' \
-H 'x-adobe-flow-id: d5262d48-0f47-4949-be6d-795f06933527' \
-d '{
"header": {
"flowId" : "d5262d48-0f47-4949-be6d-795f06933527",
"imsOrgId": "{ORG_ID}",
"datasetId": "62259f817f62d71947929a7b",
"operations": {
"data": "merge",
"identity": "create",
"identityDatasetId": "6254a93b851ecd194b64af9e"
}
},
{
"body": {
"homeAddress": {
"country": "US",
"state": "GA",
"region": "va7"
},
"homePhone": {
"number": "123.456.799"
},
"identityMap": {
"Email": [{
"id": "sampleEmail@gmail.com",
"primary": true
}]
},
"personalEmail": {
"address": "sampleEmail@gmail.com",
"primary": true
},
"personID": "346576345",
"_id": "346576345",
"timestamp": "2021-05-05T17:51:45.1880+02",
"workEmail": "sampleWorkEmail@gmail.com"
}
}'
既知の制限と主な考慮事項
次に、Data Prep でアップサートをストリーミングする際に考慮すべき既知の制限事項のリストを示します。
- ストリーミングアップサート方法は、部分行の更新を Real-Time Customer Profile に送信する場合にのみ使用してください。 部分行の更新は、データレイクによって使用 れ せん）。
- ストリーミングアップサートのメソッドでは、ID の更新、置換、削除はサポートされていません。 存在しない場合は、新しい ID が作成されます。 したがって、
identity操作は常に create に設定する必要があります。 ID が既に存在する場合、操作は no-op です。 - ストリーミングアップサート方式では、現在、Adobe Experience Platform Web SDK および Adobe Experience Platform Mobile SDK をサポートしていません。
次の手順
このドキュメントでは、アップサートをストリーミングして Real-Time Customer Profile データに部分行の更新を送信すると同時に、単一の API リクエストで ID を作成 Data Prep リンクする方法を説明しました。 その他の Data Prep 機能について詳しくは、Data Prep 概要を参照してください。 Data Prep API 内でのマッピングセットの使用方法については、Data Prep 開発者ガイドを参照してください。