Flow Service APIを使用した宛先アカウントの削除

Destinationsは、Adobe Experience Platformからのデータのシームレスなアクティベーションを可能にする、宛先プラットフォームとの事前定義済みの統合です。 宛先を使用して、クロスチャネルマーケティングキャンペーン、メールキャンペーン、ターゲット広告、その他多くの使用事例に関する既知および不明なデータをアクティブ化できます。

データをアクティブ化する前に、まず宛先アカウントを設定して宛先に接続する必要があります。 このチュートリアルでは、Flow Service APIを使用して、不要になった宛先アカウントを削除する手順について説明します。

NOTE
宛先アカウントの削除は、現在Flow Service APIでのみサポートされています。 宛先アカウントは、Experience Platform UIを使用して削除できません。

はじめに get-started

このチュートリアルでは、有効な接続 ID が必要です。接続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

削除する宛先アカウントの接続IDを検索します find-connection-id

NOTE
このチュートリアルでは、飛行船の宛先を例として使用しますが、概要が記載されている手順は、利用可能な宛先のいずれかに適用されます。

宛先アカウントを削除する最初の手順は、削除する宛先アカウントに対応する接続IDを見つけることです。

Experience Platform UIで、Destinations > Accounts​を参照し、Destinations​列の番号を選択して、削除するアカウントを選択します。

削除する宛先アカウントを選択

次に、ブラウザーのURLから宛先アカウントの接続IDを取得できます。

URLから接続IDを取得

接続を削除 delete-connection

IMPORTANT
宛先アカウントを削除する前に、宛先アカウントに対する既存のデータフローをすべて削除する必要があります。
既存のデータフローを削除するには、次のページを参照してください。

接続IDを取得し、宛先アカウントにデータフローが存在しないことを確認したら、Flow Service APIに対してDELETE リクエストを実行します。

API 形式

DELETE /connections/{CONNECTION_ID}
パラメーター
説明
{CONNECTION_ID}
削除する接続の一意のid値。

リクエスト

curl -X DELETE \
    'https://platform.adobe.io/data/foundation/flowservice/connections/c8622ec7-7d94-44a5-a35a-ffcc6bdcc384' \
    -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 ステータス 204(コンテンツなし)が空白の本文とともに返されます。接続に対してルックアップ(GET)リクエストを試みることで、削除を確定できます。 APIは、宛先アカウントが削除されたことを示すHTTP 404 (Not Found)エラーを返します。

API エラー処理 api-error-handling

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

次の手順 next-steps

Flow Service APIを使用して既存の宛先アカウントを削除しました。 宛先の使用について詳しくは、宛先の概要を参照してください。

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