Method: accounts.homepage.updateHomepage
Stay organized with collections
Save and categorize content based on your preferences.
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):
|
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-25 UTC.
[null,null,["Last updated 2025-02-25 UTC."],[[["\u003cp\u003eThis operation updates a store's homepage and requires admin access.\u003c/p\u003e\n"],["\u003cp\u003eThe request uses the \u003ccode\u003ePATCH\u003c/code\u003e method and requires specifying the homepage's resource name in the URL path.\u003c/p\u003e\n"],["\u003cp\u003eYou can optionally use the \u003ccode\u003eupdateMask\u003c/code\u003e query parameter to specify which fields to update within the homepage.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should contain a \u003ccode\u003eHomepage\u003c/code\u003e object with the desired updates, and a successful response will also return a \u003ccode\u003eHomepage\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This describes updating a store's homepage via a PATCH request to a specific URL: `https://merchantapi.googleapis.com/accounts/v1beta/{homepage.name=accounts/*/homepage}`. The `homepage.name` path parameter is required, formatted as `accounts/{account}/homepage`. An optional `updateMask` query parameter specifies fields to update. The request and response bodies are `Homepage` instances. Admin access and the `https://www.googleapis.com/auth/content` OAuth scope are required. The method utilizes gRPC Transcoding.\n"],null,["# Method: accounts.homepage.updateHomepage\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates a store's homepage. Executing this method requires admin access.\n\n### HTTP request\n\n`PATCH https://merchantapi.googleapis.com/accounts/v1beta/{homepage.name=accounts/*/homepage}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------------|-------------------------------------------------------------------------------------------------------|\n| `homepage.name` | `string` Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` |\n\n### Query parameters\n\n| Parameters ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` format)` Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri` |\n\n### Request body\n\nThe request body contains an instance of [Homepage](/merchant/api/reference/rest/accounts_v1beta/accounts.homepage#Homepage).\n\n### Response body\n\nIf successful, the response body contains an instance of [Homepage](/merchant/api/reference/rest/accounts_v1beta/accounts.homepage#Homepage).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
