Google Cloud Discovery Engine V1 Client - Class CollectUserEventRequest (0.6.0)

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 DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} .

↳ 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.

getParent

Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} .

Returns
Type
Description
string

setParent

Required. The parent DataStore resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store} .

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

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 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

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.

Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: