Node.js idiomatic client for Google Cloud Platform services.
This client supports the following Google Cloud Platform services at a General Availability (GA) quality level:
- Cloud Datastore (GA)
- Cloud Storage (GA)
- Google Stackdriver Logging (GA)
This client supports the following Google Cloud Platform services at a Beta quality level:
- Cloud Natural Language (Beta)
- Cloud Translation API (Beta)
- Cloud Vision (Beta)
- Google BigQuery (Beta)
This client supports the following Google Cloud Platform services at an Alpha quality level:
- Cloud Bigtable (Alpha)
- Cloud DNS (Alpha)
- Cloud Pub/Sub (Alpha)
- Cloud Resource Manager (Alpha)
- Cloud Spanner (Alpha)
- Cloud Speech (Alpha)
- Google Compute Engine (Alpha)
- Google Prediction API (Alpha)
- Google Stackdriver Debugger (Alpha)
- Google Stackdriver Error Reporting (Alpha)
- Google Stackdriver Trace (Alpha)
- Google Stackdriver Monitoring (Alpha)
If you need support for other Google APIs, check out the Google Node.js API Client library.
We recommend installing the individual packages that you need, which are provided under the @google-cloud namespace. For example:
$ npm install --save @google-cloud/datastore
$ npm install --save @google-cloud/storagevarconfig={projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'};vardatastore=require('@google-cloud/datastore')(config);varstorage=require('@google-cloud/storage')(config);We also provide a meta-package, google-cloud, which provides all of the individual APIs. However, in order to keep file size and memory use low, the use of this package is not recommended.
If you want the kitchen sink, however, get it with:
$ npm install --save google-cloudvargcloud=require('google-cloud')({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});vardatastore=gcloud.datastore();varstorage=gcloud.storage();- 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.
With google-cloud it's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Cloud services.
If you are running this client on Google Cloud Platform, we handle authentication for you with no configuration. You just need to make sure that when you set up the GCE instance, you add the correct scopes for the APIs you want to access.
vargcloud=require('google-cloud');// ...you're good to go! See the next section to get started using the APIs.If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account:
- Visit the Google Developers Console.
- Create a new project or click on an existing project.
- Navigate to APIs & auth > APIs section and turn on the following APIs (you may need to enable billing in order to use these services):
- BigQuery API
- Cloud Bigtable API
- Cloud Bigtable Admin API
- Cloud Bigtable Table Admin API
- Cloud Spanner API
- Google Cloud Datastore API
- Google Cloud DNS API
- Google Cloud Natural Language API
- Google Cloud Pub/Sub API
- Google Cloud Resource Manager API
- Google Cloud Speech API
- Google Cloud Storage
- Google Cloud Storage JSON API
- Google Cloud Translation API
- Google Cloud Vision API
- Google Compute Engine API
- Prediction API
- Stackdriver Logging API
- Navigate to APIs & auth > Credentials and then:
- If you want to use a new service account key, click on Create credentials and select Service account key. After the account key is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests.
- If you want to generate a new service account key for an existing service account, click on Generate new JSON key and download the JSON key file.
// Authenticating on a global basis.varprojectId=process.env.GCLOUD_PROJECT;// E.g. 'grape-spaceship-123'vargcloud=require('google-cloud')({projectId: projectId,// The path to your key file:keyFilename: '/path/to/keyfile.json'// Or the contents of the key file:credentials: require('./path/to/keyfile.json')// For any APIs that accept an API key:key: '...'
});// ...you're good to go! See the next section to get started using the APIs.You can also set auth on a per-API-instance basis. The examples below show you how.
Follow the activation instructions to use the Cloud Datastore API with your project.
$ npm install --save @google-cloud/datastore
vardatastore=require('@google-cloud/datastore');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).vardatastoreClient=datastore({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});varkey=datastoreClient.key(['Product','Computer']);datastoreClient.get(key,function(err,entity){console.log(err||entity);});// Save data to Datastore.varblogPostData={title: 'How to make the perfect homemade pasta',author: 'Andrew Chilton',isDraft: true};varblogPostKey=datastoreClient.key('BlogPost');datastoreClient.save({key: blogPostKey,data: blogPostData},function(err){// `blogPostKey` has been updated with an ID so you can do more operations// with it, such as an update.blogPostData.isDraft=false;datastoreClient.save({key: blogPostKey,data: blogPostData},function(err){if(!err){// The blog post is now published!}});});$ npm install --save @google-cloud/storage
varstorage=require('@google-cloud/storage');varfs=require('fs');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).vargcs=storage({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Create a new bucket.gcs.createBucket('my-new-bucket',function(err,bucket){if(!err){// "my-new-bucket" was successfully created.}});// Reference an existing bucket.varbucket=gcs.bucket('my-existing-bucket');// Upload a local file to a new file to be created in your bucket.bucket.upload('/photos/zoo/zebra.jpg',function(err,file){if(!err){// "zebra.jpg" is now in your bucket.}});// Download a file from your bucket.bucket.file('giraffe.jpg').download({destination: '/photos/zoo/giraffe.jpg'},function(err){});// Streams are also supported for reading and writing files.varremoteReadStream=bucket.file('giraffe.jpg').createReadStream();varlocalWriteStream=fs.createWriteStream('/photos/zoo/giraffe.jpg');remoteReadStream.pipe(localWriteStream);varlocalReadStream=fs.createReadStream('/photos/zoo/zebra.jpg');varremoteWriteStream=bucket.file('zebra.jpg').createWriteStream();localReadStream.pipe(remoteWriteStream);$ npm install --save @google-cloud/logging
varlogging=require('@google-cloud/logging');// Authenticating on a global-basis. You can also authenticate on a per-API-// basis (see Authentication section above).varloggingClient=logging({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Create a sink using a Bucket as a destination.vargcs=storage();loggingClient.createSink('my-new-sink',{destination: gcs.bucket('my-sink')},function(err,sink){});// Write a critical entry to a log.varsyslog=loggingClient.log('syslog');varmetadata={resource: {type: 'gce_instance',labels: {zone: 'global',instance_id: '3'}}};varentry=syslog.entry(metadata,{delegate: process.env.user});syslog.critical(entry,function(err){});// Get all entries in your project.loggingClient.getEntries(function(err,entries){if(!err){// `entries` contains all of the entries from the logs in your project.}});$ npm install --save @google-cloud/language
varlanguage=require('@google-cloud/language');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authorization section above).varlanguageClient=language({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Get the entities from a sentence.languageClient.detectEntities('Stephen of Michigan!',function(err,entities){// entities = [// {// name: 'Stephen',// type: 'PERSON',// metadata: {// mid: '/m/05d8y4q'// },// salience: 0.7309288382530212,// mentions: [// {// text: {// content: 'Stephen',// beginOffset: -1// },// type: 'PROPER'// }// ]// },// // ...// ]});// Create a document if you plan to run multiple detections.vardocument=languageClient.document('Contributions welcome!');// Analyze the sentiment of the document.document.detectSentiment(function(err,sentiment){// sentiment = {// magnitude: 0.5,// score: 0.5// }});// Parse the syntax of the document.document.annotate(function(err,annotation){// annotation = {// language: 'en',// sentiment: {// magnitude: 0.30000001192092896,// score: 0.30000001192092896// },// entities: [// {// name: 'Contributions',// type: 'OTHER',// metadata: {},// salience: 1,// mentions: [// {// text: {// content: 'Contributions',// beginOffset: -1// },// type: 'COMMON'// }// ]// }// ],// sentences: [// {// text: {// content: 'Contributions welcome!',// beginOffset: -1// },// sentiment: {// magnitude: 0.30000001192092896,// score: 0.30000001192092896// }// }// ],// tokens: [// {// text: {// content: 'Contributions',// beginOffset: -1// },// partOfSpeech: {// tag: 'NOUN',// aspect: 'ASPECT_UNKNOWN',// case: 'CASE_UNKNOWN',// form: 'FORM_UNKNOWN',// gender: 'GENDER_UNKNOWN',// mood: 'MOOD_UNKNOWN',// number: 'PLURAL',// person: 'PERSON_UNKNOWN',// proper: 'PROPER_UNKNOWN',// reciprocity: 'RECIPROCITY_UNKNOWN',// tense: 'TENSE_UNKNOWN',// voice: 'VOICE_UNKNOWN'// },// dependencyEdge: {// headTokenIndex: 1,// label: 'NSUBJ'// },// lemma: 'contribution'// },// // ...// ]// }});$ npm install --save @google-cloud/translate
vartranslate=require('@google-cloud/translate');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).vartranslateClient=translate({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Translate a string of text.translateClient.translate('Hello','es',function(err,translation){if(!err){// translation = 'Hola'}});// Detect a language from a string of text.translateClient.detect('Hello',function(err,results){if(!err){// results = {// language: 'en',// confidence: 1,// input: 'Hello'// }}});// Get a list of supported languages.translateClient.getLanguages(function(err,languages){if(!err){// languages = [// 'af',// 'ar',// 'az',// ...// ]}});$ npm install --save @google-cloud/vision
varvision=require('@google-cloud/vision');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).varvisionClient=vision({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Read the text from an image.visionClient.detectText('./image.jpg',function(err,text){// text = [// 'This was text found in the image',// 'This was more text found in the image'// ]});// Detect faces and the locations of their features in an image.visionClient.detectFaces('./image.jpg',function(err,faces){// faces = [// {// angles: {pan,tilt,roll},// bounds: {// head: [{x,y},{x,y},{x,y},{x,y}],// face: [{x,y},{x,y},{x,y},{x,y}]// },// features: {// confidence: 34.489909,// chin: {// center: {x,y,z},// left: {x,y,z},// right: {x,y,z}// },// ears: {// left: {x,y,z},// right: {x,y,z}// },// eyebrows: {// left: {// left: {x,y,z},// right: {x,y,z},// top: {x,y,z}// },// right: {// left: {x,y,z},// right: {x,y,z},// top: {x,y,z}// }// },// eyes: {// left: {// bottom: {x,y,z},// center: {x,y,z},// left: {x,y,z},// pupil: {x,y,z},// right: {x,y,z},// top: {x,y,z}// },// right: {// bottom: {x,y,z},// center: {x,y,z},// left: {x,y,z},// pupil: {x,y,z},// right: {x,y,z},// top: {x,y,z}// }// },// forehead: {x,y,z},// lips: {// bottom: {x,y,z},// top: {x,y,z}// },// mouth: {// center: {x,y,z},// left: {x,y,z},// right: {x,y,z}// },// nose: {// bottom: {// center: {x,y,z},// left: {x,y,z},// right: {x,y,z}// },// tip: {x,y,z},// top: {x,y,z}// }// },// confidence: 56.748849,// blurry: false,// dark: false,// happy: false,// hat: false,// mad: false,// sad: false,// surprised: false// }// ]});$ npm install --save @google-cloud/bigquery
varbigquery=require('@google-cloud/bigquery');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).varbigqueryClient=bigquery({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Access an existing dataset and table.varschoolsDataset=bigqueryClient.dataset('schools');varschoolsTable=schoolsDataset.table('schoolsData');// Import data into a table.schoolsTable.import('/local/file.json',function(err,job){});// Get results from a query job.varjob=bigqueryClient.job('job-id');// Use a callback.job.getQueryResults(function(err,rows){});// Or get the same results as a readable stream.job.getQueryResults().on('data',function(row){});You may need to create an instance to use the Cloud Bigtable API with your project.
$ npm install --save @google-cloud/bigtable
varbigtable=require('@google-cloud/bigtable');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).varbigtableClient=bigtable({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});varinstance=bigtableClient.instance('my-instance');vartable=instance.table('prezzy');table.getRows(function(err,rows){});// Update a row in your table.varrow=table.row('alincoln');row.save('follows:gwashington',1,function(err){if(err){// Error handling omitted.}row.get('follows:gwashington',function(err,data){if(err){// Error handling omitted.}// data = {// follows: {// gwashington: [// {// value: 1// }// ]// }// }});});$ npm install --save @google-cloud/dns
vardns=require('@google-cloud/dns');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).vardnsClient=dns({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Create a managed zone.dnsClient.createZone('my-new-zone',{dnsName: 'my-domain.com.'},function(err,zone){});// Reference an existing zone.varzone=dnsClient.zone('my-existing-zone');// Create an NS record.varnsRecord=zone.record('ns',{ttl: 86400,name: 'my-domain.com.',data: 'ns-cloud1.googledomains.com.'});zone.addRecords([nsRecord],function(err,change){});// Create a zonefile from the records in your zone.zone.export('/zonefile.zone',function(err){});$ npm install --save @google-cloud/pubsub
varpubsub=require('@google-cloud/pubsub');// Authenticating on a per-API-basis. You don't need to do this if you// auth on a global basis (see Authentication section above).varpubsubClient=pubsub({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Reference a topic that has been previously created.vartopic=pubsubClient.topic('my-topic');// Publish a message to the topic.topic.publish('New message!',function(err){});// Subscribe to the topic.topic.subscribe('subscription-name',function(err,subscription){// Register listeners to start pulling for messages.functiononError(err){}functiononMessage(message){}subscription.on('error',onError);subscription.on('message',onMessage);// Remove listeners to stop pulling for messages.subscription.removeListener('message',onMessage);subscription.removeListener('error',onError);});$ npm install --save @google-cloud/resource
varresource=require('@google-cloud/resource');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).varresourceClient=resource({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Get all of the projects you maintain.resourceClient.getProjects(function(err,projects){if(!err){// `projects` contains all of your projects.}});// Get the metadata from your project. (defaults to `grape-spaceship-123`)varproject=resourceClient.project();project.getMetadata(function(err,metadata){// `metadata` describes your project.});$ npm install --save @google-cloud/spanner
varspanner=require('@google-cloud/spanner');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).varspannerClient=spanner({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});varinstance=spannerClient.instance('my-instance');vardatabase=instance.database('my-database');// Create a table.varschema='CREATE TABLE Singers ('+' SingerId INT64 NOT NULL,'+' FirstName STRING(1024),'+' LastName STRING(1024),'+' SingerInfo BYTES(MAX),'+') PRIMARY KEY(SingerId)';database.createTable(schema,function(err,table,operation){if(err){// Error handling omitted.}operation.on('error',function(err){}).on('complete',function(){// Table created successfully.});});// Insert data into the table.vartable=database.table('Singers');table.insert({SingerId: 10,FirstName: 'Eddie',LastName: 'Wilson'},function(err){if(!err){// Row inserted successfully.}});// Run a query as a readable object stream.database.runStream('SELECT * FROM Singers').on('error',function(err){}).on('data',function(row){// row.toJSON() = {// SingerId: 10,// FirstName: 'Eddie',// LastName: 'Wilson'// }}}).on('end',function(){// All results retrieved.});$ npm install --save @google-cloud/speech
varspeech=require('@google-cloud/speech');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).varspeechClient=speech({projectId: 'my-project',keyFilename: '/path/to/keyfile.json'});// Detect the speech in an audio file.speechClient.recognize('./audio.raw',{encoding: 'LINEAR16',sampleRateHertz: 16000},function(err,transcript){// transcript = 'how old is the Brooklyn Bridge'});// Detect the speech in an audio file stream.fs.createReadStream('./audio.raw').on('error',console.error).pipe(speechClient.createRecognizeStream({config: {encoding: 'LINEAR16',sampleRateHertz: 16000},singleUtterance: false,interimResults: false})).on('error',console.error).on('data',function(data){// data.results = "how old is the Brooklyn Bridge"});$ npm install --save @google-cloud/compute
varcompute=require('@google-cloud/compute');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).vargce=compute({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Create a new VM using the latest OS image of your choice.varzone=gce.zone('us-central1-a');varname='ubuntu-http';zone.createVM(name,{os: 'ubuntu'},function(err,vm,operation){// `operation` lets you check the status of long-running tasks.operation.on('error',function(err){}).on('running',function(metadata){}).on('complete',function(metadata){// Virtual machine created!});});$ npm install --save @google-cloud/prediction
varprediction=require('@google-cloud/prediction');// Authenticating on a per-API-basis. You don't need to do this if you auth on a// global basis (see Authentication section above).varpredictionClient=prediction({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});// Get all of the trained models in your project.predictionClient.getModels(function(err,models){if(!err){// `models` is an array of Model objects.}});// Reference an existing trained model.varmodel=predictionClient.model('my-existing-model');// Train a model.model.train('english','Hello from your friends at Google!',function(err){});// Query a model.model.query('Hello',function(err,results){if(!err){// results.winner == 'english'// results.scores == [// {// label: 'english',// score: 1// },// {// label: 'spanish',// score: 0// }// ]}});The source code for the Node.js Cloud Debugger Agent lives in a separate repo.
$ npm install --save @google-cloud/debug-agent
require('@google-cloud/debug-agent').start({allowExpressions: true});For more details on API usage, please see the Stackdriver Debug Agent Github Repository.
$ npm install --save @google-cloud/error-reporting
The module provides automatic uncaught exception handling, manual error reporting, and integration with common frameworks like express and hapi.
varerrors=require('@google-cloud/error-reporting')();errors.report(newError('Something broke!'));For more details on API usage, please see the documentation.
It does not follow the conventions you're familiar with from other parts of our library. A handwritten layer is not yet available.
The example below shows you how to instantiate the generated client. For further documentation, please browse the Monitoring .proto files on GitHub.
$ npm install --save @google-cloud/monitoring
varmonitoring=require('@google-cloud/monitoring');varmonitoringClient=monitoring.v3({projectId: 'grape-spaceship-123',keyFilename: '/path/to/keyfile.json'});The source code for the Node.js Cloud Trace Agent lives in a separate repo.
$ npm install --save @google-cloud/trace-agent
vartrace=require('@google-cloud/trace-agent').start();For more details on API usage, please see the Stackdriver Trace Agent Github Repository.
This library follows 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.
GA: Libraries defined at the GA (general availability) 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 GA libraries are addressed with the highest priority.
Please note that the auto-generated portions of the GA libraries (the ones in modules such as v1 or v2) are considered to be of Beta quality, even if the libraries that wrap them are GA.
Beta: Libraries defined at the Beta quality level are expected to be mostly stable, while we work towards their release candidate. We will address issues and requests with a higher priority.
Alpha: Libraries defined at the Alpha quality level are still a work-in-progress and are more likely to get backwards-incompatible updates.
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information on how to get started.
Apache 2.0 - See COPYING for more information.