Google Shopping Merchant Accounts V1 Client - Class GbpAccount (1.1.0)

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

Collection of information related to a Google Business Profile (GBP) account.

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

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 GBP account. Format: accounts/{account}/gbpAccount/{gbp_account}

↳ gbp_account_id string

The id of the GBP account.

↳ type int

The type of the Business Profile.

↳ gbp_account_name string

The name of the Business Profile. For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account.

↳ listing_count int|string

Number of listings under this account.

getName

Identifier. The resource name of the GBP account. Format: accounts/{account}/gbpAccount/{gbp_account}

Returns
Type Description
string

setName

Identifier. The resource name of the GBP account. Format: accounts/{account}/gbpAccount/{gbp_account}

Parameter
Name Description
var string
Returns
Type Description
$this

getGbpAccountId

The id of the GBP account.

Returns
Type Description
string

setGbpAccountId

The id of the GBP account.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

The type of the Business Profile.

Returns
Type Description
int Enum of type Type.

setType

The type of the Business Profile.

Parameter
Name Description
var int

Enum of type Type.

Returns
Type Description
$this

getGbpAccountName

The name of the Business Profile.

For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account.

Returns
Type Description
string

setGbpAccountName

The name of the Business Profile.

For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account.

Parameter
Name Description
var string
Returns
Type Description
$this

getListingCount

Number of listings under this account.

Returns
Type Description
int|string

setListingCount

Number of listings under this account.

Parameter
Name Description
var int|string
Returns
Type Description
$this