Package google.shopping.merchant.quota.v1

Index

AccountLimitsService

Service to retrieve account limits.

GetAccountLimit

rpc GetAccountLimit(GetAccountLimitRequest) returns (AccountLimit)

Retrieves an account limit.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

ListAccountLimits

rpc ListAccountLimits(ListAccountLimitsRequest) returns (ListAccountLimitsResponse)

Lists the limits of an account.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.

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.

AccountLimit

A limit of a certain type that is applied to an account.

Fields
name

string

Identifier. The limit part of the name will be a combination of the type and the scope. For example: accounts/123/limits/products~ADS_NON_EEA

Format: accounts/{account}/limits/{limit}

Union field type. The type of the limit. type can be only one of the following:
products

ProductLimit

The limit for products.

GetAccountLimitRequest

Request message for the GetAccountLimit method.

Fields
name

string

Required. The name of the limit to retrieve. Format: accounts/{account}/limits/{limit} For example: accounts/123/limits/products~ADS_NON_EEA

ListAccountLimitsRequest

Request message for the ListAccountLimits method.

Fields
parent

string

Required. The parent account. Format: accounts/{account}

page_size

int32

Optional. The maximum number of limits to return. The service may return fewer than this value. If unspecified, at most 100 limits will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token

string

Optional. A page token, received from a previous ListAccountLimits call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAccountLimits must match the call that provided the page token.

filter

string

Required. A filter on the limit type is required, for example, type = "products".

ListAccountLimitsResponse

Response message for the ListAccountLimits method.

Fields
account_limits[]

AccountLimit

The limits for the given account.

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.

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

ProductLimit

The limit for products.

Fields
scope

Scope

Required. The scope of the product limit.

limit

int64

Required. The maximum number of products that are allowed in the account in the given scope.

Scope

The scope of the limit.

Enums
SCOPE_UNSPECIFIED Default value. Should not be used.
ADS_NON_EEA Limit for products in non-EEA countries.
ADS_EEA Limit for products in EEA countries.

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.