Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaCollectUserEventRequest

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

Overview

Request message for CollectUserEvent method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaCollectUserEventRequest

Returns a new instance of GoogleCloudRetailV2alphaCollectUserEventRequest.



2273
2274
2275
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2273

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

Instance Attribute Details

#ets ⇒ Fixnum

The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. Corresponds to the JSON property ets

Returns:

  • (Fixnum) 


2244
2245
2246
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2244

def ets
  @ets
end

#prebuilt_rule ⇒ String

The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema. Corresponds to the JSON property prebuiltRule

Returns:

  • (String) 


2250
2251
2252
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2250

def prebuilt_rule
  @prebuilt_rule
end

#raw_json ⇒ String

An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only. Corresponds to the JSON property rawJson

Returns:

  • (String) 


2258
2259
2260
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2258

def raw_json
  @raw_json
end

#uri ⇒ String

The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests. Corresponds to the JSON property uri

Returns:

  • (String) 


2265
2266
2267
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2265

def uri
  @uri
end

#user_event ⇒ String

Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. Corresponds to the JSON property userEvent

Returns:

  • (String) 


2271
2272
2273
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2271

def user_event
  @user_event
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2278
2279
2280
2281
2282
2283
2284
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2278

def update!(**args)
  @ets = args[:ets] if args.key?(:ets)
  @prebuilt_rule = args[:prebuilt_rule] if args.key?(:prebuilt_rule)
  @raw_json = args[:raw_json] if args.key?(:raw_json)
  @uri = args[:uri] if args.key?(:uri)
  @user_event = args[:user_event] if args.key?(:user_event)
end