レート制限
BrazeのAPIインフラは、顧客ベース全体で大量のデータを処理できるように設計されています。このため、ワークスペースごとにAPIレート制限を設けています。
レート制限とは、APIが一定時間内に受け取れるリクエスト数のことです。大規模システムにおける負荷ベースのサービス拒否インシデントの多くは、悪意のある攻撃ではなく、ソフトウェアや設定のエラーによって引き起こされる意図しないものです。レート制限は、このようなエラーによってBraze APIのリソースがお客様に提供できなくなることを防ぎます。一定時間内に多くのリクエストが送信された場合、ステータスコード429のエラー応答が返されることがあります。これは、レート制限に達したことを示します。
APIレート制限は、システムの適切な使用状況に応じて変更される場合があります。損害や悪用を防ぐため、APIコールを行う際には適切な制限を設けることを推奨します。
リクエストタイプ別のレート制限
さまざまなリクエストタイプのデフォルトAPIレート制限については、以下を参照してください。これらのデフォルト制限は、リクエストに応じて引き上げることができます。詳しくはカスタマーサクセスマネージャーにお問い合わせください。
個別のレート制限があるリクエスト
共有レート制限のリクエスト
以下のリクエストには、1時間あたり250,000リクエストの共有レート制限が適用されます。
/app_group/sdk_authentication/create/app_group/sdk_authentication/keys/app_group/sdk_authentication/delete/app_group/sdk_authentication/primary/campaigns/details/campaigns/list/campaigns/trigger/send（非ブロードキャストコールのみ—external_user_idsまたはaliasesを指定するリクエスト）/campaigns/trigger/schedule/create（非ブロードキャストコールのみ）/campaigns/trigger/schedule/delete/campaigns/trigger/schedule/update/canvas/data_series/canvas/data_summary/canvas/details/canvas/list/canvas/trigger/send（非ブロードキャストコールのみ）/canvas/trigger/schedule/create（非ブロードキャストコールのみ）/canvas/trigger/schedule/delete/canvas/trigger/schedule/update/content_blocks/create/content_blocks/info/content_blocks/list/content_blocks/update/email/blocklist/email/blacklist/email/bounce/remove/email/hard_bounces/email/spam/remove/email/status/email/unsubscribes/events/data_series/kpi/dau/data_series/kpi/mau/data_series/kpi/new_users/data_series/kpi/uninstalls/data_series/messages/live_activity/start/messages/live_activity/update/messages/send（非ブロードキャストコールのみ）/messages/schedule/create/messages/schedule/delete/messages/schedule/update/messages/scheduled_broadcasts/segments/data_series/segments/details/segments/list/sends/data_series/sessions/data_series/sms/invalid_phone_numbers/sms/invalid_phone_numbers/remove/subscription/status/get/subscription/user/status/templates/email/create/templates/email/info/templates/email/list/templates/email/update/users/export/global_control_group/users/export/segment
同一ユニークオーディエンスとしてカウントされる条件
これは以下のエンドポイントに適用されます：/messages/send、/campaigns/trigger/send、/canvas/trigger/send、/campaigns/trigger/schedule/create、および/canvas/trigger/schedule/create。
これらのエンドポイントでは、以下のすべてが一致する場合、ブロードキャストリクエストは同一のユニークオーディエンスをターゲットしているとみなされます。
- トリガーされるキャンペーンまたはキャンバス（APIリクエスト内の
campaign_idまたはcanvas_id（指定されている場合）） - ターゲットされるオーディエンス（セグメントまたはフィルター。APIキャンペーンの場合はAPIリクエスト内の
segment_id） - 接続オーディエンスフィルター（APIリクエスト内の
audienceオブジェクト（指定されている場合））
これらの属性のユニークな組み合わせがそれぞれ個別のオーディエンスとしてカウントされるため、各ユニークオーディエンスに対する追加のレート制限は、それぞれの組み合わせに独立して適用されます。
APIリクエストのバッチ処理
Braze APIはバッチ処理をサポートするように構築されています。バッチ処理を使用すると、Brazeは単一のAPI呼び出しでできるだけ多くのデータを取り込むことができるため、大量のAPI呼び出しを行う必要がありません。Brazeにとって、データをバッチで処理する方が、一度に1つずつ呼び出しを処理するよりも効率的です。たとえば、1,000件のバッチAPIリクエストを処理する方が、75,000件の個別の呼び出しを処理するよりもリソースの消費が少なくなります。バッチ処理は、1時間あたり75,000件を超える呼び出しが必要になる可能性のあるアプリケーションにとって非常に重要です。
REST APIのレート制限の引き上げは、APIバッチ処理機能を活用しているお客様のニーズに基づいて検討されます。
ユーザーの作成および更新エンドポイントのリクエストのバッチ処理
各/users/trackリクエストには、attributes、events、purchasesを合わせて最大75個のオブジェクトを含めることができます。各オブジェクトは1人のユーザーを更新できます。1つのユーザープロファイルを複数のオブジェクトで更新することも可能です。
レガシーレート制限
レガシーレート制限が適用されているお客様の場合、各配列（attributes、events、purchases）にはそれぞれ最大75個のオブジェクトを独立して含めることができ、リクエストあたり最大225個のオブジェクトを合計で含めることができます。
/users/trackのレート制限の詳細については、POST：ユーザーの作成と更新を参照してください。
このエンドポイントへのリクエストは、通常以下の順序で処理が開始されます。
- 属性
- イベント
- 購入
メッセージングエンドポイントリクエストのバッチ処理
メッセージングエンドポイントへの単一のリクエストで、以下のいずれかに到達できます。
- 最大50個の特定の
external_ids（それぞれに個別のメッセージパラメーターを設定可能） - Brazeダッシュボードで作成された任意のサイズのセグメント（
segment_idで指定） - リクエスト内でコネクテッドオーディエンスオブジェクトとして定義された、任意のサイズの追加オーディエンスフィルターに一致するユーザー
バッチリクエストの例
以下の例では、external_idを使用してメールとSMSに対して1回のAPI呼び出しを行います。
curl --location --request POST 'https://rest.iad-01.braze.com/v2/subscription/status/set' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY' \
--data-raw '{
"subscription_groups":[
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"external_ids":["example-user","[email protected]"]
},
{
"subscription_group_id":"subscription_group_identifier",
"subscription_state":"subscribed",
"external_ids":["example-user","[email protected]"]
}
]
}
レートリミットのモニタリング
Brazeに送信されるすべてのAPIリクエストは、レスポンスヘッダーに以下の情報を返します。
| ヘッダー名 | 説明 |
|---|---|
X-RateLimit-Limit |
指定された間隔内に行えるリクエストの最大数（レートリミット）。 |
X-RateLimit-Remaining |
現在のレートリミットウィンドウ内で残っているリクエスト数。 |
X-RateLimit-Reset |
現在のレートリミットウィンドウがリセットされる時刻（UTCエポック秒）。 |
この情報は、Brazeダッシュボードではなく、APIリクエストのレスポンスヘッダーに意図的に含まれています。これにより、APIとやり取りする際にシステムがリアルタイムで適切に対応できます。たとえば、X-RateLimit-Remainingの値が特定のしきい値を下回った場合、すべてのトランザクションメールが確実に送信されるように送信速度を落とすことが考えられます。または、値がゼロに達した場合、X-RateLimit-Resetで指定された時刻が経過するまですべての送信を一時停止することが考えられます。
HTTPヘッダーはすべて小文字で返されます。この動作は、すべてのヘッダーフィールド名を小文字にすることを義務付けるHTTP/2プロトコルに準拠しています。これは、ヘッダー名が大文字小文字を区別しないものの、さまざまな大文字表記で記述されることが一般的だったHTTP/1.Xとは異なります。
APIリミットについてご質問がある場合は、カスタマーサクセスマネージャーにお問い合わせいただくか、サポートチケットを開いてください。
エンドポイント間の最適な遅延時間
エラーを最小限に抑えるために、連続するエンドポイント呼び出しの間に5分間の遅延を設けることをお勧めします。
Braze APIに連続して呼び出しを行う際には、エンドポイント間の最適な遅延時間を理解することが重要です。エンドポイントが他のエンドポイントの正常な処理に依存している場合、早すぎる呼び出しはエラーを引き起こす可能性があります。たとえば、/user/alias/newエンドポイントを通じてユーザーにエイリアスを割り当て、その後/users/trackエンドポイントを通じてそのエイリアスを使用してカスタムイベントを送信する場合、どのくらい待つべきでしょうか。
通常の条件下では、データの結果整合性が発生するまでの時間は10〜100ミリ秒（1/10秒）です。ただし、整合性の発生により長い時間がかかる場合もあるため、エラーの可能性を最小限に抑えるために、後続の呼び出しの間に5分間の遅延を設けることをお勧めします。
ペイロードサイズ制限
Braze APIリクエストには、レート制限とは別にペイロードサイズ制限が適用されます。ほとんどのエンドポイントでは、最大4 MBのリクエストボディを受け付けます。リクエストが該当する制限を超えた場合、Brazeはエンドポイントに応じて HTTP 413 Request Entity Too Large または HTTP 400 Bad Request で拒否することがあります。
/users/track/bulk エンドポイントには2 MBのペイロード制限があり、リクエストボディがこの制限を超えた場合は HTTP 400 を返します。エンドポイントごとの制限やエラー処理の詳細については、ユーザーデータエンドポイントを参照してください。
レート制限のリセット
レート制限は、ローリングウィンドウではなく、時計の正時にリセットされます。たとえば、1時間あたり250,000リクエストが上限の場合、午後10時00分から午後10時59分の間に50,000リクエストを送信し、午後11時00分から午後11時59分の間にさらに250,000リクエストを送信できます。これは、各時間の開始時にカウンターがリセットされるためです。