Reference documentation and code samples for the Google Shopping Merchant Lfp V1 Client class LfpInventory.
Local Inventory for the merchant.
Generated from protobuf message google.shopping.merchant.lfp.v1.LfpInventory
Namespace
Google \ Shopping \ Merchant \ Lfp \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Identifier. The name for the LfpInventory
resource. Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}
↳ target_account
int|string
Required. The Merchant Center ID of the merchant to submit the inventory for.
↳ store_code
string
Required. The identifier of the merchant's store. Either the store code inserted through InsertLfpStore
or the store code in the Business Profile.
↳ offer_id
string
Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product. Note: if the merchant sells the same product new and used, they should have different IDs.
↳ region_code
↳ content_language
string
Required. The two-letter ISO 639-1 language code for the item.
↳ gtin
string
Optional. The Global Trade Item Number of the product.
↳ price
↳ availability
string
Required. Availability of the product at this store. For accepted attribute values, see the local product inventory data specification
↳ quantity
int|string
Optional. Quantity of the product available at this store. Must be greater than or equal to zero.
↳ collection_time
Google\Protobuf\Timestamp
Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.
↳ pickup_method
string
Optional. Supported pickup method for this offer. Unless the value is "not supported", this field must be submitted together with pickupSla
. For accepted attribute values, see the local product inventory data specification
.
↳ pickup_sla
string
Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with pickupMethod
. For accepted attribute values, see the local product inventory data specification
.
↳ feed_label
string
Optional. The feed label
for the product. If this is not set, it will default to regionCode
.
getName
Output only. Identifier. The name for the LfpInventory
resource.
Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}
string
setName
Output only. Identifier. The name for the LfpInventory
resource.
Format: accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}
var
string
$this
getTargetAccount
Required. The Merchant Center ID of the merchant to submit the inventory for.
int|string
setTargetAccount
Required. The Merchant Center ID of the merchant to submit the inventory for.
var
int|string
$this
getStoreCode
Required. The identifier of the merchant's store. Either the store code
inserted through InsertLfpStore
or the store code in the Business
Profile.
string
setStoreCode
Required. The identifier of the merchant's store. Either the store code
inserted through InsertLfpStore
or the store code in the Business
Profile.
var
string
$this
getOfferId
Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.
Note: if the merchant sells the same product new and used, they should have different IDs.
string
setOfferId
Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product.
Note: if the merchant sells the same product new and used, they should have different IDs.
var
string
$this
getRegionCode
Required. The CLDR territory code for the country where the product is sold.
string
setRegionCode
Required. The CLDR territory code for the country where the product is sold.
var
string
$this
getContentLanguage
Required. The two-letter ISO 639-1 language code for the item.
string
setContentLanguage
Required. The two-letter ISO 639-1 language code for the item.
var
string
$this
getGtin
Optional. The Global Trade Item Number of the product.
string
hasGtin
clearGtin
setGtin
Optional. The Global Trade Item Number of the product.
var
string
$this
getPrice
Optional. The current price of the product.
hasPrice
clearPrice
setPrice
Optional. The current price of the product.
$this
getAvailability
Required. Availability of the product at this store.
For accepted attribute values, see the local product inventory data specification
string
setAvailability
Required. Availability of the product at this store.
For accepted attribute values, see the local product inventory data specification
var
string
$this
getQuantity
Optional. Quantity of the product available at this store. Must be greater than or equal to zero.
int|string
hasQuantity
clearQuantity
setQuantity
Optional. Quantity of the product available at this store. Must be greater than or equal to zero.
var
int|string
$this
getCollectionTime
Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.
hasCollectionTime
clearCollectionTime
setCollectionTime
Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted.
$this
getPickupMethod
Optional. Supported pickup method for this offer. Unless the value is "not
supported", this field must be submitted together with pickupSla
. For
accepted attribute values, see the local product inventory data
specification
.
string
hasPickupMethod
clearPickupMethod
setPickupMethod
Optional. Supported pickup method for this offer. Unless the value is "not
supported", this field must be submitted together with pickupSla
. For
accepted attribute values, see the local product inventory data
specification
.
var
string
$this
getPickupSla
Optional. Expected date that an order will be ready for pickup relative to
the order date. Must be submitted together with pickupMethod
. For
accepted attribute values, see the local product inventory data
specification
.
string
hasPickupSla
clearPickupSla
setPickupSla
Optional. Expected date that an order will be ready for pickup relative to
the order date. Must be submitted together with pickupMethod
. For
accepted attribute values, see the local product inventory data
specification
.
var
string
$this
getFeedLabel
Optional. The feed
label
for the product. If this is not set, it will default to regionCode
.
string
hasFeedLabel
clearFeedLabel
setFeedLabel
Optional. The feed
label
for the product. If this is not set, it will default to regionCode
.
var
string
$this
