コンテンツにスキップ

データオブジェクトを一括削除

delete

/data_objects/objects

このエンドポイントを使用すると、1回のリクエストで最大50件のデータオブジェクト (タイプの混在も可) を削除できます。

Brazeはリクエストを受け付け、バックグラウンドで処理します。202 レスポンスは、バッチがキューに追加されたことを意味し、適用済みであることを意味するものではありません。1件のデータオブジェクトを削除して変更をすぐに確認するには、データオブジェクトを削除を使用します。それぞれの使い分けについては、一括エンドポイントを参照してください。

前提条件

このエンドポイントを使用するには、data_objects.bulk_delete 権限を持つ API キーが必要です。data_objects.delete などの単一レコード用の権限では、このエンドポイントへのアクセスは許可されません。

レート制限

このエンドポイントはData Objectsの一括書き込みバケットに属し、デフォルトの制限はワークスペースごとに1分あたり1,000リクエストです。この制限は6つの一括エンドポイントすべて、およびデータオブジェクトのCloud Data Ingestion同期と共有され、単一レコードの書き込み制限とは別に適用されます。

リクエストパラメーター

次の表は、/data_objects/objects エンドポイントの JSON リクエスト本文パラメーターの一覧と説明です。

パラメーター 必須 データ型 説明
records 必須 配列 削除するデータオブジェクト。1~50件のレコードを含める必要があります。Brazeはその他のトップレベルフィールドをすべて拒否します。
records[].type_name 必須 文字列 データオブジェクトタイプのマシン名
records[].object_id 必須 文字列 オブジェクトの識別子。単一レコードエンドポイントのパスにある object_id と同じ値です

Brazeによるバッチの処理方法

  • 検証はオールオアナッシングです。いずれかのレコードが検証に失敗した場合、Brazeはリクエスト全体を 400 で拒否し、何も保存せず、すべてのエラーを一覧表示します。エラーを修正し、リクエスト全体を再送信してください。
  • 検索は処理中に行われます。Brazeはバッチの処理時に各タイプとオブジェクトが存在するかどうかを確認するため、202 を返したリクエストでも、後で個々のレコードが失敗する場合があります。処理エラーを参照してください。
  • レコードは受信時刻順に処理されます。Brazeはすべてのレコードにリクエストの受信時刻を付与するため、updated_at は送信しないでください。これを含むリクエストは拒否されます。2つのリクエストが同じオブジェクトを変更する場合は、Brazeが後に受信したほうが優先され、その後に届いた古い書き込みはスキップされます。
  • 削除は待機する場合があります。まだ存在しないオブジェクトの削除は、すぐに失敗するのではなく待機します。Brazeは約40時間 (10回) 再試行します。それでもオブジェクトが存在しない場合、そのレコードは data-object-dependency-not-found で失敗します。
  • 同じオブジェクトの削除後に受信したアップサートは、そのオブジェクトを再作成します。

リクエスト例

このセクションには、JSON ペイロードのサンプルと cURL リクエストのサンプルが含まれています。

リクエストペイロードのサンプル

{
  "records": [
    {"type_name": "account", "object_id": "acct-001"},
    {"type_name": "opportunity", "object_id": "opp-001"}
  ]
}

cURL リクエストのサンプル

この例では、同じリクエストで account レコード1件と opportunity レコード1件を削除します。

curl --location --request DELETE 'https://rest.iad-01.braze.com/data_objects/objects' \
--header 'Authorization: Bearer YOUR_REST_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "records": [
    {"type_name": "account", "object_id": "acct-001"},
    {"type_name": "opportunity", "object_id": "opp-001"}
  ]
}'

レスポンス

このセクションには、成功時のレスポンスのサンプルとレスポンスフィールドが含まれています。

成功時のレスポンス例

ステータスコード 202 では、次のレスポンス本文が返される場合があります。

{
  "source_import_id": "api-20261022T153012123456-9f3a1c2b",
  "status": "queued",
  "record_count": 2
}

レスポンスパラメーター

次の表は、成功時のレスポンスに含まれるフィールドの一覧と説明です。

パラメーター 必須 データ型 説明
source_import_id 必須 文字列 Brazeがこのリクエストに対して生成した識別子。各リクエストはそれぞれ独立したインポートです。
status 必須 文字列 常に queued です。バッチは受け付けられ、処理待ちの状態です。
record_count 必須 整数 リクエスト内のレコード数

処理エラー

Brazeはこれらのコードをエンドポイントから返しません。キューに追加されたバッチを処理する際に、個々のレコードに対して記録します。

コード 意味
data-object-type-not-found type_name がワークスペース内のアクティブなタイプを指していません。
data-object-ingestion-rejected 拒否された object_id など、その他の拒否。
data-object-dependency-not-found 約40時間の再試行後もオブジェクトが存在しませんでした。

エラー

400 レスポンスは、Brazeが何も保存しなかったことを意味します。各エラーには id、message、該当する場合は問題のある parameter、さらにレコードレベルのエラーではレコードの index (records 内の0から始まる位置) が含まれます。

次の表は、このエンドポイントでよく発生するエラーとその解決方法の一覧です。

ステータス 原因 対処方法
400 無効なリクエスト (invalid-request): 本文が JSON オブジェクトではないか不正な形式の JSON である、records がないかエントリが1件未満または50件を超えている、または本文にBrazeが設定するフィールド (source_type、source_import_id、source_chunk_id、record_type) が含まれている records のみをフィールドとし、1~50件のレコードを含む JSON オブジェクトを送信してください。
400 スキーマの不一致 (schema-mismatch): レコードに必須フィールドがない、認識されないフィールド (updated_at を含む) がある、またはフィールドの型が誤っているか空文字列である 一覧表示されたすべてのレコードを修正し、リクエスト全体を再送信してください。
401 REST API キーがないか無効です Authorization ヘッダーで Bearer YOUR_REST_API_KEY が使用されていること、およびキーが有効であることを確認してください。
403 API キーに権限がないか、リクエストが許可リストによってブロックされています キーに data_objects.bulk_delete があること、および許可リストが設定されている場合は送信元IPがキーの許可リストに含まれていることを確認してください。
404 会社でData Objectsが有効になっていません ワークスペースでAccountsがプロビジョニングされていることを確認してください。
429 レート制限を超えました X-RateLimit-Reset の後に再試行し、リクエストの頻度を減らしてください。
500 バッチを受け付けられませんでした (internal-error) Brazeは何も受け付けていないため、リクエストを安全に再試行できます。
New Stuff!