@google-cloud/retail
TypeScript icon, indicating that this package has built-in type declarations

3.4.0 • Public • Published

Google Cloud Platform logo

release level npm version

Retail client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Retail API API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/retail

Using the client library

// Imports the Google Cloud client library
const {CatalogServiceClient} = require('@google-cloud/retail');

// TODO(developer): uncomment these variables with your information
// const projectId = 'my-project'
// const location = 'global'

// Creates a client
const client = new CatalogServiceClient();

async function listCatalogs() {
  const catalogs = await client.listCatalogs({
    parent: `projects/${projectId}/locations/${location}`,
  });
  console.info(catalogs);
}
listCatalogs();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Analytics_service.export_analytics_metrics source code Open in Cloud Shell
Catalog_service.add_catalog_attribute source code Open in Cloud Shell
Catalog_service.get_attributes_config source code Open in Cloud Shell
Catalog_service.get_completion_config source code Open in Cloud Shell
Catalog_service.get_default_branch source code Open in Cloud Shell
Catalog_service.list_catalogs source code Open in Cloud Shell
Catalog_service.remove_catalog_attribute source code Open in Cloud Shell
Catalog_service.replace_catalog_attribute source code Open in Cloud Shell
Catalog_service.set_default_branch source code Open in Cloud Shell
Catalog_service.update_attributes_config source code Open in Cloud Shell
Catalog_service.update_catalog source code Open in Cloud Shell
Catalog_service.update_completion_config source code Open in Cloud Shell
Completion_service.complete_query source code Open in Cloud Shell
Completion_service.import_completion_data source code Open in Cloud Shell
Control_service.create_control source code Open in Cloud Shell
Control_service.delete_control source code Open in Cloud Shell
Control_service.get_control source code Open in Cloud Shell
Control_service.list_controls source code Open in Cloud Shell
Control_service.update_control source code Open in Cloud Shell
Model_service.create_model source code Open in Cloud Shell
Model_service.delete_model source code Open in Cloud Shell
Model_service.get_model source code Open in Cloud Shell
Model_service.list_models source code Open in Cloud Shell
Model_service.pause_model source code Open in Cloud Shell
Model_service.resume_model source code Open in Cloud Shell
Model_service.tune_model source code Open in Cloud Shell
Model_service.update_model source code Open in Cloud Shell
Prediction_service.predict source code Open in Cloud Shell
Product_service.add_fulfillment_places source code Open in Cloud Shell
Product_service.add_local_inventories source code Open in Cloud Shell
Product_service.create_product source code Open in Cloud Shell
Product_service.delete_product source code Open in Cloud Shell
Product_service.get_product source code Open in Cloud Shell
Product_service.import_products source code Open in Cloud Shell
Product_service.list_products source code Open in Cloud Shell
Product_service.remove_fulfillment_places source code Open in Cloud Shell
Product_service.remove_local_inventories source code Open in Cloud Shell
Product_service.set_inventory source code Open in Cloud Shell
Product_service.update_product source code Open in Cloud Shell
Search_service.search source code Open in Cloud Shell
Serving_config_service.add_control source code Open in Cloud Shell
Serving_config_service.create_serving_config source code Open in Cloud Shell
Serving_config_service.delete_serving_config source code Open in Cloud Shell
Serving_config_service.get_serving_config source code Open in Cloud Shell
Serving_config_service.list_serving_configs source code Open in Cloud Shell
Serving_config_service.remove_control source code Open in Cloud Shell
Serving_config_service.update_serving_config source code Open in Cloud Shell
User_event_service.collect_user_event source code Open in Cloud Shell
User_event_service.import_user_events source code Open in Cloud Shell
User_event_service.purge_user_events source code Open in Cloud Shell
User_event_service.rejoin_user_events source code Open in Cloud Shell
User_event_service.write_user_event source code Open in Cloud Shell
Analytics_service.export_analytics_metrics source code Open in Cloud Shell
Catalog_service.add_catalog_attribute source code Open in Cloud Shell
Catalog_service.batch_remove_catalog_attributes source code Open in Cloud Shell
Catalog_service.get_attributes_config source code Open in Cloud Shell
Catalog_service.get_completion_config source code Open in Cloud Shell
Catalog_service.get_default_branch source code Open in Cloud Shell
Catalog_service.list_catalogs source code Open in Cloud Shell
Catalog_service.remove_catalog_attribute source code Open in Cloud Shell
Catalog_service.replace_catalog_attribute source code Open in Cloud Shell
Catalog_service.set_default_branch source code Open in Cloud Shell
Catalog_service.update_attributes_config source code Open in Cloud Shell
Catalog_service.update_catalog source code Open in Cloud Shell
Catalog_service.update_completion_config source code Open in Cloud Shell
Completion_service.complete_query source code Open in Cloud Shell
Completion_service.import_completion_data source code Open in Cloud Shell
Control_service.create_control source code Open in Cloud Shell
Control_service.delete_control source code Open in Cloud Shell
Control_service.get_control source code Open in Cloud Shell
Control_service.list_controls source code Open in Cloud Shell
Control_service.update_control source code Open in Cloud Shell
Merchant_center_account_link_service.create_merchant_center_account_link source code Open in Cloud Shell
Merchant_center_account_link_service.delete_merchant_center_account_link source code Open in Cloud Shell
Merchant_center_account_link_service.list_merchant_center_account_links source code Open in Cloud Shell
Model_service.create_model source code Open in Cloud Shell
Model_service.delete_model source code Open in Cloud Shell
Model_service.get_model source code Open in Cloud Shell
Model_service.list_models source code Open in Cloud Shell
Model_service.pause_model source code Open in Cloud Shell
Model_service.resume_model source code Open in Cloud Shell
Model_service.tune_model source code Open in Cloud Shell
Model_service.update_model source code Open in Cloud Shell
Prediction_service.predict source code Open in Cloud Shell
Product_service.add_fulfillment_places source code Open in Cloud Shell
Product_service.add_local_inventories source code Open in Cloud Shell
Product_service.create_product source code Open in Cloud Shell
Product_service.delete_product source code Open in Cloud Shell
Product_service.get_product source code Open in Cloud Shell
Product_service.import_products source code Open in Cloud Shell
Product_service.list_products source code Open in Cloud Shell
Product_service.purge_products source code Open in Cloud Shell
Product_service.remove_fulfillment_places source code Open in Cloud Shell
Product_service.remove_local_inventories source code Open in Cloud Shell
Product_service.set_inventory source code Open in Cloud Shell
Product_service.update_product source code Open in Cloud Shell
Search_service.search source code Open in Cloud Shell
Serving_config_service.add_control source code Open in Cloud Shell
Serving_config_service.create_serving_config source code Open in Cloud Shell
Serving_config_service.delete_serving_config source code Open in Cloud Shell
Serving_config_service.get_serving_config source code Open in Cloud Shell
Serving_config_service.list_serving_configs source code Open in Cloud Shell
Serving_config_service.remove_control source code Open in Cloud Shell
Serving_config_service.update_serving_config source code Open in Cloud Shell
User_event_service.collect_user_event source code Open in Cloud Shell
User_event_service.import_user_events source code Open in Cloud Shell
User_event_service.purge_user_events source code Open in Cloud Shell
User_event_service.rejoin_user_events source code Open in Cloud Shell
User_event_service.write_user_event source code Open in Cloud Shell
Analytics_service.export_analytics_metrics source code Open in Cloud Shell
Catalog_service.add_catalog_attribute source code Open in Cloud Shell
Catalog_service.batch_remove_catalog_attributes source code Open in Cloud Shell
Catalog_service.get_attributes_config source code Open in Cloud Shell
Catalog_service.get_completion_config source code Open in Cloud Shell
Catalog_service.get_default_branch source code Open in Cloud Shell
Catalog_service.list_catalogs source code Open in Cloud Shell
Catalog_service.remove_catalog_attribute source code Open in Cloud Shell
Catalog_service.replace_catalog_attribute source code Open in Cloud Shell
Catalog_service.set_default_branch source code Open in Cloud Shell
Catalog_service.update_attributes_config source code Open in Cloud Shell
Catalog_service.update_catalog source code Open in Cloud Shell
Catalog_service.update_completion_config source code Open in Cloud Shell
Completion_service.complete_query source code Open in Cloud Shell
Completion_service.import_completion_data source code Open in Cloud Shell
Control_service.create_control source code Open in Cloud Shell
Control_service.delete_control source code Open in Cloud Shell
Control_service.get_control source code Open in Cloud Shell
Control_service.list_controls source code Open in Cloud Shell
Control_service.update_control source code Open in Cloud Shell
Model_service.create_model source code Open in Cloud Shell
Model_service.delete_model source code Open in Cloud Shell
Model_service.get_model source code Open in Cloud Shell
Model_service.list_models source code Open in Cloud Shell
Model_service.pause_model source code Open in Cloud Shell
Model_service.resume_model source code Open in Cloud Shell
Model_service.tune_model source code Open in Cloud Shell
Model_service.update_model source code Open in Cloud Shell
Prediction_service.predict source code Open in Cloud Shell
Product_service.add_fulfillment_places source code Open in Cloud Shell
Product_service.add_local_inventories source code Open in Cloud Shell
Product_service.create_product source code Open in Cloud Shell
Product_service.delete_product source code Open in Cloud Shell
Product_service.get_product source code Open in Cloud Shell
Product_service.import_products source code Open in Cloud Shell
Product_service.list_products source code Open in Cloud Shell
Product_service.remove_fulfillment_places source code Open in Cloud Shell
Product_service.remove_local_inventories source code Open in Cloud Shell
Product_service.set_inventory source code Open in Cloud Shell
Product_service.update_product source code Open in Cloud Shell
Search_service.search source code Open in Cloud Shell
Serving_config_service.add_control source code Open in Cloud Shell
Serving_config_service.create_serving_config source code Open in Cloud Shell
Serving_config_service.delete_serving_config source code Open in Cloud Shell
Serving_config_service.get_serving_config source code Open in Cloud Shell
Serving_config_service.list_serving_configs source code Open in Cloud Shell
Serving_config_service.remove_control source code Open in Cloud Shell
Serving_config_service.update_serving_config source code Open in Cloud Shell
User_event_service.collect_user_event source code Open in Cloud Shell
User_event_service.import_user_events source code Open in Cloud Shell
User_event_service.purge_user_events source code Open in Cloud Shell
User_event_service.rejoin_user_events source code Open in Cloud Shell
User_event_service.write_user_event source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Retail API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/retail@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE

Package Sidebar

Install

npm i @google-cloud/retail

Weekly Downloads

8,388

Version

3.4.0

License

Apache-2.0

Unpacked Size

19.6 MB

Total Files

173

Last publish

Collaborators

  • google-wombot
  • google-admin