public interface ProductDetailOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAvailableQuantity()
public abstract int 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.
int32 available_quantity = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The availableQuantity. |
getCurrencyCode()
public abstract String getCurrencyCode()Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.
string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The currencyCode. |
getCurrencyCodeBytes()
public abstract ByteString getCurrencyCodeBytes()Optional. Currency code for price/costs. Use three-character ISO-4217 code. Required only if originalPrice or displayPrice is set.
string currency_code = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for currencyCode. |
getDisplayPrice()
public abstract float getDisplayPrice()Optional. Display price of the product (e.g. discounted price). If provided, this will override the display price in Catalog for this product.
float display_price = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The displayPrice. |
getId()
public abstract String getId()Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.
string id = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The id. |
getIdBytes()
public abstract ByteString getIdBytes()Required. Catalog item ID. UTF-8 encoded string with a length limit of 128 characters.
string id = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for id. |
getItemAttributes()
public abstract FeatureMap getItemAttributes()Optional. Extra features associated with a product in the user event.
.google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureMap |
The itemAttributes. |
getItemAttributesOrBuilder()
public abstract FeatureMapOrBuilder getItemAttributesOrBuilder()Optional. Extra features associated with a product in the user event.
.google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FeatureMapOrBuilder |
|
getOriginalPrice()
public abstract float getOriginalPrice()Optional. Original price of the product. If provided, this will override the original price in Catalog for this product.
float original_price = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
float |
The originalPrice. |
getQuantity()
public abstract int 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.
int32 quantity = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The quantity. |
getStockState()
public abstract ProductCatalogItem.StockState getStockState()Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.
.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProductCatalogItem.StockState |
The stockState. |
getStockStateValue()
public abstract int getStockStateValue()Optional. Item stock state. If provided, this overrides the stock state in Catalog for items in this event.
.google.cloud.recommendationengine.v1beta1.ProductCatalogItem.StockState stock_state = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for stockState. |
hasItemAttributes()
public abstract boolean hasItemAttributes()Optional. Extra features associated with a product in the user event.
.google.cloud.recommendationengine.v1beta1.FeatureMap item_attributes = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the itemAttributes field is set. |