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 \ V1Methods
__construct
Constructor.
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}
.
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}
.
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 third-party requests.
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.
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
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.
var
int|string
$this
