API の使用制限

制限と割り当ては、Groups Settings API を不適切な方法で使用する自動プロセスから Google のインフラストラクチャを保護するための仕組みです。API からの過剰なリクエストは、無害な入力ミスや、不要な API 呼び出しを行う非効率的に設計されたシステムが原因で発生することがあります。原因にかかわらず、Google Workspace システムの全体的な健全性を維持するには、特定のソースからのトラフィックが一定のレベルに達したらブロックする必要があります。

API リクエストの失敗

API リクエストが失敗した場合、アプリケーションは HTTP ステータス コード レスポンスを受け取ります。HTTP ステータス コード 403 には、超過した API 割り当てを示すエラー情報が含まれています。このレスポンスにより、カスタム アプリケーションはエラーを検出し、適切なアクションを実行できます。

時間的制約のあるリクエスト

リクエストを一定期間内に完了する必要がある場合は、リクエストを並列で送信するか、Java または C# アプリケーションで複数のスレッドを使用します。たとえば、リクエストを月単位または別の期間に分割します。スレッドの場合は、10 個のスレッド(リクエストごとに 1 つのスレッド)から始めてみてください。スレッドの推奨事項にはトレードオフがあり、すべての API 状況で有用なわけではありません。リクエスト数が多すぎると、割り当てエラーが発生します。

時間ベースのエラー

時間ベースのすべてのエラー(スレッドごとに X 秒間に最大 N 個の処理)、特に 503 ステータス コード エラーの場合、コードで例外をキャッチし、指数バックオフ アルゴリズムを使用して、失敗した呼び出しを再試行する前に少し待つことをおすすめします。1 つのスレッドの Groups Settings API の例では、5 秒待ってから失敗した呼び出しを再試行します。リクエストが成功した場合は、他のスレッドでもこのパターンを繰り返します。2 番目のリクエストが成功しなかった場合、アプリケーションは呼び出しが成功するまでリクエストの頻度を減らす必要があります。たとえば、最初の 5 秒の遅延を 10 秒に増やして、失敗した呼び出しを再試行します。また、再試行の上限を決定します。たとえば、アプリケーションがユーザーにエラーを返す前に、異なる遅延時間でリクエストを 5 ~ 7 回再試行します。

割り当て

API 割り当てカテゴリ 割り当て
クエリ/日

1 日に最大 100,000 件のクエリを実行できます。この上限を超える容量が必要な場合は、Google Cloud コンソールの [割り当て] ページからリクエストを送信できます。

グループの説明、最大サイズ グループの説明は 4,096 文字以内で入力できます。
グループ名、最大サイズ グループ名は 60 文字以内で指定できます。
defaultMessageDenyNotificationText 通知テキストは 10,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 を有効にするをご覧ください。