Merchant API (merchantapi:accounts_v1)

2025-08-06

70 new methods | New API

Additions

    Methods
  • merchantapi.accounts.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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/v1/accounts:createAndConfigure

      Flat Path : accounts/v1/accounts:createAndConfigure

      HTTP Method : POST

      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.

  • merchantapi.accounts.delete

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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

        force

          Description : Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers.

          Location : query

          Type : boolean

      Parameter Order : name

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

      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. 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.

  • merchantapi.accounts.patch

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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 : 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

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates an account regardless of its type: standalone, advanced account or sub-account. Executing this method requires admin access.

  • merchantapi.accounts.list

      Path : accounts/v1/accounts

      Flat Path : accounts/v1/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 `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.

          Location : query

          Type : string

        filter

          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

          Type : string

      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.listSubaccounts

      Path : accounts/v1/{+provider}:listSubaccounts

      Flat Path : accounts/v1/accounts/{accountsId}:listSubaccounts

      HTTP Method : GET

      Parameters :

        provider

          Description : Required. The aggregation service provider. Format: `accounts/{accountId}`

          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 `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.

          Location : query

          Type : string

      Parameter Order : provider

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

      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"))`

  • merchantapi.accounts.issues.list

      Path : accounts/v1/{+parent}/issues

      Flat Path : accounts/v1/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 issues 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

          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

          Type : string

      Parameter Order : parent

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

      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.

  • merchantapi.accounts.services.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/services/{servicesId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the account service to get. Format: `accounts/{account}/services/{service}`

          Pattern : ^accounts/[^/]+/services/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Retrieve an account service.

  • merchantapi.accounts.services.list

      Path : accounts/v1/{+parent}/services

      Flat Path : accounts/v1/accounts/{accountsId}/services

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent account of the account service to filter by. Format: `accounts/{account}`

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageToken

          Description : Optional. The token returned by the previous `list` request.

          Location : query

          Type : string

        pageSize

          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

          Type : integer

          Format : int32

      Parameter Order : parent

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

      Description : List account services for the specified accounts. Supports filtering.

  • merchantapi.accounts.services.propose

      Path : accounts/v1/{+parent}/services:propose

      Flat Path : accounts/v1/accounts/{accountsId}/services:propose

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The resource name of the parent account for the service. Format: `accounts/{account}`

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Propose an account service.

  • merchantapi.accounts.services.approve

      Path : accounts/v1/{+name}:approve

      Flat Path : accounts/v1/accounts/{accountsId}/services/{servicesId}:approve

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of the account service to approve. Format: `accounts/{account}/services/{service}`

          Pattern : ^accounts/[^/]+/services/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Approve an account service proposal.

  • merchantapi.accounts.services.reject

      Path : accounts/v1/{+name}:reject

      Flat Path : accounts/v1/accounts/{accountsId}/services/{servicesId}:reject

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The resource name of the account service to reject. Format: `accounts/{account}/services/{service}`

          Pattern : ^accounts/[^/]+/services/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Reject an account service (both proposed and approve services can be rejected).

  • merchantapi.accounts.relationships.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/relationships/{relationshipsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the account relationship to get. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`.

          Pattern : ^accounts/[^/]+/relationships/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Retrieve an account relationship.

  • merchantapi.accounts.relationships.patch

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/relationships/{relationshipsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`.

          Pattern : ^accounts/[^/]+/relationships/[^/]+$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `account_id_alias`

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates the account relationship. Executing this method requires admin access.

  • merchantapi.accounts.relationships.list

      Path : accounts/v1/{+parent}/relationships

      Flat Path : accounts/v1/accounts/{accountsId}/relationships

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent account of the account relationship to filter by. Format: `accounts/{account}`

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageToken

          Description : Optional. The token returned by the previous `list` request.

          Location : query

          Type : string

        pageSize

          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

          Type : integer

          Format : int32

      Parameter Order : parent

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

      Description : List account relationships for the specified account.

  • merchantapi.accounts.users.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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/v1/{+parent}/users

      Flat Path : accounts/v1/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/v1/{+name}

      Flat Path : accounts/v1/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. The user to be deleted can't be the last admin user of that account. Also a user is protected from deletion if it is managed by Business Manager"

  • merchantapi.accounts.users.patch

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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 : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `access_rights`

          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/v1/{+parent}/users

      Flat Path : accounts/v1/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.autofeedSettings.getAutofeedSettings

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/autofeedSettings

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`

          Pattern : ^accounts/[^/]+/autofeedSettings$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Retrieves the autofeed settings of an account.

  • merchantapi.accounts.autofeedSettings.updateAutofeedSettings

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/autofeedSettings

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`.

          Pattern : ^accounts/[^/]+/autofeedSettings$

          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 autofeed settings of an account.

  • merchantapi.accounts.automaticImprovements.getAutomaticImprovements

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/automaticImprovements

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the automatic improvements. Format: `accounts/{account}/automaticImprovements`

          Pattern : ^accounts/[^/]+/automaticImprovements$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Retrieves the automatic improvements of an account.

  • merchantapi.accounts.automaticImprovements.updateAutomaticImprovements

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/automaticImprovements

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the automatic improvements. Format: `accounts/{account}/automaticImprovements`.

          Pattern : ^accounts/[^/]+/automaticImprovements$

          Location : path

          Required : Yes

          Type : string

        updateMask

          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`

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates the automatic improvements of an account.

  • merchantapi.accounts.businessIdentity.getBusinessIdentity

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/businessIdentity

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`. For example, `accounts/123456/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.businessIdentity.updateBusinessIdentity

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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 : 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`

          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.businessInfo.getBusinessInfo

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/businessInfo

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`. For example, `accounts/123456/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.businessInfo.updateBusinessInfo

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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 : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `address` - `customer_service` - `korean_business_registration_number`

          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.developerRegistration.registerGcp

      Path : accounts/v1/{+name}:registerGcp

      Flat Path : accounts/v1/accounts/{accountsId}/developerRegistration:registerGcp

      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`

          Pattern : ^accounts/[^/]+/developerRegistration$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      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.

  • merchantapi.accounts.developerRegistration.getDeveloperRegistration

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/developerRegistration

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The `name` (ID) of the developer registration.

          Pattern : ^accounts/[^/]+/developerRegistration$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Retrieves a developer registration for a merchant.

  • merchantapi.accounts.developerRegistration.unregisterGcp

      Path : accounts/v1/{+name}:unregisterGcp

      Flat Path : accounts/v1/accounts/{accountsId}/developerRegistration:unregisterGcp

      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`

          Pattern : ^accounts/[^/]+/developerRegistration$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      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.

  • merchantapi.accounts.emailPreferences.getEmailPreferences

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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. 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.

  • merchantapi.accounts.emailPreferences.updateEmailPreferences

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `news_and_tips`

          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. 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.gbpAccounts.list

      Path : accounts/v1/{+parent}/gbpAccounts

      Flat Path : accounts/v1/accounts/{accountsId}/gbpAccounts

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The name of the parent resource under which the GBP accounts are listed. Format: `accounts/{account}`.

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          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.

          Location : query

          Type : integer

          Format : int32

        pageToken

          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

          Type : string

      Parameter Order : parent

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

      Description : List the GBP accounts for a given merchant.

  • merchantapi.accounts.gbpAccounts.linkGbpAccount

      Path : accounts/v1/{+parent}/gbpAccounts:linkGbpAccount

      Flat Path : accounts/v1/accounts/{accountsId}/gbpAccounts:linkGbpAccount

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The name of the parent resource to which the GBP account is linked. Format: `accounts/{account}`.

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

      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}`.

  • merchantapi.accounts.homepage.getHomepage

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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.homepage.updateHomepage

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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 : Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`

          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.homepage.claim

      Path : accounts/v1/{+name}:claim

      Flat Path : accounts/v1/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 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).

  • merchantapi.accounts.homepage.unclaim

      Path : accounts/v1/{+name}:unclaim

      Flat Path : accounts/v1/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.omnichannelSettings.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the omnichannel setting to retrieve. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`

          Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Get the omnichannel settings for a given merchant.

  • merchantapi.accounts.omnichannelSettings.list

      Path : accounts/v1/{+parent}/omnichannelSettings

      Flat Path : accounts/v1/accounts/{accountsId}/omnichannelSettings

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The parent, which owns this collection of omnichannel settings. Format: `accounts/{account}`

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          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.

          Location : query

          Type : integer

          Format : int32

        pageToken

          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.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : List all the omnichannel settings for a given merchant.

  • merchantapi.accounts.omnichannelSettings.create

      Path : accounts/v1/{+parent}/omnichannelSettings

      Flat Path : accounts/v1/accounts/{accountsId}/omnichannelSettings

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The parent resource where this omnichannel setting will be created. Format: `accounts/{account}`

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Create the omnichannel settings for a given merchant.

  • merchantapi.accounts.omnichannelSettings.patch

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the omnichannel setting. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`

          Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$

          Location : path

          Required : Yes

          Type : string

        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.

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Update the omnichannel setting for a given merchant in a given country.

  • merchantapi.accounts.omnichannelSettings.requestInventoryVerification

      Path : accounts/v1/{+name}:requestInventoryVerification

      Flat Path : accounts/v1/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}:requestInventoryVerification

      HTTP Method : POST

      Parameters :

        name

          Description : Required. The name of the omnichannel setting to request inventory verification. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`

          Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Requests inventory verification for a given merchant in a given country.

  • merchantapi.accounts.omnichannelSettings.lfpProviders.find

      Path : accounts/v1/{+parent}/lfpProviders:find

      Flat Path : accounts/v1/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/lfpProviders:find

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The name of the parent resource under which the LFP providers are found. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}`.

          Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+$

          Location : path

          Required : Yes

          Type : string

        pageSize

          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

          Format : int32

        pageToken

          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.

          Location : query

          Type : string

      Parameter Order : parent

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

      Description : Find the LFP provider candidates in a given country.

  • merchantapi.accounts.omnichannelSettings.lfpProviders.linkLfpProvider

      Path : accounts/v1/{+name}:linkLfpProvider

      Flat Path : accounts/v1/accounts/{accountsId}/omnichannelSettings/{omnichannelSettingsId}/lfpProviders/{lfpProvidersId}:linkLfpProvider

      HTTP Method : POST

      Parameters :

        name

          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.

          Pattern : ^accounts/[^/]+/omnichannelSettings/[^/]+/lfpProviders/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Link the specified merchant to a LFP provider for the specified country.

  • merchantapi.accounts.onlineReturnPolicies.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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 for a given business.

  • merchantapi.accounts.onlineReturnPolicies.list

      Path : accounts/v1/{+parent}/onlineReturnPolicies

      Flat Path : accounts/v1/accounts/{accountsId}/onlineReturnPolicies

      HTTP Method : GET

      Parameters :

        parent

          Description : Required. The Merchant Center 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 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

          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 for a given business.

  • merchantapi.accounts.onlineReturnPolicies.create

      Path : accounts/v1/{+parent}/onlineReturnPolicies

      Flat Path : accounts/v1/accounts/{accountsId}/onlineReturnPolicies

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The Merchant Center account for which the return policy will be created. Format: `accounts/{account}`

          Pattern : ^accounts/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Creates a new return policy for a given business.

  • merchantapi.accounts.onlineReturnPolicies.delete

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/onlineReturnPolicies/{onlineReturnPoliciesId}

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name of the return policy to delete. 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 : Deletes an existing return policy.

  • merchantapi.accounts.programs.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/programs/{programsId}

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the program to retrieve. Format: `accounts/{account}/programs/{program}`. For example, `accounts/123456/programs/free-listings`.

          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/v1/{+parent}/programs

      Flat Path : accounts/v1/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/v1/{+name}:enable

      Flat Path : accounts/v1/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}`. For example, `accounts/123456/programs/free-listings`.

          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.

  • merchantapi.accounts.programs.disable

      Path : accounts/v1/{+name}:disable

      Flat Path : accounts/v1/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}`. For example, `accounts/123456/programs/free-listings`.

          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.

  • merchantapi.accounts.programs.checkoutSettings.getCheckoutSettings

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/programs/{programsId}/checkoutSettings

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings`

          Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Gets `CheckoutSettings` for the given merchant. This includes information about review state, enrollment state and URL settings.

  • merchantapi.accounts.programs.checkoutSettings.create

      Path : accounts/v1/{+parent}/checkoutSettings

      Flat Path : accounts/v1/accounts/{accountsId}/programs/{programsId}/checkoutSettings

      HTTP Method : POST

      Parameters :

        parent

          Description : Required. The merchant account for which the `CheckoutSettings` will be created.

          Pattern : ^accounts/[^/]+/programs/[^/]+$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : parent

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

      Description : Creates `CheckoutSettings` for the given merchant.

  • merchantapi.accounts.programs.checkoutSettings.updateCheckoutSettings

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/programs/{programsId}/checkoutSettings

      HTTP Method : PATCH

      Parameters :

        name

          Description : Identifier. The resource name of the program configuration settings. Format: `accounts/{account}/programs/{program}/checkoutSettings`

          Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$

          Location : path

          Required : Yes

          Type : string

        updateMask

          Description : Required. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `eligible_destinations` - `uri_settings`

          Location : query

          Type : string

          Format : google-fieldmask

      Parameter Order : name

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

      Description : Updates `CheckoutSettings` for the given merchant.

  • merchantapi.accounts.programs.checkoutSettings.deleteCheckoutSettings

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/programs/{programsId}/checkoutSettings

      HTTP Method : DELETE

      Parameters :

        name

          Description : Required. The name/identifier of the merchant account. Format: `accounts/{account}/programs/{program}/checkoutSettings`

          Pattern : ^accounts/[^/]+/programs/[^/]+/checkoutSettings$

          Location : path

          Required : Yes

          Type : string

      Parameter Order : name

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

      Description : Deletes `CheckoutSettings` and unenrolls merchant from `Checkout` program.

  • merchantapi.accounts.regions.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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/v1/{+parent}/regions

      Flat Path : accounts/v1/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/v1/{+name}

      Flat Path : accounts/v1/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/v1/{+name}

      Flat Path : accounts/v1/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/v1/{+parent}/regions

      Flat Path : accounts/v1/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.getShippingSettings

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/shippingSettings

      HTTP Method : GET

      Parameters :

        name

          Description : Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsettings`

          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.shippingSettings.insert

      Path : accounts/v1/{+parent}/shippingSettings:insert

      Flat Path : accounts/v1/accounts/{accountsId}/shippingSettings:insert

      HTTP Method : POST

      Parameters :

        parent

          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}`

          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 business with the request shipping setting. Executing this method requires admin access.

  • merchantapi.accounts.termsOfServiceAgreementStates.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/accounts/{accountsId}/termsOfServiceAgreementStates/{termsOfServiceAgreementStatesId}

      HTTP Method : GET

      Parameters :

        name

          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

          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/v1/{+parent}/termsOfServiceAgreementStates:retrieveForApplication

      Flat Path : accounts/v1/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. Application terms of service covers permissions related to the usage of data provided through Merchant Center, CSS Center, Manufacturer Center, and more.

  • merchantapi.termsOfService.get

      Path : accounts/v1/{+name}

      Flat Path : accounts/v1/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/v1/termsOfService:retrieveLatest

      Flat Path : accounts/v1/termsOfService:retrieveLatest

      HTTP Method : GET

      Parameters :

        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

        kind

          Description : Required. The Kind this terms of service version applies to.

          Location : query

          Type : string

          Enum Descriptions :

        • Default value. This value is unused.
        • Merchant Center application.
        • Enum :

        • TERMS_OF_SERVICE_KIND_UNSPECIFIED
        • MERCHANT_CENTER

      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/v1/{+name}:accept

      Flat Path : accounts/v1/termsOfService/{termsOfServiceId}:accept

      HTTP Method : POST

      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. Format: `accounts/{account}`

          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.