Flow Service API を使用した宛先データフローの更新

Last update: Mon Jan 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
Destinations

作成対象：

Admin
User

このチュートリアルでは、宛先データフローを更新する手順を説明します。を使用して、データフローを有効または無効にしたり、基本情報を更新したり、オーディエンスと属性を追加および削除したりする方法について説明します。 Flow Service API. Experience PlatformUI を使用した宛先データフローの編集について詳しくは、アクティベーションフローを編集.

はじめに get-started

このチュートリアルは、有効なフロー ID を保有しているユーザーを対象としています。有効なフロー ID がない場合は、宛先カタログそして、以下に示す手順に従います。宛先に接続およびデータをアクティブ化このチュートリアルを試す前に

NOTE

用語流れおよび データフロー このチュートリアルでは、同じ意味で使用されます。このチュートリアルのコンテキストでは、は同じ意味を持ちます。

このチュートリアルでは、Adobe Experience Platform の次のコンポーネントについて十分に理解していることを前提にしています。

宛先: Destinations は、Adobe Experience Platformからのデータのシームレスなアクティベーションを可能にする、宛先プラットフォームとの事前定義済みの統合です。宛先を使用して、クロスチャネルマーケティングキャンペーン、メールキャンペーン、ターゲット広告、その他多くの使用事例に関する既知および不明なデータをアクティブ化できます。
サンドボックス：Experience Platform には、単一の Platform インスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

以下の節では、 Flow Service API.

API 呼び出し例の読み取り reading-sample-api-calls

このチュートリアルでは、API 呼び出しの例を提供し、リクエストの形式を設定する方法を示します。これには、パス、必須ヘッダー、適切な形式のリクエストペイロードが含まれます。また、API レスポンスで返されるサンプル JSON も示されています。ドキュメントで使用される API 呼び出し例の表記について詳しくは、Experience Platform トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。

必須ヘッダーの値の収集 gather-values-for-required-headers

Platform API への呼び出しを実行する前に、認証に関するチュートリアルを完了する必要があります。認証に関するチュートリアルを完了すると、すべての Experience Platform API 呼び出しで使用する、以下のような各必須ヘッダーの値が提供されます。

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

