REST Resource: accounts.homepage

  • The Homepage resource represents a merchant's primary online store domain within the system and can be used to unlock features requiring verification.

  • Merchants can claim and verify their homepage to prove ownership and access advanced functionalities, with further details available in the online store URL verification documentation.

  • The Homepage resource includes information like name, claim status, and URI, and supports methods to claim, retrieve, unclaim, and update the homepage.

  • This resource enables merchants to manage their online store presence and leverage verification for enhanced features within the platform.

Resource: Homepage

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

A business'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 business 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.