Class v2beta.UserEventServiceClient (1.3.0)

Service for ingesting end user actions on the customer website. v2beta

Package

@google-cloud/retail

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of UserEventServiceClient.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

operationsClient

operationsClient: gax.OperationsClient;
Property Value
Type Description
gax.OperationsClient

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

userEventServiceStub

userEventServiceStub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

catalogPath(project, location, catalog)

catalogPath(project: string, location: string, catalog: string): string;

Return a fully-qualified catalog resource name string.

Parameters
Name Description
project string
location string
catalog string
Returns
Type Description
string

{string} Resource name string.

checkImportUserEventsProgress(name)

checkImportUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.retail.v2beta.ImportUserEventsResponse, protos.google.cloud.retail.v2beta.ImportMetadata>>;

Check the status of the long running operation returned by importUserEvents().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.retail.v2beta.ImportUserEventsResponse, protos.google.cloud.retail.v2beta.ImportMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkImportUserEventsProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkPurgeUserEventsProgress(name)

checkPurgeUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.retail.v2beta.PurgeUserEventsResponse, protos.google.cloud.retail.v2beta.PurgeMetadata>>;

Check the status of the long running operation returned by purgeUserEvents().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.retail.v2beta.PurgeUserEventsResponse, protos.google.cloud.retail.v2beta.PurgeMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkPurgeUserEventsProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

checkRejoinUserEventsProgress(name)

checkRejoinUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.retail.v2beta.RejoinUserEventsResponse, protos.google.cloud.retail.v2beta.RejoinUserEventsMetadata>>;

Check the status of the long running operation returned by rejoinUserEvents().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.retail.v2beta.RejoinUserEventsResponse, protos.google.cloud.retail.v2beta.RejoinUserEventsMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
Example

const decodedOperation = await checkRejoinUserEventsProgress(name); console.log(decodedOperation.result); console.log(decodedOperation.done); console.log(decodedOperation.metadata);

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

collectUserEvent(request, options)

collectUserEvent(request?: protos.google.cloud.retail.v2beta.ICollectUserEventRequest, options?: CallOptions): Promise<[
        protos.google.api.IHttpBody,
        protos.google.cloud.retail.v2beta.ICollectUserEventRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.ICollectUserEventRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.api.IHttpBody, protos.google.cloud.retail.v2beta.ICollectUserEventRequest | undefined, {} | undefined ]>

collectUserEvent(request, options, callback)

