Class UserEventService.UserEventServiceClient

Client for UserEventService

Inheritance
System.Object
ClientBase
ClientBase<UserEventService.UserEventServiceClient>
UserEventService.UserEventServiceClient
Inherited Members
System.Object.ToString()
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Cloud.Retail.V2
Assembly: Google.Cloud.Retail.V2.dll
Syntax
public class UserEventServiceClient : ClientBase<UserEventService.UserEventServiceClient>

Constructors

UserEventServiceClient()

Protected parameterless constructor to allow creation of test doubles.

Declaration
protected UserEventServiceClient()

UserEventServiceClient(CallInvoker)

Creates a new client for UserEventService that uses a custom CallInvoker.

Declaration
public UserEventServiceClient(CallInvoker callInvoker)
Parameters
Type Name Description
CallInvoker callInvoker

The callInvoker to use to make remote calls.

UserEventServiceClient(ChannelBase)

Creates a new client for UserEventService

Declaration
public UserEventServiceClient(ChannelBase channel)
Parameters
Type Name Description
ChannelBase channel

The channel to use to make remote calls.

UserEventServiceClient(ClientBase.ClientBaseConfiguration)

Protected constructor to allow creation of configured clients.

Declaration
protected UserEventServiceClient(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration

The client configuration.

Methods

CollectUserEvent(CollectUserEventRequest, CallOptions)

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 Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Declaration
public virtual HttpBody CollectUserEvent(CollectUserEventRequest request, CallOptions options)
Parameters
Type Name Description
CollectUserEventRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
HttpBody

The response received from the server.

CollectUserEvent(CollectUserEventRequest, Metadata, Nullable<DateTime>, CancellationToken)

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 Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Declaration
public virtual HttpBody CollectUserEvent(CollectUserEventRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
CollectUserEventRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
HttpBody

The response received from the server.

CollectUserEventAsync(CollectUserEventRequest, CallOptions)

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 Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Declaration
public virtual AsyncUnaryCall<HttpBody> CollectUserEventAsync(CollectUserEventRequest request, CallOptions options)
Parameters
Type Name Description
CollectUserEventRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
AsyncUnaryCall<HttpBody>

The call object.

CollectUserEventAsync(CollectUserEventRequest, Metadata, Nullable<DateTime>, CancellationToken)

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 Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Declaration
public virtual AsyncUnaryCall<HttpBody> CollectUserEventAsync(CollectUserEventRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
CollectUserEventRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<HttpBody>

The call object.

CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Declaration
public virtual Operations.OperationsClient CreateOperationsClient()
Returns
Type Description
Operations.OperationsClient

A new Operations client for the same target as this client.

ImportUserEvents(ImportUserEventsRequest, CallOptions)

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.

Declaration
public virtual Operation ImportUserEvents(ImportUserEventsRequest request, CallOptions options)
Parameters
Type Name Description
ImportUserEventsRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
Operation

The response received from the server.

ImportUserEvents(ImportUserEventsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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.

Declaration
public virtual Operation ImportUserEvents(ImportUserEventsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
ImportUserEventsRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

ImportUserEventsAsync(ImportUserEventsRequest, CallOptions)

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.

Declaration
public virtual AsyncUnaryCall<Operation> ImportUserEventsAsync(ImportUserEventsRequest request, CallOptions options)
Parameters
Type Name Description
ImportUserEventsRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

ImportUserEventsAsync(ImportUserEventsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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.

Declaration
public virtual AsyncUnaryCall<Operation> ImportUserEventsAsync(ImportUserEventsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
ImportUserEventsRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

Creates a new instance of client from given ClientBaseConfiguration.

Declaration
protected override UserEventService.UserEventServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)
Parameters
Type Name Description
ClientBase.ClientBaseConfiguration configuration
Returns
Type Description
UserEventService.UserEventServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Retail.V2.UserEventService.UserEventServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PurgeUserEvents(PurgeUserEventsRequest, CallOptions)

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.

Declaration
public virtual Operation PurgeUserEvents(PurgeUserEventsRequest request, CallOptions options)
Parameters
Type Name Description
PurgeUserEventsRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
Operation

The response received from the server.

PurgeUserEvents(PurgeUserEventsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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.

Declaration
public virtual Operation PurgeUserEvents(PurgeUserEventsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
PurgeUserEventsRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

PurgeUserEventsAsync(PurgeUserEventsRequest, CallOptions)

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.

Declaration
public virtual AsyncUnaryCall<Operation> PurgeUserEventsAsync(PurgeUserEventsRequest request, CallOptions options)
Parameters
Type Name Description
PurgeUserEventsRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

PurgeUserEventsAsync(PurgeUserEventsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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.

Declaration
public virtual AsyncUnaryCall<Operation> PurgeUserEventsAsync(PurgeUserEventsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
PurgeUserEventsRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

RejoinUserEvents(RejoinUserEventsRequest, CallOptions)

Triggers a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of product catalog. It can also be used to correct events joined with wrong product catalog.

Declaration
public virtual Operation RejoinUserEvents(RejoinUserEventsRequest request, CallOptions options)
Parameters
Type Name Description
RejoinUserEventsRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
Operation

The response received from the server.

RejoinUserEvents(RejoinUserEventsRequest, Metadata, Nullable<DateTime>, CancellationToken)

Triggers a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of product catalog. It can also be used to correct events joined with wrong product catalog.

Declaration
public virtual Operation RejoinUserEvents(RejoinUserEventsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
RejoinUserEventsRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
Operation

The response received from the server.

RejoinUserEventsAsync(RejoinUserEventsRequest, CallOptions)

Triggers a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of product catalog. It can also be used to correct events joined with wrong product catalog.

Declaration
public virtual AsyncUnaryCall<Operation> RejoinUserEventsAsync(RejoinUserEventsRequest request, CallOptions options)
Parameters
Type Name Description
RejoinUserEventsRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

RejoinUserEventsAsync(RejoinUserEventsRequest, Metadata, Nullable<DateTime>, CancellationToken)

Triggers a user event rejoin operation with latest product catalog. Events will not be annotated with detailed product information if product is missing from the catalog at the time the user event is ingested, and these events are stored as unjoined events with a limited usage on training and serving. This API can be used to trigger a 'join' operation on specified events with latest version of product catalog. It can also be used to correct events joined with wrong product catalog.

Declaration
public virtual AsyncUnaryCall<Operation> RejoinUserEventsAsync(RejoinUserEventsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
RejoinUserEventsRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<Operation>

The call object.

WriteUserEvent(WriteUserEventRequest, CallOptions)

Writes a single user event.

Declaration
public virtual UserEvent WriteUserEvent(WriteUserEventRequest request, CallOptions options)
Parameters
Type Name Description
WriteUserEventRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
UserEvent

The response received from the server.

WriteUserEvent(WriteUserEventRequest, Metadata, Nullable<DateTime>, CancellationToken)

Writes a single user event.

Declaration
public virtual UserEvent WriteUserEvent(WriteUserEventRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
WriteUserEventRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
UserEvent

The response received from the server.

WriteUserEventAsync(WriteUserEventRequest, CallOptions)

Writes a single user event.

Declaration
public virtual AsyncUnaryCall<UserEvent> WriteUserEventAsync(WriteUserEventRequest request, CallOptions options)
Parameters
Type Name Description
WriteUserEventRequest request

The request to send to the server.
CallOptions options

The options for the call.
Returns
Type Description
AsyncUnaryCall<UserEvent>

The call object.

WriteUserEventAsync(WriteUserEventRequest, Metadata, Nullable<DateTime>, CancellationToken)

Writes a single user event.

Declaration
public virtual AsyncUnaryCall<UserEvent> WriteUserEventAsync(WriteUserEventRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
WriteUserEventRequest request

The request to send to the server.
Metadata headers

The initial metadata to send with the call. This parameter is optional.
System.Nullable<System.DateTime> deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.
System.Threading.CancellationToken cancellationToken

An optional token for canceling the call.
Returns
Type Description
AsyncUnaryCall<UserEvent>

The call object.