Google Cloud Discovery Engine V1beta Client - Class CollectUserEventRequest (0.7.1)

Version 0.7.1

• 0.11.2 (latest)
• 0.11.1
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class CollectUserEventRequest.

Request message for CollectUserEvent method.

Generated from protobuf message google.cloud.discoveryengine.v1beta.CollectUserEventRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

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

Parameter
Name	Description
var	int|string

Returns
Type	Description
$this