2026-11-05
▼ ▲ merchantapi.accounts.businessIdentity.updateBusinessIdentity
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/businessIdentity$
Type : string
Description : Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
Location : path
updateMask
Location : query
Type : string
Description : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `black_owned` - `latino_owned` - `promotions_consent` - `small_business` - `veteran_owned` - `women_owned`
Format : google-fieldmask
HTTP Method : PATCH
Description : Updates the business identity of an account. Executing this method requires admin access.
Flat Path : accounts/v1beta/accounts/{accountsId}/businessIdentity
Parameter Order : name
Path : accounts/v1beta/{+name}
▼ ▲ merchantapi.accounts.businessIdentity.getBusinessIdentity
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/businessIdentity
Parameters :
name
Description : Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`. For example, `accounts/123456/businessIdentity`.
Type : string
Required : Yes
Pattern : ^accounts/[^/]+/businessIdentity$
Location : path
HTTP Method : GET
Description : Retrieves the business identity of an account.
▼ ▲ merchantapi.accounts.issues.list
Parameters :
pageSize
Description : Optional. The maximum number of issues to return. The service may return fewer than this value. If unspecified, at most 50 issues will be returned. The maximum value is 100; values above 100 will be coerced to 100
Location : query
Type : integer
Format : int32
parent
Required : Yes
Description : Required. The parent, which owns this collection of issues. Format: `accounts/{account}`
Location : path
Pattern : ^accounts/[^/]+$
Type : string
languageCode
Type : string
Location : query
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.
timeZone
Type : string
Description : Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in human-readable fields. For example 'America/Los_Angeles'. If not set, 'America/Los_Angeles' will be used.
Location : query
pageToken
Location : query
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.
Type : string
Description : Lists all account issues of a Merchant Center account. When called on a multi-client account, this method only returns issues belonging to that account, not its sub-accounts. To retrieve issues for sub-accounts, you must first call the accounts.listSubaccounts method to obtain a list of sub-accounts, and then call `accounts.issues.list` for each sub-account individually.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/content
Parameter Order : parent
Flat Path : accounts/v1beta/accounts/{accountsId}/issues
Path : accounts/v1beta/{+parent}/issues
▼ ▲ merchantapi.accounts.relationships.patch
HTTP Method : PATCH
Description : Updates the account relationship. Executing this method requires admin access.
Parameters :
name
Type : string
Description : Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`.
Required : Yes
Pattern : ^accounts/[^/]+/relationships/[^/]+$
Location : path
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_id_alias`
Parameter Order : name
Path : accounts/v1beta/{+name}
Scopes : https://www.googleapis.com/auth/content
Flat Path : accounts/v1beta/accounts/{accountsId}/relationships/{relationshipsId}
▼ ▲ merchantapi.accounts.relationships.list
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+parent}/relationships
Description : List account relationships for the specified account.
Flat Path : accounts/v1beta/accounts/{accountsId}/relationships
HTTP Method : GET
Parameters :
pageSize
Type : integer
Format : int32
Location : query
Description : Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.
pageToken
Description : Optional. The token returned by the previous `list` request.
Type : string
Location : query
parent
Type : string
Location : path
Description : Required. The parent account of the account relationship to filter by. Format: `accounts/{account}`
Pattern : ^accounts/[^/]+$
Required : Yes
Parameter Order : parent
▼ ▲ merchantapi.accounts.relationships.get
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/content
Flat Path : accounts/v1beta/accounts/{accountsId}/relationships/{relationshipsId}
Parameters :
name
Description : Required. The resource name of the account relationship to get. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`.
Required : Yes
Pattern : ^accounts/[^/]+/relationships/[^/]+$
Location : path
Type : string
Parameter Order : name
Description : Retrieve an account relationship.
Path : accounts/v1beta/{+name}
▼ ▲ merchantapi.accounts.termsOfServiceAgreementStates.get
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}/termsOfServiceAgreementStates/{termsOfServiceAgreementStatesId}
Scopes : https://www.googleapis.com/auth/content
Parameters :
name
Type : string
Required : Yes
Description : Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementStates/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}`
Pattern : ^accounts/[^/]+/termsOfServiceAgreementStates/[^/]+$
Location : path
Description : Returns the state of a terms of service agreement.
Path : accounts/v1beta/{+name}
HTTP Method : GET
▼ ▲ merchantapi.accounts.termsOfServiceAgreementStates.retrieveForApplication
Description : Retrieves the state of the agreement for the application terms of service. Application terms of service covers permissions related to the usage of data provided through Merchant Center, CSS Center, Manufacturer Center, and more.
Parameters :
parent
Required : Yes
Type : string
Description : Required. The account for which to get a TermsOfServiceAgreementState Format: `accounts/{account}`
Pattern : ^accounts/[^/]+$
Location : path
HTTP Method : GET
Path : accounts/v1beta/{+parent}/termsOfServiceAgreementStates:retrieveForApplication
Flat Path : accounts/v1beta/accounts/{accountsId}/termsOfServiceAgreementStates:retrieveForApplication
Scopes : https://www.googleapis.com/auth/content
Parameter Order : parent
▼ ▲ merchantapi.accounts.developerRegistration.getAccountForGcpRegistration
Description : Retrieves the merchant account that the calling GCP is registered with.
Flat Path : accounts/v1beta/accounts:getAccountForGcpRegistration
Path : accounts/v1beta/accounts:getAccountForGcpRegistration
Scopes : https://www.googleapis.com/auth/content
HTTP Method : GET
▼ ▲ merchantapi.accounts.developerRegistration.registerGcp
Description : Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration.
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/developerRegistration$
Location : path
Description : Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center.
Type : string
HTTP Method : POST
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}/developerRegistration:registerGcp
Path : accounts/v1beta/{+name}:registerGcp
▼ ▲ merchantapi.accounts.developerRegistration.unregisterGcp
Description : Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.
HTTP Method : POST
Parameters :
name
Description : Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration`
Type : string
Pattern : ^accounts/[^/]+/developerRegistration$
Location : path
Required : Yes
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}/developerRegistration:unregisterGcp
Path : accounts/v1beta/{+name}:unregisterGcp
▼ ▲ merchantapi.accounts.developerRegistration.getDeveloperRegistration
Description : Retrieves a developer registration for a merchant.
Flat Path : accounts/v1beta/accounts/{accountsId}/developerRegistration
Parameters :
name
Required : Yes
Type : string
Description : Required. The `name` (ID) of the developer registration.
Pattern : ^accounts/[^/]+/developerRegistration$
Location : path
Path : accounts/v1beta/{+name}
HTTP Method : GET
Parameter Order : name
▼ ▲ merchantapi.accounts.automaticImprovements.getAutomaticImprovements
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+name}
Parameter Order : name
HTTP Method : GET
Description : Retrieves the automatic improvements of an account.
Flat Path : accounts/v1beta/accounts/{accountsId}/automaticImprovements
Parameters :
name
Location : path
Type : string
Description : Required. The resource name of the automatic improvements. Format: `accounts/{account}/automaticImprovements`
Pattern : ^accounts/[^/]+/automaticImprovements$
Required : Yes
▼ ▲ merchantapi.accounts.automaticImprovements.updateAutomaticImprovements
HTTP Method : PATCH
Description : Updates the automatic improvements of an account.
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `item_updates` - `item_updates.account_level_settings` - `image_improvements` - `image_improvements.account_level_settings` - `shipping_improvements` - `shipping_improvements.allow_shipping_improvements`
name
Location : path
Pattern : ^accounts/[^/]+/automaticImprovements$
Type : string
Required : Yes
Description : Identifier. The resource name of the automatic improvements. Format: `accounts/{account}/automaticImprovements`.
Path : accounts/v1beta/{+name}
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}/automaticImprovements
▼ ▲ merchantapi.accounts.gbpAccounts.linkGbpAccount
Scopes : https://www.googleapis.com/auth/content
Description : Link the specified merchant to a GBP account for all countries. To run this method, you must have admin access to the Merchant Center account. If you don't have admin access, the request fails with the error message `User is not an administrator of account {ACCOUNT_ID}`.
Path : accounts/v1beta/{+parent}/gbpAccounts:linkGbpAccount
Flat Path : accounts/v1beta/accounts/{accountsId}/gbpAccounts:linkGbpAccount
Parameter Order : parent
Parameters :
parent
Description : Required. The name of the parent resource to which the GBP account is linked. Format: `accounts/{account}`.
Location : path
Type : string
Pattern : ^accounts/[^/]+$
Required : Yes
HTTP Method : POST
▼ ▲ merchantapi.accounts.gbpAccounts.list
Path : accounts/v1beta/{+parent}/gbpAccounts
Parameters :
parent
Location : path
Pattern : ^accounts/[^/]+$
Description : Required. The name of the parent resource under which the GBP accounts are listed. Format: `accounts/{account}`.
Required : Yes
Type : string
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. The maximum number of `GbpAccount` resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the `pageSize`. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
pageToken
Type : string
Description : Optional. A page token, received from a previous `ListGbpAccounts` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `ListGbpAccounts` must match the call that provided the page token.
Location : query
Flat Path : accounts/v1beta/accounts/{accountsId}/gbpAccounts
Description : List the GBP accounts for a given merchant.
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/content
Parameter Order : parent
▼ ▲ merchantapi.accounts.users.delete
Path : accounts/v1beta/{+name}
Parameters :
name
Location : path
Pattern : ^accounts/[^/]+/users/[^/]+$
Type : string
Required : Yes
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`.
Scopes : https://www.googleapis.com/auth/content
HTTP Method : DELETE
Parameter Order : name
Description : Deletes a Merchant Center account user. Executing this method requires admin access. The user to be deleted can't be the last admin user of that account.
Flat Path : accounts/v1beta/accounts/{accountsId}/users/{usersId}
▼ ▲ merchantapi.accounts.users.create
Flat Path : accounts/v1beta/accounts/{accountsId}/users
Path : accounts/v1beta/{+parent}/users
Scopes : https://www.googleapis.com/auth/content
Parameter Order : parent
HTTP Method : POST
Parameters :
parent
Location : path
Description : Required. The resource name of the account for which a user will be created. Format: `accounts/{account}`
Required : Yes
Type : string
Pattern : ^accounts/[^/]+$
userId
Type : string
Description : Required. The email address of the user (for example, `john.doe@gmail.com`).
Location : query
Description : Creates a Merchant Center account user. Executing this method requires admin access.
▼ ▲ merchantapi.accounts.users.get
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Description : Retrieves a Merchant Center account user.
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/users/[^/]+$
Location : path
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`.
Type : string
Path : accounts/v1beta/{+name}
HTTP Method : GET
Flat Path : accounts/v1beta/accounts/{accountsId}/users/{usersId}
▼ ▲ merchantapi.accounts.users.patch
Parameters :
name
Type : string
Location : path
Pattern : ^accounts/[^/]+/users/[^/]+$
Required : Yes
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`.
updateMask
Description : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `access_rights`
Location : query
Format : google-fieldmask
Type : string
HTTP Method : PATCH
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/users/{usersId}
Description : Updates a Merchant Center account user. Executing this method requires admin access.
Parameter Order : name
▼ ▲ merchantapi.accounts.users.list
HTTP Method : GET
Parameters :
parent
Description : Required. The parent, which owns this collection of users. Format: `accounts/{account}`
Location : path
Type : string
Pattern : ^accounts/[^/]+$
Required : Yes
pageToken
Type : string
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
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
Format : int32
Type : integer
Location : query
Path : accounts/v1beta/{+parent}/users
Description : Lists all users of a Merchant Center account.
Flat Path : accounts/v1beta/accounts/{accountsId}/users
Parameter Order : parent
▼ ▲ merchantapi.accounts.users.me.verifySelf
Description : Updates the user that is represented by the caller from pending to verified.
Path : accounts/v1beta/{+account}/users/me:verifySelf
Parameters :
account
Required : Yes
Pattern : ^accounts/[^/]+$
Description : Required. The name of the account under which the caller is a user. Format: `accounts/{account}`
Location : path
Type : string
Scopes : https://www.googleapis.com/auth/content
HTTP Method : PATCH
Flat Path : accounts/v1beta/accounts/{accountsId}/users/me:verifySelf
Parameter Order : account
▼ ▲ merchantapi.accounts.programs.list
Flat Path : accounts/v1beta/accounts/{accountsId}/programs
Parameters :
parent
Required : Yes
Description : Required. The name of the account for which to retrieve all programs. Format: `accounts/{account}`
Location : path
Type : string
Pattern : ^accounts/[^/]+$
pageToken
Description : Optional. A continuation token, received from a previous `ListPrograms` call. Provide this to retrieve the next page.
Location : query
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.
Type : integer
Location : query
Format : int32
HTTP Method : GET
Parameter Order : parent
Path : accounts/v1beta/{+parent}/programs
Scopes : https://www.googleapis.com/auth/content
Description : Retrieves all programs for the account.
▼ ▲ merchantapi.accounts.programs.disable
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/programs/[^/]+$
Location : path
Description : Required. The name of the program for which to disable participation for the given account. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`.
Type : string
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}:disable
Parameter Order : name
HTTP Method : POST
Description : Disable participation in the specified program for the account.
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+name}:disable
▼ ▲ merchantapi.accounts.programs.enable
Parameters :
name
Type : string
Location : path
Description : Required. The name of the program for which to enable participation for the given account. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`.
Required : Yes
Pattern : ^accounts/[^/]+/programs/[^/]+$
Description : Enable participation in the specified program for the account.
Scopes : https://www.googleapis.com/auth/content
HTTP Method : POST
Path : accounts/v1beta/{+name}:enable
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}:enable
Parameter Order : name
▼ ▲ merchantapi.accounts.programs.get
Scopes : https://www.googleapis.com/auth/content
HTTP Method : GET
Parameters :
name
Location : path
Pattern : ^accounts/[^/]+/programs/[^/]+$
Description : Required. The name of the program to retrieve. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`.
Required : Yes
Type : string
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}
Description : Retrieves the specified program for the account.
Path : accounts/v1beta/{+name}
▼ ▲ merchantapi.accounts.programs.checkoutSettings.create
Description : Creates `CheckoutSettings` for the given merchant.
Parameter Order : parent
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+parent}/checkoutSettings
HTTP Method : POST
Parameters :
parent
Location : path
Description : Required. The merchant account for which the `CheckoutSettings` will be created.
Pattern : ^accounts/[^/]+/programs/[^/]+$
Required : Yes
Type : string
▼ ▲ merchantapi.accounts.programs.checkoutSettings.updateCheckoutSettings
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings
HTTP Method : PATCH
Parameters :
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `uri_settings`
name
Required : Yes
Type : string
Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$
Location : path
Description : Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`
Path : accounts/v1beta/{+name}
Parameter Order : name
Description : Updates `CheckoutSettings` for the given merchant.
▼ ▲ merchantapi.accounts.programs.checkoutSettings.getCheckoutSettings
Path : accounts/v1beta/{+name}
HTTP Method : GET
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings
Description : Gets `CheckoutSettings` for the given merchant. This includes information about review state, enrollment state and URL settings.
Parameters :
name
Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$
Required : Yes
Location : path
Description : Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings`
Type : string
Scopes : https://www.googleapis.com/auth/content
Parameter Order : name
▼ ▲ merchantapi.accounts.programs.checkoutSettings.deleteCheckoutSettings
HTTP Method : DELETE
Description : Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.
Parameters :
name
Location : path
Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$
Description : Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings`
Type : string
Required : Yes
Flat Path : accounts/v1beta/accounts/{accountsId}/programs/{programsId}/checkoutSettings
Parameter Order : name
Path : accounts/v1beta/{+name}
▼ ▲ merchantapi.accounts.services.get
Parameters :
name
Location : path
Pattern : ^accounts/[^/]+/services/[^/]+$
Description : Required. The resource name of the account service to get. Format: `accounts/{account}/services/{service}`
Required : Yes
Type : string
HTTP Method : GET
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}/services/{servicesId}
Description : Retrieve an account service.
Path : accounts/v1beta/{+name}
▼ ▲ merchantapi.accounts.services.approve
Scopes : https://www.googleapis.com/auth/content
Description : Approve an account service proposal.
Parameter Order : name
HTTP Method : POST
Flat Path : accounts/v1beta/accounts/{accountsId}/services/{servicesId}:approve
Path : accounts/v1beta/{+name}:approve
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/services/[^/]+$
Type : string
Location : path
Description : Required. The resource name of the account service to approve. Format: `accounts/{account}/services/{service}`
▼ ▲ merchantapi.accounts.services.list
Scopes : https://www.googleapis.com/auth/content
Flat Path : accounts/v1beta/accounts/{accountsId}/services
HTTP Method : GET
Path : accounts/v1beta/{+parent}/services
Description : List account services for the specified accounts. Supports filtering.
Parameters :
pageToken
Description : Optional. The token returned by the previous `list` request.
Type : string
Location : query
pageSize
Format : int32
Type : integer
Description : Optional. The maximum number of elements to return in the response. Use for paging. If no `page_size` is specified, `100` is used as the default value. The maximum allowed value is `1000`.
Location : query
parent
Required : Yes
Pattern : ^accounts/[^/]+$
Description : Required. The parent account of the account service to filter by. Format: `accounts/{account}`
Location : path
Type : string
Parameter Order : parent
▼ ▲ merchantapi.accounts.services.propose
Scopes : https://www.googleapis.com/auth/content
Parameters :
parent
Location : path
Required : Yes
Pattern : ^accounts/[^/]+$
Type : string
Description : Required. The resource name of the parent account for the service. Format: `accounts/{account}`
Parameter Order : parent
HTTP Method : POST
Path : accounts/v1beta/{+parent}/services:propose
Flat Path : accounts/v1beta/accounts/{accountsId}/services:propose
Description : Propose an account service.
▼ ▲ merchantapi.accounts.services.reject
Scopes : https://www.googleapis.com/auth/content
Flat Path : accounts/v1beta/accounts/{accountsId}/services/{servicesId}:reject
Description : Reject an account service (both proposed and approve services can be rejected).
HTTP Method : POST
Parameter Order : name
Path : accounts/v1beta/{+name}:reject
Parameters :
name
Description : Required. The resource name of the account service to reject. Format: `accounts/{account}/services/{service}`
Required : Yes
Type : string
Location : path
Pattern : ^accounts/[^/]+/services/[^/]+$
▼ ▲ merchantapi.accounts.onlineReturnPolicies.patch
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The name of the `OnlineReturnPolicy` resource. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
Required : Yes
Pattern : ^accounts/[^/]+/onlineReturnPolicies/[^/]+$
Location : path
Type : string
updateMask
Format : google-fieldmask
Type : string
Description : Optional. Only support updating the entire OnlineReturnPolicy message. For update_mask, always use `*`.
Location : query
Path : accounts/v1beta/{+name}
Parameter Order : name
Description : Updates an existing return policy for a given business.
Flat Path : accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies/{onlineReturnPoliciesId}
▼ ▲ merchantapi.accounts.onlineReturnPolicies.create
Parameters :
parent
Description : Required. The Merchant Center account for which the return policy will be created. Format: `accounts/{account}`
Type : string
Location : path
Pattern : ^accounts/[^/]+$
Required : Yes
HTTP Method : POST
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+parent}/onlineReturnPolicies
Flat Path : accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies
Description : Creates a new return policy for a given business.
▼ ▲ merchantapi.accounts.onlineReturnPolicies.list
Parameter Order : parent
Description : Lists all existing return policies for a given business.
Parameters :
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
parent
Type : string
Required : Yes
Pattern : ^accounts/[^/]+$
Description : Required. The Merchant Center account for which to list return policies. Format: `accounts/{account}`
Location : path
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 business 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
Format : int32
Location : query
Type : integer
Flat Path : accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies
HTTP Method : GET
Path : accounts/v1beta/{+parent}/onlineReturnPolicies
▼ ▲ merchantapi.accounts.onlineReturnPolicies.delete
Flat Path : accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies/{onlineReturnPoliciesId}
HTTP Method : DELETE
Description : Deletes an existing return policy.
Parameters :
name
Pattern : ^accounts/[^/]+/onlineReturnPolicies/[^/]+$
Required : Yes
Description : Required. The name of the return policy to delete. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
Type : string
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+name}
▼ ▲ merchantapi.accounts.onlineReturnPolicies.get
Description : Gets an existing return policy for a given business.
HTTP Method : GET
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Pattern : ^accounts/[^/]+/onlineReturnPolicies/[^/]+$
Description : Required. The name of the return policy to retrieve. Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
Location : path
Path : accounts/v1beta/{+name}
Scopes : https://www.googleapis.com/auth/content
Flat Path : accounts/v1beta/accounts/{accountsId}/onlineReturnPolicies/{onlineReturnPoliciesId}
▼ ▲ merchantapi.accounts.omnichannelSettings.lfpProviders.linkLfpProvider
HTTP Method : POST
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/lfpProviders/{lfpProvidersId}:linkLfpProvider
Parameter Order : name
Description : Link the specified merchant to a LFP provider for the specified country.
Parameters :
name
Type : string
Location : path
Description : Required. The name of the LFP provider resource to link. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}`. The `lfp_provider` is the LFP provider ID.
Required : Yes
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+/lfpProviders/[^/]+$
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+name}:linkLfpProvider
▼ ▲ merchantapi.accounts.omnichannelSettings.lfpProviders.find
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+parent}/lfpProviders:find
Description : Find the LFP provider candidates in a given country.
Parameters :
pageToken
Type : string
Location : query
Description : Optional. A page token, received from a previous `FindLfpProviders` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `FindLfpProviders` must match the call that provided the page token.
pageSize
Format : int32
Description : Optional. The maximum number of `LfpProvider` resources to return. The service returns fewer than this value if the number of lfp providers is less that than the `pageSize`. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum.
Location : query
Type : integer
parent
Location : path
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$
Required : Yes
Description : Required. The name of the parent resource under which the LFP providers are found. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.
Type : string
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/lfpProviders:find
HTTP Method : GET
Parameter Order : parent
▼ ▲ merchantapi.accounts.omnichannelSettings.create
HTTP Method : POST
Path : accounts/v1beta/{+parent}/omnichannelSettings
Parameter Order : parent
Description : Create the omnichannel settings for a given merchant.
Parameters :
parent
Location : path
Pattern : ^accounts/[^/]+$
Type : string
Description : Required. The parent resource where this omnichannel setting will be created. Format: `accounts/{account}`
Required : Yes
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings
▼ ▲ merchantapi.accounts.omnichannelSettings.get
Parameters :
name
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$
Location : path
Description : Required. The name of the omnichannel setting to retrieve. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
Required : Yes
Type : string
HTTP Method : GET
Description : Get the omnichannel settings for a given merchant.
Scopes : https://www.googleapis.com/auth/content
Parameter Order : name
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}
▼ ▲ merchantapi.accounts.omnichannelSettings.list
Parameter Order : parent
HTTP Method : GET
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings
Path : accounts/v1beta/{+parent}/omnichannelSettings
Description : List all the omnichannel settings for a given merchant.
Parameters :
parent
Location : path
Type : string
Pattern : ^accounts/[^/]+$
Description : Required. The parent, which owns this collection of omnichannel settings. Format: `accounts/{account}`
Required : Yes
pageToken
Location : query
Description : Optional. A page token, received from a previous `ListOmnichannelSettings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListOmnichannelSettings` must match the call that provided the page token.
Type : string
pageSize
Description : Optional. The maximum number of omnichannel settings to return. The service may return fewer than this value. If unspecified, at most 50 omnichannel settings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Format : int32
Type : integer
Location : query
▼ ▲ merchantapi.accounts.omnichannelSettings.patch
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}
Path : accounts/v1beta/{+name}
Parameter Order : name
Parameters :
name
Description : Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
Location : path
Type : string
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$
Required : Yes
updateMask
Description : Required. The list of fields to be updated. The following fields are supported in snake_case only: - `lsf_type` - `in_stock` - `pickup` - `odo` - `about` - `inventory_verification` Full replacement with wildcard `*`is supported, while empty/implied update mask is not.
Format : google-fieldmask
Location : query
Type : string
Description : Update the omnichannel setting for a given merchant in a given country.
HTTP Method : PATCH
▼ ▲ merchantapi.accounts.omnichannelSettings.requestInventoryVerification
Scopes : https://www.googleapis.com/auth/content
HTTP Method : POST
Path : accounts/v1beta/{+name}:requestInventoryVerification
Flat Path : accounts/v1beta/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}:requestInventoryVerification
Parameter Order : name
Parameters :
name
Required : Yes
Description : Required. The name of the omnichannel setting to request inventory verification. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`
Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$
Type : string
Location : path
Description : Requests inventory verification for a given merchant in a given country.
▼ ▲ merchantapi.accounts.businessInfo.getBusinessInfo
Description : Retrieves the business info of an account.
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+name}
HTTP Method : GET
Parameters :
name
Pattern : ^accounts/[^/]+/businessInfo$
Location : path
Description : Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`. For example, `accounts/123456/businessInfo`.
Required : Yes
Type : string
Flat Path : accounts/v1beta/accounts/{accountsId}/businessInfo
Parameter Order : name
▼ ▲ merchantapi.accounts.businessInfo.updateBusinessInfo
Parameters :
name
Pattern : ^accounts/[^/]+/businessInfo$
Required : Yes
Type : string
Location : path
Description : Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
updateMask
Description : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `address` - `customer_service` - `korean_business_registration_number`
Format : google-fieldmask
Type : string
Location : query
Path : accounts/v1beta/{+name}
HTTP Method : PATCH
Description : Updates the business info of an account. Executing this method requires admin access.
Scopes : https://www.googleapis.com/auth/content
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}/businessInfo
▼ ▲ merchantapi.accounts.autofeedSettings.getAutofeedSettings
Parameter Order : name
Description : Retrieves the autofeed settings of an account.
Parameters :
name
Location : path
Pattern : ^accounts/[^/]+/autofeedSettings$
Type : string
Required : Yes
Description : Required. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`
Path : accounts/v1beta/{+name}
HTTP Method : GET
Flat Path : accounts/v1beta/accounts/{accountsId}/autofeedSettings
▼ ▲ merchantapi.accounts.autofeedSettings.updateAutofeedSettings
Scopes : https://www.googleapis.com/auth/content
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/autofeedSettings
Parameter Order : name
HTTP Method : PATCH
Description : Updates the autofeed settings of an account.
Parameters :
updateMask
Format : google-fieldmask
Type : string
Location : query
Description : Required. List of fields being updated.
name
Pattern : ^accounts/[^/]+/autofeedSettings$
Required : Yes
Description : Identifier. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`.
Location : path
Type : string
▼ ▲ merchantapi.accounts.emailPreferences.getEmailPreferences
HTTP Method : GET
Description : Returns the email preferences for a Merchant Center account user. This service only permits retrieving and updating email preferences for the authenticated user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
Path : accounts/v1beta/{+name}
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/users/[^/]+/emailPreferences$
Description : Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`
Location : path
Type : string
▼ ▲ merchantapi.accounts.emailPreferences.updateEmailPreferences
Scopes : https://www.googleapis.com/auth/content
Flat Path : accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences
Parameters :
updateMask
Type : string
Description : Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `news_and_tips`
Location : query
Format : google-fieldmask
name
Type : string
Location : path
Description : Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
Pattern : ^accounts/[^/]+/users/[^/]+/emailPreferences$
Required : Yes
HTTP Method : PATCH
Path : accounts/v1beta/{+name}
Parameter Order : name
Description : Updates the email preferences for a Merchant Center account user. Advanced account users should specify the advanced account rather than a sub-account of the advanced account. 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.shippingSettings.insert
Parameter Order : parent
Flat Path : accounts/v1beta/accounts/{accountsId}/shippingSettings:insert
Description : Replace the shipping setting of a business with the request shipping setting. Executing this method requires admin access.
Path : accounts/v1beta/{+parent}/shippingSettings:insert
Parameters :
parent
Type : string
Location : path
Pattern : ^accounts/[^/]+$
Required : Yes
Description : Required. The account for which this shipping setting will be inserted. If you are using an advanced account, you must specify the unique identifier of the sub-account for which you want to insert the shipping setting. Format: `accounts/{ACCOUNT_ID}`
HTTP Method : POST
▼ ▲ merchantapi.accounts.shippingSettings.getShippingSettings
Path : accounts/v1beta/{+name}
Description : Retrieve shipping setting information.
Flat Path : accounts/v1beta/accounts/{accountsId}/shippingSettings
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/shippingSettings$
Description : Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsettings`
Type : string
Location : path
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
HTTP Method : GET
▼ ▲ merchantapi.accounts.regions.delete
Flat Path : accounts/v1beta/accounts/{accountsId}/regions/{regionsId}
Parameter Order : name
Scopes : https://www.googleapis.com/auth/content
Parameters :
name
Description : Required. The name of the region to delete. Format: `accounts/{account}/regions/{region}`
Required : Yes
Type : string
Location : path
Pattern : ^accounts/[^/]+/regions/[^/]+$
Description : Deletes a region definition from your Merchant Center account. Executing this method requires admin access.
Path : accounts/v1beta/{+name}
HTTP Method : DELETE
▼ ▲ merchantapi.accounts.regions.get
Description : Retrieves a region defined in your Merchant Center account.
HTTP Method : GET
Flat Path : accounts/v1beta/accounts/{accountsId}/regions/{regionsId}
Path : accounts/v1beta/{+name}
Parameters :
name
Pattern : ^accounts/[^/]+/regions/[^/]+$
Location : path
Required : Yes
Type : string
Description : Required. The name of the region to retrieve. Format: `accounts/{account}/regions/{region}`
Scopes : https://www.googleapis.com/auth/content
Parameter Order : name
▼ ▲ merchantapi.accounts.regions.create
Parameters :
regionId
Type : string
Description : Required. The identifier for the region, unique over all regions of the same account.
Location : query
parent
Pattern : ^accounts/[^/]+$
Type : string
Location : path
Description : Required. The account to create a region for. Format: `accounts/{account}`
Required : Yes
HTTP Method : POST
Path : accounts/v1beta/{+parent}/regions
Flat Path : accounts/v1beta/accounts/{accountsId}/regions
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
Parameters :
updateMask
Description : Optional. The comma-separated field mask indicating the fields to update. Example: `"displayName,postalCodeArea.regionCode"`.
Type : string
Location : query
Format : google-fieldmask
name
Type : string
Required : Yes
Pattern : ^accounts/[^/]+/regions/[^/]+$
Description : Identifier. The resource name of the region. Format: `accounts/{account}/regions/{region}`
Location : path
HTTP Method : PATCH
Description : Updates a region definition in your Merchant Center account. Executing this method requires admin access.
Path : accounts/v1beta/{+name}
Flat Path : accounts/v1beta/accounts/{accountsId}/regions/{regionsId}
Scopes : https://www.googleapis.com/auth/content
Parameter Order : name
▼ ▲ merchantapi.accounts.regions.list
Parameters :
pageToken
Type : string
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
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.
Type : integer
Format : int32
Location : query
parent
Pattern : ^accounts/[^/]+$
Location : path
Description : Required. The account to list regions for. Format: `accounts/{account}`
Required : Yes
Type : string
Scopes : https://www.googleapis.com/auth/content
Parameter Order : parent
HTTP Method : GET
Flat Path : accounts/v1beta/accounts/{accountsId}/regions
Path : accounts/v1beta/{+parent}/regions
Description : Lists the regions in your Merchant Center account.
▼ ▲ merchantapi.accounts.homepage.unclaim
Parameter Order : name
Path : accounts/v1beta/{+name}:unclaim
Flat Path : accounts/v1beta/accounts/{accountsId}/homepage:unclaim
Description : Unclaims a store's homepage. Executing this method requires admin access. This method only removes a claim made directly on the account. If the account inherits the claim from its advanced account (for example, from an advanced account that is exempted from claiming), the homepage stays claimed: the method returns a successful response and `claimed` remains `true`. If the account itself is exempted from claiming, the method returns a `FAILED_PRECONDITION` error.
HTTP Method : POST
Parameters :
name
Description : Required. The name of the homepage to unclaim. Format: `accounts/{account}/homepage`
Location : path
Pattern : ^accounts/[^/]+/homepage$
Type : string
Required : Yes
▼ ▲ merchantapi.accounts.homepage.updateHomepage
Description : Updates a store's homepage. Executing this method requires admin access.
Scopes : https://www.googleapis.com/auth/content
Flat Path : accounts/v1beta/accounts/{accountsId}/homepage
HTTP Method : PATCH
Path : accounts/v1beta/{+name}
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/homepage$
Description : Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
Location : path
Type : string
updateMask
Format : google-fieldmask
Type : string
Description : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`
Location : query
Parameter Order : name
▼ ▲ merchantapi.accounts.homepage.claim
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 business 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 is returned: * PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account. * FAILED_PRECONDITION: - The account is not a Merchant Center account. - Merchant Center account doesn't have a homepage. - Claiming failed (in this case the error message contains more details).
Flat Path : accounts/v1beta/accounts/{accountsId}/homepage:claim
Path : accounts/v1beta/{+name}:claim
Parameter Order : name
HTTP Method : POST
Parameters :
name
Location : path
Pattern : ^accounts/[^/]+/homepage$
Required : Yes
Description : Required. The name of the homepage to claim. Format: `accounts/{account}/homepage`
Type : string
▼ ▲ merchantapi.accounts.homepage.getHomepage
HTTP Method : GET
Parameter Order : name
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+/homepage$
Type : string
Location : path
Description : Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`
Flat Path : accounts/v1beta/accounts/{accountsId}/homepage
Description : Retrieves a store's homepage.
Path : accounts/v1beta/{+name}
▼ ▲ merchantapi.accounts.list
Flat Path : accounts/v1beta/accounts
Parameters :
filter
Type : string
Description : Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax).
Location : query
pageSize
Type : integer
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
Format : int32
pageToken
Location : query
Description : Optional. A page token, received from a previous `accounts.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided in the `accounts.list` request must match the call that provided the page token.
Type : string
Path : accounts/v1beta/accounts
HTTP Method : GET
Scopes : https://www.googleapis.com/auth/content
Description : Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.
▼ ▲ merchantapi.accounts.patch
Description : Updates an account regardless of its type: standalone, advanced account or sub-account. Executing this method requires admin access.
Parameter Order : name
Path : accounts/v1beta/{+name}
Scopes : https://www.googleapis.com/auth/content
HTTP Method : PATCH
Flat Path : accounts/v1beta/accounts/{accountsId}
Parameters :
updateMask
Format : google-fieldmask
Type : string
Description : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_name` - `adult_content` - `language_code` - `time_zone`
Location : query
name
Type : string
Location : path
Description : Identifier. The resource name of the account. Format: `accounts/{account}`
Pattern : ^accounts/[^/]+$
Required : Yes
▼ ▲ merchantapi.accounts.createAndConfigure
Path : accounts/v1beta/accounts:createAndConfigure
Scopes : https://www.googleapis.com/auth/content
Description : Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.
HTTP Method : POST
Flat Path : accounts/v1beta/accounts:createAndConfigure
▼ ▲ merchantapi.accounts.createTestAccount
Parameters :
parent
Type : string
Required : Yes
Pattern : ^accounts/[^/]+$
Description : Required. The account resource name to create the test account under. Format: accounts/{account}
Location : path
Scopes : https://www.googleapis.com/auth/content
HTTP Method : POST
Parameter Order : parent
Flat Path : accounts/v1beta/accounts/{accountsId}:createTestAccount
Description : Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic.
Path : accounts/v1beta/{+parent}:createTestAccount
▼ ▲ merchantapi.accounts.get
HTTP Method : GET
Path : accounts/v1beta/{+name}
Parameters :
name
Required : Yes
Pattern : ^accounts/[^/]+$
Type : string
Location : path
Description : Required. The name of the account to retrieve. Format: `accounts/{account}`
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.
Parameter Order : name
Flat Path : accounts/v1beta/accounts/{accountsId}
▼ ▲ merchantapi.accounts.delete
Scopes : https://www.googleapis.com/auth/content
Flat Path : accounts/v1beta/accounts/{accountsId}
Parameters :
force
Location : query
Description : Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers.
Type : boolean
name
Type : string
Location : path
Pattern : ^accounts/[^/]+$
Required : Yes
Description : Required. The name of the account to delete. Format: `accounts/{account}`
Path : accounts/v1beta/{+name}
Parameter Order : name
Description : Deletes the specified account regardless of its type: standalone, advanced account or sub-account. Deleting an advanced account leads to the deletion of all of its sub-accounts. This also deletes the account's [developer registration entity](/merchant/api/reference/rest/accounts_v1beta/accounts.developerRegistration) and any associated GCP project to the account. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the `force` parameter to override this.
HTTP Method : DELETE
▼ ▲ merchantapi.accounts.listSubaccounts
Description : List all sub-accounts for a given advanced account. This is a convenience wrapper for the more powerful `accounts.list` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`
Scopes : https://www.googleapis.com/auth/content
Parameter Order : provider
Flat Path : accounts/v1beta/accounts/{accountsId}:listSubaccounts
Path : accounts/v1beta/{+provider}:listSubaccounts
HTTP Method : GET
Parameters :
pageToken
Description : Optional. A page token, received from a previous `accounts.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided in the `accounts.list` request must match the call that provided the page token.
Type : string
Location : query
provider
Description : Required. The aggregation service provider. Format: `accounts/{accountId}`
Type : string
Required : Yes
Pattern : ^accounts/[^/]+$
Location : path
pageSize
Type : integer
Format : int32
Location : query
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.
▼ ▲ merchantapi.termsOfService.accept
Parameter Order : name
Path : accounts/v1beta/{+name}:accept
Description : Accepts a `TermsOfService`. Executing this method requires admin access.
Flat Path : accounts/v1beta/termsOfService/{termsOfServiceId}:accept
HTTP Method : POST
Parameters :
regionCode
Type : string
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
account
Location : query
Description : Required. The account for which to accept the ToS. Format: `accounts/{account}`
Type : string
name
Type : string
Location : path
Description : Required. The resource name of the terms of service version. Format: `termsOfService/{version}`
Pattern : ^termsOfService/[^/]+$
Required : Yes
▼ ▲ merchantapi.termsOfService.retrieveLatest
Path : accounts/v1beta/termsOfService:retrieveLatest
Scopes : https://www.googleapis.com/auth/content
HTTP Method : GET
Flat Path : accounts/v1beta/termsOfService:retrieveLatest
Description : Retrieves the latest version of the `TermsOfService` for a given `kind` and `region_code`.
Parameters :
kind
Location : query
Type : string
Description : Required. The Kind this terms of service version applies to.
Enum :
Enum Descriptions :
regionCode
Type : string
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
▼ ▲ merchantapi.termsOfService.get
HTTP Method : GET
Flat Path : accounts/v1beta/termsOfService/{termsOfServiceId}
Parameters :
name
Description : Required. The resource name of the terms of service version. Format: `termsOfService/{version}`
Location : path
Pattern : ^termsOfService/[^/]+$
Type : string
Required : Yes
Path : accounts/v1beta/{+name}
Description : Retrieves the `TermsOfService` associated with the provided version.
Parameter Order : name