UserEventService

google.cloud.retail.v2. UserEventService

Represents a UserEventService

Constructor

new UserEventService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new UserEventService service.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited

Extends

  • $protobuf.rpc.Service

Methods

collectUserEvent(request, callback) → {undefined}

Calls CollectUserEvent.

Parameters:
Name Type Description
request google.cloud.retail.v2.ICollectUserEventRequest

CollectUserEventRequest message or plain object
callback google.cloud.retail.v2.UserEventService.CollectUserEventCallback

Node-style callback called with the error, if any, and HttpBody
Returns:
Type Description
undefined

collectUserEvent(request) → {Promise.<google.api.HttpBody>}

Calls CollectUserEvent.

Parameters:
Name Type Description
request google.cloud.retail.v2.ICollectUserEventRequest

CollectUserEventRequest message or plain object
Returns:
Type Description
Promise.<google.api.HttpBody>

Promise

importUserEvents(request, callback) → {undefined}

Calls ImportUserEvents.

Parameters:
Name Type Description
request google.cloud.retail.v2.IImportUserEventsRequest

ImportUserEventsRequest message or plain object
callback google.cloud.retail.v2.UserEventService.ImportUserEventsCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

importUserEvents(request) → {Promise.<google.longrunning.Operation>}

Calls ImportUserEvents.

Parameters:
Name Type Description
request google.cloud.retail.v2.IImportUserEventsRequest

ImportUserEventsRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

purgeUserEvents(request, callback) → {undefined}

Calls PurgeUserEvents.

Parameters:
Name Type Description
request google.cloud.retail.v2.IPurgeUserEventsRequest

PurgeUserEventsRequest message or plain object
callback google.cloud.retail.v2.UserEventService.PurgeUserEventsCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

purgeUserEvents(request) → {Promise.<google.longrunning.Operation>}

Calls PurgeUserEvents.

Parameters:
Name Type Description
request google.cloud.retail.v2.IPurgeUserEventsRequest

PurgeUserEventsRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

rejoinUserEvents(request, callback) → {undefined}

Calls RejoinUserEvents.

Parameters:
Name Type Description
request google.cloud.retail.v2.IRejoinUserEventsRequest

RejoinUserEventsRequest message or plain object
callback google.cloud.retail.v2.UserEventService.RejoinUserEventsCallback

Node-style callback called with the error, if any, and Operation
Returns:
Type Description
undefined

rejoinUserEvents(request) → {Promise.<google.longrunning.Operation>}

Calls RejoinUserEvents.

Parameters:
Name Type Description
request google.cloud.retail.v2.IRejoinUserEventsRequest

RejoinUserEventsRequest message or plain object
Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

writeUserEvent(request, callback) → {undefined}

Calls WriteUserEvent.

Parameters:
Name Type Description
request google.cloud.retail.v2.IWriteUserEventRequest

WriteUserEventRequest message or plain object
callback google.cloud.retail.v2.UserEventService.WriteUserEventCallback

Node-style callback called with the error, if any, and UserEvent
Returns:
Type Description
undefined

writeUserEvent(request) → {Promise.<google.cloud.retail.v2.UserEvent>}

Calls WriteUserEvent.

Parameters:
Name Type Description
request google.cloud.retail.v2.IWriteUserEventRequest

WriteUserEventRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.retail.v2.UserEvent>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {UserEventService}

Creates new UserEventService service using the specified rpc implementation.

Parameters:
Name Type Attributes Default Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean <optional>
 false

Whether requests are length-delimited
responseDelimited boolean <optional>
 false

Whether responses are length-delimited
Returns:
Type Description
UserEventService

RPC service. Useful where requests and/or responses are streamed.

Type Definitions

CollectUserEventCallback(error, responseopt)

Callback as used by collectUserEvent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.api.HttpBody <optional>

HttpBody

ImportUserEventsCallback(error, responseopt)

Callback as used by importUserEvents.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

PurgeUserEventsCallback(error, responseopt)

Callback as used by purgeUserEvents.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

RejoinUserEventsCallback(error, responseopt)

Callback as used by rejoinUserEvents.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

WriteUserEventCallback(error, responseopt)

Callback as used by writeUserEvent.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.retail.v2.UserEvent <optional>

UserEvent