[BindServiceMethod(typeof(UserEventService), "BindService")]
public abstract class UserEventServiceBase
Base class for server-side implementations of UserEventService
Namespace
Google.Cloud.RecommendationEngine.V1Beta1Assembly
Google.Cloud.RecommendationEngine.V1Beta1.dll
Methods
CollectUserEvent(CollectUserEventRequest, ServerCallContext)
public virtual Task<HttpBody> CollectUserEvent(CollectUserEventRequest request, ServerCallContext context)
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain.
This method is used only by the Recommendations AI JavaScript pixel. Users should not call this method directly.
Parameters | |
---|---|
Name | Description |
request | CollectUserEventRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<HttpBody> | The response to send back to the client (wrapped by a task). |
ImportUserEvents(ImportUserEventsRequest, ServerCallContext)
public virtual Task<Operation> ImportUserEvents(ImportUserEventsRequest request, ServerCallContext context)
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
Parameters | |
---|---|
Name | Description |
request | ImportUserEventsRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Operation> | The response to send back to the client (wrapped by a task). |
ListUserEvents(ListUserEventsRequest, ServerCallContext)
public virtual Task<ListUserEventsResponse> ListUserEvents(ListUserEventsRequest request, ServerCallContext context)
Gets a list of user events within a time range, with potential filtering.
Parameters | |
---|---|
Name | Description |
request | ListUserEventsRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<ListUserEventsResponse> | The response to send back to the client (wrapped by a task). |
PurgeUserEvents(PurgeUserEventsRequest, ServerCallContext)
public virtual Task<Operation> PurgeUserEvents(PurgeUserEventsRequest request, ServerCallContext context)
Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.
Parameters | |
---|---|
Name | Description |
request | PurgeUserEventsRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Operation> | The response to send back to the client (wrapped by a task). |
WriteUserEvent(WriteUserEventRequest, ServerCallContext)
public virtual Task<UserEvent> WriteUserEvent(WriteUserEventRequest request, ServerCallContext context)
Writes a single user event.
Parameters | |
---|---|
Name | Description |
request | WriteUserEventRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<UserEvent> | The response to send back to the client (wrapped by a task). |