Represents a UserEvent.
Package
@google-cloud/retailConstructors
(constructor)(properties)
constructor(properties?: google.cloud.retail.v2alpha.IUserEvent);
Constructs a new UserEvent.
Parameter | |
---|---|
Name | Description |
properties |
IUserEvent
Properties to set |
Properties
attributes
public attributes: { [k: string]: google.cloud.retail.v2alpha.ICustomAttribute };
UserEvent attributes.
attributionToken
public attributionToken: string;
UserEvent attributionToken.
cartId
public cartId: string;
UserEvent cartId.
completionDetail
public completionDetail?: (google.cloud.retail.v2alpha.ICompletionDetail|null);
UserEvent completionDetail.
eventTime
public eventTime?: (google.protobuf.ITimestamp|null);
UserEvent eventTime.
eventType
public eventType: string;
UserEvent eventType.
experimentIds
public experimentIds: string[];
UserEvent experimentIds.
filter
public filter: string;
UserEvent filter.
offset
public offset: number;
UserEvent offset.
orderBy
public orderBy: string;
UserEvent orderBy.
pageCategories
public pageCategories: string[];
UserEvent pageCategories.
pageViewId
public pageViewId: string;
UserEvent pageViewId.
productDetails
public productDetails: google.cloud.retail.v2alpha.IProductDetail[];
UserEvent productDetails.
purchaseTransaction
public purchaseTransaction?: (google.cloud.retail.v2alpha.IPurchaseTransaction|null);
UserEvent purchaseTransaction.
referrerUri
public referrerUri: string;
UserEvent referrerUri.
searchQuery
public searchQuery: string;
UserEvent searchQuery.
sessionId
public sessionId: string;
UserEvent sessionId.
uri
public uri: string;
UserEvent uri.
userInfo
public userInfo?: (google.cloud.retail.v2alpha.IUserInfo|null);
UserEvent userInfo.
visitorId
public visitorId: string;
UserEvent visitorId.
Methods
create(properties)
public static create(properties?: google.cloud.retail.v2alpha.IUserEvent): google.cloud.retail.v2alpha.UserEvent;
Creates a new UserEvent instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IUserEvent
Properties to set |
Returns | |
---|---|
Type | Description |
google.cloud.retail.v2alpha.UserEvent | UserEvent instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2alpha.UserEvent;
Decodes a UserEvent message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
google.cloud.retail.v2alpha.UserEvent | UserEvent |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2alpha.UserEvent;
Decodes a UserEvent message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
($protobuf.Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
google.cloud.retail.v2alpha.UserEvent | UserEvent |
encode(message, writer)
public static encode(message: google.cloud.retail.v2alpha.IUserEvent, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified UserEvent message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IUserEvent
UserEvent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.retail.v2alpha.IUserEvent, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified UserEvent message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IUserEvent
UserEvent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
Returns | |
---|---|
Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2alpha.UserEvent;
Creates a UserEvent message from a plain object. Also converts values to their respective internal types.
Parameter | |
---|---|
Name | Description |
object |
{ [k: string]: any }
Plain object |
Returns | |
---|---|
Type | Description |
google.cloud.retail.v2alpha.UserEvent | UserEvent |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for UserEvent
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this UserEvent to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.retail.v2alpha.UserEvent, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from a UserEvent message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
google.cloud.retail.v2alpha.UserEvent
UserEvent |
options |
$protobuf.IConversionOptions
Conversion options |
Returns | |
---|---|
Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a UserEvent message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|