Experience Platform内のすべてのリソース ( Flow Serviceは、特定の仮想サンドボックスに分離されています。 Platform API へのすべてのリクエストには、操作がおこなわれるサンドボックスの名前を指定するヘッダーが必要です。

x-sandbox-name: {SANDBOX_NAME}

NOTE

次の場合、 x-sandbox-name ヘッダーが指定されていない場合、リクエストは prod サンドボックス。

ペイロード（POST、PUT、PATCH）を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。

Content-Type: application/json

データフローの詳細の検索 look-up-dataflow-details

宛先データフローを更新する最初の手順は、フロー ID を使用してデータフローの詳細を取得することです。 /flows エンドポイントに対して GET リクエストを実行することで、既存のデータフローの現在の詳細を表示できます。

API 形式

GET /flows/{FLOW_ID}

パラメーター

説明

{FLOW_ID}

一意の id 取得する宛先データフローの値。

リクエスト

次のリクエストでは、フロー ID に関する情報を取得します。

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'

応答

正常な応答は、バージョン、一意の識別子 (id)、およびその他の関連情報。

{
   "items":[
      {
         "id":"226fb2e1-db69-4760-b67e-9e671e05abfc",
         "createdAt":"{CREATED_AT}",
         "updatedAt":"{UPDATED_BY}",
         "createdBy":"{CREATED_BY}",
         "updatedBy":"{UPDATED_BY}",
         "createdClient":"{CREATED_CLIENT}",
         "updatedClient":"{UPDATED_CLIENT}",
         "sandboxId":"{SANDBOX_ID}",
         "sandboxName":"prod",
         "imsOrgId":"{ORG_ID}",
         "name":"2021 winter campaign",
         "description":"ACME company holiday campaign for high fidelity customers",
         "flowSpec":{
            "id":"71471eba-b620-49e4-90fd-23f1fa0174d8",
            "version":"1.0"
         },
         "state":"enabled",
         "version":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "etag":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "sourceConnectionIds":[
            "5e45582a-5336-4ea1-9ec9-d0004a9f344a"
         ],
         "targetConnectionIds":[
            "8ce3dc63-3766-4220-9f61-51d2f8f14618"
         ],
         "inheritedAttributes":{
            "sourceConnections":[
               {
                  "id":"5e45582a-5336-4ea1-9ec9-d0004a9f344a",
                  "connectionSpec":{
                     "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"0a82f29f-b457-47f7-bb30-33856e2ae5aa",
                     "connectionSpec":{
                        "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                        "version":"1.0"
                     }
                  },
                  "typeInfo":{
                     "type":"ProfileFragments",
                     "id":"ups"
                  }
               }
            ],
            "targetConnections":[
               {
                  "id":"8ce3dc63-3766-4220-9f61-51d2f8f14618",
                  "connectionSpec":{
                     "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"7fbf542b-83ed-498f-8838-8fde0c4d4d69",
                     "connectionSpec":{
                        "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                        "version":"1.0"
                     }
                  }
               }
            ]
         },
         "transformations":[
            {
               "name":"GeneralTransform",
               "params":{
                  "profileSelectors":{
                     "selectors":[
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"Email",
                              "operator":"EXISTS",
                              "identity":{
                                 "namespace":"Email"
                              },
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"Email",
                                 "destination":"Email",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"Email",
                                 "destinationXdmPath":"Email"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"person.name.firstName",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"person.name.firstName",
                                 "destination":"person.name.firstName",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"person.name.firstName",
                                 "destinationXdmPath":"person.name.firstName"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"person.name.lastName",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"person.name.lastName",
                                 "destination":"person.name.lastName",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"person.name.lastName",
                                 "destinationXdmPath":"person.name.lastName"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"personalEmail.address",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"personalEmail.address",
                                 "destination":"personalEmail.address",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"personalEmail.address",
                                 "destinationXdmPath":"personalEmail.address"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"segmentMembership.status",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"segmentMembership.status",
                                 "destination":"segmentMembership.status",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"segmentMembership.status",
                                 "destinationXdmPath":"segmentMembership.status"
                              }
                           }
                        }
                     ],
                     "mandatoryFields":[
                        "Email",
                        "person.name.firstName",
                        "person.name.lastName"
                     ],
                     "primaryFields":[
                        {
                           "identityNamespace":"Email",
                           "fieldType":"IDENTITY"
                        }
                     ]
                  },
                  "segmentSelectors":{
                     "selectors":[
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"9f7d37fd-7039-4454-94ef-2b0cd6c3206a",
                              "name":"Interested in Mountain Biking",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"DAILY_FULL_EXPORT",
                              "schedule":{
                                 "frequency":"ONCE",
                                 "startDate":"2021-12-25",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"f52a3785-2e7c-40a7-8137-9be99af7794e",
                              "name":"Birth year 1970",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"DAILY_FULL_EXPORT",
                              "schedule":{
                                 "frequency":"DAILY",
                                 "startDate":"2021-12-23",
                                 "endDate":"2021-12-31",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"6caa79b9-39e0-4c37-892b-5061cdca2377",
                              "name":"Account Leads",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
                              "schedule":{
                                 "frequency":"DAILY",
                                 "startDate":"2021-12-23",
                                 "endDate":"2021-12-31",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"4c41c318-9e8c-4a4f-b880-877cdd629fc7",
                              "name":"Batch export for autumn campaign",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
                              "schedule":{
                                 "frequency":"EVERY_6_HOURS",
                                 "startDate":"2022-01-05",
                                 "endDate":"2022-12-30",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        }
                     ]
                  }
               }
            }
         ]
      }
   ]

データフロー名と説明を更新 update-dataflow

データフローの名前と説明を更新するには、に対してPATCHリクエストを実行します。 Flow Service フロー ID、バージョンおよび使用する新しい値を指定する際の API。

IMPORTANT

If-Match ヘッダーは、PATCH リクエストを行う際に必要です。このヘッダーの値は、更新するデータフローの一意のバージョンです。 ETag の値は、データフローが正常に更新されるたびに更新されます。

API 形式

PATCH /flows/{FLOW_ID}

リクエスト

次のリクエストは、データフローの名前と説明を更新します。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
            {
                "op": "replace",
                "path": "/name",
                "value": "2021/2022 winter campaign"
            },
            {
                "op": "replace",
                "path": "/description",
                "value": "ACME company holiday campaign for high fidelity customers and prospects"
            }
        ]'

プロパティ

説明

op

データフローの更新に必要なアクションを定義するために使用される操作呼び出し。操作には、add、replace、remove があります。

path

更新するフローの部分を定義します。

value

パラメーターの更新に使用する新しい値。

応答

リクエストが成功した場合は、フロー ID と更新された etag が返されます。更新を検証するには、Flow Service API へ GET リクエストを行い、その際にフロー ID を指定します。

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

データフローを有効または無効にする enable-disable-dataflow

有効にすると、データフローが宛先にプロファイルをエクスポートします。データフローはデフォルトで有効になっていますが、無効にしてプロファイルエクスポートを一時停止することができます。

に対してPOSTリクエストをおこなうことで、既存の宛先データフローを有効または無効にできます。 Flow Service フローを更新する API と状態を指定します。

API 形式

POST /flows/{FLOW_ID}/action?op=enable or disable

リクエスト

次のリクエストでは、データフローの状態を有効に更新します。

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc/action?op=enable' \
    -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}'

次のリクエストでは、データフローの状態が無効に更新されます。

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc/action?op=disable' \
    -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}'

応答

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

オーディエンスをデータフローに追加する add-segment

オーディエンスを宛先データフローに追加するには、に対してPATCHリクエストを実行します。 Flow Service フロー ID、バージョン、追加するオーディエンスを指定する際の API。

API 形式

PATCH /flows/{FLOW_ID}

リクエスト

次のリクエストでは、新しいオーディエンスを既存の宛先データフローに追加します。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
   {
      "op":"add",
      "path":"/transformations/0/params/segmentSelectors/selectors/-",
      "value":{
         "type":"PLATFORM_SEGMENT",
         "value":{
            "id":"2d79d0d8-724f-49fc-a09d-d1dec338c93c",
            "name":"Winter 2021/2022 campaign",
            "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%SEGMENT_NAME%_%DATETIME(YYYYMMdd_HHmmss)%_custom-text",
            "exportMode":"DAILY_FULL_EXPORT",
            "schedule":{
               "startDate":"2022-01-05",
               "frequency":"DAILY",
               "triggerType": "AFTER_SEGMENT_EVAL",
               "endDate":"2022-03-10"
            }
         }
      }
   }
]'

