フローサービス API を使用した宛先アカウントの削除

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

データをアクティブ化する前に、まず宛先アカウントを設定して宛先に接続する必要があります。 このチュートリアルでは、 Flow Service API.

メモ

宛先アカウントの削除は、現在、フローサービス API でのみサポートされています。 宛先アカウントは、Experience PlatformUI を使用して削除できません。

はじめに

このチュートリアルでは、有効な接続 ID が必要です。接続 ID は、宛先へのアカウント接続を表します。 有効な接続 ID がない場合は、 宛先カタログ そして、以下に示す手順に従います。 宛先に接続 このチュートリアルを試す前に

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

以下の節では、 Flow Service API

API 呼び出し例の読み取り

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

必須ヘッダーの値の収集

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}
メモ

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

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

  • Content-Type: application/json

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

メモ

このチュートリアルでは、 飛行船の目的地 例として挙げられる手順は、次のいずれかに適用されます。 使用可能な宛先.

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

Experience PlatformUI で、を参照します。 宛先 > アカウント をクリックし、「 宛先 列。

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

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

URL から接続 ID を取得

接続を削除

重要

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

接続 ID を取得し、宛先アカウントにデータフローが存在しないことを確認したら、に対してDELETEリクエストを実行します。 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 エンドポイントは、Experience PlatformAPI エラーメッセージの一般的な原則に従います。 Platform トラブルシューティングガイドの API ステータスコードおよびリクエストヘッダーエラーを参照してください。

次の手順

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

このページ