public final class ProductEventDetail extends GeneratedMessageV3 implements ProductEventDetailOrBuilder
ProductEventDetail captures user event information specific to retail
products.
Protobuf type google.cloud.recommendationengine.v1beta1.ProductEventDetail
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
Static Fields
CART_ID_FIELD_NUMBER
public static final int CART_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LIST_ID_FIELD_NUMBER
public static final int LIST_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PAGE_CATEGORIES_FIELD_NUMBER
public static final int PAGE_CATEGORIES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PRODUCT_DETAILS_FIELD_NUMBER
public static final int PRODUCT_DETAILS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PURCHASE_TRANSACTION_FIELD_NUMBER
public static final int PURCHASE_TRANSACTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SEARCH_QUERY_FIELD_NUMBER
public static final int SEARCH_QUERY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ProductEventDetail getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ProductEventDetail.Builder newBuilder()
newBuilder(ProductEventDetail prototype)
public static ProductEventDetail.Builder newBuilder(ProductEventDetail prototype)
public static ProductEventDetail parseDelimitedFrom(InputStream input)
public static ProductEventDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ProductEventDetail parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProductEventDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ProductEventDetail parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProductEventDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProductEventDetail parseFrom(CodedInputStream input)
public static ProductEventDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ProductEventDetail parseFrom(InputStream input)
public static ProductEventDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ProductEventDetail parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProductEventDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ProductEventDetail> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getCartId()
public 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 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.
|
getDefaultInstanceForType()
public ProductEventDetail getDefaultInstanceForType()
getListId()
public 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 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 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
|
getPageCategoriesCount()
public 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 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;
getPageCategoriesOrBuilder(int index)
public 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
|
getPageCategoriesOrBuilderList()
public 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> | |
getParserForType()
public Parser<ProductEventDetail> getParserForType()
Overrides
getProductDetails(int index)
public 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-list
This field is optional for the following event types:
page-visit
shopping-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-view
home-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getProductDetailsCount()
public 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-list
This field is optional for the following event types:
page-visit
shopping-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-view
home-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Returns |
|---|
| Type | Description |
int | |
getProductDetailsList()
public 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-list
This field is optional for the following event types:
page-visit
shopping-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-view
home-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
getProductDetailsOrBuilder(int index)
public 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-list
This field is optional for the following event types:
page-visit
shopping-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-view
home-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Parameter |
|---|
| Name | Description |
index | int
|
getProductDetailsOrBuilderList()
public 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-list
This field is optional for the following event types:
page-visit
shopping-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-view
home-page-viewsearch
repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.recommendationengine.v1beta1.ProductDetailOrBuilder> | |
getPurchaseTransaction()
public 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];
getPurchaseTransactionOrBuilder()
public 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];
getSearchQuery()
public 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
hasPurchaseTransaction()
public 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ProductEventDetail.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ProductEventDetail.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ProductEventDetail.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
