Retail v2 API - Class LocalInventory (2.3.0)

public sealed class LocalInventory : IMessage<LocalInventory>, IEquatable<LocalInventory>, IDeepCloneable<LocalInventory>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class LocalInventory.

The inventory information at a place (e.g. a store) identified by a place ID.

Inheritance

Object > LocalInventory

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

LocalInventory()

public LocalInventory()

LocalInventory(LocalInventory)

public LocalInventory(LocalInventory other)
Parameter
NameDescription
otherLocalInventory

Properties

Attributes

public MapField<string, CustomAttribute> Attributes { get; }

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.
Property Value
TypeDescription
MapField<System.String, CustomAttribute>

FulfillmentTypes

public RepeatedField<string> FulfillmentTypes { get; }

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.

Property Value
TypeDescription
RepeatedField<System.String>

PlaceId

public string PlaceId { get; set; }

The place ID for the current set of inventory information.

Property Value
TypeDescription
System.String

PriceInfo

public PriceInfo PriceInfo { get; set; }

Product price and cost information.

Google Merchant Center property price.

Property Value
TypeDescription
PriceInfo