Method: accounts.homepage.updateHomepage

  • This operation updates a store's homepage and requires admin access.

  • The request uses the PATCH method and requires specifying the homepage's resource name in the URL path.

  • You can optionally use the updateMask query parameter to specify which fields to update within the homepage.

  • The request body should contain a Homepage object with the desired updates, and a successful response will also return a Homepage object.

  • Authorization requires the https://www.googleapis.com/auth/content OAuth scope.

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

HTTP request

PATCH https://merchantapi.googleapis.com/accounts/v1beta/{homepage.name=accounts/*/homepage}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
homepage.name

string

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

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. List of fields being updated.

The following fields are supported (in both snake_case and lowerCamelCase):

  • uri

Request body

The request body contains an instance of Homepage.

Response body

If successful, the response body contains an instance of Homepage.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.