Flow Service API を使用して、ファイルベースの宛先に対するオーディエンスをアクティブ化します
拡張されたファイル書き出し機能を使用すると、Experience Platformからファイルを書き出す際に拡張カスタマイズ機能にアクセスできます。
- 追加のファイル命名オプション。
- 書き出されたファイルにカスタムファイルヘッダーを設定する機能(マッピングステップの改善による)
- 書き出されたファイルの ファイルタイプを選択する機能。
- 書き出された CSV データファイルの形式をカスタマイズする機能。
この機能は、以下に示す 6 つのクラウドストレージカードでサポートされています。
この記事では、Flow Service API を使用して、認定プロファイルをAdobe Experience Platformから上記にリンクされたクラウドストレージの場所の 1 つに書き出すために必要なワークフローについて説明します。
はじめに get-started
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
- Experience Data Model (XDM) System:Experience Platform がカスタマーエクスペリエンスのデータの整理に使用する、標準化されたフレームワーク。
- Segmentation Service: Adobe Experience Platform Segmentation Service を使用すると、オーディエンスを作成し、Real-Time Customer Profile データから Adobe Experience Platform でオーディエンスを生成できます。
- Sandboxes:Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。
次の節では、Platform でファイルベースの宛先に対してデータをアクティブ化するために必要な追加情報を示します。
必要な権限 permissions
プロファイルを書き出すには、宛先の表示、宛先のアクティブ化、プロファイルの表示 および セグメントの表示 アクセス制御権限が必要です。 アクセス制御の概要を参照するか、製品管理者に問い合わせて必要な権限を取得してください。
ID を書き出すには、ID グラフの表示 アクセス制御権限が必要です。
{width="100" modal="regular"}
API 呼び出し例の読み取り reading-sample-api-calls
このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してくださいExperience Platform。
必須ヘッダーおよびオプションヘッダーの値の収集 gather-values-headers
Platform API を呼び出すには、まず Experience Platform認証チュートリアルを完了する必要があります。 次に示すように、すべての Experience Platform API 呼び出しに必要な各ヘッダーの値は認証チュートリアルで説明されています。
- Authorization: Bearer
{ACCESS_TOKEN}
- x-api-key:
{API_KEY}
- x-gw-ims-org-id:
{ORG_ID}
Experience Platform のリソースは、特定の仮想サンドボックスに分離できます。Platform API へのリクエストでは、操作を実行するサンドボックスの名前と ID を指定できます。次に、オプションのパラメーターを示します。
- x-sandbox-name:
{SANDBOX_NAME}
ペイロード(POST
、PUT
、PATCH
)を含むすべてのリクエストには、次のような追加のメディアタイプヘッダーが必要です。
- Content-Type:
application/json
API リファレンスドキュメント api-reference-documentation
このチュートリアルに含まれるすべての API 操作について、付属リファレンスドキュメントが用意されています。詳しくは、Adobe Developer web サイト Flow Service - Destinations API ドキュメントを参照してください。 このチュートリアルと API リファレンスのドキュメントを並行して使用することをお勧めします。
用語集 glossary
この API チュートリアルで発生する用語については、API リファレンスドキュメントの 用語集の節を参照してください。
オーディエンスを書き出す宛先を選択 select-destination
プロファイルの書き出しワークフローを開始する前に、オーディエンスの書き出し先とする宛先の接続仕様およびフロー仕様 ID を特定します。 以下の表を参照してください。
4fce964d-3f37-408f-9778-e597338a21ee
1a0514a6-33d4-4c7f-aff8-594799c47549
6d6b59bf-fb58-4107-9064-4d246c0e5bb2
752d422f-b16f-4f0d-b1c6-26e448e3b388
be2c3209-53bc-47e7-ab25-145db8b873e1
17be2013-2549-41ce-96e7-a70363bec293
10440537-2a7b-4583-ac39-ed38d4b848e8
cd2fc47e-e838-4f38-a581-8fff2f99b63a
c5d93acb-ea8b-4b14-8f53-02138444ae99
585c15c4-6cbf-4126-8f87-e26bff78b657
36965a81-b1c6-401b-99f8-22508f1e6a26
fd36aaa4-bf2b-43fb-9387-43785eeeb799
これらの ID は、このチュートリアルの次の手順で様々なフローサービスエンティティを構築するために必要です。 また、接続仕様自体の一部を参照して、特定のエンティティを設定し、Flow Service API から接続仕様を取得できるようにする必要もあります。 テーブル内のすべての宛先の接続仕様を取得する例を以下に示します。
リクエスト
accordion | ||
---|---|---|
Amazon S3 の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
Amazon S3 – 接続仕様 | ||
|
リクエスト
accordion | ||
---|---|---|
Azure Blob Storage の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
Azure Blob Storage - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2 の connection spec の取得) | ||
|
応答
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
Data Landing Zone(DLZ) の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
Data Landing Zone(DLZ) - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
Google Cloud Storage の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
Google Cloud Storage - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
SFTP の connection spec の取得 | ||
|
応答
accordion | ||
---|---|---|
SFTP - Connection spec | ||
|
クラウドストレージの宛先へのオーディエンス書き出しデータフローを設定するには、次の手順に従います。 一部の手順では、リクエストと応答はクラウドストレージの様々な宛先間で異なります。 その場合、ページ上のタブを使用して、オーディエンスの接続および書き出し先となる宛先に固有のリクエストと応答を取得します。 設定している宛先に適した connection spec
と flow spec
を使用してください。
Source接続の作成 create-source-connection
オーディエンスを書き出す宛先を決定したら、ソース接続を作成する必要があります。 ソース接続は、内部 Experience Platformプロファイルストアへの接続を表します。
リクエスト
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、インラインコメントを削除します。
code language-shell |
---|
|
応答
code language-json |
---|
|
リクエストが成功した場合は、新しく作成したソース接続の ID (id
)と etag
が返されます。 後でデータフローを作成する際に必要になるので、ソース接続 ID をメモしておきます。
ベース接続の作成 create-base-connection
ベース接続は、資格情報を宛先に安全に保存します。 宛先のタイプによって、その宛先に対して認証するために必要な資格情報は異なる場合があります。 これらの認証パラメーターを見つけるには、 オーディエンスの書き出し先の宛先の選択の節で説明されているように、最初に目的の宛先の connection spec
を取得してから、応答の authSpec
を確認します。 サポートされているすべての宛先の authSpec
プロパティについては、以下のタブを参照してください。
accordion | ||
---|---|---|
auth spec を表示している Amazon S3 - Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
accordion | ||
---|---|---|
auth spec を表示している Azure Blob Storage - Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
accordion | ||
---|---|---|
auth spec を表示している Azure Data Lake Gen 2(ADLS Gen2) - Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
accordion | |||||
---|---|---|---|---|---|
auth spec を表示している Data Landing Zone(DLZ) - Connection spec | |||||
|
accordion | ||
---|---|---|
auth spec を表示している Google Cloud Storage - Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
accordion | |||||
---|---|---|---|---|---|
SFTP - auth spec を表示する Connection spec | |||||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。この例では、connection spec 内の認証パラメーターの場所に関する追加情報を提供しています。
|
認証仕様で指定されたプロパティ(つまり、応答からの authSpec
)を使用して、以下の例に示すように、各宛先タイプに固有の必要な資格情報を含むベース接続を作成できます。
リクエスト
accordion | |||||
---|---|---|---|---|---|
Amazon S3 - アクセスキーと秘密鍵の認証を使用したベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Amazon S3 – 想定される役割認証を使用したベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
Amazon S3 ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Blob Storage - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
Azure Blob Storage - ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Data Landing Zone(DLZ) - ベース接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
Data Landing Zone - ベース接続応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Google Cloud Storage - ベース接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
Google Cloud Storage - ベース接続応答 | ||
|
リクエスト
accordion | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パスワードを使用した SFTP - ベース接続リクエスト | |||||||||||||||||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SSH キーを使用した SFTP - ベース接続リクエスト | |||||||||||||||||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
SFTP - ベース接続応答 | ||
|
書き出したファイルへの暗号化の追加
オプションで、書き出したファイルに暗号化を追加できます。 これを行うには、encryptionSpecs
から項目を追加する必要があります。 必須パラメーターがハイライト表示された以下のリクエストの例を参照してください。
code language-json line-numbers data-start-1 data-line-offset-4 h-26-27 |
---|
|
リクエスト
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、インラインコメントを削除します。
code language-shell line-numbers data-start-1 data-line-offset-4 h-19 |
---|
|
応答
code language-json |
---|
|
応答からの接続 ID をメモしておきます。 この ID は、次の手順でターゲット接続を作成する際に必要になります。
ターゲット接続の作成 create-target-connection
次に、ターゲット接続を作成する必要があります。 ターゲット接続書き出されたオーディエンスの書き出しパラメーターを保存します。 書き出しパラメータには、書き出し場所、ファイル形式、圧縮、およびその他の詳細が含まれます。 例えば、CSV ファイルの場合は、複数の書き出しオプションを選択できます。 ファイル形式設定ページで、サポートされるすべての CSV 書き出しオプションに関する詳細な情報を取得します。
各宛先タイプでサポートされているプロパティを理解するには、宛先の connection spec
で提供されている targetSpec
のプロパティを参照してください。 サポートされているすべての宛先の targetSpec
プロパティについては、以下のタブを参照してください。
accordion | ||
---|---|---|
Amazon S3 - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 また、以下の例では、オーディエンス書き出しの宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
Azure Blob Storage - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 また、以下の例では、オーディエンス書き出しの宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 また、以下の例では、オーディエンス書き出しの宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
Data Landing Zone(DLZ) - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 また、以下の例では、オーディエンス書き出しの宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
Google Cloud Storage - ターゲット接続パラメーターを示す Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 また、以下の例では、オーディエンス書き出しの宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
accordion | ||
---|---|---|
SFTP - ターゲット接続パラメーターを表示する Connection spec | ||
次の connection spec の例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。これは、接続仕様で target spec のパラメーターが見つかる場所に関する追加情報を提供します。 また、以下の例では、オーディエンス書き出しの宛先に適用されない 適用されない ターゲットパラメーターも確認できます。
|
上記の仕様を使用すると、以下のタブに示すように、目的のクラウドストレージの宛先に固有のターゲット接続リクエストを作成できます。
リクエスト
accordion | |||||
---|---|---|---|---|---|
Amazon S3 - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Amazon S3 - CSV オプションを使用したターゲット接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Blob Storage - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Azure Blob Storage - CSV オプションを使用したターゲット接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - CSV オプションを使用したターゲット接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Data Landing Zone - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Data Landing Zone - CSV オプションを使用したターゲット接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Google Cloud Storage - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Google Cloud Storage - CSV オプションを使用したターゲット接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
SFTP - ターゲット接続リクエスト | |||||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
SFTP - CSV オプションを使用したターゲット接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
ターゲット接続 – 応答 | ||
|
応答からの target connection ID
に注意してください。 この ID は、次の手順で、オーディエンスを書き出すデータフローを作成する際に必要になります。
リクエストが成功した場合は、新しくターゲットにしたソース接続の ID (id
)と etag
が返されます。 後でデータフローを作成する際に必要になるので、ターゲット接続 ID をメモしておきます。
データフローの作成 create-dataflow
宛先設定の次の手順は、データフローを作成することです。 データフローは、以前に作成したエンティティを結び付け、オーディエンスの書き出しスケジュールを設定するためのオプションも提供します。 データフローを作成するには、目的のクラウドストレージ宛先に応じて以下のペイロードを使用し、前の手順で取得したフローエンティティ ID を置き換えます。 この手順では、属性または ID マッピングに関連する情報をデータフローに追加しません。 それは次のステップに続きます。
リクエスト
accordion | ||
---|---|---|
宛先へのオーディエンス書き出しデータフロー Amazon S3 作成 – リクエスト | ||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
宛先へのオーディエンス書き出しデータフロー Azure Blob Storage 作成 – リクエスト | ||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
宛先へのオーディエンス書き出しデータフロー Azure Data Lake Gen 2(ADLS Gen2) 作成 – リクエスト | ||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
宛先へのオーディエンス書き出しデータフロー Data Landing Zone 作成 – リクエスト | ||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
宛先へのオーディエンス書き出しデータフロー Google Cloud Storage 作成 – リクエスト | ||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
SFTP 宛先へのオーディエンス書き出しデータフローの作成 – リクエスト | ||
リクエストの例では、ハイライト表示された行にインラインコメントが付いていることに注意してください。このコメントによって追加情報が提供されます。 リクエストを選択したターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 – 応答 | ||
|
応答のデータフロー ID をメモします。 この ID は、後の手順で必要になります。
書き出しにオーディエンスを追加
この手順では、宛先に書き出すオーディエンスを選択することもできます。 この手順と、オーディエンスをデータフローに追加するリクエスト形式に関する詳細な情報については、API リファレンスドキュメントの 宛先データフローの更新の節の例を参照してください。
属性および ID マッピングの設定 attribute-and-identity-mapping
データフローを作成したら、書き出す属性と ID のマッピングを設定する必要があります。 これは、次の 3 つの手順で構成されます。
- 入力スキーマの作成
- 出力スキーマの作成
- マッピングセットの設定による作成済みスキーマの接続
例えば、UI に表示される次のマッピングを取得するには、上記の 3 つの手順を実行し、次の見出しで詳しく説明する必要があります。
入力スキーマの作成
入力スキーマを作成するには、まず 和集合スキーマと、宛先に書き出すことができる ID を取得する必要があります。 これは、ソースマッピングとして選択できる属性および ID のスキーマです。
属性と ID を取得するためのリクエストと応答の例を以下に示します。
属性の取得リクエスト
code language-shell |
---|
|
応答
以下の応答は、簡潔にするために短縮されました。
code language-json |
---|
|
ID の取得リクエスト
code language-shell |
---|
|
応答
応答は、入力スキーマを作成する際に使用できる ID を返します。 この応答は、Experience Platformで設定した 標準ID 名前空間と カスタムID 名前空間の両方を返します。
code language-json |
---|
|
次に、上記の応答をコピーし、それを使用して入力スキーマを作成する必要があります。 上記の応答から JSON 応答全体をコピーして、以下に示す jsonSchema
オブジェクトに配置できます。
入力スキーマの作成リクエスト
code language-shell |
---|
|
応答
code language-json |
---|
|
応答の ID は、作成した入力スキーマの一意の ID を表します。 後の手順で再利用できるように、応答から ID をコピーします。
出力スキーマの作成
次に、書き出しの出力スキーマを設定する必要があります。 まず、既存のパートナースキーマを見つけて検査する必要があります。
リクエスト
以下の例では、Amazon S3 に connection spec ID
を使用しています。 この値を、宛先に固有の接続仕様 ID に置き換えてください。
code language-shell |
---|
|
スキーマの例を使用した応答
上記の呼び出しを実行する際に取得した応答をInspectします。 応答を詳しく調べて、オブジェクト targetSpec.attributes.partnerSchema.jsonSchema
を見つける必要があります
code language-json |
---|
|
次に、出力スキーマを作成します。 上記で取得した JSON 応答をコピーし、以下の jsonSchema
オブジェクトに貼り付けます。
リクエスト
code language-shell |
---|
|
応答
code language-json |
---|
|
応答の ID は、作成した入力スキーマの一意の ID を表します。 後の手順で再利用できるように、応答から ID をコピーします。
マッピングセットを作成 create-mapping-set
次に、data prep API を使用して、入力スキーマ ID、出力スキーマ ID および目的のフィールドマッピングを使用してマッピングセットを作成します。
リクエスト
note important |
---|
IMPORTANT |
|
code language-shell line-numbers data-start-1 data-line-offset-4 h-16-38 |
---|
|
応答
code language-json |
---|
|
マッピングセットの ID をメモします。次の手順で、既存のデータフローをマッピングセット ID で更新する際に必要になります。
次に、更新するデータフローの ID を取得します。
データフローの ID の取得について詳しくは、 宛先データフローの詳細の取得を参照してください。
最後に、作成したマッピングセット情報を使用してデータフローを PATCH
成する必要があります。
リクエスト
code language-shell |
---|
|
応答
Flow Service API からの応答は、更新されたデータフローの ID を返します。
code language-json |
---|
|
他のデータフロー更新を行う other-dataflow-updates
データフローを更新するには、PATCH
操作を使用します。 例えば、データフローにマーケティングアクションを追加できます。 または、データフローを更新して、フィールドを必須キーまたは重複排除キーとして選択できます。
マーケティングアクションの追加 add-marketing-action
マーケティングアクションを追加するには、以下のリクエストと応答の例を参照してください。
PATCH
リクエストを行う場合、If-Match
ヘッダーは必須です。 このヘッダーの値は、更新するデータフローの一意のバージョンです。 etag の値は、データフロー、ターゲット接続などのフローエンティティが正常に更新されるたびに更新されます。https://platform.adobe.io/data/foundation/flowservice/flows/{ID}
エンドポイントに対してGETリクエストを実行します。{ID}
は、更新するデータフロー ID です。PATCH
リクエストを行う場合は、以下の例のように、If-Match
ヘッダーの値を必ず二重引用符で囲みます。リクエスト
code language-shell |
---|
|
応答
応答が成功すると、応答コード 200
と、更新されたデータフローの ID および更新された eTag が返されます。
code language-json |
---|
|
必須キーを追加 add-mandatory-key
必須キーを追加するには、以下のリクエストと応答の例を参照してください。
PATCH
リクエストを行う場合、If-Match
ヘッダーは必須です。 このヘッダーの値は、更新するデータフローの一意のバージョンです。 etag の値は、データフロー、ターゲット接続などのフローエンティティが正常に更新されるたびに更新されます。https://platform.adobe.io/data/foundation/flowservice/flows/{ID}
エンドポイントに対してGETリクエストを実行します。{ID}
は、更新するデータフロー ID です。PATCH
リクエストを行う場合は、以下の例のように、If-Match
ヘッダーの値を必ず二重引用符で囲みます。リクエスト
code language-shell |
---|
|
code language-shell |
---|
|
応答
code language-json |
---|
|
重複排除キーを追加 add-deduplication-key
重複排除キーを追加するには、以下のリクエストと応答の例を参照してください
PATCH
リクエストを行う場合、If-Match
ヘッダーは必須です。 このヘッダーの値は、更新するデータフローの一意のバージョンです。 etag の値は、データフロー、ターゲット接続などのフローエンティティが正常に更新されるたびに更新されます。https://platform.adobe.io/data/foundation/flowservice/flows/{ID}
エンドポイントに対してGETリクエストを実行します。{ID}
は、更新するデータフロー ID です。PATCH
リクエストを行う場合は、以下の例のように、If-Match
ヘッダーの値を必ず二重引用符で囲みます。リクエスト
code language-shell |
---|
|
code language-shell |
---|
|
応答
code language-json |
---|
|
データフローの検証(データフローの実行を取得) get-dataflow-runs
データフローの実行を確認するには、Dataflow Runs API を使用します。
リクエスト
code language-shell |
---|
|
応答
code language-json |
---|
|
データフロー実行 API によって返される様々なパラメーターに関する情報については、API リファレンスドキュメントを参照してください。
API エラー処理 api-error-handling
このチュートリアルの API エンドポイントは、一般的なExperience PlatformAPI エラーメッセージの原則に従っています。 エラー応答の解釈について詳しくは、Platform トラブルシューティングガイドの API ステータスコードおよび リクエストヘッダーエラーを参照してください。
次の手順 next-steps
このチュートリアルでは、目的のクラウドストレージ宛先の 1 つに Platform を正常に接続し、オーディエンスを書き出すためのそれぞれの宛先へのデータフローを設定しました。 次のページでは、Flow Service API を使用した既存のデータフローの編集方法などの詳細を確認します。