Reference documentation and code samples for the Google Cloud Retail V2 Client class CollectUserEventRequest.
Request message for CollectUserEvent method.
Generated from protobuf messagegoogle.cloud.retail.v2.CollectUserEventRequest
Namespace
Google \ Cloud \ Retail \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
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 asprojects/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.
Returns
Type
Description
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getParent
Required. The parent catalog name, such asprojects/1234/locations/global/catalogs/default_catalog.
Returns
Type
Description
string
setParent
Required. The parent catalog name, such asprojects/1234/locations/global/catalogs/default_catalog.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getUserEvent
Required. URL encoded UserEvent proto with a length limit of 2,000,000
characters.
Returns
Type
Description
string
setUserEvent
Required. URL encoded UserEvent proto with a length limit of 2,000,000
characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$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.
Returns
Type
Description
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Retail V2 Client - Class CollectUserEventRequest (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-retail/latest/V2.CollectUserEventRequest)\n- [2.3.0](/php/docs/reference/cloud-retail/2.3.0/V2.CollectUserEventRequest)\n- [2.2.1](/php/docs/reference/cloud-retail/2.2.1/V2.CollectUserEventRequest)\n- [2.1.3](/php/docs/reference/cloud-retail/2.1.3/V2.CollectUserEventRequest)\n- [2.0.0](/php/docs/reference/cloud-retail/2.0.0/V2.CollectUserEventRequest)\n- [1.7.0](/php/docs/reference/cloud-retail/1.7.0/V2.CollectUserEventRequest)\n- [1.6.4](/php/docs/reference/cloud-retail/1.6.4/V2.CollectUserEventRequest)\n- [1.5.0](/php/docs/reference/cloud-retail/1.5.0/V2.CollectUserEventRequest)\n- [1.4.2](/php/docs/reference/cloud-retail/1.4.2/V2.CollectUserEventRequest)\n- [1.3.1](/php/docs/reference/cloud-retail/1.3.1/V2.CollectUserEventRequest)\n- [1.2.1](/php/docs/reference/cloud-retail/1.2.1/V2.CollectUserEventRequest)\n- [1.1.1](/php/docs/reference/cloud-retail/1.1.1/V2.CollectUserEventRequest)\n- [1.0.1](/php/docs/reference/cloud-retail/1.0.1/V2.CollectUserEventRequest) \nReference documentation and code samples for the Google Cloud Retail V2 Client class CollectUserEventRequest.\n\nRequest message for CollectUserEvent method.\n\nGenerated from protobuf message `google.cloud.retail.v2.CollectUserEventRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Retail \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPrebuiltRule\n\nThe prebuilt rule name that can convert a specific type of raw_json.\n\nFor example: \"ga4_bq\" rule for the GA4 user event schema.\n\n### hasPrebuiltRule\n\n### setPrebuiltRule\n\nThe prebuilt rule name that can convert a specific type of raw_json.\n\nFor example: \"ga4_bq\" rule for the GA4 user event schema.\n\n### getParent\n\nRequired. The parent catalog name, such as\n`projects/1234/locations/global/catalogs/default_catalog`.\n\n### setParent\n\nRequired. The parent catalog name, such as\n`projects/1234/locations/global/catalogs/default_catalog`.\n\n### getUserEvent\n\nRequired. URL encoded UserEvent proto with a length limit of 2,000,000\ncharacters.\n\n### setUserEvent\n\nRequired. URL encoded UserEvent proto with a length limit of 2,000,000\ncharacters.\n\n### getUri\n\nThe URL including cgi-parameters but excluding the hash fragment with a\nlength limit of 5,000 characters. This is often more useful than the\nreferer URL, because many browsers only send the domain for 3rd party\nrequests.\n\n### setUri\n\nThe URL including cgi-parameters but excluding the hash fragment with a\nlength limit of 5,000 characters. This is often more useful than the\nreferer URL, because many browsers only send the domain for 3rd party\nrequests.\n\n### getEts\n\nThe event timestamp in milliseconds. This prevents browser caching of\notherwise identical get requests. The name is abbreviated to reduce the\npayload bytes.\n\n### setEts\n\nThe event timestamp in milliseconds. This prevents browser caching of\notherwise identical get requests. The name is abbreviated to reduce the\npayload bytes.\n\n### getRawJson\n\nAn arbitrary serialized JSON string that contains necessary information\nthat can comprise a user event. When this field is specified, the\nuser_event field will be ignored. Note: line-delimited JSON is not\nsupported, a single JSON only.\n\n### setRawJson\n\nAn arbitrary serialized JSON string that contains necessary information\nthat can comprise a user event. When this field is specified, the\nuser_event field will be ignored. Note: line-delimited JSON is not\nsupported, a single JSON only.\n\n### getConversionRule"]]
