public final class ProductEventDetail extends GeneratedMessageV3 implements ProductEventDetailOrBuilder
ProductEventDetail captures user event information specific to retail
products.
Protobuf type google.cloud.recommendationengine.v1beta1.ProductEventDetail
Static Fields
CART_ID_FIELD_NUMBER
public static final int CART_ID_FIELD_NUMBER
Field Value
LIST_ID_FIELD_NUMBER
public static final int LIST_ID_FIELD_NUMBER
Field Value
PAGE_CATEGORIES_FIELD_NUMBER
public static final int PAGE_CATEGORIES_FIELD_NUMBER
Field Value
PRODUCT_DETAILS_FIELD_NUMBER
public static final int PRODUCT_DETAILS_FIELD_NUMBER
Field Value
PURCHASE_TRANSACTION_FIELD_NUMBER
public static final int PURCHASE_TRANSACTION_FIELD_NUMBER
Field Value
SEARCH_QUERY_FIELD_NUMBER
public static final int SEARCH_QUERY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ProductEventDetail getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ProductEventDetail.Builder newBuilder()
Returns
newBuilder(ProductEventDetail prototype)
public static ProductEventDetail.Builder newBuilder(ProductEventDetail prototype)
Parameter
Returns
public static ProductEventDetail parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ProductEventDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ProductEventDetail parseFrom(byte[] data)
Parameter
| Name |
Description |
| data |
byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ProductEventDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ProductEventDetail parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ProductEventDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ProductEventDetail parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ProductEventDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ProductEventDetail parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ProductEventDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ProductEventDetail parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ProductEventDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ProductEventDetail> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
| 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];
getDefaultInstanceForType()
public ProductEventDetail getDefaultInstanceForType()
Returns
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;
| 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;
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;
| Name |
Description |
| index |
int
|
Returns
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;
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;
| Name |
Description |
| index |
int
|
Returns
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;
| Type |
Description |
| List<? extends com.google.cloud.recommendationengine.v1beta1.CatalogItem.CategoryHierarchyOrBuilder> |
|
getParserForType()
public Parser<ProductEventDetail> getParserForType()
Returns
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-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;
| Name |
Description |
| index |
int
|
Returns
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-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;
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-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;
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-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;
| Name |
Description |
| index |
int
|
Returns
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-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;
| 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;
| 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;
| Type |
Description |
| ByteString |
The bytes for searchQuery.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
| Type |
Description |
| boolean |
Whether the purchaseTransaction field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ProductEventDetail.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ProductEventDetail.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ProductEventDetail.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
