Package com.google.cloud.retail.v2alpha

Interface UserEventOrBuilder

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

    • Method Detail

      • getEventType

        String getEventType()
         Required. User event type. Allowed values are:

 * `add-to-cart`: Products being added to cart.
 * `category-page-view`: Special pages such as sale or promotion pages
   viewed.
 * `detail-page-view`: Products detail page viewed.
 * `home-page-view`: Homepage viewed.
 * `promotion-offered`: Promotion is offered to a user.
 * `promotion-not-offered`: Promotion is not offered to a user.
 * `purchase-complete`: User finishing a purchase.
 * `search`: Product search.
 * `shopping-cart-page-view`: User viewing a shopping cart.
        string event_type = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The eventType.

      • getEventTypeBytes

        com.google.protobuf.ByteString getEventTypeBytes()
         Required. User event type. Allowed values are:

 * `add-to-cart`: Products being added to cart.
 * `category-page-view`: Special pages such as sale or promotion pages
   viewed.
 * `detail-page-view`: Products detail page viewed.
 * `home-page-view`: Homepage viewed.
 * `promotion-offered`: Promotion is offered to a user.
 * `promotion-not-offered`: Promotion is not offered to a user.
 * `purchase-complete`: User finishing a purchase.
 * `search`: Product search.
 * `shopping-cart-page-view`: User viewing a shopping cart.
        string event_type = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for eventType.

      • getVisitorId

        String getVisitorId()
         Required. A unique identifier for tracking visitors.

 For example, this could be implemented with an HTTP cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.

 Don't set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded model
 quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 The field should not contain PII or user-data. We recommend to use Google
 Analytics [Client
 ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.
        string visitor_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The visitorId.

      • getVisitorIdBytes

        com.google.protobuf.ByteString getVisitorIdBytes()
         Required. A unique identifier for tracking visitors.

 For example, this could be implemented with an HTTP cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.

 Don't set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded model
 quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 The field should not contain PII or user-data. We recommend to use Google
 Analytics [Client
 ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
 for this field.
        string visitor_id = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The bytes for visitorId.

      • getSessionId

        String getSessionId()
         A unique identifier for tracking a visitor session with a length limit of
 128 bytes. A session is an aggregation of an end user behavior in a time
 span.

 A general guideline to populate the sesion_id:
 1. If user has no activity for 30 min, a new session_id should be assigned.
 2. The session_id should be unique across users, suggest use uuid or add
 visitor_id as prefix.
        string session_id = 21;
        Returns:
        The sessionId.

      • getSessionIdBytes

        com.google.protobuf.ByteString getSessionIdBytes()
         A unique identifier for tracking a visitor session with a length limit of
 128 bytes. A session is an aggregation of an end user behavior in a time
 span.

 A general guideline to populate the sesion_id:
 1. If user has no activity for 30 min, a new session_id should be assigned.
 2. The session_id should be unique across users, suggest use uuid or add
 visitor_id as prefix.
        string session_id = 21;
        Returns:
        The bytes for sessionId.

      • hasEventTime

        boolean hasEventTime()
         Only required for
 [UserEventService.ImportUserEvents][google.cloud.retail.v2alpha.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.
        .google.protobuf.Timestamp event_time = 3;
        Returns:
        Whether the eventTime field is set.

      • getEventTime

        com.google.protobuf.Timestamp getEventTime()
         Only required for
 [UserEventService.ImportUserEvents][google.cloud.retail.v2alpha.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.
        .google.protobuf.Timestamp event_time = 3;
        Returns:
        The eventTime.

      • getEventTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder()
         Only required for
 [UserEventService.ImportUserEvents][google.cloud.retail.v2alpha.UserEventService.ImportUserEvents]
 method. Timestamp of when the user event happened.
        .google.protobuf.Timestamp event_time = 3;

      • getExperimentIdsList

        List<String> getExperimentIdsList()
         A list of identifiers for the independent experiment groups this user event
 belongs to. This is used to distinguish between user events associated with
 different experiment setups (e.g. using Retail API, using different
 recommendation models).
        repeated string experiment_ids = 4;
        Returns:
        A list containing the experimentIds.

      • getExperimentIdsCount

        int getExperimentIdsCount()
         A list of identifiers for the independent experiment groups this user event
 belongs to. This is used to distinguish between user events associated with
 different experiment setups (e.g. using Retail API, using different
 recommendation models).
        repeated string experiment_ids = 4;
        Returns:
        The count of experimentIds.

      • getExperimentIds

        String getExperimentIds​(int index)
         A list of identifiers for the independent experiment groups this user event
 belongs to. This is used to distinguish between user events associated with
 different experiment setups (e.g. using Retail API, using different
 recommendation models).
        repeated string experiment_ids = 4;
        Parameters:
        index - The index of the element to return.
        Returns:
        The experimentIds at the given index.

      • getExperimentIdsBytes

        com.google.protobuf.ByteString getExperimentIdsBytes​(int index)
         A list of identifiers for the independent experiment groups this user event
 belongs to. This is used to distinguish between user events associated with
 different experiment setups (e.g. using Retail API, using different
 recommendation models).
        repeated string experiment_ids = 4;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experimentIds at the given index.

      • getAttributionToken

        String getAttributionToken()
         Highly recommended for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2alpha.PredictionService.Predict].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2alpha.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2alpha.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 This token enables us to accurately attribute page view or purchase back to
 the event and the particular predict response containing this
 clicked/purchased product. If user clicks on product K in the
 recommendation results, pass
 [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
 as a URL parameter to product K's page. When recording events on product
 K's page, log the
 [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
 to this field.
        string attribution_token = 5;
        Returns:
        The attributionToken.

      • getAttributionTokenBytes

        com.google.protobuf.ByteString getAttributionTokenBytes()
         Highly recommended for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2alpha.PredictionService.Predict].
 This field enables accurate attribution of recommendation model
 performance.

 The value must be a valid
 [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
 for user events that are the result of
 [PredictionService.Predict][google.cloud.retail.v2alpha.PredictionService.Predict].
 The value must be a valid
 [SearchResponse.attribution_token][google.cloud.retail.v2alpha.SearchResponse.attribution_token]
 for user events that are the result of
 [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search].

 This token enables us to accurately attribute page view or purchase back to
 the event and the particular predict response containing this
 clicked/purchased product. If user clicks on product K in the
 recommendation results, pass
 [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
 as a URL parameter to product K's page. When recording events on product
 K's page, log the
 [PredictResponse.attribution_token][google.cloud.retail.v2alpha.PredictResponse.attribution_token]
 to this field.
        string attribution_token = 5;
        Returns:
        The bytes for attributionToken.

      • getProductDetailsList

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

 This field is optional except for the following event types:

 * `add-to-cart`
 * `detail-page-view`
 * `purchase-complete`

 In a `search` event, this field represents the products returned to the end
 user on the current page (the end user may have not finished browsing the
 whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [product_details][google.cloud.retail.v2alpha.UserEvent.product_details] is
 desired. The end user may have not finished browsing the whole page yet.
        repeated .google.cloud.retail.v2alpha.ProductDetail product_details = 6;

      • getProductDetails

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

 This field is optional except for the following event types:

 * `add-to-cart`
 * `detail-page-view`
 * `purchase-complete`

 In a `search` event, this field represents the products returned to the end
 user on the current page (the end user may have not finished browsing the
 whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [product_details][google.cloud.retail.v2alpha.UserEvent.product_details] is
 desired. The end user may have not finished browsing the whole page yet.
        repeated .google.cloud.retail.v2alpha.ProductDetail product_details = 6;

      • getProductDetailsCount

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

 This field is optional except for the following event types:

 * `add-to-cart`
 * `detail-page-view`
 * `purchase-complete`

 In a `search` event, this field represents the products returned to the end
 user on the current page (the end user may have not finished browsing the
 whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [product_details][google.cloud.retail.v2alpha.UserEvent.product_details] is
 desired. The end user may have not finished browsing the whole page yet.
        repeated .google.cloud.retail.v2alpha.ProductDetail product_details = 6;

      • getProductDetailsOrBuilderList

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

 This field is optional except for the following event types:

 * `add-to-cart`
 * `detail-page-view`
 * `purchase-complete`

 In a `search` event, this field represents the products returned to the end
 user on the current page (the end user may have not finished browsing the
 whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [product_details][google.cloud.retail.v2alpha.UserEvent.product_details] is
 desired. The end user may have not finished browsing the whole page yet.
        repeated .google.cloud.retail.v2alpha.ProductDetail product_details = 6;

      • getProductDetailsOrBuilder

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

 This field is optional except for the following event types:

 * `add-to-cart`
 * `detail-page-view`
 * `purchase-complete`

 In a `search` event, this field represents the products returned to the end
 user on the current page (the end user may have not finished browsing the
 whole page yet). When a new page is returned to the end user, after
 pagination/filtering/ordering even for the same query, a new `search` event
 with different
 [product_details][google.cloud.retail.v2alpha.UserEvent.product_details] is
 desired. The end user may have not finished browsing the whole page yet.
        repeated .google.cloud.retail.v2alpha.ProductDetail product_details = 6;

      • hasCompletionDetail

        boolean hasCompletionDetail()
         The main auto-completion details related to the event.

 This field should be set for `search` event when autocomplete function is
 enabled and the user clicks a suggestion for search.
        .google.cloud.retail.v2alpha.CompletionDetail completion_detail = 22;
        Returns:
        Whether the completionDetail field is set.

      • getCompletionDetail

        CompletionDetail getCompletionDetail()
         The main auto-completion details related to the event.

 This field should be set for `search` event when autocomplete function is
 enabled and the user clicks a suggestion for search.
        .google.cloud.retail.v2alpha.CompletionDetail completion_detail = 22;
        Returns:
        The completionDetail.

      • getCompletionDetailOrBuilder

        CompletionDetailOrBuilder getCompletionDetailOrBuilder()
         The main auto-completion details related to the event.

 This field should be set for `search` event when autocomplete function is
 enabled and the user clicks a suggestion for search.
        .google.cloud.retail.v2alpha.CompletionDetail completion_detail = 22;

      • getAttributesCount

        int getAttributesCount()
         Extra user event features to include in the recommendation model.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Retail API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
   characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
   allowed. Each value must be a UTF-8 encoded string with a length limit of
   256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 traffic_channel, which is how a user arrives at the site. Users can arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
        map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 7;

      • containsAttributes

        boolean containsAttributes​(String key)
         Extra user event features to include in the recommendation model.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Retail API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
   characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
   allowed. Each value must be a UTF-8 encoded string with a length limit of
   256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 traffic_channel, which is how a user arrives at the site. Users can arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
        map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 7;

      • getAttributesMap

        Map<String,​CustomAttribute> getAttributesMap()
         Extra user event features to include in the recommendation model.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Retail API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
   characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
   allowed. Each value must be a UTF-8 encoded string with a length limit of
   256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 traffic_channel, which is how a user arrives at the site. Users can arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
        map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 7;

      • getAttributesOrDefault

        CustomAttribute getAttributesOrDefault​(String key,
                                       CustomAttribute defaultValue)
         Extra user event features to include in the recommendation model.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Retail API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
   characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
   allowed. Each value must be a UTF-8 encoded string with a length limit of
   256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 traffic_channel, which is how a user arrives at the site. Users can arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
        map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 7;

      • getAttributesOrThrow

        CustomAttribute getAttributesOrThrow​(String key)
         Extra user event features to include in the recommendation model.

 If you provide custom attributes for ingested user events, also include
 them in the user events that you associate with prediction requests. Custom
 attribute formatting must be consistent between imported events and events
 provided with prediction requests. This lets the Retail API use
 those custom attributes when training models and serving predictions, which
 helps improve recommendation quality.

 This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT
 error is returned:

 * The key must be a UTF-8 encoded string with a length limit of 5,000
   characters.
 * For text attributes, at most 400 values are allowed. Empty values are not
   allowed. Each value must be a UTF-8 encoded string with a length limit of
   256 characters.
 * For number attributes, at most 400 values are allowed.

 For product recommendations, an example of extra user information is
 traffic_channel, which is how a user arrives at the site. Users can arrive
 at the site by coming to the site directly, coming through Google
 search, or in other ways.
        map<string, .google.cloud.retail.v2alpha.CustomAttribute> attributes = 7;

      • getCartId

        String getCartId()
         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`, `purchase-complete`, or
 `shopping-cart-page-view` events.
        string cart_id = 8;
        Returns:
        The cartId.

      • getCartIdBytes

        com.google.protobuf.ByteString getCartIdBytes()
         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`, `purchase-complete`, or
 `shopping-cart-page-view` events.
        string cart_id = 8;
        Returns:
        The bytes for cartId.

      • hasPurchaseTransaction

        boolean hasPurchaseTransaction()
         A transaction represents the entire purchase transaction.

 Required for `purchase-complete` events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
        .google.cloud.retail.v2alpha.PurchaseTransaction purchase_transaction = 9;
        Returns:
        Whether the purchaseTransaction field is set.

      • getPurchaseTransaction

        PurchaseTransaction getPurchaseTransaction()
         A transaction represents the entire purchase transaction.

 Required for `purchase-complete` events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
        .google.cloud.retail.v2alpha.PurchaseTransaction purchase_transaction = 9;
        Returns:
        The purchaseTransaction.

      • getPurchaseTransactionOrBuilder

        PurchaseTransactionOrBuilder getPurchaseTransactionOrBuilder()
         A transaction represents the entire purchase transaction.

 Required for `purchase-complete` events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
        .google.cloud.retail.v2alpha.PurchaseTransaction purchase_transaction = 9;

      • getSearchQuery

        String getSearchQuery()
         The user's search query.

 See [SearchRequest.query][google.cloud.retail.v2alpha.SearchRequest.query]
 for definition.

 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 At least one of
 [search_query][google.cloud.retail.v2alpha.UserEvent.search_query] or
 [page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories] is
 required for `search` events. Other event types should not set this field.
 Otherwise, an INVALID_ARGUMENT error is returned.
        string search_query = 10;
        Returns:
        The searchQuery.

      • getSearchQueryBytes

        com.google.protobuf.ByteString getSearchQueryBytes()
         The user's search query.

 See [SearchRequest.query][google.cloud.retail.v2alpha.SearchRequest.query]
 for definition.

 The value must be a UTF-8 encoded string with a length limit of 5,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 At least one of
 [search_query][google.cloud.retail.v2alpha.UserEvent.search_query] or
 [page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories] is
 required for `search` events. Other event types should not set this field.
 Otherwise, an INVALID_ARGUMENT error is returned.
        string search_query = 10;
        Returns:
        The bytes for searchQuery.

      • getFilter

        String getFilter()
         The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the products being filtered.

 See
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string filter = 16;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         The filter syntax consists of an expression language for constructing a
 predicate from one or more fields of the products being filtered.

 See
 [SearchRequest.filter][google.cloud.retail.v2alpha.SearchRequest.filter]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string filter = 16;
        Returns:
        The bytes for filter.

      • getOrderBy

        String getOrderBy()
         The order in which products are returned.

 See
 [SearchRequest.order_by][google.cloud.retail.v2alpha.SearchRequest.order_by]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
        string order_by = 17;
        Returns:
        The orderBy.

      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes()
         The order in which products are returned.

 See
 [SearchRequest.order_by][google.cloud.retail.v2alpha.SearchRequest.order_by]
 for definition and syntax.

 The value must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
        string order_by = 17;
        Returns:
        The bytes for orderBy.

      • getOffset

        int getOffset()
         An integer that specifies the current offset for pagination (the 0-indexed
 starting location, amongst the products deemed by the API as relevant).

 See
 [SearchRequest.offset][google.cloud.retail.v2alpha.SearchRequest.offset]
 for definition.

 If this field is negative, an INVALID_ARGUMENT is returned.

 This can only be set for `search` events. Other event types should not set
 this field. Otherwise, an INVALID_ARGUMENT error is returned.
        int32 offset = 18;
        Returns:
        The offset.

      • getPageCategoriesList

        List<String> getPageCategoriesList()
         The categories associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].

 Required for `category-page-view` events. At least one of
 [search_query][google.cloud.retail.v2alpha.UserEvent.search_query] or
 [page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories] is
 required for `search` events. Other event types should not set this field.
 Otherwise, an INVALID_ARGUMENT error is returned.
        repeated string page_categories = 11;
        Returns:
        A list containing the pageCategories.

      • getPageCategoriesCount

        int getPageCategoriesCount()
         The categories associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].

 Required for `category-page-view` events. At least one of
 [search_query][google.cloud.retail.v2alpha.UserEvent.search_query] or
 [page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories] is
 required for `search` events. Other event types should not set this field.
 Otherwise, an INVALID_ARGUMENT error is returned.
        repeated string page_categories = 11;
        Returns:
        The count of pageCategories.

      • getPageCategories

        String getPageCategories​(int index)
         The categories associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].

 Required for `category-page-view` events. At least one of
 [search_query][google.cloud.retail.v2alpha.UserEvent.search_query] or
 [page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories] is
 required for `search` events. Other event types should not set this field.
 Otherwise, an INVALID_ARGUMENT error is returned.
        repeated string page_categories = 11;
        Parameters:
        index - The index of the element to return.
        Returns:
        The pageCategories at the given index.

      • getPageCategoriesBytes

        com.google.protobuf.ByteString getPageCategoriesBytes​(int index)
         The categories associated with a category page.

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].

 Required for `category-page-view` events. At least one of
 [search_query][google.cloud.retail.v2alpha.UserEvent.search_query] or
 [page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories] is
 required for `search` events. Other event types should not set this field.
 Otherwise, an INVALID_ARGUMENT error is returned.
        repeated string page_categories = 11;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the pageCategories at the given index.

      • hasUserInfo

        boolean hasUserInfo()
         User information.
        .google.cloud.retail.v2alpha.UserInfo user_info = 12;
        Returns:
        Whether the userInfo field is set.

      • getUserInfo

        UserInfo getUserInfo()
         User information.
        .google.cloud.retail.v2alpha.UserInfo user_info = 12;
        Returns:
        The userInfo.

      • getUserInfoOrBuilder

        UserInfoOrBuilder getUserInfoOrBuilder()
         User information.
        .google.cloud.retail.v2alpha.UserInfo user_info = 12;

      • getUri

        String getUri()
         Complete URL (window.location.href) of the user's current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. Maximum length 5,000
 characters.
        string uri = 13;
        Returns:
        The uri.

      • getUriBytes

        com.google.protobuf.ByteString getUriBytes()
         Complete URL (window.location.href) of the user's current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically. Maximum length 5,000
 characters.
        string uri = 13;
        Returns:
        The bytes for uri.

      • getReferrerUri

        String getReferrerUri()
         The referrer URL of the current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
        string referrer_uri = 14;
        Returns:
        The referrerUri.

      • getReferrerUriBytes

        com.google.protobuf.ByteString getReferrerUriBytes()
         The referrer URL of the current page.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
        string referrer_uri = 14;
        Returns:
        The bytes for referrerUri.

      • getPageViewId

        String getPageViewId()
         A unique ID of a web page view.

 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page. The `pageViewId` property should
 be kept the same for all these events so that they can be grouped together
 properly.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
        string page_view_id = 15;
        Returns:
        The pageViewId.

      • getPageViewIdBytes

        com.google.protobuf.ByteString getPageViewIdBytes()
         A unique ID of a web page view.

 This should be kept the same for all user events triggered from the same
 pageview. For example, an item detail page view could trigger multiple
 events as the user is browsing the page. The `pageViewId` property should
 be kept the same for all these events so that they can be grouped together
 properly.

 When using the client side event reporting with JavaScript pixel and Google
 Tag Manager, this value is filled in automatically.
        string page_view_id = 15;
        Returns:
        The bytes for pageViewId.

      • getEntity

        String getEntity()
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 It is recommended to set this field to get better per-entity search,
 completion and prediction results.
        string entity = 23;
        Returns:
        The entity.

      • getEntityBytes

        com.google.protobuf.ByteString getEntityBytes()
         The entity for customers that may run multiple different entities, domains,
 sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
 `google.com`, `youtube.com`, etc.
 It is recommended to set this field to get better per-entity search,
 completion and prediction results.
        string entity = 23;
        Returns:
        The bytes for entity.