Class: Google::Apis::RetailV2::GoogleCloudRetailV2UserEvent

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2UserEvent

Returns a new instance of GoogleCloudRetailV2UserEvent.



1515
1516
1517
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1515

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attributes ⇒ Hash<String,Google::Apis::RetailV2::GoogleCloudRetailV2CustomAttribute>

Extra user event features to include in the recommendation model. The key must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. For product recommendation, an example of extra user information is traffic_channel, i.e. how user arrives at the site. Users can arrive at the site by coming to the site directly, or coming through Google search, and etc. Corresponds to the JSON property attributes

Returns:



1384
1385
1386
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1384

def attributes
  @attributes
end

#attribution_token ⇒ String

Highly recommended for user events that are the result of PredictionService. Predict. This field enables accurate attribution of recommendation model performance. The value must be a valid PredictResponse.attribution_token for user events that are the result of PredictionService.Predict. 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 as a URL parameter to product K's page. When recording events on product K's page, log the PredictResponse.attribution_token to this field. Corresponds to the JSON property attributionToken

Returns:

  • (String) 


1398
1399
1400
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1398

def attribution_token
  @attribution_token
end

#cart_id ⇒ String

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. Corresponds to the JSON property cartId

Returns:

  • (String) 


1406
1407
1408
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1406

def cart_id
  @cart_id
end

#event_time ⇒ String

Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. Corresponds to the JSON property eventTime

Returns:

  • (String) 


1412
1413
1414
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1412

def event_time
  @event_time
end

#event_type ⇒ String

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. * completion: Completion query result showed/clicked. * 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. Corresponds to the JSON property eventType

Returns:

  • (String) 


1424
1425
1426
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1424

def event_type
  @event_type
end

#experiment_ids ⇒ Array<String>

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). Corresponds to the JSON property experimentIds

Returns:

  • (Array<String>) 


1432
1433
1434
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1432

def experiment_ids
  @experiment_ids
end

#page_categories ⇒ Array<String>

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, please 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 or page_categories is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property pageCategories

Returns:

  • (Array<String>) 


1445
1446
1447
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1445

def page_categories
  @page_categories
end

#page_view_id ⇒ String

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. Corresponds to the JSON property pageViewId

Returns:

  • (String) 


1456
1457
1458
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1456

def page_view_id
  @page_view_id
end

#product_details ⇒ Array<Google::Apis::RetailV2::GoogleCloudRetailV2ProductDetail>

The main product details related to the event. This field is required 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 broswing 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 is desired. The end user may have not finished broswing the whole page yet. Corresponds to the JSON property productDetails

Returns:



1468
1469
1470
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1468

def product_details
  @product_details
end

#purchase_transaction ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2PurchaseTransaction

A transaction represents the entire purchase transaction. Corresponds to the JSON property purchaseTransaction

Returns:



1473
1474
1475
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1473

def purchase_transaction
  @purchase_transaction
end

#referrer_uri ⇒ String

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. Corresponds to the JSON property referrerUri

Returns:

  • (String) 


1480
1481
1482
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1480

def referrer_uri
  @referrer_uri
end

#search_query ⇒ String

The user's search query. 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 or page_categories is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON property searchQuery

Returns:

  • (String) 


1489
1490
1491
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1489

def search_query
  @search_query
end

#uri ⇒ String

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. Corresponds to the JSON property uri

Returns:

  • (String) 


1496
1497
1498
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1496

def uri
  @uri
end

#user_info ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2UserInfo

Information of an end user. Corresponds to the JSON property userInfo

Returns:



1501
1502
1503
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1501

def 
  @user_info
end

#visitor_id ⇒ String

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. 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 Analystics Client ID for this field. Corresponds to the JSON property visitorId

Returns:

  • (String) 


1513
1514
1515
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1513

def visitor_id
  @visitor_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1520

def update!(**args)
  @attributes = args[:attributes] if args.key?(:attributes)
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
  @cart_id = args[:cart_id] if args.key?(:cart_id)
  @event_time = args[:event_time] if args.key?(:event_time)
  @event_type = args[:event_type] if args.key?(:event_type)
  @experiment_ids = args[:experiment_ids] if args.key?(:experiment_ids)
  @page_categories = args[:page_categories] if args.key?(:page_categories)
  @page_view_id = args[:page_view_id] if args.key?(:page_view_id)
  @product_details = args[:product_details] if args.key?(:product_details)
  @purchase_transaction = args[:purchase_transaction] if args.key?(:purchase_transaction)
  @referrer_uri = args[:referrer_uri] if args.key?(:referrer_uri)
  @search_query = args[:search_query] if args.key?(:search_query)
  @uri = args[:uri] if args.key?(:uri)
  @user_info = args[:user_info] if args.key?(:user_info)
  @visitor_id = args[:visitor_id] if args.key?(:visitor_id)
end