Package com.google.cloud.recommendationengine.v1beta1

Interface ProductEventDetailOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ProductEventDetail, ProductEventDetail.Builder
    public interface ProductEventDetailOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getSearchQuery

        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:
        The searchQuery.

      • getSearchQueryBytes

        com.google.protobuf.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:
        The bytes for searchQuery.

      • getPageCategoriesList

        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;

      • getPageCategories

        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;

      • getPageCategoriesCount

        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;

      • getPageCategoriesOrBuilderList

        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;

      • getPageCategoriesOrBuilder

        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;

      • getProductDetailsList

        List<ProductDetail> getProductDetailsList()
         The main product details related to the event.

 This field is required for the following event types:

 * `add-to-cart`
 * `add-to-list`
 * `checkout-start`
 * `detail-page-view`
 * `purchase-complete`
 * `refund`
 * `remove-from-cart`
 * `remove-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-view`
 * `search`
        repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;

      • getProductDetails

        ProductDetail getProductDetails​(int index)
         The main product details related to the event.

 This field is required for the following event types:

 * `add-to-cart`
 * `add-to-list`
 * `checkout-start`
 * `detail-page-view`
 * `purchase-complete`
 * `refund`
 * `remove-from-cart`
 * `remove-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-view`
 * `search`
        repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;

      • getProductDetailsCount

        int getProductDetailsCount()
         The main product details related to the event.

 This field is required for the following event types:

 * `add-to-cart`
 * `add-to-list`
 * `checkout-start`
 * `detail-page-view`
 * `purchase-complete`
 * `refund`
 * `remove-from-cart`
 * `remove-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-view`
 * `search`
        repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;

      • getProductDetailsOrBuilderList

        List<? extends ProductDetailOrBuilder> getProductDetailsOrBuilderList()
         The main product details related to the event.

 This field is required for the following event types:

 * `add-to-cart`
 * `add-to-list`
 * `checkout-start`
 * `detail-page-view`
 * `purchase-complete`
 * `refund`
 * `remove-from-cart`
 * `remove-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-view`
 * `search`
        repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;

      • getProductDetailsOrBuilder

        ProductDetailOrBuilder getProductDetailsOrBuilder​(int index)
         The main product details related to the event.

 This field is required for the following event types:

 * `add-to-cart`
 * `add-to-list`
 * `checkout-start`
 * `detail-page-view`
 * `purchase-complete`
 * `refund`
 * `remove-from-cart`
 * `remove-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-view`
 * `search`
        repeated .google.cloud.recommendationengine.v1beta1.ProductDetail product_details = 3;

      • getListId

        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:
        The listId.

      • getListIdBytes

        com.google.protobuf.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:
        The bytes for listId.

      • getCartId

        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:
        The cartId.

      • getCartIdBytes

        com.google.protobuf.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:
        The bytes for cartId.

      • hasPurchaseTransaction

        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:
        Whether the purchaseTransaction field is set.

      • getPurchaseTransaction

        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:
        The purchaseTransaction.

      • getPurchaseTransactionOrBuilder

        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];