Class UserEventServiceClientImpl

UserEventService client wrapper implementation, for convenient use.

Inheritance

System.Object

UserEventServiceClient

UserEventServiceClientImpl

Inherited Members

UserEventServiceClient.DefaultEndpoint

UserEventServiceClient.DefaultScopes

UserEventServiceClient.CreateAsync(CancellationToken)

UserEventServiceClient.Create()

UserEventServiceClient.ShutdownDefaultChannelsAsync()

UserEventServiceClient.WriteUserEventAsync(WriteUserEventRequest, CancellationToken)

UserEventServiceClient.CollectUserEventAsync(CollectUserEventRequest, CancellationToken)

UserEventServiceClient.PurgeUserEventsAsync(PurgeUserEventsRequest, CancellationToken)

UserEventServiceClient.PollOncePurgeUserEvents(String, CallSettings)

UserEventServiceClient.PollOncePurgeUserEventsAsync(String, CallSettings)

UserEventServiceClient.ImportUserEventsAsync(ImportUserEventsRequest, CancellationToken)

UserEventServiceClient.PollOnceImportUserEvents(String, CallSettings)

UserEventServiceClient.PollOnceImportUserEventsAsync(String, CallSettings)

UserEventServiceClient.RejoinUserEventsAsync(RejoinUserEventsRequest, CancellationToken)

UserEventServiceClient.PollOnceRejoinUserEvents(String, CallSettings)

UserEventServiceClient.PollOnceRejoinUserEventsAsync(String, CallSettings)

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 sealed class UserEventServiceClientImpl : UserEventServiceClient

Remarks

Service for ingesting end user actions on the customer website.

Constructors

UserEventServiceClientImpl(UserEventService.UserEventServiceClient, UserEventServiceSettings)

Constructs a client wrapper for the UserEventService service, with the specified gRPC client and settings.

Declaration

public UserEventServiceClientImpl(UserEventService.UserEventServiceClient grpcClient, UserEventServiceSettings settings)

Parameters

Type	Name	Description
UserEventService.UserEventServiceClient	grpcClient	The underlying gRPC client.
UserEventServiceSettings	settings	The base UserEventServiceSettings used within this client.

Properties

GrpcClient

The underlying gRPC UserEventService client

Declaration

public override UserEventService.UserEventServiceClient GrpcClient { get; }

Property Value

Type	Description
UserEventService.UserEventServiceClient

Overrides

UserEventServiceClient.GrpcClient

ImportUserEventsOperationsClient

The long-running operations client for ImportUserEvents.

Declaration

public override OperationsClient ImportUserEventsOperationsClient { get; }

Property Value

Type	Description
OperationsClient

Overrides

UserEventServiceClient.ImportUserEventsOperationsClient

PurgeUserEventsOperationsClient

The long-running operations client for PurgeUserEvents.

Declaration

public override OperationsClient PurgeUserEventsOperationsClient { get; }

Property Value

Type	Description
OperationsClient

Overrides

UserEventServiceClient.PurgeUserEventsOperationsClient

RejoinUserEventsOperationsClient

The long-running operations client for RejoinUserEvents.

Declaration

public override OperationsClient RejoinUserEventsOperationsClient { get; }

Property Value

Type	Description
OperationsClient

Overrides

UserEventServiceClient.RejoinUserEventsOperationsClient

Methods

CollectUserEvent(CollectUserEventRequest, CallSettings)

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 override HttpBody CollectUserEvent(CollectUserEventRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CollectUserEventRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
HttpBody	The RPC response.

Overrides

UserEventServiceClient.CollectUserEvent(CollectUserEventRequest, CallSettings)

CollectUserEventAsync(CollectUserEventRequest, CallSettings)

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 override Task<HttpBody> CollectUserEventAsync(CollectUserEventRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
CollectUserEventRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<HttpBody>	A Task containing the RPC response.

Overrides

UserEventServiceClient.CollectUserEventAsync(CollectUserEventRequest, CallSettings)

ImportUserEvents(ImportUserEventsRequest, CallSettings)

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 override Operation<ImportUserEventsResponse, ImportMetadata> ImportUserEvents(ImportUserEventsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ImportUserEventsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<ImportUserEventsResponse, ImportMetadata>	The RPC response.

Overrides

UserEventServiceClient.ImportUserEvents(ImportUserEventsRequest, CallSettings)

ImportUserEventsAsync(ImportUserEventsRequest, CallSettings)

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 override Task<Operation<ImportUserEventsResponse, ImportMetadata>> ImportUserEventsAsync(ImportUserEventsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
ImportUserEventsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<Operation<ImportUserEventsResponse, ImportMetadata>>	A Task containing the RPC response.

Overrides

UserEventServiceClient.ImportUserEventsAsync(ImportUserEventsRequest, CallSettings)

PurgeUserEvents(PurgeUserEventsRequest, CallSettings)

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 override Operation<PurgeUserEventsResponse, PurgeMetadata> PurgeUserEvents(PurgeUserEventsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
PurgeUserEventsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<PurgeUserEventsResponse, PurgeMetadata>	The RPC response.

Overrides

UserEventServiceClient.PurgeUserEvents(PurgeUserEventsRequest, CallSettings)

PurgeUserEventsAsync(PurgeUserEventsRequest, CallSettings)

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 override Task<Operation<PurgeUserEventsResponse, PurgeMetadata>> PurgeUserEventsAsync(PurgeUserEventsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
PurgeUserEventsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<Operation<PurgeUserEventsResponse, PurgeMetadata>>	A Task containing the RPC response.

Overrides

UserEventServiceClient.PurgeUserEventsAsync(PurgeUserEventsRequest, CallSettings)

RejoinUserEvents(RejoinUserEventsRequest, CallSettings)

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 override Operation<RejoinUserEventsResponse, RejoinUserEventsMetadata> RejoinUserEvents(RejoinUserEventsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RejoinUserEventsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
Operation<RejoinUserEventsResponse, RejoinUserEventsMetadata>	The RPC response.

Overrides

UserEventServiceClient.RejoinUserEvents(RejoinUserEventsRequest, CallSettings)

RejoinUserEventsAsync(RejoinUserEventsRequest, CallSettings)

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 override Task<Operation<RejoinUserEventsResponse, RejoinUserEventsMetadata>> RejoinUserEventsAsync(RejoinUserEventsRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
RejoinUserEventsRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<Operation<RejoinUserEventsResponse, RejoinUserEventsMetadata>>	A Task containing the RPC response.

Overrides

UserEventServiceClient.RejoinUserEventsAsync(RejoinUserEventsRequest, CallSettings)

WriteUserEvent(WriteUserEventRequest, CallSettings)

Writes a single user event.

Declaration

public override UserEvent WriteUserEvent(WriteUserEventRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
WriteUserEventRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
UserEvent	The RPC response.

Overrides

UserEventServiceClient.WriteUserEvent(WriteUserEventRequest, CallSettings)

WriteUserEventAsync(WriteUserEventRequest, CallSettings)

Writes a single user event.

Declaration

public override Task<UserEvent> WriteUserEventAsync(WriteUserEventRequest request, CallSettings callSettings = null)

Parameters

Type	Name	Description
WriteUserEventRequest	request	The request object containing all of the parameters for the API call.
CallSettings	callSettings	If not null, applies overrides to this RPC call.

Returns

Type	Description
System.Threading.Tasks.Task<UserEvent>	A Task containing the RPC response.

Overrides

UserEventServiceClient.WriteUserEventAsync(WriteUserEventRequest, CallSettings)