Google Shopping Merchant Lfp V1 Client - Class LfpMerchantState (1.1.1)

Reference documentation and code samples for the Google Shopping Merchant Lfp V1 Client class LfpMerchantState.

The LFP state of a merchant.

Generated from protobuf message google.shopping.merchant.lfp.v1.LfpMerchantState

Namespace

Google \ Shopping \ Merchant \ Lfp \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The name of the `LfpMerchantState` resource. Format: `accounts/{account}/lfpMerchantStates/{target_merchant}`. For example, `accounts/123456/lfpMerchantStates/567890`.
`↳ linked_gbps`	`int\|string` Number of GBPs this merchant has access to.
`↳ store_states`	`array<LfpMerchantState\LfpStoreState>` Output only. The state per store from the specified merchant. The field will be absent if the merchant has no stores submitted through LFP.
`↳ inventory_stats`	`LfpMerchantState\InventoryStats` The inventory statistics for the merchant. The field will be absent if the merchant has no inventory submitted through LFP.
`↳ country_settings`	`array<LfpMerchantState\CountrySettings>` Country-specific settings for the merchant.

getName

Identifier. The name of the LfpMerchantState resource. Format: accounts/{account}/lfpMerchantStates/{target_merchant}. For example, accounts/123456/lfpMerchantStates/567890.

Returns
Type	Description
`string`

setName

Identifier. The name of the LfpMerchantState resource. Format: accounts/{account}/lfpMerchantStates/{target_merchant}. For example, accounts/123456/lfpMerchantStates/567890.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLinkedGbps

Number of GBPs this merchant has access to.

Returns
Type	Description
`int\|string`

setLinkedGbps

Number of GBPs this merchant has access to.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getStoreStates

Output only. The state per store from the specified merchant. The field will be absent if the merchant has no stores submitted through LFP.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setStoreStates

Output only. The state per store from the specified merchant. The field will be absent if the merchant has no stores submitted through LFP.

Parameter
Name	Description
`var`	`array<LfpMerchantState\LfpStoreState>`

Returns
Type	Description
`$this`

getInventoryStats

The inventory statistics for the merchant. The field will be absent if the merchant has no inventory submitted through LFP.

Returns
Type	Description
`LfpMerchantState\InventoryStats\|null`

hasInventoryStats

clearInventoryStats

setInventoryStats