プロパティ

説明

op

データフローの更新に必要なアクションを定義するために使用される操作呼び出し。操作には、add、replace、remove があります。オーディエンスをデータフローに追加するには、 add 操作。

path

更新するフローの部分を定義します。オーディエンスをデータフローに追加する場合は、例で指定したパスを使用します。

value

パラメーターの更新に使用する新しい値。

id

宛先データフローに追加するオーディエンスの ID を指定します。

name

（オプション）. 宛先データフローに追加するオーディエンスの名前を指定します。このフィールドは必須ではなく、名前を指定せずにオーディエンスを宛先データフローに正常に追加できます。

filenameTemplate

の場合 バッチ宛先 のみ。このフィールドは、Amazon S3、SFTP、Azure Blob などのバッチファイル書き出し先でオーディエンスをデータフローに追加する場合にのみ必要です。
このフィールドは、宛先に書き出すファイルのファイル名の形式を決定します。
以下のオプションを利用できます。

%DESTINATION_NAME%：必須。書き出されるファイルには、宛先名が含まれます。
%SEGMENT_ID%：必須。書き出されたファイルには、書き出されたオーディエンスの ID が含まれます。
%SEGMENT_NAME%: （オプション）. 書き出されたファイルには、書き出されたオーディエンスの名前が含まれます。
DATETIME(YYYYMMdd_HHmmss) または %TIMESTAMP%: （オプション）. ファイルが Experience Platform で生成された時刻を含めるには、これら 2 つのオプションのいずれかを選択します。
custom-text: （オプション）. ファイル名の末尾に追加したいカスタムテキストでこのプレースホルダーを置き換えます。

