REST Resource: accounts.businessIdentity

• Resource: BusinessIdentity
  • JSON representation
• PromotionsConsent
• IdentityAttribute
  • JSON representation
• IdentityDeclaration
• Methods

Resource: BusinessIdentity

Collection of information related to the identity of a business.

JSON representation
{ "name": string, "promotionsConsent": enum (PromotionsConsent), "blackOwned": { object (IdentityAttribute) }, "womenOwned": { object (IdentityAttribute) }, "veteranOwned": { object (IdentityAttribute) }, "latinoOwned": { object (IdentityAttribute) }, "smallBusiness": { object (IdentityAttribute) } }

Fields
name	string Identifier. The resource name of the business identity. Format: accounts/{account}/businessIdentity
promotionsConsent	enum (PromotionsConsent) Required. Whether the identity attributes may be used for promotions.
blackOwned	object (IdentityAttribute) Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to US. It is also not applicable for marketplaces or marketplace sellers.
womenOwned	object (IdentityAttribute) Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.
veteranOwned	object (IdentityAttribute) Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.
latinoOwned	object (IdentityAttribute) Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for businesses with the business country set to US. It is also not applicable for marketplaces or marketplace sellers.
smallBusiness	object (IdentityAttribute) Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for businesses with a business country set to US. It is also not applicable for marketplaces.

PromotionsConsent

All possible settings regarding promotions related to the business identity.

Enums
PROMOTIONS_CONSENT_UNSPECIFIED	Default value indicating that no selection was made.
PROMOTIONS_CONSENT_GIVEN	Indicates that the account consented to having their business identity used for promotions.
PROMOTIONS_CONSENT_DENIED	Indicates that the account did not consent to having their business identity used for promotions.

IdentityAttribute

All information related to an identity attribute.

JSON representation
{ "identityDeclaration": enum (IdentityDeclaration) }

Fields
identityDeclaration	enum (IdentityDeclaration) Required. The declaration of identity for this attribute.

IdentityDeclaration

All possible settings regarding the declaration of an identity.

Enums
IDENTITY_DECLARATION_UNSPECIFIED	Default value indicating that no selection was made.
SELF_IDENTIFIES_AS	Indicates that the account identifies with the attribute.
DOES_NOT_SELF_IDENTIFY_AS	Indicates that the account does not identify with the attribute.

Methods
getBusinessIdentity	Retrieves the business identity of an account.
updateBusinessIdentity	Updates the business identity of an account.