Google Cloud Node.js Client Libraries

Node.js idiomatic client libraries for Google Cloud Platform services.

• Node.js on Google Cloud

Libraries are available on GitHub and npm for developing Node.js applications that interact with individual Google Cloud services:

Repo Release Level Version Access Approval Access Context Manager Advisory Notifications API AI Platform Notebooks AlloyDB API Analytics Hub API Anthos Multi-Cloud API API Gateway API Keys API Apigee Connect API App Engine Admin API Artifact Registry Asset Inventory Assured Workloads for Government AutoML Backup and DR Service API Backup for GKE API Bare Metal Solution API BeyondCorp API BeyondCorp API BigQuery Migration API Bigtable Billing Billing Budgets Binary Authorization Build Certificate Authority Service Certificate Manager Channel API Commerce Consumer Procurement API Composer Confidential Computing API Connectors API Contact Center AI Insights API Controls Partner API Data Catalog Data Fusion Data Lineage API Data Loss Prevention Database Migration Service Dataplex Dataproc Dataproc Metastore Datastore Datastream Deploy Dialogflow API Dialogflow CX API Discovery Engine API Distributed Cloud Edge Container API Distributed Cloud Edge Network API DNS Document AI Document AI Warehouse Domains Error Reporting Essential Contacts API Eventarc Eventarc Publishing API Filestore Functions GKE Hub Google BigQuery Google BigQuery Connection Google BigQuery Data Transfer Service Google BigQuery Reservation Google Compute Engine Google Container Analysis Google Workspace Add-ons API Grafeas IAM Policy Troubleshooter API IAM Service Account Credentials API Identity and Access Management Identity-Aware Proxy IDS Infrastructure Manager API Internet of Things (IoT) Core Key Management Service Kubernetes Engine Cluster Manager API Live Stream API Logging Logging for Bunyan Logging for Winston Managed Service for Microsoft Active Directory Media Translation Memorystore for Memcached Migrate for Compute Engine Migration Center API Monitoring Dashboards Natural Language NetApp API Network Connectivity Center Network Management API Network Security API Network Services API Organization Policy OS Config API OS Login Policy Simulator API Profiler Pub/Sub Public Certificate Authority Quotas API Rapid Migration Assessment API reCAPTCHA Enterprise Recommender Redis Resource Manager API Retail API Run Scheduler Secret Manager Secure Source Manager API Security Center Management API Security Command Center Service Control API Service Directory Service Health API Service Management API Service Usage Shell Speech SQL Admin API Stackdriver Monitoring Storage API Storage Insights API Storage Transfer Service Support API Talent Solution Tasks Telco Automation API Text-to-Speech TPU Transcoder API Translation Vertex AI Video Intelligence Video Stitcher API Virtual Private Cloud Vision API VMware Engine API Web Risk API Web Security Scanner Workflow Executions Workstations API API hub API Apigee Registry API App Hub API Area120 Tables API Batch BeyondCorp API BeyondCorp API BeyondCorp API CSS API Data Labeling Data QnA Dataflow Dataform API Developer Connect API GDC Hardware Management API Generative Language API GKE Connect Gateway Google Ad Manager API Google Analytics Admin Google Analytics Data Google Chat API Google Maps Routing Google Marketing Platform Admin API Google Meet API Last Mile Fleet Solution Delivery API Life Sciences Local Rides and Deliveries API Managed Service for Apache Kafka API Memorystore API Memorystore for Redis API Merchant API Merchant API Merchant API Merchant API Merchant API Merchant API Merchant API Merchant API Merchant API Merchant API Model Armor API Oracle Database@Google Cloud API Parallelstore API Parameter Manager API Phishing Protection Places API (New) Places Insights API Policy Troubleshooter API Private Catalog Privileged Access Manager API Profiler API Route Optimization API Solar API Trace

If the service is not listed above, google-api-nodejs-client interfaces with additional Google Cloud APIs using a legacy REST interface.

When building Node.js applications, preference should be given to the libraries listed in the table.

Enabling APIs

Before you can interact with a given Google Cloud Service, you must enable its API.

Links are available for enabling APIs in the table at the beginning of this document, and in each libraries README.md.

Authentication

Download your Service Account Credentials JSON file

To use Application Default Credentials, You first need to download a set of JSON credentials for your project. Go to APIs & Auth > Credentials in the Google Developers Console and select Service account from the Add credentials dropdown.

This file is your only copy of these credentials. It should never be committed with your source code, and should be stored securely.

Once downloaded, store the path to this file in the GOOGLE_APPLICATION_CREDENTIALS environment variable.

Other Authentication Methods

Other authentication methods are outlined in the README for google-auth-library-nodejs, which is the authentication library used by all Google Cloud Node.js clients.

Example Applications

• nodejs-getting-started - A sample and tutorial that demonstrates how to build a complete web application using Cloud Datastore, Cloud Storage, and Cloud Pub/Sub and deploy it to Google App Engine or Google Compute Engine.
• gcloud-node-todos - A TodoMVC backend using google-cloud-node and Datastore.
• gitnpm - Easily lookup an npm package’s GitHub repo using google-cloud-node and Google App Engine.
• gcloud-kvstore - Use Datastore as a simple key-value store.
• hya-wave - Cloud-based web sample editor. Part of the hya-io family of products.
• gstore-node - Google Datastore Entities Modeling library.
• gstore-api - REST API builder for Google Datastore Entities.

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, {{ metadata['lib_install_cmd'] }}@legacy-10 installs client libraries for versions compatible with Node.js 10.

Versioning

Our libraries follow Semantic Versioning.

Please note it is currently under active development. Any release versioned 0.x.y is subject to backwards-incompatible changes at any time.

Stable: Libraries defined at the Stable quality level are 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.

Preview: Libraries defined at the preview quality level are still a work-in-progress and are more likely to get backwards-incompatible updates.

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information on how to get started.

License

Apache 2.0 - See LICENSE for more information.