Merchant API (merchantapi:accounts_v1beta)

2024-07-11

9 new methods | 9 removed methods

Additions

    Methods

  • ▼ ▲ merchantapi.accounts.businessIdentity.getBusinessIdentity

      Path: accounts/v1beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Retrieves the business identity of an account.

  • ▼ ▲ merchantapi.accounts.businessIdentity.updateBusinessIdentity

      Path: accounts/v1beta/{+name}

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

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. List of fields being updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates the business identity of an account. Executing this method requires admin access.

  • ▼ ▲ merchantapi.accounts.businessInfo.getBusinessInfo

      Path: accounts/v1beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Retrieves the business info of an account.

  • ▼ ▲ merchantapi.accounts.businessInfo.updateBusinessInfo

      Path: accounts/v1beta/{+name}

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

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. List of fields being updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates the business info of an account. Executing this method requires admin access.

  • ▼ ▲ merchantapi.accounts.emailpreferences.getEmailPreferences

      Path: accounts/v1beta/{+name}

      Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`

          Pattern: ^accounts/[^/]+/users/[^/]+/emailPreferences$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

  • ▼ ▲ merchantapi.accounts.emailpreferences.updateEmailPreferences

      Path: accounts/v1beta/{+name}

      Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.

          Pattern: ^accounts/[^/]+/users/[^/]+/emailPreferences$

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. List of fields being updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

  • ▼ ▲ merchantapi.accounts.homepage.getHomepage

      Path: accounts/v1beta/{+name}

      Flat Path: accounts/v1beta/accounts/{accountsId}/homepage

      HTTP Method: GET

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Retrieves a store's homepage.

  • ▼ ▲ merchantapi.accounts.homepage.updateHomepage

      Path: accounts/v1beta/{+name}

      Flat Path: accounts/v1beta/accounts/{accountsId}/homepage

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. List of fields being updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates a store's homepage. Executing this method requires admin access.

  • ▼ ▲ merchantapi.accounts.shippingSettings.getShippingSettings

      Path: accounts/v1beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Retrieve shipping setting information.

Deletions

    Methods

  • ▼ ▲ merchantapi.accounts.getBusinessIdentity

      Path: accounts/v1beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Retrieves the business identity of an account.

  • ▼ ▲ merchantapi.accounts.updateBusinessIdentity

      Path: accounts/v1beta/{+name}

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

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. List of fields being updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates the business identity of an account. Executing this method requires admin access.

  • ▼ ▲ merchantapi.accounts.getBusinessInfo

      Path: accounts/v1beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Retrieves the business info of an account.

  • ▼ ▲ merchantapi.accounts.updateBusinessInfo

      Path: accounts/v1beta/{+name}

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

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. List of fields being updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates the business info of an account. Executing this method requires admin access.

  • ▼ ▲ merchantapi.accounts.getHomepage

      Path: accounts/v1beta/{+name}

      Flat Path: accounts/v1beta/accounts/{accountsId}/homepage

      HTTP Method: GET

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Retrieves a store's homepage.

  • ▼ ▲ merchantapi.accounts.updateHomepage

      Path: accounts/v1beta/{+name}

      Flat Path: accounts/v1beta/accounts/{accountsId}/homepage

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. List of fields being updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates a store's homepage. Executing this method requires admin access.

  • ▼ ▲ merchantapi.accounts.getShippingSettings

      Path: accounts/v1beta/{+name}

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

      HTTP Method: GET

      Parameters:

        name

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

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Retrieve shipping setting information.

  • ▼ ▲ merchantapi.accounts.users.getEmailPreferences

      Path: accounts/v1beta/{+name}

      Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`

          Pattern: ^accounts/[^/]+/users/[^/]+/emailPreferences$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

  • ▼ ▲ merchantapi.accounts.users.updateEmailPreferences

      Path: accounts/v1beta/{+name}

      Flat Path: accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.

          Pattern: ^accounts/[^/]+/users/[^/]+/emailPreferences$

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. List of fields being updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.