collectUserEvent(request: protos.google.cloud.retail.v2beta.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.retail.v2beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.ICollectUserEventRequest
options CallOptions
callback Callback<protos.google.api.IHttpBody, protos.google.cloud.retail.v2beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

collectUserEvent(request, callback)

collectUserEvent(request: protos.google.cloud.retail.v2beta.ICollectUserEventRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.retail.v2beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.ICollectUserEventRequest
callback Callback<protos.google.api.IHttpBody, protos.google.cloud.retail.v2beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

importUserEvents(request, options)

importUserEvents(request?: protos.google.cloud.retail.v2beta.IImportUserEventsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.retail.v2beta.IImportUserEventsResponse, protos.google.cloud.retail.v2beta.IImportMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IImportUserEventsRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.retail.v2beta.IImportUserEventsResponse, protos.google.cloud.retail.v2beta.IImportMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

importUserEvents(request, options, callback)

importUserEvents(request: protos.google.cloud.retail.v2beta.IImportUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2beta.IImportUserEventsResponse, protos.google.cloud.retail.v2beta.IImportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IImportUserEventsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.retail.v2beta.IImportUserEventsResponse, protos.google.cloud.retail.v2beta.IImportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

importUserEvents(request, callback)

importUserEvents(request: protos.google.cloud.retail.v2beta.IImportUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2beta.IImportUserEventsResponse, protos.google.cloud.retail.v2beta.IImportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IImportUserEventsRequest
callback Callback<LROperation<protos.google.cloud.retail.v2beta.IImportUserEventsResponse, protos.google.cloud.retail.v2beta.IImportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

matchBranchFromProductName(productName)

matchBranchFromProductName(productName: string): string | number;

Parse the branch from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the branch.

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName: string): string | number;

Parse the catalog from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName: string): string | number;

Parse the catalog from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName: string): string | number;

Parse the location from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProductName(productName)

matchLocationFromProductName(productName: string): string | number;

Parse the location from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

Parse the product from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the product.

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName: string): string | number;

Parse the project from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProductName(productName)

matchProjectFromProductName(productName: string): string | number;

Parse the project from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the project.

productPath(project, location, catalog, branch, product)

productPath(project: string, location: string, catalog: string, branch: string, product: string): string;

Return a fully-qualified product resource name string.

Parameters
Name Description
project string
location string
catalog string
branch string
product string
Returns
Type Description
string

{string} Resource name string.

purgeUserEvents(request, options)

purgeUserEvents(request?: protos.google.cloud.retail.v2beta.IPurgeUserEventsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.retail.v2beta.IPurgeUserEventsResponse, protos.google.cloud.retail.v2beta.IPurgeMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IPurgeUserEventsRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.retail.v2beta.IPurgeUserEventsResponse, protos.google.cloud.retail.v2beta.IPurgeMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

purgeUserEvents(request, options, callback)

purgeUserEvents(request: protos.google.cloud.retail.v2beta.IPurgeUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2beta.IPurgeUserEventsResponse, protos.google.cloud.retail.v2beta.IPurgeMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IPurgeUserEventsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.retail.v2beta.IPurgeUserEventsResponse, protos.google.cloud.retail.v2beta.IPurgeMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

purgeUserEvents(request, callback)

purgeUserEvents(request: protos.google.cloud.retail.v2beta.IPurgeUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2beta.IPurgeUserEventsResponse, protos.google.cloud.retail.v2beta.IPurgeMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IPurgeUserEventsRequest
callback Callback<LROperation<protos.google.cloud.retail.v2beta.IPurgeUserEventsResponse, protos.google.cloud.retail.v2beta.IPurgeMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

rejoinUserEvents(request, options)

rejoinUserEvents(request?: protos.google.cloud.retail.v2beta.IRejoinUserEventsRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.retail.v2beta.IRejoinUserEventsResponse, protos.google.cloud.retail.v2beta.IRejoinUserEventsMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IRejoinUserEventsRequest
options CallOptions
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.retail.v2beta.IRejoinUserEventsResponse, protos.google.cloud.retail.v2beta.IRejoinUserEventsMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

rejoinUserEvents(request, options, callback)

rejoinUserEvents(request: protos.google.cloud.retail.v2beta.IRejoinUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2beta.IRejoinUserEventsResponse, protos.google.cloud.retail.v2beta.IRejoinUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IRejoinUserEventsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.retail.v2beta.IRejoinUserEventsResponse, protos.google.cloud.retail.v2beta.IRejoinUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

rejoinUserEvents(request, callback)

rejoinUserEvents(request: protos.google.cloud.retail.v2beta.IRejoinUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2beta.IRejoinUserEventsResponse, protos.google.cloud.retail.v2beta.IRejoinUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IRejoinUserEventsRequest
callback Callback<LROperation<protos.google.cloud.retail.v2beta.IRejoinUserEventsResponse, protos.google.cloud.retail.v2beta.IRejoinUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

writeUserEvent(request, options)

writeUserEvent(request?: protos.google.cloud.retail.v2beta.IWriteUserEventRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2beta.IUserEvent,
        protos.google.cloud.retail.v2beta.IWriteUserEventRequest | undefined,
        {} | undefined
    ]>;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IWriteUserEventRequest
options CallOptions
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2beta.IUserEvent, protos.google.cloud.retail.v2beta.IWriteUserEventRequest | undefined, {} | undefined ]>

writeUserEvent(request, options, callback)

writeUserEvent(request: protos.google.cloud.retail.v2beta.IWriteUserEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2beta.IUserEvent, protos.google.cloud.retail.v2beta.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IWriteUserEventRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2beta.IUserEvent, protos.google.cloud.retail.v2beta.IWriteUserEventRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

writeUserEvent(request, callback)

writeUserEvent(request: protos.google.cloud.retail.v2beta.IWriteUserEventRequest, callback: Callback<protos.google.cloud.retail.v2beta.IUserEvent, protos.google.cloud.retail.v2beta.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.cloud.retail.v2beta.IWriteUserEventRequest
callback Callback<protos.google.cloud.retail.v2beta.IUserEvent, protos.google.cloud.retail.v2beta.IWriteUserEventRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void