オーディエンスからすべてのメンバーを削除する

このガイドでは、RemoveAllAudienceMembersRequest を送信して、カスタマー マッチ オーディエンスからすべてのメンバーを削除する方法について説明します。

このメソッドは、単一のリクエストでユーザーリストをクリアする場合や、リストのすべてのオーディエンス メンバーを置き換える場合に便利です。

オーディエンスをクリアする

オーディエンスからすべてのメンバーを削除するには、RemoveAllAudienceMembersRequest を送信し、removeAsOfTime フィールドを省略します。これにより、削除時間がデフォルトで現在時刻に設定され、リストから現在のメンバーがすべてクリアされます。

すべてのメンバーを置き換える

ユーザーリストが空にならないようにしながら、カスタマー マッチ オーディエンスのすべてのメンバーを置き換えるには、次の手順を行います。

  1. 現在時刻を T として記録します。
  2. IngestAudienceMembersRequest を送信して、新しいメンバーのアップロードを開始します。必要に応じて、複数の取り込みリクエストを行うことができます。
  3. すべての取り込みリクエストの処理が完了するまで待ちます。リクエストのステータスは、診断で確認できます。

  4. ステップ 1 で記録したタイムスタンプ T に設定された removeAsOfTime を含む RemoveAllAudienceMembersRequest を送信します。これにより、新しいメンバーのアップロードを開始するに追加されたメンバーのみが削除され、新しく追加されたメンバーのみが残ります。

リクエストを作成する

RemoveAllAudienceMembersRequest 本文で次のフィールドを設定します。

destinations
必須。宛先のリスト。各宛先の productDestinationId フィールドには、メンバーを削除するオーディエンスを指定します。詳細については、宛先を構成するをご覧ください。
removeAsOfTime
省略可。この時間より前に追加されたメンバーのみが削除されます。形式の詳細については、タイムスタンプ形式をご覧ください。設定しない場合、この値はデフォルトで現在の時刻になります。
validateOnly
省略可。変更を適用せずにリクエストを検証するには、true に設定します。変更を適用する準備ができたら、false に設定します。

サンプル リクエスト

以下は、カスタマー マッチ リストからすべてのメンバーを削除するリクエストの例です。

  1. [API Explorer で開く] をクリックして、新しいタブまたはウィンドウで API Explorer を開きます。
  2. API エクスプローラの本文で、REPLACE_WITH で始まる各文字列(REPLACE_WITH_OPERATING_ACCOUNT_TYPE など)を関連する値に置き換えます。
  3. API エクスプローラ ページの下部にある [実行] をクリックし、認証プロンプトに沿って操作してリクエストを送信します。
  4. validateOnlytrue に設定して、変更を適用せずにリクエストを検証します。変更を適用する準備ができたら、validateOnlyfalse に設定します。

広告主様

{
    "destinations": [
        {
            "operatingAccount": {
                "accountType": "OPERATING_ACCOUNT_TYPE",
                "accountId": "OPERATING_ACCOUNT_ID"
            },
            "loginAccount": {
                "accountType": "LOGIN_ACCOUNT_TYPE",
                "accountId": "LOGIN_ACCOUNT_ID"
            },
            "productDestinationId": "AUDIENCE_ID"
        }
    ],
    "removeAsOfTime": "2026-07-20T15:01:23Z",
    "validateOnly": true
}

データ パートナー

{
    "destinations": [
        {
            "operatingAccount": {
                "accountType": "OPERATING_ACCOUNT_TYPE",
                "accountId": "OPERATING_ACCOUNT_ID"
            },
            "loginAccount": {
                "accountType": "DATA_PARTNER",
                "accountId": "DATA_PARTNER_ACCOUNT_ID"
            },
            "linkedAccount": {
                "accountType": "LINKED_ACCOUNT_TYPE",
                "accountId": "LINKED_ACCOUNT_ID"
            },
            "productDestinationId": "AUDIENCE_ID"
        }
    ],
    "removeAsOfTime": "2026-07-20T15:01:23Z",
    "validateOnly": true
}

リクエストを送信する

リクエストを removeAll エンドポイントに送信します。

リクエストが成功すると、レスポンスには requestId が含まれます。これを使用して、オペレーションのステータスを追跡できます。

{
  "requestId": "REQUEST_ID"
}

リクエストが失敗した場合は、エラーを調べて、失敗の原因を特定します。