Google Shopping Merchant Accounts V1beta Client - Class BusinessIdentity (0.2.0)

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

Collection of information related to the identity of a business.

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

Namespace

Google \ Shopping \ Merchant \ Accounts \ V1beta

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` Optional. Whether the identity attributes may be used for promotions.
`↳ black_owned`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute` 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.
`↳ women_owned`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute` 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.
`↳ veteran_owned`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute` 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.
`↳ latino_owned`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute` 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.
`↳ small_business`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute` 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.

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

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

Returns
Type	Description
`int`

setPromotionsConsent

Optional. 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 merchants with a business country set to US. It is also not applicable for marketplaces or marketplace sellers.

Returns
Type	Description
`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute\|null`

hasBlackOwned

clearBlackOwned

setBlackOwned

Parameter
Name	Description
`var`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute`

Returns
Type	Description
`$this`

getWomenOwned

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.

Returns
Type	Description
`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute\|null`

hasWomenOwned

clearWomenOwned

setWomenOwned

Parameter
Name	Description
`var`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute`

Returns
Type	Description
`$this`

getVeteranOwned

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.

Returns
Type	Description
`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute\|null`

hasVeteranOwned

clearVeteranOwned

setVeteranOwned

Parameter
Name	Description
`var`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute`

Returns
Type	Description
`$this`

getLatinoOwned

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.

Returns
Type	Description
`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute\|null`

hasLatinoOwned

clearLatinoOwned

setLatinoOwned

Parameter
Name	Description
`var`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute`

Returns
Type	Description
`$this`

getSmallBusiness

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.

Returns
Type	Description
`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute\|null`

hasSmallBusiness

clearSmallBusiness

setSmallBusiness

Parameter
Name	Description
`var`	`Google\Shopping\Merchant\Accounts\V1beta\BusinessIdentity\IdentityAttribute`

Returns
Type	Description
`$this`