ProductServiceClient

Service for ingesting Product information of the customer's website.

Constructor

new ProductServiceClient(optionsopt, gaxInstanceopt)

Construct an instance of ProductServiceClient.

Parameters:

Name Type Attributes Description

options

object

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

Credentials object.

Properties

Name	Type	Attributes	Description
`client_email`	string	<optional>
`private_key`	string	<optional>

email

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

string

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

The port on which to connect to the remote host.

projectId

string

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

The domain name of the API remote host.

clientConfig

gax.ClientConfig

Client configuration override. Follows the structure of gapicConfig.

fallback

boolean

Use HTTP/1.1 REST mode. For more information, please check the documentation.

gaxInstance

gax

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 ProductServiceClient({fallback: true}, gax);

Members

apiEndpoint

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

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

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.

branchPath(project, location, catalog, branch) → {string}

Return a fully-qualified branch resource name string.

Parameters:

Name	Type	Description
`project`	string
`location`	string
`catalog`	string
`branch`	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 parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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) checkAddFulfillmentPlacesProgress(name) → {Promise}

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

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. Full resource name of Product google.cloud.retail.v2.Product,
   *  such as
   *  `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
   *  If the caller does not have permission to access the
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   */
  // const product = 'abc123'
  /**
   *  Required. The fulfillment type, including commonly used types (such as
   *  pickup in store and same day delivery), and custom types.
   *  Supported values:
   *  * "pickup-in-store"
   *  * "ship-to-store"
   *  * "same-day-delivery"
   *  * "next-day-delivery"
   *  * "custom-type-1"
   *  * "custom-type-2"
   *  * "custom-type-3"
   *  * "custom-type-4"
   *  * "custom-type-5"
   *  If this field is set to an invalid value other than these, an
   *  INVALID_ARGUMENT error is returned.
   *  This field directly corresponds to
   *  Product.fulfillment_info.type google.cloud.retail.v2.FulfillmentInfo.type.
   */
  // const type = 'abc123'
  /**
   *  Required. The IDs for this
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.type, such as
   *  the store IDs for "pickup-in-store" or the region IDs for
   *  "same-day-delivery" to be added for this
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.type. Duplicate
   *  IDs will be automatically ignored.
   *  At least 1 value is required, and a maximum of 2000 values are allowed.
   *  Each value must be a string with a length limit of 10 characters, matching
   *  the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   *  If the total number of place IDs exceeds 2000 for this
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.type  after
   *  adding, then the update will be rejected.
   */
  // const placeIds = ['abc','def']
  /**
   *  The time when the fulfillment updates are issued, used to prevent
   *  out-of-order updates on fulfillment information. If not provided, the
   *  internal system time will be used.
   */
  // const addTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, the fulfillment information will still be processed and retained for
   *  at most 1 day and processed once the
   *  Product google.cloud.retail.v2.Product  is created. If set to false, a
   *  NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callAddFulfillmentPlaces() {
    // Construct request
    const request = {
      product,
      type,
      placeIds,
    };

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

  callAddFulfillmentPlaces();

(async) checkAddLocalInventoriesProgress(name) → {Promise}

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

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. Full resource name of Product google.cloud.retail.v2.Product,
   *  such as
   *  `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
   *  If the caller does not have permission to access the
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   */
  // const product = 'abc123'
  /**
   *  Required. A list of inventory information at difference places. Each place
   *  is identified by its place ID. At most 3000 inventories are allowed per
   *  request.
   */
  // const localInventories = [1,2,3,4]
  /**
   *  Indicates which inventory fields in the provided list of
   *  LocalInventory google.cloud.retail.v2.LocalInventory  to update. The
   *  field is updated to the provided value.
   *  If a field is set while the place does not have a previous local inventory,
   *  the local inventory at that store is created.
   *  If a field is set while the value of that field is not provided, the
   *  original field value, if it exists, is deleted.
   *  If the mask is not set or set with empty paths, all inventory fields will
   *  be updated.
   *  If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   *  is returned and the entire update will be ignored.
   */
  // const addMask = {}
  /**
   *  The time when the inventory updates are issued. Used to prevent
   *  out-of-order updates on local inventory fields. If not provided, the
   *  internal system time will be used.
   */
  // const addTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, the local inventory will still be processed and retained for at most
   *  1 day and processed once the Product google.cloud.retail.v2.Product  is
   *  created. If set to false, a NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callAddLocalInventories() {
    // Construct request
    const request = {
      product,
      localInventories,
    };

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

  callAddLocalInventories();

(async) checkImportProductsProgress(name) → {Promise}

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

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/branches/default_branch`
   *  If no updateMask is specified, requires products.create permission.
   *  If updateMask is specified, requires products.update permission.
   */
  // const parent = 'abc123'
  /**
   *  Required. The desired input location of the data.
   */
  // const inputConfig = {}
  /**
   *  The desired location of errors incurred during the Import.
   */
  // const errorsConfig = {}
  /**
   *  Indicates which fields in the provided imported `products` to update. If
   *  not set, all fields are updated.
   */
  // const updateMask = {}
  /**
   *  The mode of reconciliation between existing products and the products to be
   *  imported. Defaults to
   *  ReconciliationMode.INCREMENTAL google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode.INCREMENTAL.
   */
  // const reconciliationMode = {}
  /**
   *  Full Pub/Sub topic name for receiving notification. If this field is set,
   *  when the import is finished, a notification is sent to
   *  specified Pub/Sub topic. The message data is JSON string of a
   *  Operation google.longrunning.Operation.
   *  Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has
   *  to be within the same project as
   *  ImportProductsRequest.parent google.cloud.retail.v2.ImportProductsRequest.parent.
   *  Make sure that `service-<project
   *  number>@gcp-sa-retail.iam.gserviceaccount.com` has the
   *  `pubsub.topics.publish` IAM permission on the topic.
   */
  // const notificationPubsubTopic = 'abc123'

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

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

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

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

  callImportProducts();

(async) checkRemoveFulfillmentPlacesProgress(name) → {Promise}

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

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. Full resource name of Product google.cloud.retail.v2.Product,
   *  such as
   *  `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
   *  If the caller does not have permission to access the
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   */
  // const product = 'abc123'
  /**
   *  Required. The fulfillment type, including commonly used types (such as
   *  pickup in store and same day delivery), and custom types.
   *  Supported values:
   *  * "pickup-in-store"
   *  * "ship-to-store"
   *  * "same-day-delivery"
   *  * "next-day-delivery"
   *  * "custom-type-1"
   *  * "custom-type-2"
   *  * "custom-type-3"
   *  * "custom-type-4"
   *  * "custom-type-5"
   *  If this field is set to an invalid value other than these, an
   *  INVALID_ARGUMENT error is returned.
   *  This field directly corresponds to
   *  Product.fulfillment_info.type google.cloud.retail.v2.FulfillmentInfo.type.
   */
  // const type = 'abc123'
  /**
   *  Required. The IDs for this
   *  type google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type, such as
   *  the store IDs for "pickup-in-store" or the region IDs for
   *  "same-day-delivery", to be removed for this
   *  type google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type.
   *  At least 1 value is required, and a maximum of 2000 values are allowed.
   *  Each value must be a string with a length limit of 10 characters, matching
   *  the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   */
  // const placeIds = ['abc','def']
  /**
   *  The time when the fulfillment updates are issued, used to prevent
   *  out-of-order updates on fulfillment information. If not provided, the
   *  internal system time will be used.
   */
  // const removeTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, the fulfillment information will still be processed and retained for
   *  at most 1 day and processed once the
   *  Product google.cloud.retail.v2.Product  is created. If set to false, a
   *  NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callRemoveFulfillmentPlaces() {
    // Construct request
    const request = {
      product,
      type,
      placeIds,
    };

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

  callRemoveFulfillmentPlaces();

(async) checkRemoveLocalInventoriesProgress(name) → {Promise}

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

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. Full resource name of Product google.cloud.retail.v2.Product,
   *  such as
   *  `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`.
   *  If the caller does not have permission to access the
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   */
  // const product = 'abc123'
  /**
   *  Required. A list of place IDs to have their inventory deleted.
   *  At most 3000 place IDs are allowed per request.
   */
  // const placeIds = ['abc','def']
  /**
   *  The time when the inventory deletions are issued. Used to prevent
   *  out-of-order updates and deletions on local inventory fields. If not
   *  provided, the internal system time will be used.
   */
  // const removeTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, the local inventory removal request will still be processed and
   *  retained for at most 1 day and processed once the
   *  Product google.cloud.retail.v2.Product  is created. If set to false, a
   *  NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callRemoveLocalInventories() {
    // Construct request
    const request = {
      product,
      placeIds,
    };

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

  callRemoveLocalInventories();

(async) checkSetInventoryProgress(name) → {Promise}

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

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 inventory information to update. The allowable fields to
   *  update are:
   *  * Product.price_info google.cloud.retail.v2.Product.price_info 
   *  * Product.availability google.cloud.retail.v2.Product.availability 
   *  * Product.available_quantity google.cloud.retail.v2.Product.available_quantity 
   *  * Product.fulfillment_info google.cloud.retail.v2.Product.fulfillment_info 
   *  The updated inventory fields must be specified in
   *  SetInventoryRequest.set_mask google.cloud.retail.v2.SetInventoryRequest.set_mask.
   *  If
   *  SetInventoryRequest.inventory.name google.cloud.retail.v2.Product.name 
   *  is empty or invalid, an INVALID_ARGUMENT error is returned.
   *  If the caller does not have permission to update the
   *  Product google.cloud.retail.v2.Product  named in
   *  Product.name google.cloud.retail.v2.Product.name, regardless of whether
   *  or not it exists, a PERMISSION_DENIED error is returned.
   *  If the Product google.cloud.retail.v2.Product  to update does not have
   *  existing inventory information, the provided inventory information will be
   *  inserted.
   *  If the Product google.cloud.retail.v2.Product  to update has existing
   *  inventory information, the provided inventory information will be merged
   *  while respecting the last update time for each inventory field, using the
   *  provided or default value for
   *  SetInventoryRequest.set_time google.cloud.retail.v2.SetInventoryRequest.set_time.
   *  The caller can replace place IDs for a subset of fulfillment types in the
   *  following ways:
   *  * Adds "fulfillment_info" in
   *  SetInventoryRequest.set_mask google.cloud.retail.v2.SetInventoryRequest.set_mask 
   *  * Specifies only the desired fulfillment types and corresponding place IDs
   *  to update in
   *  SetInventoryRequest.inventory.fulfillment_info google.cloud.retail.v2.Product.fulfillment_info 
   *  The caller can clear all place IDs from a subset of fulfillment types in
   *  the following ways:
   *  * Adds "fulfillment_info" in
   *  SetInventoryRequest.set_mask google.cloud.retail.v2.SetInventoryRequest.set_mask 
   *  * Specifies only the desired fulfillment types to clear in
   *  SetInventoryRequest.inventory.fulfillment_info google.cloud.retail.v2.Product.fulfillment_info 
   *  * Checks that only the desired fulfillment info types have empty
   *  SetInventoryRequest.inventory.fulfillment_info.place_ids google.cloud.retail.v2.FulfillmentInfo.place_ids 
   *  The last update time is recorded for the following inventory fields:
   *  * Product.price_info google.cloud.retail.v2.Product.price_info 
   *  * Product.availability google.cloud.retail.v2.Product.availability 
   *  * Product.available_quantity google.cloud.retail.v2.Product.available_quantity 
   *  * Product.fulfillment_info google.cloud.retail.v2.Product.fulfillment_info 
   *  If a full overwrite of inventory information while ignoring timestamps is
   *  needed,
   *  ProductService.UpdateProduct google.cloud.retail.v2.ProductService.UpdateProduct 
   *  should be invoked instead.
   */
  // const inventory = {}
  /**
   *  Indicates which inventory fields in the provided
   *  Product google.cloud.retail.v2.Product  to update.
   *  At least one field must be provided.
   *  If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   *  is returned and the entire update will be ignored.
   */
  // const setMask = {}
  /**
   *  The time when the request is issued, used to prevent
   *  out-of-order updates on inventory fields with the last update time
   *  recorded. If not provided, the internal system time will be used.
   */
  // const setTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  with name
   *  Product.name google.cloud.retail.v2.Product.name  is not found, the
   *  inventory update will still be processed and retained for at most 1 day
   *  until the Product google.cloud.retail.v2.Product  is created. If set to
   *  false, a NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callSetInventory() {
    // Construct request
    const request = {
      inventory,
    };

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

  callSetInventory();

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 parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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

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 parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function

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

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

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 parent branch resource name, such as `projects/* /locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
`pageSize`	number	Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
`pageToken`	string	A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
`filter`	string	A filter to apply on the list results. Supported features: List all the products under the parent branch if filter is unset. List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: `primary_product_id = "some_product_id"` List Products bundled in a Product.Type.COLLECTION Product. For example: `collection_product_id = "some_product_id"` List Products with a partibular type. For example: `type = "PRIMARY"` `type = "VARIANT"` `type = "COLLECTION"` If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.
`readMask`	google.protobuf.FieldMask	The fields of Product to return in the responses. If not set or empty, the following fields are returned: Product.name Product.id Product.title Product.uri Product.images Product.price_info Product.brands If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

options

object

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 parent branch resource name, such as
   *  `projects/* /locations/global/catalogs/default_catalog/branches/0`. Use
   *  `default_branch` as the branch ID, to list products under the default
   *  branch.
   *  If the caller does not have permission to list
   *  Product google.cloud.retail.v2.Product s under this branch, regardless of
   *  whether or not this branch exists, a PERMISSION_DENIED error is returned.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of Product google.cloud.retail.v2.Product s to return. If
   *  unspecified, defaults to 100. The maximum allowed value is 1000. Values
   *  above 1000 will be coerced to 1000.
   *  If this field is negative, an INVALID_ARGUMENT error is returned.
   */
  // const pageSize = 1234
  /**
   *  A page token
   *  ListProductsResponse.next_page_token google.cloud.retail.v2.ListProductsResponse.next_page_token,
   *  received from a previous
   *  ProductService.ListProducts google.cloud.retail.v2.ProductService.ListProducts 
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  ProductService.ListProducts google.cloud.retail.v2.ProductService.ListProducts 
   *  must match the call that provided the page token. Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter to apply on the list results. Supported features:
   *  * List all the products under the parent branch if
   *  filter google.cloud.retail.v2.ListProductsRequest.filter  is unset.
   *  * List Product.Type.VARIANT google.cloud.retail.v2.Product.Type.VARIANT 
   *  Product google.cloud.retail.v2.Product s sharing the same
   *    Product.Type.PRIMARY google.cloud.retail.v2.Product.Type.PRIMARY 
   *    Product google.cloud.retail.v2.Product. For example:
   *      `primary_product_id = "some_product_id"`
   *  * List Product google.cloud.retail.v2.Product s bundled in a
   *  Product.Type.COLLECTION google.cloud.retail.v2.Product.Type.COLLECTION 
   *  Product google.cloud.retail.v2.Product.
   *    For example:
   *      `collection_product_id = "some_product_id"`
   *  * List Product google.cloud.retail.v2.Product s with a partibular type.
   *  For example:
   *      `type = "PRIMARY"`
   *      `type = "VARIANT"`
   *      `type = "COLLECTION"`
   *  If the field is unrecognizable, an INVALID_ARGUMENT error is returned.
   *  If the specified
   *  Product.Type.PRIMARY google.cloud.retail.v2.Product.Type.PRIMARY 
   *  Product google.cloud.retail.v2.Product  or
   *  Product.Type.COLLECTION google.cloud.retail.v2.Product.Type.COLLECTION 
   *  Product google.cloud.retail.v2.Product  does not exist, a NOT_FOUND error
   *  is returned.
   */
  // const filter = 'abc123'
  /**
   *  The fields of Product google.cloud.retail.v2.Product  to return in the
   *  responses. If not set or empty, the following fields are returned:
   *  * Product.name google.cloud.retail.v2.Product.name 
   *  * Product.id google.cloud.retail.v2.Product.id 
   *  * Product.title google.cloud.retail.v2.Product.title 
   *  * Product.uri google.cloud.retail.v2.Product.uri 
   *  * Product.images google.cloud.retail.v2.Product.images 
   *  * Product.price_info google.cloud.retail.v2.Product.price_info 
   *  * Product.brands google.cloud.retail.v2.Product.brands 
   *  If "*" is provided, all fields are returned.
   *  Product.name google.cloud.retail.v2.Product.name  is always returned no
   *  matter what mask is set.
   *  If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
   *  is returned.
   */
  // const readMask = {}

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

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

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

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

  callListProducts();

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 parent branch resource name, such as `projects/* /locations/global/catalogs/default_catalog/branches/0`. Use `default_branch` as the branch ID, to list products under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
`pageSize`	number	Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
`pageToken`	string	A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
`filter`	string	A filter to apply on the list results. Supported features: List all the products under the parent branch if filter is unset. List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: `primary_product_id = "some_product_id"` List Products bundled in a Product.Type.COLLECTION Product. For example: `collection_product_id = "some_product_id"` List Products with a partibular type. For example: `type = "PRIMARY"` `type = "VARIANT"` `type = "COLLECTION"` If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.
`readMask`	google.protobuf.FieldMask	The fields of Product to return in the responses. If not set or empty, the following fields are returned: Product.name Product.id Product.title Product.uri Product.images Product.price_info Product.brands If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

options

object

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.

matchBranchFromBranchName(branchName) → {string}

Parse the branch from Branch resource.

Parameters:

Name	Type	Description
`branchName`	string	A fully-qualified path representing Branch resource.

Returns:

Type	Description
string	A string representing the branch.

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.

matchCatalogFromBranchName(branchName) → {string}

Parse the catalog from Branch resource.

Parameters:

Name	Type	Description
`branchName`	string	A fully-qualified path representing Branch 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.

matchLocationFromBranchName(branchName) → {string}

Parse the location from Branch resource.

Parameters:

Name	Type	Description
`branchName`	string	A fully-qualified path representing Branch 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.

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.

matchProjectFromBranchName(branchName) → {string}

Parse the project from Branch resource.

Parameters:

Name	Type	Description
`branchName`	string	A fully-qualified path representing Branch 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.