ファイル名の設定について詳しくは、バッチ宛先の有効化に関するチュートリアルの「ファイル名の設定」の節を参照してください。

exportMode

の場合 バッチ宛先 のみ。このフィールドは、Amazon S3、SFTP、Azure Blob などのバッチファイル書き出し先でオーディエンスをデータフローに追加する場合にのみ必要です。
必須です。 "DAILY_FULL_EXPORT" または "FIRST_FULL_THEN_INCREMENTAL" を選択します。この 2 つのオプションについて詳しくは、バッチ宛先の有効化に関するチュートリアルの「完全なファイルのエクスポート」および「増分ファイルのエクスポート」を参照してください。

startDate

オーディエンスが宛先へのプロファイルのエクスポートを開始する日付を選択します。

frequency

の場合 バッチ宛先 のみ。このフィールドは、Amazon S3、SFTP、Azure Blob などのバッチファイル書き出し先でオーディエンスをデータフローに追加する場合にのみ必要です。
必須です。

"DAILY_FULL_EXPORT" エクスポートモードの場合は、ONCE または DAILY を選択できます。
"FIRST_FULL_THEN_INCREMENTAL" エクスポートモードの場合は、"DAILY"、"EVERY_3_HOURS"、"EVERY_6_HOURS"、"EVERY_8_HOURS"、"EVERY_12_HOURS" を選択できます。

triggerType

の場合 バッチ宛先 のみ。このフィールドは、 "DAILY_FULL_EXPORT" モード frequency セレクター。
必須です。

選択 "AFTER_SEGMENT_EVAL" ：毎日の Platform バッチセグメント化ジョブが完了した直後にアクティベーションジョブを実行する場合。これにより、アクティベーションジョブが実行されると、最新のプロファイルが確実に宛先に書き出されます。
選択 "SCHEDULED" を追加して、特定の時間にアクティベーションジョブを実行する必要があります。これにより、Experience Platformプロファイルデータは毎日同時に書き出されますが、アクティベーションジョブの開始前にバッチセグメントジョブが完了しているかどうかに応じて、書き出すプロファイルが最新ではない場合があります。このオプションを選択する場合は、 startTime を使用して、毎日の書き出しが発生する時刻 (UTC) を指定します。

endDate

の場合 バッチ宛先 のみ。このフィールドは、Amazon S3、SFTP、Azure Blob などのバッチファイル書き出し先でオーディエンスをデータフローに追加する場合にのみ必要です。
選択時には適用されません "exportMode":"DAILY_FULL_EXPORT" および "frequency":"ONCE".
オーディエンスメンバーが宛先への書き出しを停止する日付を設定します。

startTime

の場合 バッチ宛先 のみ。このフィールドは、Amazon S3、SFTP、Azure Blob などのバッチファイル書き出し先でオーディエンスをデータフローに追加する場合にのみ必要です。
必須です。オーディエンスのメンバーを含むファイルを生成し、宛先に書き出す時間を選択します。

応答

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

データフローからのオーディエンスの削除 remove-segment

既存の宛先データフローからオーディエンスを削除するには、に対してPATCHリクエストを実行します。 Flow Service 削除するオーディエンスのフロー ID、バージョン、インデックスセレクターを指定する際の API。インデックス作成は次の時点で開始： 0. 例えば、以下のリクエスト例では、最初と 2 番目のオーディエンスがデータフローから削除されています。

API 形式

PATCH /flows/{FLOW_ID}

リクエスト

次のリクエストでは、2 つのオーディエンスが既存の宛先データフローから削除されます。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
{
   "op":"remove",
   "path":"/transformations/0/params/segmentSelectors/selectors/0",
   "value":{
      "type":"PLATFORM_SEGMENT",
      "value":{
      }
   }
},
{
   "op":"remove",
   "path":"/transformations/0/params/segmentSelectors/selectors/1",
   "value":{
      "type":"PLATFORM_SEGMENT",
      "value":{
      }
   }
}
]'

プロパティ

説明

op

