Constructor
new UserEvent(propertiesopt)
Constructs a new UserEvent.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.IUserEvent |
<optional> |
Properties to set |
- Implements:
-
- IUserEvent
Members
attributes
UserEvent attributes.
attributionToken
UserEvent attributionToken.
cartId
UserEvent cartId.
completionDetail
UserEvent completionDetail.
entity
UserEvent entity.
eventTime
UserEvent eventTime.
eventType
UserEvent eventType.
experimentIds
UserEvent experimentIds.
filter
UserEvent filter.
offset
UserEvent offset.
orderBy
UserEvent orderBy.
pageCategories
UserEvent pageCategories.
pageViewId
UserEvent pageViewId.
productDetails
UserEvent productDetails.
purchaseTransaction
UserEvent purchaseTransaction.
referrerUri
UserEvent referrerUri.
searchQuery
UserEvent searchQuery.
sessionId
UserEvent sessionId.
uri
UserEvent uri.
userInfo
UserEvent userInfo.
visitorId
UserEvent visitorId.
Methods
toJSON() → {Object.<string, *>}
Converts this UserEvent to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.retail.v2.UserEvent}
Creates a new UserEvent instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.retail.v2.IUserEvent |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.UserEvent |
UserEvent instance |
(static) decode(reader, lengthopt) → {google.cloud.retail.v2.UserEvent}
Decodes a UserEvent message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.UserEvent |
UserEvent |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.retail.v2.UserEvent}
Decodes a UserEvent message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.UserEvent |
UserEvent |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified UserEvent message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.IUserEvent |
UserEvent message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified UserEvent message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.IUserEvent |
UserEvent message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.retail.v2.UserEvent}
Creates a UserEvent message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.retail.v2.UserEvent |
UserEvent |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for UserEvent
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a UserEvent message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.retail.v2.UserEvent |
UserEvent |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a UserEvent message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|