レート制限
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は1回のAPI呼び出しでできるだけ多くのデータを取り込むことができるため、多数のAPI呼び出しを行う必要がありません。データを1回ずつ処理するよりも、バッチで処理する方がBrazeにとって効率的です。例えば、1,000件のバッチAPI呼び出しの処理は、75,000件の個別の呼び出しの処理よりもリソースが少なくて済みます。バッチ処理は、1時間あたり75,000回以上の呼び出しが必要になる可能性のあるアプリケーションにとって非常に重要です。
REST APIのレート制限の引き上げは、APIバッチ処理機能を活用しているお客様のニーズに基づいて検討されます。
ユーザーの作成および更新エンドポイントのリクエストのバッチ処理
各/users/trackリクエストには、attributes、events、purchases全体で合計最大75個のオブジェクトを含めることができます。各オブジェクトは1人のユーザーを更新できます。1つのユーザープロファイルは複数のオブジェクトで更新できます。
レガシーレート制限
レガシーレート制限が適用されるお客様の場合、各配列（attributes、events、purchases）にはそれぞれ独立して最大75個のオブジェクトを含めることができ、1リクエストあたりの合計最大数は225個になります。
/users/trackのレート制限の詳細については、POST: ユーザーの作成と更新を参照してください。
このエンドポイントへのリクエストは、一般的に次の順序で処理が開始されます。
- 属性
- イベント
- 購入
メッセージングエンドポイントリクエストのバッチ処理
メッセージングエンドポイントへの1回のリクエストで、以下のいずれかに到達できます。
- 個別のメッセージパラメーターを持つ最大50件の特定の
external_ids - Brazeダッシュボードで作成された任意のサイズのセグメント（
segment_idで指定） - リクエスト内でコネクテッドオーディエンスオブジェクトとして定義された、任意のサイズの追加オーディエンスフィルターに一致するユーザー
バッチリクエストの例
以下の例では、external_idを使用してメールとSMSに対して1回のAPI呼び出しを行います。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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リクエストを送信できます。これはカウンターが各時間の正時にリセットされるためです。