データフローの更新に必要なアクションを定義するために使用される操作呼び出し。操作には、add、replace、remove があります。データフローからオーディエンスを削除するには、 remove 操作。

path

オーディエンスセレクターのインデックスに基づいて、宛先データフローから削除する既存のオーディエンスを指定します。データフロー内のオーディエンスの順序を取得するには、に対してGET呼び出しを実行します。 /flows エンドポイントと検査 transformations.segmentSelectors プロパティ。データフローの最初のオーディエンスを削除するには、を使用します。 "path":"/transformations/0/params/segmentSelectors/selectors/0".

応答

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

データフロー内のオーディエンスのコンポーネントを更新 update-segment

既存の宛先データフロー内のオーディエンスのコンポーネントを更新できます。例えば、エクスポート頻度を変更したり、ファイル名テンプレートを編集したりできます。これをおこなうには、 Flow Service 更新するオーディエンスのフロー ID、バージョン、インデックスセレクターを提供する際の API。インデックス作成は次の時点で開始： 0. 例えば、以下のリクエストでは、データフローの 9 番目のオーディエンスが更新されます。

API 形式

PATCH /flows/{FLOW_ID}

リクエスト

既存の宛先GETフローのオーディエンスを更新する場合、まず操作を実行して、更新するオーディエンスの詳細を取得する必要があります。次に、更新するフィールドだけでなく、ペイロードにすべてのオーディエンス情報を指定します。次の例では、カスタムテキストがファイル名テンプレートの最後に追加され、エクスポートスケジュールの頻度が 6 時間から 12 時間に更新されています。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
   {
      "op":"replace",
      "path":"/transformations/0/params/segmentSelectors/selectors/8",
      "value":{
         "type":"PLATFORM_SEGMENT",
         "value":{
            "id":"4c41c318-9e8c-4a4f-b880-877cdd629fc7",
            "name":"Batch export for autumn campaign",
            "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_custom-text",
            "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
            "schedule":{
               "frequency":"EVERY_12_HOURS",
               "startDate":"2022-01-05",
               "endDate":"2022-01-30",
               "startTime":"20:00"
            },
            "createTime":"1640289901",
            "updateTime":"1640289901"
         }
      }
   }
]'

ペイロード内のプロパティの説明については、を参照してください。オーディエンスをデータフローに追加する.

応答

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

データフローで更新できるオーディエンスコンポーネントのその他の例については、以下の例を参照してください。

オーディエンス評価のスケジュール済みから後まで、オーディエンスのエクスポートモードを更新する update-export-mode

「」をクリックすると、オーディエンスエクスポートの更新が指定した時間に毎日アクティブ化されるのから、Platform バッチセグメント化ジョブが完了した後の毎日アクティブ化されるのに関する例が表示されます。

オーディエンスは毎日 16:00 UTC にエクスポートされます。

code language-json

code language-json
`{ "type": "PLATFORM_SEGMENT", "value": { "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f", "name": "12JAN22-AEP-NA-NTC-90D-MW", "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%", "exportMode": "DAILY_FULL_EXPORT" "schedule": { "frequency": "DAILY", "triggerType": "SCHEDULED", "startDate": "2022-01-13", "endDate": "2023-01-13", "startTime":"16:00" }, "createTime": "1642041770", "updateTime": "1642615573" } }`

