@google-cloud/retail

Retail API: Node.js Client

Retail client for Node.js

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

• Retail API Node.js Client API Reference
• Retail API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-retail

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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 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
Catalog_service.add_catalog_attribute	source code
Catalog_service.get_attributes_config	source code
Catalog_service.get_completion_config	source code
Catalog_service.get_default_branch	source code
Catalog_service.list_catalogs	source code
Catalog_service.remove_catalog_attribute	source code
Catalog_service.replace_catalog_attribute	source code
Catalog_service.set_default_branch	source code
Catalog_service.update_attributes_config	source code
Catalog_service.update_catalog	source code
Catalog_service.update_completion_config	source code
Completion_service.complete_query	source code
Completion_service.import_completion_data	source code
Control_service.create_control	source code
Control_service.delete_control	source code
Control_service.get_control	source code
Control_service.list_controls	source code
Control_service.update_control	source code
Generative_question_service.batch_update_generative_question_configs	source code
Generative_question_service.get_generative_questions_feature_config	source code
Generative_question_service.list_generative_question_configs	source code
Generative_question_service.update_generative_question_config	source code
Generative_question_service.update_generative_questions_feature_config	source code
Model_service.create_model	source code
Model_service.delete_model	source code
Model_service.get_model	source code
Model_service.list_models	source code
Model_service.pause_model	source code
Model_service.resume_model	source code
Model_service.tune_model	source code
Model_service.update_model	source code
Prediction_service.predict	source code
Product_service.add_fulfillment_places	source code
Product_service.add_local_inventories	source code
Product_service.create_product	source code
Product_service.delete_product	source code
Product_service.get_product	source code
Product_service.import_products	source code
Product_service.list_products	source code
Product_service.purge_products	source code
Product_service.remove_fulfillment_places	source code
Product_service.remove_local_inventories	source code
Product_service.set_inventory	source code
Product_service.update_product	source code
Search_service.search	source code
Serving_config_service.add_control	source code
Serving_config_service.create_serving_config	source code
Serving_config_service.delete_serving_config	source code
Serving_config_service.get_serving_config	source code
Serving_config_service.list_serving_configs	source code
Serving_config_service.remove_control	source code
Serving_config_service.update_serving_config	source code
User_event_service.collect_user_event	source code
User_event_service.import_user_events	source code
User_event_service.purge_user_events	source code
User_event_service.rejoin_user_events	source code
User_event_service.write_user_event	source code
Analytics_service.export_analytics_metrics	source code
Branch_service.get_branch	source code
Branch_service.list_branches	source code
Catalog_service.add_catalog_attribute	source code
Catalog_service.batch_remove_catalog_attributes	source code
Catalog_service.get_attributes_config	source code
Catalog_service.get_completion_config	source code
Catalog_service.get_default_branch	source code
Catalog_service.list_catalogs	source code
Catalog_service.remove_catalog_attribute	source code
Catalog_service.replace_catalog_attribute	source code
Catalog_service.set_default_branch	source code
Catalog_service.update_attributes_config	source code
Catalog_service.update_catalog	source code
Catalog_service.update_completion_config	source code
Completion_service.complete_query	source code
Completion_service.import_completion_data	source code
Control_service.create_control	source code
Control_service.delete_control	source code
Control_service.get_control	source code
Control_service.list_controls	source code
Control_service.update_control	source code
Generative_question_service.batch_update_generative_question_configs	source code
Generative_question_service.get_generative_questions_feature_config	source code
Generative_question_service.list_generative_question_configs	source code
Generative_question_service.update_generative_question_config	source code
Generative_question_service.update_generative_questions_feature_config	source code
Merchant_center_account_link_service.create_merchant_center_account_link	source code
Merchant_center_account_link_service.delete_merchant_center_account_link	source code
Merchant_center_account_link_service.list_merchant_center_account_links	source code
Model_service.create_model	source code
Model_service.delete_model	source code
Model_service.get_model	source code
Model_service.list_models	source code
Model_service.pause_model	source code
Model_service.resume_model	source code
Model_service.tune_model	source code
Model_service.update_model	source code
Prediction_service.predict	source code
Product_service.add_fulfillment_places	source code
Product_service.add_local_inventories	source code
Product_service.create_product	source code
Product_service.delete_product	source code
Product_service.export_products	source code
Product_service.get_product	source code
Product_service.import_products	source code
Product_service.list_products	source code
Product_service.purge_products	source code
Product_service.remove_fulfillment_places	source code
Product_service.remove_local_inventories	source code
Product_service.set_inventory	source code
Product_service.update_product	source code
Project_service.accept_terms	source code
Project_service.enroll_solution	source code
Project_service.get_alert_config	source code
Project_service.get_logging_config	source code
Project_service.get_project	source code
Project_service.list_enrolled_solutions	source code
Project_service.update_alert_config	source code
Project_service.update_logging_config	source code
Search_service.search	source code
Serving_config_service.add_control	source code
Serving_config_service.create_serving_config	source code
Serving_config_service.delete_serving_config	source code
Serving_config_service.get_serving_config	source code
Serving_config_service.list_serving_configs	source code
Serving_config_service.remove_control	source code
Serving_config_service.update_serving_config	source code
User_event_service.collect_user_event	source code
User_event_service.export_user_events	source code
User_event_service.import_user_events	source code
User_event_service.purge_user_events	source code
User_event_service.rejoin_user_events	source code
User_event_service.write_user_event	source code
Analytics_service.export_analytics_metrics	source code
Catalog_service.add_catalog_attribute	source code
Catalog_service.batch_remove_catalog_attributes	source code
Catalog_service.get_attributes_config	source code
Catalog_service.get_completion_config	source code
Catalog_service.get_default_branch	source code
Catalog_service.list_catalogs	source code
Catalog_service.remove_catalog_attribute	source code
Catalog_service.replace_catalog_attribute	source code
Catalog_service.set_default_branch	source code
Catalog_service.update_attributes_config	source code
Catalog_service.update_catalog	source code
Catalog_service.update_completion_config	source code
Completion_service.complete_query	source code
Completion_service.import_completion_data	source code
Control_service.create_control	source code
Control_service.delete_control	source code
Control_service.get_control	source code
Control_service.list_controls	source code
Control_service.update_control	source code
Generative_question_service.batch_update_generative_question_configs	source code
Generative_question_service.get_generative_questions_feature_config	source code
Generative_question_service.list_generative_question_configs	source code
Generative_question_service.update_generative_question_config	source code
Generative_question_service.update_generative_questions_feature_config	source code
Model_service.create_model	source code
Model_service.delete_model	source code
Model_service.get_model	source code
Model_service.list_models	source code
Model_service.pause_model	source code
Model_service.resume_model	source code
Model_service.tune_model	source code
Model_service.update_model	source code
Prediction_service.predict	source code
Product_service.add_fulfillment_places	source code
Product_service.add_local_inventories	source code
Product_service.create_product	source code
Product_service.delete_product	source code
Product_service.export_products	source code
Product_service.get_product	source code
Product_service.import_products	source code
Product_service.list_products	source code
Product_service.purge_products	source code
Product_service.remove_fulfillment_places	source code
Product_service.remove_local_inventories	source code
Product_service.set_inventory	source code
Product_service.update_product	source code
Project_service.get_alert_config	source code
Project_service.update_alert_config	source code
Search_service.search	source code
Serving_config_service.add_control	source code
Serving_config_service.create_serving_config	source code
Serving_config_service.delete_serving_config	source code
Serving_config_service.get_serving_config	source code
Serving_config_service.list_serving_configs	source code
Serving_config_service.remove_control	source code
Serving_config_service.update_serving_config	source code
User_event_service.collect_user_event	source code
User_event_service.export_user_events	source code
User_event_service.import_user_events	source code
User_event_service.purge_user_events	source code
User_event_service.rejoin_user_events	source code
User_event_service.write_user_event	source code
Quickstart	source code

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