Reference documentation and code samples for the Google Cloud Retail V2 Client class LocalInventory.
The inventory information at a place (e.g. a store) identified by a place ID.
Generated from protobuf message google.cloud.retail.v2.LocalInventory
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ place_id
string
The place ID for the current set of inventory information.
↳ price_info
Google\Cloud\Retail\V2\PriceInfo
Product price and cost information. Google Merchant Center property price .
↳ attributes
array| Google\Protobuf\Internal\MapField
Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: [a-zA-Z0-9][a-zA-Z0-9_]*
. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The searchable
field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.
↳ fulfillment_types
array
Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * "pickup-in-store" * "ship-to-store" * "same-day-delivery" * "next-day-delivery" * "custom-type-1" * "custom-type-2" * "custom-type-3" * "custom-type-4" * "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
getPlaceId
The place ID for the current set of inventory information.
string
setPlaceId
The place ID for the current set of inventory information.
var
string
$this
getPriceInfo
Product price and cost information.
Google Merchant Center property price .
hasPriceInfo
clearPriceInfo
setPriceInfo
Product price and cost information.
Google Merchant Center property price .
$this
getAttributes
Additional local inventory attributes, for example, store name, promotion tags, etc.
This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:
- At most 30 attributes are allowed.
- The key must be a UTF-8 encoded string with a length limit of 32 characters.
- The key must match the pattern:
[a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS. - The attribute values must be of the same type (text or number).
- Only 1 value is allowed for each attribute.
- For text values, the length limit is 256 UTF-8 characters.
- The attribute does not support search. The
searchablefield should be unset or set to false. - The max summed total bytes of custom attribute keys and values per product is 5MiB.
setAttributes
Additional local inventory attributes, for example, store name, promotion tags, etc.
This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned:
- At most 30 attributes are allowed.
- The key must be a UTF-8 encoded string with a length limit of 32 characters.
- The key must match the pattern:
[a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS. - The attribute values must be of the same type (text or number).
- Only 1 value is allowed for each attribute.
- For text values, the length limit is 256 UTF-8 characters.
- The attribute does not support search. The
searchablefield should be unset or set to false. - The max summed total bytes of custom attribute keys and values per product is 5MiB.
$this
getFulfillmentTypes
Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.
Supported values:
- "pickup-in-store"
- "ship-to-store"
- "same-day-delivery"
- "next-day-delivery"
- "custom-type-1"
- "custom-type-2"
- "custom-type-3"
- "custom-type-4"
- "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
setFulfillmentTypes
Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI.
Supported values:
- "pickup-in-store"
- "ship-to-store"
- "same-day-delivery"
- "next-day-delivery"
- "custom-type-1"
- "custom-type-2"
- "custom-type-3"
- "custom-type-4"
- "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.
var
string[]
$this
