com.google.cloud.retail.v2.UserEventOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2 Show documentation
Show all versions of proto-google-cloud-retail-v2 Show documentation
Proto library for google-cloud-retail
The newest version!
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/retail/v2/user_event.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2;
public interface UserEventOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.UserEvent)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. User event type. Allowed values are:
*
* * `add-to-cart`: Products being added to cart.
* * `remove-from-cart`: Products being removed from 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];
*
* @return The eventType.
*/
java.lang.String getEventType();
/**
*
*
*
* Required. User event type. Allowed values are:
*
* * `add-to-cart`: Products being added to cart.
* * `remove-from-cart`: Products being removed from 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];
*
* @return The bytes for eventType.
*/
com.google.protobuf.ByteString getEventTypeBytes();
/**
*
*
*
* 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];
*
* @return The visitorId.
*/
java.lang.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];
*
* @return The bytes for visitorId.
*/
com.google.protobuf.ByteString getVisitorIdBytes();
/**
*
*
*
* 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;
*
* @return The sessionId.
*/
java.lang.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;
*
* @return The bytes for sessionId.
*/
com.google.protobuf.ByteString getSessionIdBytes();
/**
*
*
*
* Only required for
* [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents]
* method. Timestamp of when the user event happened.
*
*
* .google.protobuf.Timestamp event_time = 3;
*
* @return Whether the eventTime field is set.
*/
boolean hasEventTime();
/**
*
*
*
* Only required for
* [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents]
* method. Timestamp of when the user event happened.
*
*
* .google.protobuf.Timestamp event_time = 3;
*
* @return The eventTime.
*/
com.google.protobuf.Timestamp getEventTime();
/**
*
*
*
* Only required for
* [UserEventService.ImportUserEvents][google.cloud.retail.v2.UserEventService.ImportUserEvents]
* method. Timestamp of when the user event happened.
*
*
* .google.protobuf.Timestamp event_time = 3;
*/
com.google.protobuf.TimestampOrBuilder getEventTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return A list containing the experimentIds.
*/
java.util.List 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;
*
* @return The count of experimentIds.
*/
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;
*
* @param index The index of the element to return.
* @return The experimentIds at the given index.
*/
java.lang.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;
*
* @param index The index of the value to return.
* @return The bytes of the experimentIds at the given index.
*/
com.google.protobuf.ByteString getExperimentIdsBytes(int index);
/**
*
*
*
* Highly recommended for user events that are the result of
* [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
* This field enables accurate attribution of recommendation model
* performance.
*
* The value must be a valid
* [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token]
* for user events that are the result of
* [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
* The value must be a valid
* [SearchResponse.attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
* for user events that are the result of
* [SearchService.Search][google.cloud.retail.v2.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.v2.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.v2.PredictResponse.attribution_token]
* to this field.
*
*
* string attribution_token = 5;
*
* @return The attributionToken.
*/
java.lang.String getAttributionToken();
/**
*
*
*
* Highly recommended for user events that are the result of
* [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
* This field enables accurate attribution of recommendation model
* performance.
*
* The value must be a valid
* [PredictResponse.attribution_token][google.cloud.retail.v2.PredictResponse.attribution_token]
* for user events that are the result of
* [PredictionService.Predict][google.cloud.retail.v2.PredictionService.Predict].
* The value must be a valid
* [SearchResponse.attribution_token][google.cloud.retail.v2.SearchResponse.attribution_token]
* for user events that are the result of
* [SearchService.Search][google.cloud.retail.v2.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.v2.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.v2.PredictResponse.attribution_token]
* to this field.
*
*
* string attribution_token = 5;
*
* @return The bytes for attributionToken.
*/
com.google.protobuf.ByteString getAttributionTokenBytes();
/**
*
*
*
* 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.v2.UserEvent.product_details] is
* desired. The end user may have not finished browsing the whole page yet.
*
*
* repeated .google.cloud.retail.v2.ProductDetail product_details = 6;
*/
java.util.List 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.v2.UserEvent.product_details] is
* desired. The end user may have not finished browsing the whole page yet.
*
*
* repeated .google.cloud.retail.v2.ProductDetail product_details = 6;
*/
com.google.cloud.retail.v2.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.v2.UserEvent.product_details] is
* desired. The end user may have not finished browsing the whole page yet.
*
*
* repeated .google.cloud.retail.v2.ProductDetail product_details = 6;
*/
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.v2.UserEvent.product_details] is
* desired. The end user may have not finished browsing the whole page yet.
*
*
* repeated .google.cloud.retail.v2.ProductDetail product_details = 6;
*/
java.util.List
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.v2.UserEvent.product_details] is
* desired. The end user may have not finished browsing the whole page yet.
*
*
* repeated .google.cloud.retail.v2.ProductDetail product_details = 6;
*/
com.google.cloud.retail.v2.ProductDetailOrBuilder getProductDetailsOrBuilder(int index);
/**
*
*
*
* 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.v2.CompletionDetail completion_detail = 22;
*
* @return Whether the completionDetail field is set.
*/
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.v2.CompletionDetail completion_detail = 22;
*
* @return The completionDetail.
*/
com.google.cloud.retail.v2.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.v2.CompletionDetail completion_detail = 22;
*/
com.google.cloud.retail.v2.CompletionDetailOrBuilder getCompletionDetailOrBuilder();
/**
*
*
*
* 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.v2.CustomAttribute> attributes = 7;
*/
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.v2.CustomAttribute> attributes = 7;
*/
boolean containsAttributes(java.lang.String key);
/** Use {@link #getAttributesMap()} instead. */
@java.lang.Deprecated
java.util.Map getAttributes();
/**
*
*
*
* 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.v2.CustomAttribute> attributes = 7;
*/
java.util.Map 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.v2.CustomAttribute> attributes = 7;
*/
/* nullable */
com.google.cloud.retail.v2.CustomAttribute getAttributesOrDefault(
java.lang.String key,
/* nullable */
com.google.cloud.retail.v2.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.v2.CustomAttribute> attributes = 7;
*/
com.google.cloud.retail.v2.CustomAttribute getAttributesOrThrow(java.lang.String key);
/**
*
*
*
* 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;
*
* @return The cartId.
*/
java.lang.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;
*
* @return The bytes for cartId.
*/
com.google.protobuf.ByteString getCartIdBytes();
/**
*
*
*
* 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.v2.PurchaseTransaction purchase_transaction = 9;
*
* @return Whether the purchaseTransaction field is set.
*/
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.v2.PurchaseTransaction purchase_transaction = 9;
*
* @return The purchaseTransaction.
*/
com.google.cloud.retail.v2.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.v2.PurchaseTransaction purchase_transaction = 9;
*/
com.google.cloud.retail.v2.PurchaseTransactionOrBuilder getPurchaseTransactionOrBuilder();
/**
*
*
*
* The user's search query.
*
* See [SearchRequest.query][google.cloud.retail.v2.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.v2.UserEvent.search_query] or
* [page_categories][google.cloud.retail.v2.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;
*
* @return The searchQuery.
*/
java.lang.String getSearchQuery();
/**
*
*
*
* The user's search query.
*
* See [SearchRequest.query][google.cloud.retail.v2.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.v2.UserEvent.search_query] or
* [page_categories][google.cloud.retail.v2.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;
*
* @return The bytes for searchQuery.
*/
com.google.protobuf.ByteString getSearchQueryBytes();
/**
*
*
*
* 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.v2.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;
*
* @return The filter.
*/
java.lang.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.v2.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;
*
* @return The bytes for filter.
*/
com.google.protobuf.ByteString getFilterBytes();
/**
*
*
*
* The order in which products are returned.
*
* See [SearchRequest.order_by][google.cloud.retail.v2.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;
*
* @return The orderBy.
*/
java.lang.String getOrderBy();
/**
*
*
*
* The order in which products are returned.
*
* See [SearchRequest.order_by][google.cloud.retail.v2.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;
*
* @return The bytes for orderBy.
*/
com.google.protobuf.ByteString getOrderByBytes();
/**
*
*
*
* 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.v2.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;
*
* @return The offset.
*/
int getOffset();
/**
*
*
*
* 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.v2.UserEvent.search_query] or
* [page_categories][google.cloud.retail.v2.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;
*
* @return A list containing the pageCategories.
*/
java.util.List 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.v2.UserEvent.search_query] or
* [page_categories][google.cloud.retail.v2.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;
*
* @return The count of pageCategories.
*/
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.v2.UserEvent.search_query] or
* [page_categories][google.cloud.retail.v2.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;
*
* @param index The index of the element to return.
* @return The pageCategories at the given index.
*/
java.lang.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.v2.UserEvent.search_query] or
* [page_categories][google.cloud.retail.v2.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;
*
* @param index The index of the value to return.
* @return The bytes of the pageCategories at the given index.
*/
com.google.protobuf.ByteString getPageCategoriesBytes(int index);
/**
*
*
*
* User information.
*
*
* .google.cloud.retail.v2.UserInfo user_info = 12;
*
* @return Whether the userInfo field is set.
*/
boolean hasUserInfo();
/**
*
*
*
* User information.
*
*
* .google.cloud.retail.v2.UserInfo user_info = 12;
*
* @return The userInfo.
*/
com.google.cloud.retail.v2.UserInfo getUserInfo();
/**
*
*
*
* User information.
*
*
* .google.cloud.retail.v2.UserInfo user_info = 12;
*/
com.google.cloud.retail.v2.UserInfoOrBuilder getUserInfoOrBuilder();
/**
*
*
*
* 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;
*
* @return The uri.
*/
java.lang.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;
*
* @return The bytes for uri.
*/
com.google.protobuf.ByteString getUriBytes();
/**
*
*
*
* 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;
*
* @return The referrerUri.
*/
java.lang.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;
*
* @return The bytes for referrerUri.
*/
com.google.protobuf.ByteString getReferrerUriBytes();
/**
*
*
*
* 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;
*
* @return The pageViewId.
*/
java.lang.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;
*
* @return The bytes for pageViewId.
*/
com.google.protobuf.ByteString getPageViewIdBytes();
/**
*
*
*
* 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.
* We recommend that you set this field to get better per-entity search,
* completion, and prediction results.
*
*
* string entity = 23;
*
* @return The entity.
*/
java.lang.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.
* We recommend that you set this field to get better per-entity search,
* completion, and prediction results.
*
*
* string entity = 23;
*
* @return The bytes for entity.
*/
com.google.protobuf.ByteString getEntityBytes();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy