Retail V2 API - Class Google::Cloud::Retail::V2::LocalInventory (v1.0.1)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::LocalInventory.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#attributes

def attributes() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}) —

    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.

#attributes=

def attributes=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}) —

    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.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Cloud::Retail::V2::CustomAttribute}) —

    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

def fulfillment_types() -> ::Array<::String>
Returns
  • (::Array<::String>) — 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.

#fulfillment_types=

def fulfillment_types=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — 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.

Returns
  • (::Array<::String>) — 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.

#place_id

def place_id() -> ::String
Returns
  • (::String) — The place ID for the current set of inventory information.

#place_id=

def place_id=(value) -> ::String
Parameter
  • value (::String) — The place ID for the current set of inventory information.
Returns
  • (::String) — The place ID for the current set of inventory information.

#price_info

def price_info() -> ::Google::Cloud::Retail::V2::PriceInfo
Returns

#price_info=

def price_info=(value) -> ::Google::Cloud::Retail::V2::PriceInfo
Parameter
Returns