API Usage Limits

Limits and quotas protect the Google infrastructure from an automated process that uses the Groups Settings API in an inappropriate way. Excessive requests from an API might result from a harmless typo, or may result from an inefficiently designed system that makes needless API calls. Regardless of the cause, blocking traffic from a specific source once it reaches a certain level is necessary for the overall health of the Google Workspace system. It ensures that one developer's actions cannot negatively impact the larger community.

In the unlikely event that your API request fails, your application receives an HTTP status code response. An HTTP status code of 403 has error information indicating which API quotas have been exceeded. The response allows your custom application to detect errors and take appropriate action.

If your requests need to be completed in a fixed period of time, send your requests in parallel or use multiple threads in your Java or C# application. For example, break your requests by month or another time period. In the case of threads, try starting with 10 threads, one thread per request. Note, the thread recommendation has tradeoffs and is not useful for all API situations. If the number of requests gets too high, quota errors will occur.

For all errors that are time based (maximum of N things for X seconds per thread), especially the 503 status code errors, we recommend your code catch the exception and, using an exponential backoff algorithm, wait for a small delay before retrying the failed call. A Groups Settings API example for one thread is to wait 5 seconds and retry the failed call. If the request is successful, repeat this pattern for the other threads. If the second request is not successful, your application should scale back on the frequency of the request until a call is successful. For example, increase the initial 5 second delay to 10 seconds and retry your failed call again. Also, decide on a retry limit. For example retry a request 5 to 7 times with different delay times before your application returns an error to the user.

API Quota Categories Quotas
Queries per day

The Groups Settings API has a courtesy limit of 100,000 queries per day. If you need capacity beyond this courtesy limit, you can send a request from the Quotas pane of the Google APIs Console.

Group description, maximum size This property value may be an empty string if no group description has been entered. If entered, the maximum group description is no more than 300 characters.
Group name, maximum size
A group's name has a maximum of 60 characters.
defaultMessageDenyNotificationText The maximum size of the notification text is 10,000 characters. To learn more about the defaultMessageDenyNotificationText property, see the API Reference.
maxMessageBytes The default maximum message size is 1Mb. To learn more about the maxMessageBytes property, see the API Reference.
Other Types of Limits Limitations and Guidelines
Data format, default
The default data format is JSON. The API also supports the Atom format. Both the JSON and Atom data formats support full read-write capabilities.
Groups Settings API, enablement The Directory API has to be enabled before making calls to the Groups Settings API. In your control panel, go to the Users and groups tab's Settings page and enable the Directory API. Save your changes. For the complete API enablement steps, see Prerequisites.