Retail V2 API - Class Google::Cloud::Retail::V2::ProductDetail (v0.16.1)

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

Detailed product information associated with a user event.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#product

def product() -> ::Google::Cloud::Retail::V2::Product
Returns
  • (::Google::Cloud::Retail::V2::Product) — Required. Product information.

    Required field(s):

    Optional override field(s):

    If any supported optional fields are provided, we will treat them as a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete.

    All other product fields are ignored and instead populated via catalog lookup after event ingestion.

#product=

def product=(value) -> ::Google::Cloud::Retail::V2::Product
Parameter
  • value (::Google::Cloud::Retail::V2::Product) — Required. Product information.

    Required field(s):

    Optional override field(s):

    If any supported optional fields are provided, we will treat them as a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete.

    All other product fields are ignored and instead populated via catalog lookup after event ingestion.

Returns
  • (::Google::Cloud::Retail::V2::Product) — Required. Product information.

    Required field(s):

    Optional override field(s):

    If any supported optional fields are provided, we will treat them as a full override when looking up product information from the catalog. Thus, it is important to ensure that the overriding fields are accurate and complete.

    All other product fields are ignored and instead populated via catalog lookup after event ingestion.

#quantity

def quantity() -> ::Google::Protobuf::Int32Value
Returns
  • (::Google::Protobuf::Int32Value) — Quantity of the product associated with the user event.

    For example, this field will be 2 if two products are added to the shopping cart for purchase-complete event. Required for add-to-cart and purchase-complete event types.

#quantity=

def quantity=(value) -> ::Google::Protobuf::Int32Value
Parameter
  • value (::Google::Protobuf::Int32Value) — Quantity of the product associated with the user event.

    For example, this field will be 2 if two products are added to the shopping cart for purchase-complete event. Required for add-to-cart and purchase-complete event types.

Returns
  • (::Google::Protobuf::Int32Value) — Quantity of the product associated with the user event.

    For example, this field will be 2 if two products are added to the shopping cart for purchase-complete event. Required for add-to-cart and purchase-complete event types.