コンテンツにスキップ

オブジェクトリレーションシップを一括削除

delete

/data_objects/object_relationships

このエンドポイントを使用して、1回のリクエストで最大50件のオブジェクト間リレーションシップを削除します。

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

前提条件

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

レート制限

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

リクエストパラメーター

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

パラメーター 必須 データ型 説明
records 必須 配列 削除するオブジェクトリレーションシップ。1~50件のレコードを含める必要があります。Brazeはその他のトップレベルフィールドをすべて拒否します。
records[].type_name 必須 文字列 ソースオブジェクトのタイプ
records[].object_id 必須 文字列 ソースオブジェクトの識別子
records[].rel_kind 必須 文字列 リレーションシップタイプの名前
records[].related_type_name 必須 文字列 ターゲットオブジェクトのタイプ
records[].related_object_id 必須 文字列 ターゲットオブジェクトの識別子

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

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

リクエスト例

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

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

{
  "records": [
    {
      "type_name": "contact",
      "object_id": "contact-001",
      "rel_kind": "works_at",
      "related_type_name": "account",
      "related_object_id": "acct-001"
    }
  ]
}

cURLリクエストのサンプル

この例では、contact-001 と acct-001 の間の works_at リレーションシップを削除します。両方のオブジェクトは残ります。

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

レスポンス

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

成功レスポンスの例

ステータスコード 202 は、次のレスポンス本文を返す可能性があります。

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

レスポンスパラメーター

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

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

処理エラー

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

コード 意味
data-object-type-not-found type_name または related_type_name が、ワークスペース内のアクティブなタイプを指していません。
data-object-relationship-type-not-found rel_kind が、これらのタイプに対するアクティブなリレーションシップタイプを指していません。
data-object-ingestion-rejected その他の拒否。
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.object_relationships.bulk_delete があること、および設定されている場合はソースIPがキーの許可リストに含まれていることを確認してください。
404 会社でData Objectsが有効になっていない ワークスペースでAccountsがプロビジョニングされていることを確認してください。
429 レート制限を超過した X-RateLimit-Reset の後に再試行し、リクエストの頻度を減らしてください。
500 バッチを受け付けられなかった(internal-error) Brazeは何も受け付けていないため、リクエストを安全に再試行できます。
New Stuff!