制限と割り当てにより、Groups Settings API を不適切な方法で使用する自動プロセスから Google インフラストラクチャが保護されます。API からの過剰なリクエストは、無害なタイプミスや、不必要な API 呼び出しを行う非効率的な設計のシステムが原因で発生する可能性があります。原因に関係なく、Google Workspace システム全体の健全性のために、特定のレベルに達した特定のソースからのトラフィックをブロックする必要があります。
API リクエストの失敗
万が一 API リクエストが失敗すると、アプリケーションは HTTP ステータス コード レスポンスを受信します。HTTP ステータス コード 403 には、どの API 割り当てを超過したかを示すエラー情報が含まれています。レスポンスにより、カスタム アプリケーションはエラーを検出し、適切な措置を講じることができます。
時間的制約のあるリクエスト
リクエストを一定の時間内に完了する必要がある場合は、リクエストを並行して送信するか、Java または C# アプリケーションで複数のスレッドを使用します。たとえば、月または別の期間でリクエストを分割します。スレッドの場合は、10 スレッド（リクエストごとに 1 スレッド）から始めてください。スレッドの推奨事項にはトレードオフがあり、API のすべての状況に役立つわけではありません。リクエストの数が多すぎると、割り当てエラーが発生します。
時間ベースのエラー
時間ベースのすべてのエラー（スレッドあたり最大 N 個のエラー、特に 503 ステータス コード エラー）については、コードで例外をキャッチし、指数バックオフ アルゴリズムを使用して少し遅延してから、失敗した呼び出しを再試行することをおすすめします。1 つのスレッドでの Groups Settings API の例は、5 秒待ってから失敗した呼び出しを再試行することです。リクエストが成功したら、他のスレッドにこのパターンを繰り返します。2 番目のリクエストが成功しなかった場合、アプリケーションは呼び出しが成功するまでリクエストの頻度を縮小する必要があります。たとえば、最初の 5 秒の遅延を 10 秒に増やしてから、失敗した呼び出しを再試行します。また、再試行の上限も決定します。たとえば、遅延時間を変えてリクエストを 5 ～ 7 回再試行すると、アプリケーションがユーザーにエラーを返します。
割り当て
| API 割り当てカテゴリ | 割り当て |
|---|---|
| クエリ/日 | 1 日あたり最大 100,000 件のクエリを作成できます。この上限を超える容量が必要な場合は、Google Cloud コンソールの [割り当て] ページからリクエストを送信できます。 |
| グループの説明、最大サイズ | グループの説明は半角 300 文字（全角 150 文字）以内で指定できます。 |
| グループ名、最大サイズ | グループ名は 60 文字以内で指定してください。 |
defaultMessageDenyNotificationText |
通知テキストは半角 10,000 文字（全角 5,000 文字）以内で指定できます。defaultMessageDenyNotificationText プロパティの詳細については、API リファレンスをご覧ください。 |
maxMessageBytes |
デフォルトの最大メッセージ サイズは 1 MB です。maxMessageBytes プロパティについて詳しくは、API リファレンスをご覧ください。 |
上限
| 上限の種類 | 制限事項とガイドライン |
|---|---|
| データ形式、デフォルト |
デフォルトのデータ形式は JSON です。API は Atom 形式もサポートしています。JSON と Atom の両方のデータ形式が完全な読み取り / 書き込み機能をサポートしています。詳しくは、JSON と Atom のデータ形式をご覧ください。 |
| Groups Settings API、有効化 | Groups Settings API を呼び出す前に、Directory API を有効にする必要があります。詳しくは、Google Workspace API を有効にするをご覧ください。 |