2024-06-14
▼ ▲ merchantapi.accounts.get
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the account to retrieve. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.
▼ ▲ merchantapi.accounts.createAndConfigure
Path: accounts/v1beta/accounts:createAndConfigure
Flat Path: accounts/v1beta/accounts:createAndConfigure
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/content
Description: Creates a standalone Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.
▼ ▲ merchantapi.accounts.delete
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the account to delete. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.patch
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The resource name of the account. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. List of fields being updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.list
Path: accounts/v1beta/accounts
Flat Path: accounts/v1beta/accounts
HTTP Method: GET
Parameters:
pageSize
Description: Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
Location: query
Type: string
filter
Description: Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).
Location: query
Type: string
Scopes: https://www.googleapis.com/auth/content
Description: Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.
▼ ▲ merchantapi.accounts.listSubaccounts
Path: accounts/v1beta/{+provider}:listSubaccounts
Flat Path: accounts/v1beta/accounts/{accountsId}:listSubaccounts
HTTP Method: GET
Parameters:
provider
Description: Required. The parent account. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.
Location: query
Type: string
Parameter Order: provider
Scopes: https://www.googleapis.com/auth/content
Description: List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`
▼ ▲ merchantapi.accounts.getBusinessIdentity
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/businessIdentity
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
Pattern: ^accounts/[^/]+/businessIdentity$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves the business identity of an account.
▼ ▲ merchantapi.accounts.updateBusinessIdentity
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/businessIdentity
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
Pattern: ^accounts/[^/]+/businessIdentity$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. List of fields being updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates the business identity of an account. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.getBusinessInfo
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/businessInfo
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`
Pattern: ^accounts/[^/]+/businessInfo$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves the business info of an account.
▼ ▲ merchantapi.accounts.updateBusinessInfo
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/businessInfo
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
Pattern: ^accounts/[^/]+/businessInfo$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. List of fields being updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates the business info of an account. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.getHomepage
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/homepage
HTTP Method: GET
Parameters:
name
Description: Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`
Pattern: ^accounts/[^/]+/homepage$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves a store's homepage.
▼ ▲ merchantapi.accounts.updateHomepage
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/homepage
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
Pattern: ^accounts/[^/]+/homepage$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. List of fields being updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates a store's homepage. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.getShippingSettings
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/shippingSettings
HTTP Method: GET
Parameters:
name
Description: Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`
Pattern: ^accounts/[^/]+/shippingSettings$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieve shipping setting information.
▼ ▲ merchantapi.accounts.accounttax.get
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}
HTTP Method: GET
Parameters:
name
Description: Required. The name from which tax settings will be retrieved
Pattern: ^accounts/[^/]+/accounttax/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Returns the tax rules that match the conditions of GetAccountTaxRequest
▼ ▲ merchantapi.accounts.accounttax.list
Path: accounts/v1beta/{+parent}/accounttax
Flat Path: accounts/v1beta/accounts/{accountsId}/accounttax
HTTP Method: GET
Parameters:
parent
Description: Required. The parent, which owns this collection of account tax. Format: accounts/{account}
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: The maximum number of tax settings to return in the response, used for paging.
Location: query
Type: integer
Format: int32
pageToken
Description: The token returned by the previous request.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.
▼ ▲ merchantapi.accounts.accounttax.patch
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The name of the tax setting. Format: "{account_tax.name=accounts/{account}}"
Pattern: ^accounts/[^/]+/accounttax/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: The list of fields to be updated
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates the tax settings of the account.
▼ ▲ merchantapi.accounts.issues.list
Path: accounts/v1beta/{+parent}/issues
Flat Path: accounts/v1beta/accounts/{accountsId}/issues
HTTP Method: GET
Parameters:
parent
Description: Required. The parent, which owns this collection of issues. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListAccountIssues` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountIssues` must match the call that provided the page token.
Location: query
Type: string
languageCode
Description: Optional. The issues in the response will have human-readable fields in the given language. The format is [BCP-47](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`. If not value is provided, `en-US` will be used.
Location: query
Type: string
timeZone.id
Description: IANA Time Zone Database time zone, e.g. "America/New_York".
Location: query
Type: string
timeZone.version
Description: Optional. IANA Time Zone Database version number, e.g. "2019a".
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Lists all account issues of a Merchant Center account.
▼ ▲ merchantapi.accounts.users.get
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the user to retrieve. Format: `accounts/{account}/users/{email}` It is also possible to retrieve the user corresponding to the caller by using `me` rather than an email address as in `accounts/{account}/users/me`.
Pattern: ^accounts/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves a Merchant Center account user.
▼ ▲ merchantapi.accounts.users.create
Path: accounts/v1beta/{+parent}/users
Flat Path: accounts/v1beta/accounts/{accountsId}/users
HTTP Method: POST
Parameters:
parent
Description: Required. The resource name of the account for which a user will be created. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
userId
Description: Required. The email address of the user (for example, `john.doe@gmail.com`).
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Creates a Merchant Center account user. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.users.delete
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the user to delete. Format: `accounts/{account}/users/{email}` It is also possible to delete the user corresponding to the caller by using `me` rather than an email address as in `accounts/{account}/users/me`.
Pattern: ^accounts/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Deletes a Merchant Center account user. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.users.patch
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`.
Pattern: ^accounts/[^/]+/users/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. List of fields being updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates a Merchant Center account user. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.users.list
Path: accounts/v1beta/{+parent}/users
Flat Path: accounts/v1beta/accounts/{accountsId}/users
HTTP Method: GET
Parameters:
parent
Description: Required. The parent, which owns this collection of users. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUsers` must match the call that provided the page token.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Lists all users of a Merchant Center account.
▼ ▲ merchantapi.accounts.users.getEmailPreferences
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences
HTTP Method: GET
Parameters:
name
Description: Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`
Pattern: ^accounts/[^/]+/users/[^/]+/emailPreferences$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
▼ ▲ merchantapi.accounts.users.updateEmailPreferences
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
Pattern: ^accounts/[^/]+/users/[^/]+/emailPreferences$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. List of fields being updated.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.
▼ ▲ merchantapi.accounts.homepage.claim
Path: accounts/v1beta/{+name}:claim
Flat Path: accounts/v1beta/accounts/{accountsId}/homepage:claim
HTTP Method: POST
Parameters:
name
Description: Required. The name of the homepage to claim. Format: `accounts/{account}/homepage`
Pattern: ^accounts/[^/]+/homepage$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details).
▼ ▲ merchantapi.accounts.homepage.unclaim
Path: accounts/v1beta/{+name}:unclaim
Flat Path: accounts/v1beta/accounts/{accountsId}/homepage:unclaim
HTTP Method: POST
Parameters:
name
Description: Required. The name of the homepage to unclaim. Format: `accounts/{account}/homepage`
Pattern: ^accounts/[^/]+/homepage$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Unclaims a store's homepage. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.onlineReturnPolicies.get
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies/{onlineReturnPoliciesId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the return policy to retrieve. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
Pattern: ^accounts/[^/]+/onlineReturnPolicies/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Gets an existing return policy.
▼ ▲ merchantapi.accounts.onlineReturnPolicies.list
Path: accounts/v1beta/{+parent}/onlineReturnPolicies
Flat Path: accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies
HTTP Method: GET
Parameters:
parent
Description: Required. The merchant account for which to list return policies. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. The maximum number of `OnlineReturnPolicy` resources to return. The service returns fewer than this value if the number of return policies for the given merchant is less that than the `pageSize`. The default value is 10. The maximum value is 100; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListOnlineReturnPolicies` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListOnlineReturnPolicies` must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Lists all existing return policies.
▼ ▲ merchantapi.accounts.programs.get
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/programs/{programsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the program to retrieve. Format: `accounts/{account}/programs/{program}`
Pattern: ^accounts/[^/]+/programs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves the specified program for the account.
▼ ▲ merchantapi.accounts.programs.list
Path: accounts/v1beta/{+parent}/programs
Flat Path: accounts/v1beta/accounts/{accountsId}/programs
HTTP Method: GET
Parameters:
parent
Description: Required. The name of the account for which to retrieve all programs. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. The maximum number of programs to return in a single response. If unspecified (or 0), a default size of 1000 is used. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A continuation token, received from a previous `ListPrograms` call. Provide this to retrieve the next page.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves all programs for the account.
▼ ▲ merchantapi.accounts.programs.enable
Path: accounts/v1beta/{+name}:enable
Flat Path: accounts/v1beta/accounts/{accountsId}/programs/{programsId}:enable
HTTP Method: POST
Parameters:
name
Description: Required. The name of the program for which to enable participation for the given account. Format: `accounts/{account}/programs/{program}`
Pattern: ^accounts/[^/]+/programs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Enable participation in the specified program for the account. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.programs.disable
Path: accounts/v1beta/{+name}:disable
Flat Path: accounts/v1beta/accounts/{accountsId}/programs/{programsId}:disable
HTTP Method: POST
Parameters:
name
Description: Required. The name of the program for which to disable participation for the given account. Format: `accounts/{account}/programs/{program}`
Pattern: ^accounts/[^/]+/programs/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Disable participation in the specified program for the account. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.regions.get
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/regions/{regionsId}
HTTP Method: GET
Parameters:
name
Description: Required. The name of the region to retrieve. Format: `accounts/{account}/regions/{region}`
Pattern: ^accounts/[^/]+/regions/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves a region defined in your Merchant Center account.
▼ ▲ merchantapi.accounts.regions.create
Path: accounts/v1beta/{+parent}/regions
Flat Path: accounts/v1beta/accounts/{accountsId}/regions
HTTP Method: POST
Parameters:
parent
Description: Required. The account to create a region for. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
regionId
Description: Required. The identifier for the region, unique over all regions of the same account.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Creates a region definition in your Merchant Center account. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.regions.patch
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/regions/{regionsId}
HTTP Method: PATCH
Parameters:
name
Description: Identifier. The resource name of the region. Format: `accounts/{account}/regions/{region}`
Pattern: ^accounts/[^/]+/regions/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Optional. The comma-separated field mask indicating the fields to update. Example: `"displayName,postalCodeArea.regionCode"`.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Updates a region definition in your Merchant Center account. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.regions.delete
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/regions/{regionsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. The name of the region to delete. Format: `accounts/{account}/regions/{region}`
Pattern: ^accounts/[^/]+/regions/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Deletes a region definition from your Merchant Center account. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.regions.list
Path: accounts/v1beta/{+parent}/regions
Flat Path: accounts/v1beta/accounts/{accountsId}/regions
HTTP Method: GET
Parameters:
parent
Description: Required. The account to list regions for. Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 regions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Lists the regions in your Merchant Center account.
▼ ▲ merchantapi.accounts.shippingSettings.insert
Path: accounts/v1beta/{+parent}/shippingSettings:insert
Flat Path: accounts/v1beta/accounts/{accountsId}/shippingSettings:insert
HTTP Method: POST
Parameters:
parent
Description: Required. The account where this product will be inserted. Format: accounts/{account}
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.termsOfServiceAgreementStates.get
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/accounts/{accountsId}/termsOfServiceAgreementStates/{termsOfServiceAgreementStatesId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`
Pattern: ^accounts/[^/]+/termsOfServiceAgreementStates/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Returns the state of a terms of service agreement.
▼ ▲ merchantapi.accounts.termsOfServiceAgreementStates.retrieveForApplication
Path: accounts/v1beta/{+parent}/termsOfServiceAgreementStates:retrieveForApplication
Flat Path: accounts/v1beta/accounts/{accountsId}/termsOfServiceAgreementStates:retrieveForApplication
HTTP Method: GET
Parameters:
parent
Description: Required. The account for which to get a TermsOfServiceAgreementState Format: `accounts/{account}`
Pattern: ^accounts/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves the state of the agreement for the application terms of service.
▼ ▲ merchantapi.termsOfService.get
Path: accounts/v1beta/{+name}
Flat Path: accounts/v1beta/termsOfService/{termsOfServiceId}
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the terms of service version. Format: `termsOfService/{version}`
Pattern: ^termsOfService/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves the `TermsOfService` associated with the provided version.
▼ ▲ merchantapi.termsOfService.retrieveLatest
Path: accounts/v1beta/termsOfService:retrieveLatest
Flat Path: accounts/v1beta/termsOfService:retrieveLatest
HTTP Method: GET
Parameters:
regionCode
Description: Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally.
Location: query
Type: string
kind
Description: The Kind this terms of service version applies to.
Location: query
Type: string
Enum Descriptions:
Enum:
Scopes: https://www.googleapis.com/auth/content
Description: Retrieves the latest version of the `TermsOfService` for a given `kind` and `region_code`.
▼ ▲ merchantapi.termsOfService.accept
Path: accounts/v1beta/{+name}:accept
Flat Path: accounts/v1beta/termsOfService/{termsOfServiceId}:accept
HTTP Method: GET
Parameters:
name
Description: Required. The resource name of the terms of service version. Format: `termsOfService/{version}`
Pattern: ^termsOfService/[^/]+$
Location: path
Required: Yes
Type: string
account
Description: Required. The account for which to accept the ToS.
Location: query
Type: string
regionCode
Description: Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally.
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/content
Description: Accepts a `TermsOfService`. Executing this method requires admin access.