ProductSearchClient

ProductSearchClient

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

  • The API has a collection of ProductSet resources, named projects/* /locations/* /productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

  • The API has a collection of Product resources, named projects/* /locations/* /products/*

  • Each Product has a collection of ReferenceImage resources, named projects/* /locations/* /products/* /referenceImages/*

Constructor

new ProductSearchClient(optionsopt, gaxInstanceopt)

Construct an instance of ProductSearchClient.

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 ProductSearchClient({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

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: ''});
```

(async) checkImportProductSetsProgress(name) → {Promise}

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

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 project in which the ProductSets should be imported.
   *  Format is `projects/PROJECT_ID/locations/LOC_ID`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The input content for the list of requests.
   */
  // const inputConfig = {}

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callImportProductSets();

(async) checkPurgeProductsProgress(name) → {Promise}

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

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.
   */
  /**
   *  Specify which ProductSet contains the Products to be deleted.
   */
  // const productSetPurgeConfig = {}
  /**
   *  If delete_orphan_products is true, all Products that are not in any
   *  ProductSet will be deleted.
   */
  // const deleteOrphanProducts = true
  /**
   *  Required. The project and location in which the Products should be deleted.
   *  Format is `projects/PROJECT_ID/locations/LOC_ID`.
   */
  // const parent = 'abc123'
  /**
   *  The default value is false. Override this value to true to actually perform
   *  the purge.
   */
  // const force = true

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callPurgeProducts();

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.

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: ''});
```

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.

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)
```

listProductSetsAsync(request, optionsopt) → {Object}

Equivalent to listProductSets, but 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
parent string

Required. The project from which ProductSets should be listed.

Format is projects/PROJECT_ID/locations/LOC_ID.
pageSize number

The maximum number of items to return. Default 10, maximum 100.
pageToken string

The next_page_token returned from a previous List request, if any.
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 ProductSet. 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
  /**
   * 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 project from which ProductSets should be listed.
   *  Format is `projects/PROJECT_ID/locations/LOC_ID`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Default 10, maximum 100.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const iterable = visionClient.listProductSetsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListProductSets();

listProductSetsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The project from which ProductSets should be listed.

Format is projects/PROJECT_ID/locations/LOC_ID.
pageSize number

The maximum number of items to return. Default 10, maximum 100.
pageToken string

The next_page_token returned from a previous List request, if any.
options object <optional>

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

An object stream which emits an object representing ProductSet on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listProductSetsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listProductsAsync(request, optionsopt) → {Object}

Equivalent to listProducts, but 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
parent string

Required. The project OR ProductSet from which Products should be listed.

Format: projects/PROJECT_ID/locations/LOC_ID
pageSize number

The maximum number of items to return. Default 10, maximum 100.
pageToken string

The next_page_token returned from a previous List request, if any.
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 Product. 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
  /**
   * 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 project OR ProductSet from which Products should be listed.
   *  Format:
   *  `projects/PROJECT_ID/locations/LOC_ID`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Default 10, maximum 100.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const iterable = visionClient.listProductsAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListProducts();

listProductsInProductSetAsync(request, optionsopt) → {Object}

Equivalent to listProductsInProductSet, but 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

Required. The ProductSet resource for which to retrieve Products.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
pageSize number

The maximum number of items to return. Default 10, maximum 100.
pageToken string

The next_page_token returned from a previous List request, if any.
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 Product. 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
  /**
   * 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 ProductSet resource for which to retrieve Products.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
   */
  // const name = 'abc123'
  /**
   *  The maximum number of items to return. Default 10, maximum 100.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

  async function callListProductsInProductSet() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const iterable = visionClient.listProductsInProductSetAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListProductsInProductSet();

listProductsInProductSetStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

Required. The ProductSet resource for which to retrieve Products.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID
pageSize number

The maximum number of items to return. Default 10, maximum 100.
pageToken string

The next_page_token returned from a previous List request, if any.
options object <optional>

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

An object stream which emits an object representing Product on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listProductsInProductSetAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listProductsStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. The project OR ProductSet from which Products should be listed.

Format: projects/PROJECT_ID/locations/LOC_ID
pageSize number

The maximum number of items to return. Default 10, maximum 100.
pageToken string

The next_page_token returned from a previous List request, if any.
options object <optional>

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

An object stream which emits an object representing Product on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listProductsAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listReferenceImagesAsync(request, optionsopt) → {Object}

Equivalent to listReferenceImages, but 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
parent string

Required. Resource name of the product containing the reference images.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
pageSize number

The maximum number of items to return. Default 10, maximum 100.
pageToken string

A token identifying a page of results to be returned. This is the value of nextPageToken returned in a previous reference image list request.

Defaults to the first page if not specified.
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 ReferenceImage. 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
  /**
   * 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 the product containing the reference images.
   *  Format is
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Default 10, maximum 100.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results to be returned. This is the value
   *  of `nextPageToken` returned in a previous reference image list request.
   *  Defaults to the first page if not specified.
   */
  // const pageToken = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const iterable = visionClient.listReferenceImagesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListReferenceImages();

listReferenceImagesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

Required. Resource name of the product containing the reference images.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.
pageSize number

The maximum number of items to return. Default 10, maximum 100.
pageToken string

A token identifying a page of results to be returned. This is the value of nextPageToken returned in a previous reference image list request.

Defaults to the first page if not specified.
options object <optional>

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

An object stream which emits an object representing ReferenceImage on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listReferenceImagesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

locationPath(project, location) → {string}

Return a fully-qualified location resource name string.

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

Resource name string.

matchLocationFromLocationName(locationName) → {string}

Parse the location from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location 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.

matchLocationFromProductSetName(productSetName) → {string}

Parse the location from ProductSet resource.

Parameters:
Name Type Description
productSetName string

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

A string representing the location.

matchLocationFromReferenceImageName(referenceImageName) → {string}

Parse the location from ReferenceImage resource.

Parameters:
Name Type Description
referenceImageName string

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

A string representing the location.

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.

matchProductFromReferenceImageName(referenceImageName) → {string}

Parse the product from ReferenceImage resource.

Parameters:
Name Type Description
referenceImageName string

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

A string representing the product.

matchProductSetFromProductSetName(productSetName) → {string}

Parse the product_set from ProductSet resource.

Parameters:
Name Type Description
productSetName string

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

A string representing the product_set.

matchProjectFromLocationName(locationName) → {string}

Parse the project from Location resource.

Parameters:
Name Type Description
locationName string

A fully-qualified path representing Location 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.

matchProjectFromProductSetName(productSetName) → {string}

Parse the project from ProductSet resource.

Parameters:
Name Type Description
productSetName string

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

A string representing the project.

matchProjectFromReferenceImageName(referenceImageName) → {string}

Parse the project from ReferenceImage resource.

Parameters:
Name Type Description
referenceImageName string

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

A string representing the project.

matchReferenceImageFromReferenceImageName(referenceImageName) → {string}

Parse the reference_image from ReferenceImage resource.

Parameters:
Name Type Description
referenceImageName string

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

A string representing the reference_image.

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

Return a fully-qualified product resource name string.

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

Resource name string.

productSetPath(project, location, product_set) → {string}

Return a fully-qualified productSet resource name string.

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

Resource name string.

referenceImagePath(project, location, product, reference_image) → {string}

Return a fully-qualified referenceImage resource name string.

Parameters:
Name Type Description
project string
location string
product string
reference_image string
Returns:
Type Description
string

Resource name string.