{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

オーディエンスは、毎日のバッチセグメント化ジョブが完了した後、毎日エクスポートされます。

code language-json

code language-json
`{ "type": "PLATFORM_SEGMENT", "value": { "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f", "name": "12JAN22-AEP-NA-NTC-90D-MW", "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%", "exportMode": "DAILY_FULL_EXPORT" "schedule": { "frequency": "DAILY", "triggerType": "AFTER_SEGMENT_EVAL", "startDate": "2022-01-13", "endDate": "2023-01-13" }, "createTime": "1642041770", "updateTime": "1642615573" } }`

{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "AFTER_SEGMENT_EVAL",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

ファイル名テンプレートを更新して、ファイル名に追加のフィールドを含めます update-filename-template

ファイル名テンプレートが更新され、ファイル名に追加のフィールドが含まれる場合の例を参照してください。

書き出されるファイルには、宛先名とExperience Platformオーディエンス ID が含まれます

code language-json

code language-json
`{ "type": "PLATFORM_SEGMENT", "value": { "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f", "name": "12JAN22-AEP-NA-NTC-90D-MW", "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%", "exportMode": "DAILY_FULL_EXPORT" "schedule": { "frequency": "DAILY", "triggerType": "SCHEDULED", "startDate": "2022-01-13", "endDate": "2023-01-13", "startTime":"16:00" }, "createTime": "1642041770", "updateTime": "1642615573" } }`

{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

書き出されるファイルには、宛先名、Experience Platformオーディエンス ID、ファイルがExperience Platformによって生成された日時、およびファイルの末尾に追加されたカスタムテキストが含まれます。

code language-json

code language-json
`{ "type": "PLATFORM_SEGMENT", "value": { "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f", "name": "12JAN22-AEP-NA-NTC-90D-MW", "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_%this is custom text%", "exportMode": "DAILY_FULL_EXPORT" "schedule": { "frequency": "DAILY", "triggerType": "SCHEDULED", "startDate": "2022-01-13", "endDate": "2023-01-13", "startTime":"16:00" }, "createTime": "1642041770", "updateTime": "1642615573" } }`

{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_%this is custom text%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

プロファイル属性をデータフローに追加する add-profile-attribute

プロファイル属性を宛先データフローに追加するには、に対してPATCHリクエストを実行します。 Flow Service 追加するフロー ID、バージョンおよびプロファイル属性を指定する際の API。

API 形式

PATCH /flows/{FLOW_ID}

リクエスト

次のリクエストでは、新しいプロファイル属性を既存の宛先データフローに追加します。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
    {
    "op":"add",
    "path":"/transformations/0/params/profileSelectors/selectors/-",
    "value":{
        "type":"JSON_PATH",
        "value":{
            "path":"mobilePhone.status"
        }
    }
    }
]'

プロパティ

説明

op

データフローの更新に必要なアクションを定義するために使用される操作呼び出し。操作には、add、replace、remove があります。プロファイル属性をデータフローに追加するには、 add 操作。

path

更新するフローの部分を定義します。プロファイル属性をデータフローに追加する場合は、例で指定したパスを使用します。

value.path

データフローに追加するプロファイル属性の値。

応答

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

データフローからプロファイル属性を削除する remove-profile-attribute

既存の宛先データフローからプロファイル属性を削除するには、に対してPATCHリクエストを実行します。 Flow Service 削除するプロファイル属性のフロー ID、バージョン、インデックスセレクターを指定する際の API。インデックス作成は次の時点で開始： 0. 例えば、次のリクエスト例では、5 番目のプロファイル属性がデータフローから削除されます。

API 形式

PATCH /flows/{FLOW_ID}

リクエスト

次のリクエストでは、既存の宛先データフローからプロファイル属性を削除します。

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
    {
    "op":"remove",
    "path":"/transformations/0/params/profileSelectors/selectors/4",
    "value":{
        "type":"JSON_PATH",
        "value":{
            "path":"mobilePhone.status"
        }
    }
    }
]'

プロパティ

説明

op

path

オーディエンスセレクターのインデックスに基づいて、宛先データフローから削除する既存のプロファイル属性を指定します。データフロー内のプロファイル属性の順序を取得するには、に対してGET呼び出しを実行します。 /flows エンドポイントと検査 transformations.profileSelectors プロパティ。データフローの最初のオーディエンスを削除するには、を使用します。 "path":"transformations/0/params/segmentSelectors/selectors/0/".

応答

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

API エラー処理 api-error-handling

このチュートリアルの API エンドポイントは、Experience PlatformAPI エラーメッセージの一般的な原則に従います。参照： API ステータスコードおよびリクエストヘッダーエラーエラー応答の解釈について詳しくは、『 Platform トラブルシューティングガイド』を参照してください。

次の手順 next-steps

このチュートリアルでは、を使用したオーディエンスやプロファイル属性の追加や削除など、宛先データフローの様々なコンポーネントの更新方法を学びました。 Flow Service API. 宛先について詳しくは、宛先の概要.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6