ドキュメントExperience Platform宛先ガイド

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

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

作成対象：

  • 管理者
  • ユーザー

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

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

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

はじめに get-started

このチュートリアルでは、有効な接続 ID が必要です。接続 ID は、宛先へのアカウント接続を表します。 有効な接続 ID がない場合は、このチュートリアルを試す前に、 宛先カタログから宛先を選択し、 宛先に接続の説明に従ってください。

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

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

次の節では、Flow Service API を使用して宛先アカウントを正常に削除するために必要な追加情報を示しています。

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

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

必須ヘッダーの値の収集 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}

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

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

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

  • Content-Type: application/json

削除する宛先アカウントの接続 ID を見つけます find-connection-id

NOTE
このチュートリアルでは Airship の宛先を例として使用しますが、説明する手順は 使用可能な宛先のいずれにも該当します。

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

Experience Platformの UI で、Destinations/Accounts を参照し、削除するアカウントを Destinations 列の数値を選んで選択します。

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

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

URL から接続 ID を取得

接続を削除 delete-connection

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

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

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 （見つかりません）エラーを返し、宛先アカウントが削除されたことを示します。

API エラー処理 api-error-handling

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

次の手順

このチュートリアルでは、既存の宛先アカウントを削除する Flow Service API を正常に使用しました。 宛先の使用について詳しくは、 宛先の概要を参照してください。

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