REST Resource: accounts.homepage

Resource: Homepage

The Homepage message represents a merchant's store homepage within the system.

A merchant's homepage is the primary domain where customers interact with their store.

The homepage can be claimed and verified as a proof of ownership and allows the merchant to unlock features that require a verified website. For more information, see Understanding online store URL verification.

JSON representation
{
  "name": string,
  "claimed": boolean,
  "uri": string
}
Fields
name

string

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

claimed

boolean

Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.

uri

string

Required. The URI (typically a URL) of the store's homepage.

Methods

claim

Claims a store's homepage.

getHomepage

Retrieves a store's homepage.

unclaim

Unclaims a store's homepage.

updateHomepage

Updates a store's homepage.