Class: Google::Cloud::Retail::V2::CollectUserEventRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/user_event_service.rb

Overview

Request message for CollectUserEvent method.

Instance Attribute Summary collapse

Instance Attribute Details

#ets ⇒ ::Integer

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

Returns:

  • (::Integer) —

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



73
74
75
76
 
# File 'proto_docs/google/cloud/retail/v2/user_event_service.rb', line 73

class CollectUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.

Returns:

  • (::String) —

    Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.



73
74
75
76
 
# File 'proto_docs/google/cloud/retail/v2/user_event_service.rb', line 73

class CollectUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#prebuilt_rule ⇒ ::String

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

Returns:

  • (::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.



73
74
75
76
 
# File 'proto_docs/google/cloud/retail/v2/user_event_service.rb', line 73

class CollectUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#raw_json ⇒ ::String

Returns 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.

Returns:

  • (::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.



73
74
75
76
 
# File 'proto_docs/google/cloud/retail/v2/user_event_service.rb', line 73

class CollectUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#uri ⇒ ::String

Returns 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.

Returns:

  • (::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.



73
74
75
76
 
# File 'proto_docs/google/cloud/retail/v2/user_event_service.rb', line 73

class CollectUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#user_event ⇒ ::String

Returns Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

Returns:

  • (::String) —

    Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.



73
74
75
76
 
# File 'proto_docs/google/cloud/retail/v2/user_event_service.rb', line 73

class CollectUserEventRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end