Google Cloud Retail V2 Client - Class ProductDetail (1.6.4)

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

Detailed product information associated with a user event.

Generated from protobuf message google.cloud.retail.v2.ProductDetail

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ product Google\Cloud\Retail\V2\Product

Required. Product information. Required field(s): * Product.id Optional override field(s): * Product.price_info 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 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.

getProduct

Required. Product information.

Required field(s):

  • Product.id Optional override field(s):
  • Product.price_info 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
Type Description
Google\Cloud\Retail\V2\Product|null

hasProduct

clearProduct

setProduct

Required. Product information.

Required field(s):

  • Product.id Optional override field(s):
  • Product.price_info 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.
Parameter
Name Description
var Google\Cloud\Retail\V2\Product
Returns
Type Description
$this

getQuantity

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
Type Description
Google\Protobuf\Int32Value|null

hasQuantity

clearQuantity

getQuantityValue

Returns the unboxed value from getQuantity()

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
Type Description
int|null

setQuantity

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.

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setQuantityValue

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

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.

Parameter
Name Description
var int|null
Returns
Type Description
$this