Package google.shopping.merchant.quota.v1beta

  • The QuotaService API allows you to retrieve method call quota information for your Merchant Center account.

  • You can use the ListQuotaGroups method to view the daily call quota and usage for each method group, including details such as quota limits and usage.

  • QuotaGroups represent a collection of methods with shared quota, providing insights into the maximum number of calls allowed per day and per minute for those methods.

  • MethodDetails provide specific information about each method within a QuotaGroup, including its name, API version, sub-API, and path.

  • The provided API endpoints and message structures enable developers to programmatically manage and monitor quota usage within their Merchant Center integrations.

Index

QuotaService

Service to get method call quota information per Merchant API method.

ListQuotaGroups

rpc ListQuotaGroups(ListQuotaGroupsRequest) returns (ListQuotaGroupsResponse)

Lists the daily call quota and usage per group for your Merchant Center account.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

ListQuotaGroupsRequest

Request message for the ListQuotaGroups method.

Fields
parent

string

Required. The merchant account who owns the collection of method quotas Format: accounts/{account}
page_size

int32

Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.
page_token

string

Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

ListQuotaGroupsResponse

Response message for the ListMethodGroups method.

Fields
quota_groups[]

QuotaGroup

The methods, current quota usage and limits per each group. The quota is shared between all methods in the group. The groups are sorted in descending order based on quota_usage.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

MethodDetails

The method details per method in the Merchant API.

Fields
method

string

Output only. The name of the method for example products.list.
version

string

Output only. The API version that the method belongs to.
subapi

string

Output only. The sub-API that the method belongs to.
path

string

Output only. The path for the method such as products/v1/productInputs.insert

QuotaGroup

The group information for methods in the Merchant API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned.

Fields
name

string

Identifier. The resource name of the quota group. Format: accounts/{account}/quotas/{group} Note: There is no guarantee on the format of {group}
quota_usage

int64

Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC.
quota_limit

int64

Output only. The maximum number of calls allowed per day for the group.
quota_minute_limit

int64

Output only. The maximum number of calls allowed per minute for the group.
method_details[]

MethodDetails

Output only. List of all methods group quota applies to.