GoogleCloudDiscoveryengineV1UserEvent (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1UserEvent

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1UserEvent
extends com.google.api.client.json.GenericJson
```
UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1UserEvent()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1UserEvent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1UserEvent`	`clone()`
`Map<String,GoogleCloudDiscoveryengineV1CustomAttribute>`	`getAttributes()` Extra user event features to include in the recommendation model.
`String`	`getAttributionToken()` Token to attribute an API response to user action(s) to trigger the event.
`GoogleCloudDiscoveryengineV1CompletionInfo`	`getCompletionInfo()` CompletionService.CompleteQuery details related to the event.
`String`	`getConversionType()` Optional.
`String`	`getDataStore()` The DataStore resource full name, of the form `projects/{project}/locations/{location}/collecti ons/{collection_id}/dataStores/{data_store_id}`.
`Boolean`	`getDirectUserRequest()` Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request.
`List<GoogleCloudDiscoveryengineV1DocumentInfo>`	`getDocuments()` List of Documents associated with this user event.
`String`	`getEngine()` The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
`String`	`getEntity()` Optional.
`String`	`getEventTime()` Only required for UserEventService.ImportUserEvents method.
`String`	`getEventType()` Required.
`String`	`getFilter()` Optional.
`GoogleCloudDiscoveryengineV1MediaInfo`	`getMediaInfo()` Media-specific info.
`GoogleCloudDiscoveryengineV1PageInfo`	`getPageInfo()` Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`GoogleCloudDiscoveryengineV1PanelInfo`	`getPanel()` Panel metadata associated with this user event.
`List<GoogleCloudDiscoveryengineV1PanelInfo>`	`getPanels()` Optional.
`List<String>`	`getPromotionIds()` The promotion IDs if this is an event associated with promotions.
`GoogleCloudDiscoveryengineV1SearchInfo`	`getSearchInfo()` SearchService.Search details related to the event.
`String`	`getSessionId()` A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`List<String>`	`getTagIds()` A list of identifiers for the independent experiment groups this user event belongs to.
`GoogleCloudDiscoveryengineV1TransactionInfo`	`getTransactionInfo()` The transaction metadata (if any) associated with this user event.
`GoogleCloudDiscoveryengineV1UserInfo`	`getUserInfo()` Information about the end user.
`String`	`getUserPseudoId()` Required.
`GoogleCloudDiscoveryengineV1UserEvent`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1UserEvent`	`setAttributes(Map<String,GoogleCloudDiscoveryengineV1CustomAttribute> attributes)` Extra user event features to include in the recommendation model.
`GoogleCloudDiscoveryengineV1UserEvent`	`setAttributionToken(String attributionToken)` Token to attribute an API response to user action(s) to trigger the event.
`GoogleCloudDiscoveryengineV1UserEvent`	`setCompletionInfo(GoogleCloudDiscoveryengineV1CompletionInfo completionInfo)` CompletionService.CompleteQuery details related to the event.
`GoogleCloudDiscoveryengineV1UserEvent`	`setConversionType(String conversionType)` Optional.
`GoogleCloudDiscoveryengineV1UserEvent`	`setDataStore(String dataStore)` The DataStore resource full name, of the form `projects/{project}/locations/{location}/collecti ons/{collection_id}/dataStores/{data_store_id}`.
`GoogleCloudDiscoveryengineV1UserEvent`	`setDirectUserRequest(Boolean directUserRequest)` Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request.
`GoogleCloudDiscoveryengineV1UserEvent`	`setDocuments(List<GoogleCloudDiscoveryengineV1DocumentInfo> documents)` List of Documents associated with this user event.
`GoogleCloudDiscoveryengineV1UserEvent`	`setEngine(String engine)` The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
`GoogleCloudDiscoveryengineV1UserEvent`	`setEntity(String entity)` Optional.
`GoogleCloudDiscoveryengineV1UserEvent`	`setEventTime(String eventTime)` Only required for UserEventService.ImportUserEvents method.
`GoogleCloudDiscoveryengineV1UserEvent`	`setEventType(String eventType)` Required.
`GoogleCloudDiscoveryengineV1UserEvent`	`setFilter(String filter)` Optional.
`GoogleCloudDiscoveryengineV1UserEvent`	`setMediaInfo(GoogleCloudDiscoveryengineV1MediaInfo mediaInfo)` Media-specific info.
`GoogleCloudDiscoveryengineV1UserEvent`	`setPageInfo(GoogleCloudDiscoveryengineV1PageInfo pageInfo)` Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
`GoogleCloudDiscoveryengineV1UserEvent`	`setPanel(GoogleCloudDiscoveryengineV1PanelInfo panel)` Panel metadata associated with this user event.
`GoogleCloudDiscoveryengineV1UserEvent`	`setPanels(List<GoogleCloudDiscoveryengineV1PanelInfo> panels)` Optional.
`GoogleCloudDiscoveryengineV1UserEvent`	`setPromotionIds(List<String> promotionIds)` The promotion IDs if this is an event associated with promotions.
`GoogleCloudDiscoveryengineV1UserEvent`	`setSearchInfo(GoogleCloudDiscoveryengineV1SearchInfo searchInfo)` SearchService.Search details related to the event.
`GoogleCloudDiscoveryengineV1UserEvent`	`setSessionId(String sessionId)` A unique identifier for tracking a visitor session with a length limit of 128 bytes.
`GoogleCloudDiscoveryengineV1UserEvent`	`setTagIds(List<String> tagIds)` A list of identifiers for the independent experiment groups this user event belongs to.
`GoogleCloudDiscoveryengineV1UserEvent`	`setTransactionInfo(GoogleCloudDiscoveryengineV1TransactionInfo transactionInfo)` The transaction metadata (if any) associated with this user event.
`GoogleCloudDiscoveryengineV1UserEvent`	`setUserInfo(GoogleCloudDiscoveryengineV1UserInfo userInfo)` Information about the end user.
`GoogleCloudDiscoveryengineV1UserEvent`	`setUserPseudoId(String userPseudoId)` Required.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1UserEvent
```
public GoogleCloudDiscoveryengineV1UserEvent()
```
- Method Detail
  - getAttributes
```
public Map<String,GoogleCloudDiscoveryengineV1CustomAttribute> getAttributes()
```
    Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. 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 Discovery Engine 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.
    
    Returns:
    
    value or null for none
  - setAttributes
```
public GoogleCloudDiscoveryengineV1UserEvent setAttributes(Map<String,GoogleCloudDiscoveryengineV1CustomAttribute> attributes)
```
    Extra user event features to include in the recommendation model. These attributes must NOT contain data that needs to be parsed or processed further, e.g. JSON or other encodings. 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 Discovery Engine 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.
    
    Parameters:
    
    attributes - attributes or null for none
  - getAttributionToken
```
public String getAttributionToken()
```
    Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion 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 RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.
    
    Returns:
    
    value or null for none
  - setAttributionToken
```
public GoogleCloudDiscoveryengineV1UserEvent setAttributionToken(String attributionToken)
```
    Token to attribute an API response to user action(s) to trigger the event. Highly recommended for user events that are the result of RecommendationService.Recommend. This field enables accurate attribution of recommendation model performance. The value must be one of: * RecommendResponse.attribution_token for events that are the result of RecommendationService.Recommend. * SearchResponse.attribution_token for events that are the result of SearchService.Search. This token enables us to accurately attribute page view or conversion completion 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 RecommendResponse.attribution_token as a URL parameter to product K's page. When recording events on product K's page, log the RecommendResponse.attribution_token to this field.
    
    Parameters:
    
    attributionToken - attributionToken or null for none
  - getCompletionInfo
```
public GoogleCloudDiscoveryengineV1CompletionInfo getCompletionInfo()
```
    CompletionService.CompleteQuery 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.
    
    Returns:
    
    value or null for none
  - setCompletionInfo
```
public GoogleCloudDiscoveryengineV1UserEvent setCompletionInfo(GoogleCloudDiscoveryengineV1CompletionInfo completionInfo)
```
    CompletionService.CompleteQuery 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.
    
    Parameters:
    
    completionInfo - completionInfo or null for none
  - getConversionType
```
public String getConversionType()
```
    Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by "-", such as "watch", "good-visit" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.
    
    Returns:
    
    value or null for none
  - setConversionType
```
public GoogleCloudDiscoveryengineV1UserEvent setConversionType(String conversionType)
```
    Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by "-", such as "watch", "good-visit" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc.
    
    Parameters:
    
    conversionType - conversionType or null for none
  - getDataStore
```
public String getDataStore()
```
    The DataStore resource full name, of the form `projects/{project}/locations/{location}/collecti ons/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.
    
    Returns:
    
    value or null for none
  - setDataStore
```
public GoogleCloudDiscoveryengineV1UserEvent setDataStore(String dataStore)
```
    The DataStore resource full name, of the form `projects/{project}/locations/{location}/collecti ons/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.
    
    Parameters:
    
    dataStore - dataStore or null for none
  - getDirectUserRequest
```
public Boolean getDirectUserRequest()
```
    Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
    
    Returns:
    
    value or null for none
  - setDirectUserRequest
```
public GoogleCloudDiscoveryengineV1UserEvent setDirectUserRequest(Boolean directUserRequest)
```
    Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
    
    Parameters:
    
    directUserRequest - directUserRequest or null for none
  - getDocuments
```
public List<GoogleCloudDiscoveryengineV1DocumentInfo> getDocuments()
```
    List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media- complete` In a `search` event, this field represents the documents 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 UserEvent.documents is desired.
    
    Returns:
    
    value or null for none
  - setDocuments
```
public GoogleCloudDiscoveryengineV1UserEvent setDocuments(List<GoogleCloudDiscoveryengineV1DocumentInfo> documents)
```
    List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media- complete` In a `search` event, this field represents the documents 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 UserEvent.documents is desired.
    
    Parameters:
    
    documents - documents or null for none
  - getEngine
```
public String getEngine()
```
    The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.
    
    Returns:
    
    value or null for none
  - setEngine
```
public GoogleCloudDiscoveryengineV1UserEvent setEngine(String engine)
```
    The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.
    
    Parameters:
    
    engine - engine or null for none
  - getEntity
```
public String getEntity()
```
    Optional. Represents 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 `entity` to get better per-entity search, completion, and prediction results.
    
    Returns:
    
    value or null for none
  - setEntity
```
public GoogleCloudDiscoveryengineV1UserEvent setEntity(String entity)
```
    Optional. Represents 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 `entity` to get better per-entity search, completion, and prediction results.
    
    Parameters:
    
    entity - entity or null for none
  - getEventTime
```
public String getEventTime()
```
    Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.
    
    Returns:
    
    value or null for none
  - setEventTime
```
public GoogleCloudDiscoveryengineV1UserEvent setEventTime(String eventTime)
```
    Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.
    
    Parameters:
    
    eventTime - eventTime or null for none
  - getEventType
```
public String getEventType()
```
    Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category- page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media- related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media- complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.
    
    Returns:
    
    value or null for none
  - setEventType
```
public GoogleCloudDiscoveryengineV1UserEvent setEventType(String eventType)
```
    Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category- page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media- related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media- complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event.
    
    Parameters:
    
    eventType - eventType or null for none
  - getFilter
```
public String getFilter()
```
    Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
    
    Returns:
    
    value or null for none
  - setFilter
```
public GoogleCloudDiscoveryengineV1UserEvent setFilter(String filter)
```
    Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
    
    Parameters:
    
    filter - filter or null for none
  - getMediaInfo
```
public GoogleCloudDiscoveryengineV1MediaInfo getMediaInfo()
```
    Media-specific info.
    
    Returns:
    
    value or null for none
  - setMediaInfo
```
public GoogleCloudDiscoveryengineV1UserEvent setMediaInfo(GoogleCloudDiscoveryengineV1MediaInfo mediaInfo)
```
    Media-specific info.
    
    Parameters:
    
    mediaInfo - mediaInfo or null for none
  - getPageInfo
```
public GoogleCloudDiscoveryengineV1PageInfo getPageInfo()
```
    Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
    
    Returns:
    
    value or null for none
  - setPageInfo
```
public GoogleCloudDiscoveryengineV1UserEvent setPageInfo(GoogleCloudDiscoveryengineV1PageInfo pageInfo)
```
    Page metadata such as categories and other critical information for certain event types such as `view-category-page`.
    
    Parameters:
    
    pageInfo - pageInfo or null for none
  - getPanel
```
public GoogleCloudDiscoveryengineV1PanelInfo getPanel()
```
    Panel metadata associated with this user event.
    
    Returns:
    
    value or null for none
  - setPanel
```
public GoogleCloudDiscoveryengineV1UserEvent setPanel(GoogleCloudDiscoveryengineV1PanelInfo panel)
```
    Panel metadata associated with this user event.
    
    Parameters:
    
    panel - panel or null for none
  - getPanels
```
public List<GoogleCloudDiscoveryengineV1PanelInfo> getPanels()
```
    Optional. List of panels associated with this event. Used for page-level impression data.
    
    Returns:
    
    value or null for none
  - setPanels
```
public GoogleCloudDiscoveryengineV1UserEvent setPanels(List<GoogleCloudDiscoveryengineV1PanelInfo> panels)
```
    Optional. List of panels associated with this event. Used for page-level impression data.
    
    Parameters:
    
    panels - panels or null for none
  - getPromotionIds
```
public List<String> getPromotionIds()
```
    The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.
    
    Returns:
    
    value or null for none
  - setPromotionIds
```
public GoogleCloudDiscoveryengineV1UserEvent setPromotionIds(List<String> promotionIds)
```
    The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.
    
    Parameters:
    
    promotionIds - promotionIds or null for none
  - getSearchInfo
```
public GoogleCloudDiscoveryengineV1SearchInfo getSearchInfo()
```
    SearchService.Search details related to the event. This field should be set for `search` event.
    
    Returns:
    
    value or null for none
  - setSearchInfo
```
public GoogleCloudDiscoveryengineV1UserEvent setSearchInfo(GoogleCloudDiscoveryengineV1SearchInfo searchInfo)
```
    SearchService.Search details related to the event. This field should be set for `search` event.
    
    Parameters:
    
    searchInfo - searchInfo or null for none
  - getSessionId
```
public 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 session_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 UserEvent.user_pseudo_id as prefix.
    
    Returns:
    
    value or null for none
  - setSessionId
```
public GoogleCloudDiscoveryengineV1UserEvent setSessionId(String sessionId)
```
    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 session_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 UserEvent.user_pseudo_id as prefix.
    
    Parameters:
    
    sessionId - sessionId or null for none
  - getTagIds
```
public List<String> getTagIds()
```
    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.
    
    Returns:
    
    value or null for none
  - setTagIds
```
public GoogleCloudDiscoveryengineV1UserEvent setTagIds(List<String> tagIds)
```
    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.
    
    Parameters:
    
    tagIds - tagIds or null for none
  - getTransactionInfo
```
public GoogleCloudDiscoveryengineV1TransactionInfo getTransactionInfo()
```
    The transaction metadata (if any) associated with this user event.
    
    Returns:
    
    value or null for none
  - setTransactionInfo
```
public GoogleCloudDiscoveryengineV1UserEvent setTransactionInfo(GoogleCloudDiscoveryengineV1TransactionInfo transactionInfo)
```
    The transaction metadata (if any) associated with this user event.
    
    Parameters:
    
    transactionInfo - transactionInfo or null for none
  - getUserInfo
```
public GoogleCloudDiscoveryengineV1UserInfo getUserInfo()
```
    Information about the end user.
    
    Returns:
    
    value or null for none
  - setUserInfo
```
public GoogleCloudDiscoveryengineV1UserEvent setUserInfo(GoogleCloudDiscoveryengineV1UserInfo userInfo)
```
    Information about the end user.
    
    Parameters:
    
    userInfo - userInfo or null for none
  - getUserPseudoId
```
public String getUserPseudoId()
```
    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. Do not 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.
    
    Returns:
    
    value or null for none
  - setUserPseudoId
```
public GoogleCloudDiscoveryengineV1UserEvent setUserPseudoId(String userPseudoId)
```
    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. Do not 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.
    
    Parameters:
    
    userPseudoId - userPseudoId or null for none
  - set
```
public GoogleCloudDiscoveryengineV1UserEvent set(String fieldName,
                                                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1UserEvent clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1UserEvent

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1UserEvent

Method Detail

getAttributes

setAttributes

getAttributionToken

setAttributionToken

getCompletionInfo

setCompletionInfo

getConversionType

setConversionType

getDataStore

setDataStore

getDirectUserRequest

setDirectUserRequest

getDocuments

setDocuments

getEngine

setEngine

getEntity

setEntity

getEventTime

setEventTime

getEventType

setEventType

getFilter

setFilter

getMediaInfo

setMediaInfo

getPageInfo

setPageInfo

getPanel

setPanel

getPanels

setPanels

getPromotionIds

setPromotionIds

getSearchInfo

setSearchInfo

getSessionId

setSessionId

getTagIds

setTagIds

getTransactionInfo

setTransactionInfo

getUserInfo

setUserInfo

getUserPseudoId

setUserPseudoId

set

clone