Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class ProductDetail.
Detailed product information associated with a user event.
Generated from protobuf message google.cloud.recommendationengine.v1beta1.ProductDetail
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters. |
↳ currency_code |
string
Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set. |
↳ original_price |
float
Optional. Original price of the product. If provided, this will override the original price in Catalog for this product. |
↳ display_price |
float
Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product. |
↳ stock_state |
int
Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event. |
↳ quantity |
int
Optional. 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 |
↳ available_quantity |
int
Optional. Quantity of the products in stock when a user event happens. Optional. If provided, this overrides the available quantity in Catalog for this event. and can only be set if |
↳ item_attributes |
Google\Cloud\RecommendationEngine\V1beta1\FeatureMap
Optional. Extra features associated with a product in the user event. |
getId
Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.
| Returns | |
|---|---|
| Type | Description |
string | |
setId
Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCurrencyCode
Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.
| Returns | |
|---|---|
| Type | Description |
string | |
setCurrencyCode
Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOriginalPrice
Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.
| Returns | |
|---|---|
| Type | Description |
float | |
setOriginalPrice
Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayPrice
Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.
| Returns | |
|---|---|
| Type | Description |
float | |
setDisplayPrice
Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStockState
Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.
| Returns | |
|---|---|
| Type | Description |
int | |
setStockState
Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQuantity
Optional. 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 add-to-cart event. Required for add-to-cart, add-to-list,
remove-from-cart, checkout-start, purchase-complete, refund event
types.
| Returns | |
|---|---|
| Type | Description |
int | |
setQuantity
Optional. 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 add-to-cart event. Required for add-to-cart, add-to-list,
remove-from-cart, checkout-start, purchase-complete, refund event
types.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAvailableQuantity
Optional. Quantity of the products in stock when a user event happens.
Optional. If provided, this overrides the available quantity in Catalog for
this event. and can only be set if stock_status is set to IN_STOCK.
Note that if an item is out of stock, you must set the stock_state field
to be OUT_OF_STOCK. Leaving this field unspecified / as zero is not
sufficient to mark the item out of stock.
| Returns | |
|---|---|
| Type | Description |
int | |
setAvailableQuantity
Optional. Quantity of the products in stock when a user event happens.
Optional. If provided, this overrides the available quantity in Catalog for
this event. and can only be set if stock_status is set to IN_STOCK.
Note that if an item is out of stock, you must set the stock_state field
to be OUT_OF_STOCK. Leaving this field unspecified / as zero is not
sufficient to mark the item out of stock.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getItemAttributes
Optional. Extra features associated with a product in the user event.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\RecommendationEngine\V1beta1\FeatureMap|null | |
hasItemAttributes
clearItemAttributes
setItemAttributes
Optional. Extra features associated with a product in the user event.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\RecommendationEngine\V1beta1\FeatureMap
|
| Returns | |
|---|---|
| Type | Description |
$this | |