Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CollectUserEventRequest.
Request message for CollectUserEvent method.
Generated from protobuf message google.cloud.discoveryengine.v1.CollectUserEventRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent resource name. If the collect user event action is applied in DataStore level, the format is: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. If the collect user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: projects/{project}/locations/{location}.
↳ 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 third-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.
getParent
Required. The parent resource name.
If the collect user event action is applied in
DataStore level, the format
is:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.
If the collect user event action is applied in
Location level, for example, the event
with Document across multiple
DataStore, the format is:
projects/{project}/locations/{location}.
Returns
Type
Description
string
setParent
Required. The parent resource name.
If the collect user event action is applied in
DataStore level, the format
is:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.
If the collect user event action is applied in
Location level, for example, the event
with Document across multiple
DataStore, the format is:
projects/{project}/locations/{location}.
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 third-party
requests.
Returns
Type
Description
string
hasUri
clearUri
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 third-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
hasEts
clearEts
setEts
The event timestamp in milliseconds. This prevents browser caching of
otherwise identical get requests. The name is abbreviated to reduce the
payload bytes.
[[["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 Discovery Engine V1 Client - Class CollectUserEventRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.CollectUserEventRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.CollectUserEventRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.CollectUserEventRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.CollectUserEventRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.CollectUserEventRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.CollectUserEventRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.CollectUserEventRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.CollectUserEventRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.CollectUserEventRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.CollectUserEventRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.CollectUserEventRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.CollectUserEventRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.CollectUserEventRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.CollectUserEventRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.CollectUserEventRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.CollectUserEventRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.CollectUserEventRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CollectUserEventRequest.\n\nRequest message for CollectUserEvent method.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.CollectUserEventRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent resource name.\n\nIf the collect user event action is applied in\n[DataStore](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore) level, the format\nis:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.\nIf the collect user event action is applied in\n[Location](https://cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html) level, for example, the event\nwith [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) across multiple\n[DataStore](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore), the format is:\n`projects/{project}/locations/{location}`.\n\n### setParent\n\nRequired. The parent resource name.\n\nIf the collect user event action is applied in\n[DataStore](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore) level, the format\nis:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.\nIf the collect user event action is applied in\n[Location](https://cloud.google.com/php/docs/reference/common-protos/latest/Cloud.Location.Location.html) level, for example, the event\nwith [Document](/php/docs/reference/cloud-discoveryengine/latest/V1.Document) across multiple\n[DataStore](/php/docs/reference/cloud-discoveryengine/latest/V1.DataStore), the format is:\n`projects/{project}/locations/{location}`.\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 third-party\nrequests.\n\n### hasUri\n\n### clearUri\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 third-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### hasEts\n\n### clearEts\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."]]
