Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::CollectUserEventRequest.
Request message for CollectUserEvent method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#ets
def ets() -> ::Integer
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.
#ets=
def ets=(value) -> ::Integer
Parameter
- value (::Integer) — 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.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The parent catalog name, such as
projects/1234/locations/global/catalogs/default_catalog.
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — 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.
#prebuilt_rule
def prebuilt_rule() -> ::String
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.
#prebuilt_rule=
def prebuilt_rule=(value) -> ::String
Parameter
- value (::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.
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.
#raw_json
def raw_json() -> ::String
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.
#raw_json=
def raw_json=(value) -> ::String
Parameter
- value (::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.
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.
#uri
def uri() -> ::String
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.
#uri=
def uri=(value) -> ::String
Parameter
- value (::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.
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.
#user_event
def user_event() -> ::String
Returns
- (::String) — Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
#user_event=
def user_event=(value) -> ::String
Parameter
- value (::String) — 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.