Reference documentation and code samples for the Google Cloud Retail V2 Client class CollectUserEventRequest.
Request message for CollectUserEvent method.
Generated from protobuf message google.cloud.retail.v2.CollectUserEventRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent catalog name, such as |
↳ 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 catalog name, such as
projects/1234/locations/global/catalogs/default_catalog.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent catalog name, such as
projects/1234/locations/global/catalogs/default_catalog.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUserEvent
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
Generated from protobuf field string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setUserEvent
Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
Generated from protobuf field string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
| 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.
Generated from protobuf field string uri = 3;
| 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.
Generated from protobuf field string uri = 3;
| 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.
Generated from protobuf field int64 ets = 4;
| 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.
Generated from protobuf field int64 ets = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |