フローサービス API を使用して、ファイルベースの宛先に対するオーディエンスをアクティブ化する
拡張ファイルエクスポート機能を使用して、Experience Platformからファイルをエクスポートする際に、拡張カスタマイズ機能にアクセスします。
- 追加のファイル命名オプション。
- 書き出されたファイルにカスタムファイルヘッダーを設定する機能(マッピングステップの改善による)
- 次の項目を選択できます。 ファイルタイプ 」と入力します。
- 書き出された CSV データファイルの形式をカスタマイズする機能。
この機能は、以下に示す 6 つのクラウドストレージカードでサポートされています。
この記事では、 フローサービス API Adobe Experience Platformから上記にリンクしたクラウドストレージの場所の 1 つに適格なプロファイルを書き出す場合。
はじめに get-started
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。
- Experience Data Model (XDM) System:Experience Platform がカスタマーエクスペリエンスのデータの整理に使用する、標準化されたフレームワーク。
- Segmentation Service: Adobe Experience Platform Segmentation Service では、オーディエンスを構築してオーディエンスを生成できます。 Adobe Experience Platform から Real-Time Customer Profile データ。
- Sandboxes:Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。
以下の節では、Platform でファイルベースの宛先に対してデータをアクティブ化する際に知っておく必要がある追加情報を示します。
必要な権限 permissions
プロファイルを書き出すには、 宛先の表示, 宛先のアクティブ化, プロファイルの表示、および セグメントを表示 アクセス制御権限. アクセス制御の概要を参照するか、製品管理者に問い合わせて必要な権限を取得してください。
書き出す id、 ID グラフを表示 アクセス制御権限.
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 サイトの宛先 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 が必要です。 また、接続仕様自体の一部を参照して特定のエンティティを設定し、フローサービス API から接続仕様を取得する必要もあります。 この表のすべての宛先の接続仕様の取得については、以下の例を参照してください。
リクエスト
accordion | ||
---|---|---|
取得 connection spec 対象: Amazon S3 | ||
|
応答
accordion | ||
---|---|---|
Amazon S3 — 接続仕様 | ||
|
リクエスト
accordion | ||
---|---|---|
取得 connection spec 対象: Azure Blob Storage | ||
|
応答
accordion | ||
---|---|---|
Azure Blob Storage - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
取得 connection spec 対象: Azure Data Lake Gen 2(ADLS Gen2) | ||
|
応答
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
取得 connection spec 対象: Data Landing Zone(DLZ) | ||
|
応答
accordion | ||
---|---|---|
Data Landing Zone(DLZ) - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
取得 connection spec 対象: Google Cloud Storage | ||
|
応答
accordion | ||
---|---|---|
Google Cloud Storage - Connection spec | ||
|
リクエスト
accordion | ||
---|---|---|
取得 connection spec (SFTP 用) | ||
|
応答
accordion | ||
---|---|---|
SFTP - Connection spec | ||
|
以下の手順に従って、クラウドストレージの宛先へのオーディエンスの書き出しデータフローを設定します。 一部の手順では、クラウドストレージの様々な宛先でリクエストと応答が異なります。 このような場合は、ページのタブを使用して、接続してオーディエンスのエクスポート先となる宛先に固有のリクエストと応答を取得します。 正しい connection spec
および flow spec
を設定します。
ソース接続の作成 create-source-connection
オーディエンスのエクスポート先を決定したら、ソース接続を作成する必要があります。 The ソース接続 内部への接続を表します。 Experience Platformプロファイルストア.
リクエスト
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、インラインコメントを削除します。
code language-shell |
---|
|
応答
code language-json |
---|
|
正常な応答は、ID(id
) をクリックし、新しく作成されたソース接続と etag
. 後でデータフローを作成する際に必要になるので、ソース接続 ID をメモしておきます。
ベース接続の作成 create-base-connection
A ベース接続 は、宛先に対する資格情報を安全に保存します。 宛先のタイプに応じて、その宛先に対する認証に必要な資格情報が異なる場合があります。 これらの認証パラメーターを検索するには、まず connection spec
を設定します。 オーディエンスのエクスポート先を選択 そして、 authSpec
応答の。 以下のタブを参照して、 authSpec
サポートされるすべての宛先のプロパティ。
accordion | ||
---|---|---|
Amazon S3 - Connection spec 表示中 auth spec | ||
インラインコメントが付いた強調表示された行に、 connection spec 次の例で、 connection spec.
|
accordion | ||
---|---|---|
Azure Blob Storage - Connection spec 表示中 auth spec | ||
インラインコメントが付いた強調表示された行に、 connection spec 次の例で、 connection spec.
|
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - Connection spec 表示中 auth spec | ||
インラインコメントが付いた強調表示された行に、 connection spec 次の例で、 connection spec.
|
accordion | |||||
---|---|---|---|---|---|
Data Landing Zone(DLZ) - Connection spec 表示中 auth spec | |||||
|
accordion | ||
---|---|---|
Google Cloud Storage - Connection spec 表示中 auth spec | ||
インラインコメントが付いた強調表示された行に、 connection spec 次の例で、 connection spec.
|
accordion | |||||
---|---|---|---|---|---|
SFTP - Connection spec 表示中 auth spec | |||||
インラインコメントが付いた強調表示された行に、 connection spec 次の例で、 connection spec.
|
認証仕様で指定されたプロパティ ( authSpec
応答から ) 必要な資格情報を使用して、以下の例に示すように、各宛先タイプに固有のベース接続を作成できます。
リクエスト
accordion | |||||
---|---|---|---|---|---|
Amazon S3 — アクセスキーと秘密鍵認証を使用したベース接続リクエスト | |||||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
++Amazon S3 — 想定されるロール認証を使用したベース接続リクエスト
note tip |
---|
TIP |
必要な認証資格情報の取得方法について詳しくは、 宛先への認証 の節を参照してください。 |
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
code language-shell line-numbers data-start-1 data-line-offset-4 h-17 |
---|
|
+++
応答
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 | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
SFTP(SSH キー) — ベース接続リクエスト | |||||||||||||||||||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
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 書き出しオプションに関する詳細な情報を取得します。 ファイルフォーマット設定ページ.
詳しくは、 targetSpec
宛先の connection spec
を参照して、各宛先タイプでサポートされるプロパティを理解してください。 以下のタブを参照して、 targetSpec
サポートされるすべての宛先のプロパティ。
accordion | ||
---|---|---|
Amazon S3 - Connection spec ターゲット接続パラメータの表示 | ||
強調表示された行に、 connection spec 以下の例。 target spec 接続仕様のパラメータ。 次の例でも、ターゲットパラメーターが示されています。 not オーディエンスの書き出し先に適用できます。
|
accordion | ||
---|---|---|
Azure Blob Storage - Connection spec ターゲット接続パラメータの表示 | ||
強調表示された行に、 connection spec 以下の例。 target spec 接続仕様のパラメータ。 次の例でも、ターゲットパラメーターが示されています。 not オーディエンスの書き出し先に適用できます。
|
accordion | ||
---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - Connection spec ターゲット接続パラメータの表示 | ||
強調表示された行に、 connection spec 以下の例。 target spec 接続仕様のパラメータ。 次の例でも、ターゲットパラメーターが示されています。 not オーディエンスの書き出し先に適用できます。
|
accordion | ||
---|---|---|
Data Landing Zone(DLZ) - Connection spec ターゲット接続パラメータの表示 | ||
強調表示された行に、 connection spec 以下の例。 target spec 接続仕様のパラメータ。 次の例でも、ターゲットパラメーターが示されています。 not オーディエンスの書き出し先に適用できます。
|
accordion | ||
---|---|---|
Google Cloud Storage - Connection spec ターゲット接続パラメータの表示 | ||
強調表示された行に、 connection spec 以下の例。 target spec 接続仕様のパラメータ。 次の例でも、ターゲットパラメーターが示されています。 not オーディエンスの書き出し先に適用できます。
|
accordion | ||
---|---|---|
SFTP - Connection spec ターゲット接続パラメータの表示 | ||
強調表示された行に、 connection spec 以下の例。 target spec 接続仕様のパラメータ。 次の例でも、ターゲットパラメーターが示されています。 not オーディエンスの書き出し先に適用できます。
|
上記の仕様を使用すると、次のタブに示すように、目的のクラウドストレージの宛先に固有のターゲット接続リクエストを作成できます。
リクエスト
accordion | |||||
---|---|---|---|---|---|
Amazon S3 - Target 接続リクエスト | |||||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Amazon S3 - CSV オプションを使用して接続リクエストをターゲット化 | |||||
|
応答
accordion | ||
---|---|---|
Target 接続 — 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Blob Storage - Target 接続リクエスト | |||||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Azure Blob Storage - CSV オプションを使用して接続リクエストをターゲット化 | |||||
|
応答
accordion | ||
---|---|---|
Target 接続 — 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - Target 接続リクエスト | |||||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Azure Data Lake Gen 2(ADLS Gen2) - CSV オプションを使用して接続リクエストをターゲット化 | |||||
|
応答
accordion | ||
---|---|---|
Target 接続 — 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Data Landing Zone - Target 接続リクエスト | |||||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Data Landing Zone - CSV オプションを使用して接続リクエストをターゲット化 | |||||
|
応答
accordion | ||
---|---|---|
Target 接続 — 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
Google Cloud Storage - Target 接続リクエスト | |||||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
Google Cloud Storage - CSV オプションを使用して接続リクエストをターゲット化 | |||||
|
応答
accordion | ||
---|---|---|
Target 接続 — 応答 | ||
|
リクエスト
accordion | |||||
---|---|---|---|---|---|
SFTP - Target 接続のリクエスト | |||||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
accordion | |||||
---|---|---|---|---|---|
SFTP - CSV オプションを使用した Target 接続リクエスト | |||||
|
応答
accordion | ||
---|---|---|
Target 接続 — 応答 | ||
|
次の点に注意してください。 target connection ID
を返します。 この ID は、オーディエンスをエクスポートするデータフローを作成する際に、次の手順で必要になります。
正常な応答は、ID(id
) を新しいターゲットソース接続と etag
. 後でデータフローを作成する際に必要になるので、ターゲット接続 ID をメモしておきます。
データフローの作成 create-dataflow
宛先設定の次の手順は、データフローの作成です。 A データフロー は、以前に作成したエンティティと結び付け、オーディエンスの書き出しスケジュールを設定するためのオプションも提供します。 データフローを作成するには、目的のクラウドストレージの宛先に応じて、以下のペイロードを使用し、前の手順のフローエンティティ ID を置き換えます。 この手順では、属性または ID マッピングに関する情報をデータフローに追加しません。 それは次のステップで続きます。
リクエスト
accordion | ||
---|---|---|
オーディエンスの書き出しデータフローの作成先 Amazon S3 destination — リクエスト | ||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 — 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
オーディエンスの書き出しデータフローの作成先 Azure Blob Storage destination — リクエスト | ||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 — 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
オーディエンスの書き出しデータフローの作成先 Azure Data Lake Gen 2(ADLS Gen2) destination — リクエスト | ||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 — 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
オーディエンスの書き出しデータフローの作成先 Data Landing Zone destination — リクエスト | ||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
accordion | ||
---|---|---|
データフローの作成 — 応答 | ||
|
リクエスト
accordion | ||
---|---|---|
オーディエンスの書き出しデータフローの作成先 Google Cloud Storage destination — リクエスト | ||
リクエスト例で、インラインコメント付きの強調表示された行に注意してください。この行には、追加情報が示されています。 リクエストを任意のターミナルにコピー&ペーストする際に、リクエスト内のインラインコメントを削除します。
|
応答
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 を返します。 この応答は、 標準 および カスタム id 名前空間を設定します。Experience Platform
code language-json |
---|
|
次に、上記の応答をコピーし、それを使用して入力スキーマを作成する必要があります。 上記の応答の JSON 応答全体をコピーし、 jsonSchema
以下に示すオブジェクト。
入力スキーマを作成するリクエスト
code language-shell |
---|
|
応答
code language-json |
---|
|
応答の ID は、作成した入力スキーマの一意の識別子を表します。 後の手順で再利用するので、ID を応答からコピーします。
出力スキーマの作成
次に、書き出しの出力スキーマを設定する必要があります。 最初に、既存のパートナースキーマを見つけて調査する必要があります。
リクエスト
次の例では、 connection spec ID
(Amazon S3 用 ) この値を、宛先に固有の接続仕様 ID に置き換えてください。
code language-shell |
---|
|
応答とサンプルスキーマ
Inspect上記の呼び出しを実行すると得られる応答。 応答をドリルダウンして、オブジェクトを検索する必要があります targetSpec.attributes.partnerSchema.jsonSchema
code language-json |
---|
|
次に、出力スキーマを作成する必要があります。 上記で取得した JSON 応答をコピーし、 jsonSchema
オブジェクトを下に置きます。
リクエスト
code language-shell |
---|
|
応答
code language-json |
---|
|
応答の ID は、作成した入力スキーマの一意の識別子を表します。 後の手順で再利用するので、ID を応答からコピーします。
マッピングセットを作成 create-mapping-set
次に、 データ準備 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 を取得します。
詳しくは、 宛先のデータフローの詳細の取得 を参照してください。
最後に、作成したマッピングセット情報を使用してデータフローをPATCH化する必要があります。
リクエスト
code language-shell |
---|
|
応答
フローサービス API からの応答は、更新されたデータフローの ID を返します。
code language-json |
---|
|
他のデータフローの更新 other-dataflow-updates
データフローを更新するには、 PATCH
operation.例えば、データフローを更新して、フィールドを必須キーまたは重複排除キーとして選択できます。
必須キーを追加 add-mandatory-key
を追加するには、以下を実行します。 必須キーについては、以下のリクエストと応答の例を参照してください。
リクエスト
code language-shell |
---|
|
code language-shell |
---|
|
応答
code language-json |
---|
|
重複排除キーを追加 add-deduplication-key
を追加するには、以下を実行します。 重複排除キーについては、以下のリクエストと応答の例を参照してください。
リクエスト
code language-shell |
---|
|
code language-shell |
---|
|
応答
code language-json |
---|
|
データフローの検証(データフローを取得) get-dataflow-runs
データフローの実行を確認するには、次の Dataflow Run API を使用します。
リクエスト
code language-shell |
---|
|
応答
code language-json |
---|
|
次の項目に関する情報を検索できます。 データフロー実行 API から返される様々なパラメーター ( API リファレンスドキュメント)を参照してください。
API エラー処理 api-error-handling
このチュートリアルの API エンドポイントは、Experience PlatformAPI エラーメッセージの一般的な原則に従います。 参照: API ステータスコード および リクエストヘッダーエラー エラー応答の解釈について詳しくは、『 Platform トラブルシューティングガイド』を参照してください。
次の手順 next-steps
このチュートリアルでは、Platform を目的のクラウドストレージの宛先の 1 つに接続し、オーディエンスをエクスポートするための各宛先へのデータフローを設定しました。 次のページでは、Flow Service API を使用した既存のデータフローの編集方法などの詳細を確認します。