Google Shopping Merchant Accounts V1 Client - Class BusinessIdentity (1.0.0)

Reference documentation and code samples for the Google Shopping Merchant Accounts V1 Client class BusinessIdentity.

Collection of information related to the identity of a business .

Generated from protobuf message google.shopping.merchant.accounts.v1.BusinessIdentity

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The resource name of the business identity. Format: accounts/{account}/businessIdentity

↳ promotions_consent
int

Required. Whether the identity attributes may be used for promotions.

↳ black_owned
BusinessIdentity\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.

↳ women_owned
BusinessIdentity\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.

↳ veteran_owned
BusinessIdentity\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.

↳ latino_owned
BusinessIdentity\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.

↳ small_business
BusinessIdentity\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.

getName

Identifier. The resource name of the business identity.

Format: accounts/{account}/businessIdentity

Returns
Type
Description
string

setName

Identifier. The resource name of the business identity.

Format: accounts/{account}/businessIdentity

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPromotionsConsent

Required. Whether the identity attributes may be used for promotions.

Returns
Type
Description
int

setPromotionsConsent

Required. Whether the identity attributes may be used for promotions.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getBlackOwned

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.

Returns
Type
Description

hasBlackOwned

clearBlackOwned

setBlackOwned

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.

Parameter
Name
Description
Returns
Type
Description
$this

getWomenOwned

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.

Returns
Type
Description

hasWomenOwned

clearWomenOwned

setWomenOwned

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.

Parameter
Name
Description
Returns
Type
Description
$this

getVeteranOwned

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.

Returns
Type
Description

hasVeteranOwned

clearVeteranOwned

setVeteranOwned

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.

Parameter
Name
Description
Returns
Type
Description
$this

getLatinoOwned

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.

Returns
Type
Description

hasLatinoOwned

clearLatinoOwned

setLatinoOwned

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.

Parameter
Name
Description
Returns
Type
Description
$this

getSmallBusiness

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.

Returns
Type
Description

hasSmallBusiness

clearSmallBusiness

setSmallBusiness

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.

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: