UserEventServiceClient

UserEventServiceClient

Service for ingesting end user actions on the customer website.

Constructor

new UserEventServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of UserEventServiceClient.

Parameters:
Name Type Attributes Description
options object <optional>

The configuration object. The options accepted by the constructor are described in detail in this document. The common options are:

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port number <optional>

The port on which to connect to the remote host.
projectId string <optional>

The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new UserEventServiceClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

Methods

alertConfigPath(project) → {string}

Return a fully-qualified alertConfig resource name string.

Parameters:
Name Type Description
project string
Returns:
Type Description
string

Resource name string.

attributesConfigPath(project, location, catalog) → {string}

Return a fully-qualified attributesConfig resource name string.

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

Resource name string.

cancelOperation(request, optionsopt, callbackopt) → {Promise}

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be cancelled.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});
```

catalogPath(project, location, catalog) → {string}

Return a fully-qualified catalog resource name string.

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

Resource name string.

(async) checkExportUserEventsProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of a Catalog google.cloud.retail.v2beta.Catalog.
   *  For example `projects/1234/locations/global/catalogs/default_catalog`
   */
  // const parent = 'abc123'
  /**
   *  Required. The output location of the data.
   */
  // const outputConfig = {}
  /**
   *  A filtering expression to specify restrictions on returned events.
   *  The expression is a sequence of terms. Each term applies a restriction to
   *  the returned user events. Use this expression to restrict results to a
   *  specific time range or to filter events by eventType.
   *  For example, `eventTime > "2012-04-23T18:25:43.511Z"
   *  eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z"
   *  eventType=search`
   *    We expect only three types of fields:
   *     * `eventTime`: This can be specified twice, once with a
   *       less than operator and once with a greater than operator. The
   *       `eventTime` restriction should result in one, contiguous, valid,
   *       `eventTime` range.
   *     * `eventType`: Boolean operators `OR` and `NOT` are supported if the
   *       expression is enclosed in parentheses and the operators are separated
   *       from the tag values by a space.
   *     * `eventsMissingCatalogItems`: This restricts results
   *       to events for which catalog items were not found in the catalog. The
   *       default behavior is to return only those events for which catalog
   *       items were found.
   *    Some examples of valid filters expressions:
   *    * Example 1: `eventTime > "2012-04-23T18:25:43.511Z"
   *              eventTime < "2012-04-23T18:30:43.511Z"`
   *    * Example 2: `eventTime > "2012-04-23T18:25:43.511Z"
   *              eventType = detail-page-view`
   *    * Example 3: `eventsMissingCatalogItems
   *              eventType = (NOT search) eventTime <
   *              "2018-04-23T18:30:43.511Z"`
   *    * Example 4: `eventTime > "2012-04-23T18:25:43.511Z"`
   *    * Example 5: `eventType = (detail-page-view OR search)`
   *    * Example 6: `eventsMissingCatalogItems`
   */
  // const filter = 'abc123'

  // Imports the Retail library
  const {UserEventServiceClient} = require('@google-cloud/retail').v2beta;

  // Instantiates a client
  const retailClient = new UserEventServiceClient();

  async function callExportUserEvents() {
    // Construct request
    const request = {
      parent,
      outputConfig,
    };

    // Run request
    const [operation] = await retailClient.exportUserEvents(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callExportUserEvents();

(async) checkImportUserEventsProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. `projects/1234/locations/global/catalogs/default_catalog`
   */
  // const parent = 'abc123'
  /**
   *  Required. The desired input location of the data.
   */
  // const inputConfig = {}
  /**
   *  The desired location of errors incurred during the Import. Cannot be set
   *  for inline user event imports.
   */
  // const errorsConfig = {}

  // Imports the Retail library
  const {UserEventServiceClient} = require('@google-cloud/retail').v2beta;

  // Instantiates a client
  const retailClient = new UserEventServiceClient();

  async function callImportUserEvents() {
    // Construct request
    const request = {
      parent,
      inputConfig,
    };

    // Run request
    const [operation] = await retailClient.importUserEvents(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callImportUserEvents();

(async) checkPurgeUserEventsProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the catalog under which the events are
   *  created. The format is
   *  `projects/${projectId}/locations/global/catalogs/${catalogId}`
   */
  // const parent = 'abc123'
  /**
   *  Required. The filter string to specify the events to be deleted with a
   *  length limit of 5,000 characters. Empty string filter is not allowed. The
   *  eligible fields for filtering are:
   *  * `eventType`: Double quoted
   *  UserEvent.event_type google.cloud.retail.v2beta.UserEvent.event_type 
   *  string.
   *  * `eventTime`: in ISO 8601 "zulu" format.
   *  * `visitorId`: Double quoted string. Specifying this will delete all
   *    events associated with a visitor.
   *  * `userId`: Double quoted string. Specifying this will delete all events
   *    associated with a user.
   *  Examples:
   *  * Deleting all events in a time range:
   *    `eventTime > "2012-04-23T18:25:43.511Z"
   *    eventTime < "2012-04-23T18:30:43.511Z"`
   *  * Deleting specific eventType in time range:
   *    `eventTime > "2012-04-23T18:25:43.511Z" eventType = "detail-page-view"`
   *  * Deleting all events for a specific visitor:
   *    `visitorId = "visitor1024"`
   *  The filtering fields are assumed to have an implicit AND.
   */
  // const filter = 'abc123'
  /**
   *  Actually perform the purge.
   *  If `force` is set to false, the method will return the expected purge count
   *  without deleting any user events.
   */
  // const force = true

  // Imports the Retail library
  const {UserEventServiceClient} = require('@google-cloud/retail').v2beta;

  // Instantiates a client
  const retailClient = new UserEventServiceClient();

  async function callPurgeUserEvents() {
    // Construct request
    const request = {
      parent,
      filter,
    };

    // Run request
    const [operation] = await retailClient.purgeUserEvents(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callPurgeUserEvents();

(async) checkRejoinUserEventsProgress(name) → {Promise}

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

Parameters:
Name Type Description
name String

The operation name that will be passed.
Returns:
Type Description
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 for more details and examples.
Example
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent catalog resource name, such as
   *  `projects/1234/locations/global/catalogs/default_catalog`.
   */
  // const parent = 'abc123'
  /**
   *  The type of the user event rejoin to define the scope and range of the user
   *  events to be rejoined with the latest product catalog. Defaults to
   *  `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to
   *  an invalid integer value.
   */
  // const userEventRejoinScope = {}

  // Imports the Retail library
  const {UserEventServiceClient} = require('@google-cloud/retail').v2beta;

  // Instantiates a client
  const retailClient = new UserEventServiceClient();

  async function callRejoinUserEvents() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const [operation] = await retailClient.rejoinUserEvents(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callRejoinUserEvents();

close() → {Promise}

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

A promise that resolves when the client is closed.

completionConfigPath(project, location, catalog) → {string}

Return a fully-qualified completionConfig resource name string.

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

Resource name string.

controlPath(project, location, catalog, control) → {string}

Return a fully-qualified control resource name string.

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

Resource name string.

deleteOperation(request, optionsopt, callbackopt) → {Promise}

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource to be deleted.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.
Returns:
Type Description
Promise
  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});
