Reference documentation and code samples for the Google Cloud Retail V2 Client class CollectUserEventRequest.
Request message for CollectUserEvent method.
Generated from protobuf message google.cloud.retail.v2.CollectUserEventRequest
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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.
↳ parent
string
Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog
.
↳ user_event
string
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
↳ 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.
↳ ets
int|string
The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
↳ 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.
getPrebuiltRule
The prebuilt rule name that can convert a specific type of raw_json.
For example: "ga4_bq" rule for the GA4 user event schema.
string
hasPrebuiltRule
setPrebuiltRule
The prebuilt rule name that can convert a specific type of raw_json.
For example: "ga4_bq" rule for the GA4 user event schema.
var
string
$this
getParent
Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog
.
string
setParent
Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog
.
var
string
$this
getUserEvent
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
string
setUserEvent
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
var
string
$this
getUri
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.
string
setUri
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.
var
string
$this
getEts
The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
int|string
setEts
The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
var
int|string
$this
getRawJson
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.
string
setRawJson
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.
var
string
$this
getConversionRule
string
