Merchant API . accounts . homepage

claim(name, body=None, x__xgafv=None)

Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the business is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message is returned: * PERMISSION_DENIED: User doesn't have the necessary permissions on this Merchant Center account. * FAILED_PRECONDITION: - The account is not a Merchant Center account. - Merchant Center account doesn't have a homepage. - Claiming failed (in this case the error message contains more details).

Args:
  name: string, Required. The name of the homepage to claim. Format: `accounts/{account}/homepage` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the `ClaimHomepage` method.
  "overwrite": True or False, # Optional. When set to `true`, this option removes any existing claim on the requested website from any other account to the account making the request, effectively replacing the previous claim.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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](//support.google.com/merchants/answer/176793).
  "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account.
  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}

close()

Close httplib2 connections.

getHomepage(name, x__xgafv=None)

Retrieves a store's homepage.

Args:
  name: string, Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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](//support.google.com/merchants/answer/176793).
  "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account.
  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}

unclaim(name, body=None, x__xgafv=None)

Unclaims a store's homepage. Executing this method requires admin access. This method only removes a claim made directly on the account. If the account inherits the claim from its advanced account (for example, from an advanced account that is exempted from claiming), the homepage stays claimed: the method returns a successful response and `claimed` remains `true`. If the account itself is exempted from claiming, the method returns a `FAILED_PRECONDITION` error.

Args:
  name: string, Required. The name of the homepage to unclaim. Format: `accounts/{account}/homepage` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for the `UnclaimHomepage` method.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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](//support.google.com/merchants/answer/176793).
  "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account.
  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}

updateHomepage(name, body=None, updateMask=None, x__xgafv=None)

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

Args:
  name: string, Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` (required)
  body: object, The request body.
    The object takes the form of:

{ # 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](//support.google.com/merchants/answer/176793).
  "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account.
  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}

  updateMask: string, Optional. List of fields being updated. The following fields are supported (in both `snake_case` and `lowerCamelCase`): - `uri`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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](//support.google.com/merchants/answer/176793).
  "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account.
  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
}