```

getLocation(request, optionsopt) → {Promise}

Gets information about a location.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Resource name for the location.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Location. Please see the documentation for more details and examples.
Example
```
const [response] = await client.getLocation(request);
```

getOperation(request, optionsopt, callbackopt) → {Promise}

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the operation resource.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback function <optional>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing google.longrunning.Operation.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing google.longrunning.Operation. The promise has a method named "cancel" which cancels the ongoing API call.
Example
```
const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)
```

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

initialize() → {Promise}

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

A promise that resolves to an authenticated service stub.

listLocationsAsync(request, optionsopt) → {Object}

Lists information about the supported locations for this service. Returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The resource that owns the locations collection, if applicable.
filter string

The standard list filter.
pageSize number

The standard list page size.
pageToken string

The standard list page token.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Location. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
```
const iterable = client.listLocationsAsync(request);
for await (const response of iterable) {
  // process response
}
```

listOperationsAsync(request, optionsopt) → {Object}

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the operation collection.
filter string

The standard list filter.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns:
Type Description
Object

An iterable Object that conforms to iteration protocols.
Example
```
const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)
```

matchBranchFromProductName(productName) → {string}

Parse the branch from Product resource.

Parameters:
Name Type Description
productName string

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

A string representing the branch.

matchCatalogFromAttributesConfigName(attributesConfigName) → {string}

Parse the catalog from AttributesConfig resource.

Parameters:
Name Type Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromCatalogName(catalogName) → {string}

Parse the catalog from Catalog resource.

Parameters:
Name Type Description
catalogName string

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

A string representing the catalog.

matchCatalogFromCompletionConfigName(completionConfigName) → {string}

Parse the catalog from CompletionConfig resource.

Parameters:
Name Type Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromControlName(controlName) → {string}

Parse the catalog from Control resource.

Parameters:
Name Type Description
controlName string

A fully-qualified path representing Control resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromModelName(modelName) → {string}

Parse the catalog from Model resource.

Parameters:
Name Type Description
modelName string

A fully-qualified path representing Model resource.
Returns:
Type Description
string

A string representing the catalog.

matchCatalogFromProductName(productName) → {string}

Parse the catalog from Product resource.

Parameters:
Name Type Description
productName string

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

A string representing the catalog.

matchCatalogFromServingConfigName(servingConfigName) → {string}

Parse the catalog from ServingConfig resource.

Parameters:
Name Type Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns:
Type Description
string

A string representing the catalog.

matchControlFromControlName(controlName) → {string}

Parse the control from Control resource.

Parameters:
Name Type Description
controlName string

A fully-qualified path representing Control resource.
Returns:
Type Description
string

A string representing the control.

matchLocationFromAttributesConfigName(attributesConfigName) → {string}

Parse the location from AttributesConfig resource.

Parameters:
Name Type Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromCatalogName(catalogName) → {string}

Parse the location from Catalog resource.

Parameters:
Name Type Description
catalogName string

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

A string representing the location.

matchLocationFromCompletionConfigName(completionConfigName) → {string}

Parse the location from CompletionConfig resource.

Parameters:
Name Type Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromControlName(controlName) → {string}

Parse the location from Control resource.

Parameters:
Name Type Description
controlName string

A fully-qualified path representing Control resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromModelName(modelName) → {string}

Parse the location from Model resource.

Parameters:
Name Type Description
modelName string

A fully-qualified path representing Model resource.
Returns:
Type Description
string

A string representing the location.

matchLocationFromProductName(productName) → {string}

Parse the location from Product resource.

Parameters:
Name Type Description
productName string

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

A string representing the location.

matchLocationFromServingConfigName(servingConfigName) → {string}

Parse the location from ServingConfig resource.

Parameters:
Name Type Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns:
Type Description
string

A string representing the location.

matchModelFromModelName(modelName) → {string}

Parse the model from Model resource.

Parameters:
Name Type Description
modelName string

A fully-qualified path representing Model resource.
Returns:
Type Description
string

A string representing the model.

matchProductFromProductName(productName) → {string}

Parse the product from Product resource.

Parameters:
Name Type Description
productName string

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

A string representing the product.

matchProjectFromAlertConfigName(alertConfigName) → {string}

Parse the project from AlertConfig resource.

Parameters:
Name Type Description
alertConfigName string

A fully-qualified path representing AlertConfig resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromAttributesConfigName(attributesConfigName) → {string}

Parse the project from AttributesConfig resource.

Parameters:
Name Type Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromCatalogName(catalogName) → {string}

Parse the project from Catalog resource.

Parameters:
Name Type Description
catalogName string

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

A string representing the project.

matchProjectFromCompletionConfigName(completionConfigName) → {string}

Parse the project from CompletionConfig resource.

Parameters:
Name Type Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromControlName(controlName) → {string}

Parse the project from Control resource.

Parameters:
Name Type Description
controlName string

A fully-qualified path representing Control resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromModelName(modelName) → {string}

Parse the project from Model resource.

Parameters:
Name Type Description
modelName string

A fully-qualified path representing Model resource.
Returns:
Type Description
string

A string representing the project.

matchProjectFromProductName(productName) → {string}

Parse the project from Product resource.

Parameters:
Name Type Description
productName string

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

A string representing the project.

matchProjectFromServingConfigName(servingConfigName) → {string}

Parse the project from ServingConfig resource.

Parameters:
Name Type Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns:
Type Description
string

A string representing the project.

matchServingConfigFromServingConfigName(servingConfigName) → {string}

Parse the serving_config from ServingConfig resource.

Parameters:
Name Type Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns:
Type Description
string

A string representing the serving_config.

modelPath(project, location, catalog, model) → {string}

Return a fully-qualified model resource name string.

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

Resource name string.

productPath(project, location, catalog, branch, product) → {string}

Return a fully-qualified product resource name string.

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

Resource name string.

servingConfigPath(project, location, catalog, serving_config) → {string}

Return a fully-qualified servingConfig resource name string.

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

Resource name string.