Socket
Socket
Sign inDemoInstall

@google-cloud/retail

Package Overview
Dependencies
89
Maintainers
2
Versions
32
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@google-cloud/retail

Retail client for Node.js


Version published
Maintainers
2
Weekly downloads
5,696
increased by57.52%
Bundle size
443 kB
Minified + gzipped

Weekly downloads

Readme

Source

Google Cloud Platform logo

Retail API: Node.js Client

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.

SampleSource CodeTry it
Analytics_service.export_analytics_metricssource codeOpen in Cloud Shell
Catalog_service.add_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.get_attributes_configsource codeOpen in Cloud Shell
Catalog_service.get_completion_configsource codeOpen in Cloud Shell
Catalog_service.get_default_branchsource codeOpen in Cloud Shell
Catalog_service.list_catalogssource codeOpen in Cloud Shell
Catalog_service.remove_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.replace_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.set_default_branchsource codeOpen in Cloud Shell
Catalog_service.update_attributes_configsource codeOpen in Cloud Shell
Catalog_service.update_catalogsource codeOpen in Cloud Shell
Catalog_service.update_completion_configsource codeOpen in Cloud Shell
Completion_service.complete_querysource codeOpen in Cloud Shell
Completion_service.import_completion_datasource codeOpen in Cloud Shell
Control_service.create_controlsource codeOpen in Cloud Shell
Control_service.delete_controlsource codeOpen in Cloud Shell
Control_service.get_controlsource codeOpen in Cloud Shell
Control_service.list_controlssource codeOpen in Cloud Shell
Control_service.update_controlsource codeOpen in Cloud Shell
Model_service.create_modelsource codeOpen in Cloud Shell
Model_service.delete_modelsource codeOpen in Cloud Shell
Model_service.get_modelsource codeOpen in Cloud Shell
Model_service.list_modelssource codeOpen in Cloud Shell
Model_service.pause_modelsource codeOpen in Cloud Shell
Model_service.resume_modelsource codeOpen in Cloud Shell
Model_service.tune_modelsource codeOpen in Cloud Shell
Model_service.update_modelsource codeOpen in Cloud Shell
Prediction_service.predictsource codeOpen in Cloud Shell
Product_service.add_fulfillment_placessource codeOpen in Cloud Shell
Product_service.add_local_inventoriessource codeOpen in Cloud Shell
Product_service.create_productsource codeOpen in Cloud Shell
Product_service.delete_productsource codeOpen in Cloud Shell
Product_service.get_productsource codeOpen in Cloud Shell
Product_service.import_productssource codeOpen in Cloud Shell
Product_service.list_productssource codeOpen in Cloud Shell
Product_service.remove_fulfillment_placessource codeOpen in Cloud Shell
Product_service.remove_local_inventoriessource codeOpen in Cloud Shell
Product_service.set_inventorysource codeOpen in Cloud Shell
Product_service.update_productsource codeOpen in Cloud Shell
Search_service.searchsource codeOpen in Cloud Shell
Serving_config_service.add_controlsource codeOpen in Cloud Shell
Serving_config_service.create_serving_configsource codeOpen in Cloud Shell
Serving_config_service.delete_serving_configsource codeOpen in Cloud Shell
Serving_config_service.get_serving_configsource codeOpen in Cloud Shell
Serving_config_service.list_serving_configssource codeOpen in Cloud Shell
Serving_config_service.remove_controlsource codeOpen in Cloud Shell
Serving_config_service.update_serving_configsource codeOpen in Cloud Shell
User_event_service.collect_user_eventsource codeOpen in Cloud Shell
User_event_service.import_user_eventssource codeOpen in Cloud Shell
User_event_service.purge_user_eventssource codeOpen in Cloud Shell
User_event_service.rejoin_user_eventssource codeOpen in Cloud Shell
User_event_service.write_user_eventsource codeOpen in Cloud Shell
Analytics_service.export_analytics_metricssource codeOpen in Cloud Shell
Catalog_service.add_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.batch_remove_catalog_attributessource codeOpen in Cloud Shell
Catalog_service.get_attributes_configsource codeOpen in Cloud Shell
Catalog_service.get_completion_configsource codeOpen in Cloud Shell
Catalog_service.get_default_branchsource codeOpen in Cloud Shell
Catalog_service.list_catalogssource codeOpen in Cloud Shell
Catalog_service.remove_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.replace_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.set_default_branchsource codeOpen in Cloud Shell
Catalog_service.update_attributes_configsource codeOpen in Cloud Shell
Catalog_service.update_catalogsource codeOpen in Cloud Shell
Catalog_service.update_completion_configsource codeOpen in Cloud Shell
Completion_service.complete_querysource codeOpen in Cloud Shell
Completion_service.import_completion_datasource codeOpen in Cloud Shell
Control_service.create_controlsource codeOpen in Cloud Shell
Control_service.delete_controlsource codeOpen in Cloud Shell
Control_service.get_controlsource codeOpen in Cloud Shell
Control_service.list_controlssource codeOpen in Cloud Shell
Control_service.update_controlsource codeOpen in Cloud Shell
Merchant_center_account_link_service.create_merchant_center_account_linksource codeOpen in Cloud Shell
Merchant_center_account_link_service.delete_merchant_center_account_linksource codeOpen in Cloud Shell
Merchant_center_account_link_service.list_merchant_center_account_linkssource codeOpen in Cloud Shell
Model_service.create_modelsource codeOpen in Cloud Shell
Model_service.delete_modelsource codeOpen in Cloud Shell
Model_service.get_modelsource codeOpen in Cloud Shell
Model_service.list_modelssource codeOpen in Cloud Shell
Model_service.pause_modelsource codeOpen in Cloud Shell
Model_service.resume_modelsource codeOpen in Cloud Shell
Model_service.tune_modelsource codeOpen in Cloud Shell
Model_service.update_modelsource codeOpen in Cloud Shell
Prediction_service.predictsource codeOpen in Cloud Shell
Product_service.add_fulfillment_placessource codeOpen in Cloud Shell
Product_service.add_local_inventoriessource codeOpen in Cloud Shell
Product_service.create_productsource codeOpen in Cloud Shell
Product_service.delete_productsource codeOpen in Cloud Shell
Product_service.get_productsource codeOpen in Cloud Shell
Product_service.import_productssource codeOpen in Cloud Shell
Product_service.list_productssource codeOpen in Cloud Shell
Product_service.purge_productssource codeOpen in Cloud Shell
Product_service.remove_fulfillment_placessource codeOpen in Cloud Shell
Product_service.remove_local_inventoriessource codeOpen in Cloud Shell
Product_service.set_inventorysource codeOpen in Cloud Shell
Product_service.update_productsource codeOpen in Cloud Shell
Search_service.searchsource codeOpen in Cloud Shell
Serving_config_service.add_controlsource codeOpen in Cloud Shell
Serving_config_service.create_serving_configsource codeOpen in Cloud Shell
Serving_config_service.delete_serving_configsource codeOpen in Cloud Shell
Serving_config_service.get_serving_configsource codeOpen in Cloud Shell
Serving_config_service.list_serving_configssource codeOpen in Cloud Shell
Serving_config_service.remove_controlsource codeOpen in Cloud Shell
Serving_config_service.update_serving_configsource codeOpen in Cloud Shell
User_event_service.collect_user_eventsource codeOpen in Cloud Shell
User_event_service.import_user_eventssource codeOpen in Cloud Shell
User_event_service.purge_user_eventssource codeOpen in Cloud Shell
User_event_service.rejoin_user_eventssource codeOpen in Cloud Shell
User_event_service.write_user_eventsource codeOpen in Cloud Shell
Analytics_service.export_analytics_metricssource codeOpen in Cloud Shell
Catalog_service.add_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.batch_remove_catalog_attributessource codeOpen in Cloud Shell
Catalog_service.get_attributes_configsource codeOpen in Cloud Shell
Catalog_service.get_completion_configsource codeOpen in Cloud Shell
Catalog_service.get_default_branchsource codeOpen in Cloud Shell
Catalog_service.list_catalogssource codeOpen in Cloud Shell
Catalog_service.remove_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.replace_catalog_attributesource codeOpen in Cloud Shell
Catalog_service.set_default_branchsource codeOpen in Cloud Shell
Catalog_service.update_attributes_configsource codeOpen in Cloud Shell
Catalog_service.update_catalogsource codeOpen in Cloud Shell
Catalog_service.update_completion_configsource codeOpen in Cloud Shell
Completion_service.complete_querysource codeOpen in Cloud Shell
Completion_service.import_completion_datasource codeOpen in Cloud Shell
Control_service.create_controlsource codeOpen in Cloud Shell
Control_service.delete_controlsource codeOpen in Cloud Shell
Control_service.get_controlsource codeOpen in Cloud Shell
Control_service.list_controlssource codeOpen in Cloud Shell
Control_service.update_controlsource codeOpen in Cloud Shell
Model_service.create_modelsource codeOpen in Cloud Shell
Model_service.delete_modelsource codeOpen in Cloud Shell
Model_service.get_modelsource codeOpen in Cloud Shell
Model_service.list_modelssource codeOpen in Cloud Shell
Model_service.pause_modelsource codeOpen in Cloud Shell
Model_service.resume_modelsource codeOpen in Cloud Shell
Model_service.tune_modelsource codeOpen in Cloud Shell
Model_service.update_modelsource codeOpen in Cloud Shell
Prediction_service.predictsource codeOpen in Cloud Shell
Product_service.add_fulfillment_placessource codeOpen in Cloud Shell
Product_service.add_local_inventoriessource codeOpen in Cloud Shell
Product_service.create_productsource codeOpen in Cloud Shell
Product_service.delete_productsource codeOpen in Cloud Shell
Product_service.get_productsource codeOpen in Cloud Shell
Product_service.import_productssource codeOpen in Cloud Shell
Product_service.list_productssource codeOpen in Cloud Shell
Product_service.remove_fulfillment_placessource codeOpen in Cloud Shell
Product_service.remove_local_inventoriessource codeOpen in Cloud Shell
Product_service.set_inventorysource codeOpen in Cloud Shell
Product_service.update_productsource codeOpen in Cloud Shell
Search_service.searchsource codeOpen in Cloud Shell
Serving_config_service.add_controlsource codeOpen in Cloud Shell
Serving_config_service.create_serving_configsource codeOpen in Cloud Shell
Serving_config_service.delete_serving_configsource codeOpen in Cloud Shell
Serving_config_service.get_serving_configsource codeOpen in Cloud Shell
Serving_config_service.list_serving_configssource codeOpen in Cloud Shell
Serving_config_service.remove_controlsource codeOpen in Cloud Shell
Serving_config_service.update_serving_configsource codeOpen in Cloud Shell
User_event_service.collect_user_eventsource codeOpen in Cloud Shell
User_event_service.import_user_eventssource codeOpen in Cloud Shell
User_event_service.purge_user_eventssource codeOpen in Cloud Shell
User_event_service.rejoin_user_eventssource codeOpen in Cloud Shell
User_event_service.write_user_eventsource codeOpen in Cloud Shell
Quickstartsource codeOpen 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

Keywords

FAQs

Last updated on 13 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc