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

エラーを含む、またはFlow Service APIを使用して古くなったデータフローを削除できます。

このチュートリアルでは、Flow Serviceを使用してバッチ宛先とストリーミング宛先の両方にデータフローを削除する手順について説明します。

はじめに get-started

このチュートリアルは、有効なフロー ID を保有しているユーザーを対象としています。有効なフローIDがない場合は、このチュートリアルを試す前に、宛先カタログ ​から目的の宛先を選択し、宛先への接続および​ データのアクティベート ​に関する手順に従ってください。

このチュートリアルでは、Adobe Experience Platformの次のコンポーネントについて理解している必要もあります。

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

以下の節では、Flow Service APIを使用してデータフローを正常に削除するために知っておく必要がある追加情報を示します。

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

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

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

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

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

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

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
x-sandbox-name ヘッダーが指定されていない場合、リクエストはprod サンドボックスで解決されます。

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

  • Content-Type: application/json

宛先データフローの削除 delete-destination-dataflow

既存のフローIDを使用して、Flow Service APIに対してDELETE リクエストを実行することで、宛先データフローを削除できます。

API 形式

DELETE /flows/{FLOW_ID}
パラメーター
説明
{FLOW_ID}
削除する宛先データフローの一意のid値。

リクエスト

curl -X DELETE \
    'https://platform.adobe.io/data/foundation/flowservice/flows/455fa81b-f290-4222-94b6-540a73e3fbc2' \
    -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}'

応答

リクエストが成功した場合は、HTTP ステータス 202(コンテンツなし)が空白の本文とともに返されます。データフローに対してルックアップ(GET)リクエストを試みることで、削除を確認することができます。API はデータフローが削除されたことを示す HTTP 404(見つかりません)エラーを返します。

API エラー処理 api-error-handling

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

次の手順 next-steps

Flow Service APIを使用して、既存のデータフローを宛先に削除しました。

ユーザーインターフェイスを使用してこれらの操作を実行する手順については、UIでのデータフローの削除に関するチュートリアルを参照してください。

​ APIを使用して、宛先アカウントを削除Flow Serviceできます。

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6