Merchant API . accounts . businessIdentity

close()

Close httplib2 connections.

getBusinessIdentity(name, x__xgafv=None)

Retrieves the business identity of an account.

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

Returns:
  An object of the form:

    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
  "promotionsConsent": "A String", # Required. Whether the identity attributes may be used for promotions.
  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
}

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

Updates the business identity of an account. Executing this method requires admin access.

Args:
  name: string, Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
  body: object, The request body.
    The object takes the form of:

{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
  "promotionsConsent": "A String", # Required. Whether the identity attributes may be used for promotions.
  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
}

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

Returns:
  An object of the form:

    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
  "promotionsConsent": "A String", # Required. Whether the identity attributes may be used for promotions.
  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
  },
}