Retail v2 API - Class UserEventService.UserEventServiceClient (2.11.0)

Version 2.11.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class UserEventService.UserEventServiceClient : ClientBase<UserEventService.UserEventServiceClient>

Reference documentation and code samples for the Retail v2 API class UserEventService.UserEventServiceClient.

Client for UserEventService

Inheritance

object > ClientBase > ClientBaseUserEventServiceUserEventServiceClient > UserEventService.UserEventServiceClient

Inherited Members

ClientBase<UserEventService.UserEventServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

UserEventServiceClient()

protected UserEventServiceClient()

Protected parameterless constructor to allow creation of test doubles.

UserEventServiceClient(CallInvoker)

public UserEventServiceClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

UserEventServiceClient(ChannelBase)

public UserEventServiceClient(ChannelBase channel)

Creates a new client for UserEventService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

UserEventServiceClient(ClientBaseConfiguration)

protected UserEventServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CollectUserEvent(CollectUserEventRequest, CallOptions)

public virtual HttpBody CollectUserEvent(CollectUserEventRequest request, CallOptions options)

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.

Parameters
Name	Description
request	CollectUserEventRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
HttpBody	The response received from the server.

CollectUserEvent(CollectUserEventRequest, Metadata, DateTime?, CancellationToken)

public virtual HttpBody CollectUserEvent(CollectUserEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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.

Parameters
Name	Description
request	CollectUserEventRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
HttpBody	The response received from the server.

CollectUserEventAsync(CollectUserEventRequest, CallOptions)

public virtual AsyncUnaryCall<HttpBody> CollectUserEventAsync(CollectUserEventRequest request, CallOptions options)

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.

Parameters
Name	Description
request	CollectUserEventRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallHttpBody	The call object.

CollectUserEventAsync(CollectUserEventRequest, Metadata, DateTime?, CancellationToken)

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

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.

Parameters
Name	Description
request	CollectUserEventRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallHttpBody	The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

ImportUserEvents(ImportUserEventsRequest, CallOptions)

public virtual Operation ImportUserEvents(ImportUserEventsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ImportUserEvents(ImportUserEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportUserEvents(ImportUserEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ImportUserEventsAsync(ImportUserEventsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportUserEventsAsync(ImportUserEventsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ImportUserEventsAsync(ImportUserEventsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

NewInstance(ClientBaseConfiguration)

protected override UserEventService.UserEventServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
UserEventServiceUserEventServiceClient

Overrides

ClientBase<UserEventService.UserEventServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

PurgeUserEvents(PurgeUserEventsRequest, CallOptions)

public virtual Operation PurgeUserEvents(PurgeUserEventsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

PurgeUserEvents(PurgeUserEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation PurgeUserEvents(PurgeUserEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

PurgeUserEventsAsync(PurgeUserEventsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PurgeUserEventsAsync(PurgeUserEventsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

PurgeUserEventsAsync(PurgeUserEventsRequest, Metadata, DateTime?, CancellationToken)

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

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RejoinUserEvents(RejoinUserEventsRequest, CallOptions)

public virtual Operation RejoinUserEvents(RejoinUserEventsRequest request, CallOptions options)

Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

Parameters
Name	Description
request	RejoinUserEventsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

RejoinUserEvents(RejoinUserEventsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RejoinUserEvents(RejoinUserEventsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

Parameters
Name	Description
request	RejoinUserEventsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

RejoinUserEventsAsync(RejoinUserEventsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RejoinUserEventsAsync(RejoinUserEventsRequest request, CallOptions options)

Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

Parameters
Name	Description
request	RejoinUserEventsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RejoinUserEventsAsync(RejoinUserEventsRequest, Metadata, DateTime?, CancellationToken)

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

Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete.

Parameters
Name	Description
request	RejoinUserEventsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

WriteUserEvent(WriteUserEventRequest, CallOptions)

public virtual UserEvent WriteUserEvent(WriteUserEventRequest request, CallOptions options)

Writes a single user event.

Parameters
Name	Description
request	WriteUserEventRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
UserEvent	The response received from the server.

WriteUserEvent(WriteUserEventRequest, Metadata, DateTime?, CancellationToken)

public virtual UserEvent WriteUserEvent(WriteUserEventRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Writes a single user event.

Parameters
Name	Description
request	WriteUserEventRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
UserEvent	The response received from the server.

WriteUserEventAsync(WriteUserEventRequest, CallOptions)

public virtual AsyncUnaryCall<UserEvent> WriteUserEventAsync(WriteUserEventRequest request, CallOptions options)

Writes a single user event.

Parameters
Name	Description
request	WriteUserEventRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallUserEvent	The call object.

WriteUserEventAsync(WriteUserEventRequest, Metadata, DateTime?, CancellationToken)

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

Writes a single user event.

Parameters
Name	Description
request	WriteUserEventRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallUserEvent	The call object.