GoogleCloudRetailV2UserEvent class

UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.

Constructors

GoogleCloudRetailV2UserEvent({Map<String, GoogleCloudRetailV2CustomAttribute>? attributes, String? attributionToken, String? cartId, GoogleCloudRetailV2CompletionDetail? completionDetail, String? entity, String? eventTime, String? eventType, List<String>? experimentIds, String? filter, int? offset, String? orderBy, List<String>? pageCategories, String? pageViewId, List<GoogleCloudRetailV2ProductDetail>? productDetails, GoogleCloudRetailV2PurchaseTransaction? purchaseTransaction, String? referrerUri, String? searchQuery, String? sessionId, String? uri, GoogleCloudRetailV2UserInfo? userInfo, String? visitorId})

GoogleCloudRetailV2UserEvent.fromJson(Map json_)

Properties

attributes ↔ Map<String, GoogleCloudRetailV2CustomAttribute>?

Extra user event features to include in the recommendation model.

getter/setter pair

attributionToken ↔ String?

Highly recommended for user events that are the result of PredictionService.Predict.

getter/setter pair

cartId ↔ String?

The ID or name of the associated shopping cart.

getter/setter pair

completionDetail ↔ GoogleCloudRetailV2CompletionDetail?

The main auto-completion details related to the event.

getter/setter pair

entity ↔ String?

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.

getter/setter pair

eventTime ↔ String?

Only required for UserEventService.ImportUserEvents method.

getter/setter pair

eventType ↔ String?

User event type.

getter/setter pair

experimentIds ↔ List<String>?

A list of identifiers for the independent experiment groups this user event belongs to.

getter/setter pair

filter ↔ String?

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

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

offset ↔ int?

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

getter/setter pair

orderBy ↔ String?

The order in which products are returned.

getter/setter pair

pageCategories ↔ List<String>?

The categories associated with a category page.

getter/setter pair

pageViewId ↔ String?

A unique ID of a web page view.

getter/setter pair

productDetails ↔ List<GoogleCloudRetailV2ProductDetail>?

The main product details related to the event.

getter/setter pair

purchaseTransaction ↔ GoogleCloudRetailV2PurchaseTransaction?

A transaction represents the entire purchase transaction.

getter/setter pair

referrerUri ↔ String?

The referrer URL of the current page.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchQuery ↔ String?

The user's search query.

getter/setter pair

sessionId ↔ String?

A unique identifier for tracking a visitor session with a length limit of 128 bytes.

getter/setter pair

uri ↔ String?

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

getter/setter pair

userInfo ↔ GoogleCloudRetailV2UserInfo?

User information.

getter/setter pair

visitorId ↔ String?

A unique identifier for tracking visitors.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited