- 0.60.0 (latest)
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.4
- 0.8.10
public interface ProductEventDetailOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCartId()
public abstract String getCartId()Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase.
This can only be set for add-to-cart, remove-from-cart,
checkout-start, purchase-complete, or shopping-cart-page-view events.
string cart_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The cartId. |
getCartIdBytes()
public abstract ByteString getCartIdBytes()Optional. The id or name of the associated shopping cart. This id is used to associate multiple items added or present in the cart before purchase.
This can only be set for add-to-cart, remove-from-cart,
checkout-start, purchase-complete, or shopping-cart-page-view events.
string cart_id = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for cartId. |
getListId()
public abstract String getListId() Required for add-to-list and remove-from-list events. The id or name of
the list that the item is being added to or removed from. Other event types
should not set this field.
string list_id = 4;
| Returns | |
|---|---|
| Type | Description |
String | The listId. |
getListIdBytes()
public abstract ByteString getListIdBytes() Required for add-to-list and remove-from-list events. The id or name of
the list that the item is being added to or removed from. Other event types
should not set this field.
string list_id = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for listId. |
getPageCategories(int index)
public abstract CatalogItem.CategoryHierarchy getPageCategories(int index) Required for category-page-view events. Other event types should not set
this field.
The categories associated with a category page.
Category pages include special pages such as sales or promotions. For
instance, a special sale page may have the category hierarchy:
categories : ["Sales", "2017 Black Friday Deals"].
repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy page_categories = 2;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CatalogItem.CategoryHierarchy | |
getPageCategoriesCount()
public abstract int getPageCategoriesCount() Required for category-page-view events. Other event types should not set
this field.
The categories associated with a category page.
Category pages include special pages such as sales or promotions. For
instance, a special sale page may have the category hierarchy:
categories : ["Sales", "2017 Black Friday Deals"].
repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy page_categories = 2;
| Returns | |
|---|---|
| Type | Description |
int | |
getPageCategoriesList()
public abstract List<CatalogItem.CategoryHierarchy> getPageCategoriesList() Required for category-page-view events. Other event types should not set
this field.
The categories associated with a category page.
Category pages include special pages such as sales or promotions. For
instance, a special sale page may have the category hierarchy:
categories : ["Sales", "2017 Black Friday Deals"].
repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy page_categories = 2;
| Returns | |
|---|---|
| Type | Description |
List<CategoryHierarchy> | |
getPageCategoriesOrBuilder(int index)
public abstract CatalogItem.CategoryHierarchyOrBuilder getPageCategoriesOrBuilder(int index) Required for category-page-view events. Other event types should not set
this field.
The categories associated with a category page.
Category pages include special pages such as sales or promotions. For
instance, a special sale page may have the category hierarchy:
categories : ["Sales", "2017 Black Friday Deals"].
repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy page_categories = 2;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
CatalogItem.CategoryHierarchyOrBuilder | |
getPageCategoriesOrBuilderList()
public abstract List<? extends CatalogItem.CategoryHierarchyOrBuilder> getPageCategoriesOrBuilderList() Required for category-page-view events. Other event types should not set
this field.
The categories associated with a category page.
Category pages include special pages such as sales or promotions. For
instance, a special sale page may have the category hierarchy:
categories : ["Sales", "2017 Black Friday Deals"].
repeated .google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchy page_categories = 2;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchyOrBuilder> | |
getProductDetails(int index)
public abstract ProductDetail getProductDetails(int index)The main product details related to the event.
This field is required for the following event types:
add-to-cartadd-to-listcheckout-startdetail-page-viewpurchase-completerefundremove-from-cartremove-from-listThis field is optional for the following event types:
page-visitshopping-cart-page-view- note that 'product_details' should be set for this unless the shopping cart is empty.This field is not allowed for the following event types:
category-page-viewhome-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ProductDetail | |
getProductDetailsCount()
public abstract int getProductDetailsCount()The main product details related to the event.
This field is required for the following event types:
add-to-cartadd-to-listcheckout-startdetail-page-viewpurchase-completerefundremove-from-cartremove-from-listThis field is optional for the following event types:
page-visitshopping-cart-page-view- note that 'product_details' should be set for this unless the shopping cart is empty.This field is not allowed for the following event types:
category-page-viewhome-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
getProductDetailsList()
public abstract List<ProductDetail> getProductDetailsList()The main product details related to the event.
This field is required for the following event types:
add-to-cartadd-to-listcheckout-startdetail-page-viewpurchase-completerefundremove-from-cartremove-from-listThis field is optional for the following event types:
page-visitshopping-cart-page-view- note that 'product_details' should be set for this unless the shopping cart is empty.This field is not allowed for the following event types:
category-page-viewhome-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Returns | |
|---|---|
| Type | Description |
List<ProductDetail> | |
getProductDetailsOrBuilder(int index)
public abstract ProductDetailOrBuilder getProductDetailsOrBuilder(int index)The main product details related to the event.
This field is required for the following event types:
add-to-cartadd-to-listcheckout-startdetail-page-viewpurchase-completerefundremove-from-cartremove-from-listThis field is optional for the following event types:
page-visitshopping-cart-page-view- note that 'product_details' should be set for this unless the shopping cart is empty.This field is not allowed for the following event types:
category-page-viewhome-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
ProductDetailOrBuilder | |
getProductDetailsOrBuilderList()
public abstract List<? extends ProductDetailOrBuilder> getProductDetailsOrBuilderList()The main product details related to the event.
This field is required for the following event types:
add-to-cartadd-to-listcheckout-startdetail-page-viewpurchase-completerefundremove-from-cartremove-from-listThis field is optional for the following event types:
page-visitshopping-cart-page-view- note that 'product_details' should be set for this unless the shopping cart is empty.This field is not allowed for the following event types:
category-page-viewhome-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.recommendationengine.v1beta1.ProductDetailOrBuilder> | |
getPurchaseTransaction()
public abstract PurchaseTransaction getPurchaseTransaction() Optional. A transaction represents the entire purchase transaction.
Required for purchase-complete events. Optional for checkout-start
events. Other event types should not set this field.
.google.cloud.recommendationengine.v1beta1.PurchaseTransaction purchase_transaction = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PurchaseTransaction | The purchaseTransaction. |
getPurchaseTransactionOrBuilder()
public abstract PurchaseTransactionOrBuilder getPurchaseTransactionOrBuilder() Optional. A transaction represents the entire purchase transaction.
Required for purchase-complete events. Optional for checkout-start
events. Other event types should not set this field.
.google.cloud.recommendationengine.v1beta1.PurchaseTransaction purchase_transaction = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
PurchaseTransactionOrBuilder | |
getSearchQuery()
public abstract String getSearchQuery() Required for search events. Other event types should not set this field.
The user's search query as UTF-8 encoded text with a length limit of 5 KiB.
string search_query = 1;
| Returns | |
|---|---|
| Type | Description |
String | The searchQuery. |
getSearchQueryBytes()
public abstract ByteString getSearchQueryBytes() Required for search events. Other event types should not set this field.
The user's search query as UTF-8 encoded text with a length limit of 5 KiB.
string search_query = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for searchQuery. |
hasPurchaseTransaction()
public abstract boolean hasPurchaseTransaction() Optional. A transaction represents the entire purchase transaction.
Required for purchase-complete events. Optional for checkout-start
events. Other event types should not set this field.
.google.cloud.recommendationengine.v1beta1.PurchaseTransaction purchase_transaction = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the purchaseTransaction field is set. |