Node.js idiomatic client for Google Cloud Platform services.
This client supports the following Google Cloud Platform services:
- Google BigQuery
- Google Cloud Datastore
- Google Cloud Storage
- Google Cloud Pub/Sub (Beta)
- Google Cloud Search (Alpha)
If you need support for other Google APIs, check out the Google Node.js API Client library.
$ npm install --save gcloud- gcloud-node-todos - A TodoMVC backend using gcloud-node and Datastore.
- gitnpm - Easily lookup an npm package's GitHub repo using gcloud-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.
With gcloud-node it's incredibly easy to get authorized 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 Google Cloud services.
If you are running this client on Google Compute Engine, we handle authorization 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.
// Authorizing on a global basis.
var projectId = process.env.GCLOUD_PROJECT_ID; // E.g. 'grape-spaceship-123'
var gcloud = require('gcloud')({
projectId: projectId
});
// ...you're good to go! See the next section to get started using the APIs.If you are not running this client on Google Compute Engine, 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):
- Google Cloud Datastore API
- Google Cloud Storage
- Google Cloud Storage JSON API
- Navigate to APIs & auth > Credentials and then:
- If you want to use a new service account, click on Create new Client ID and select Service account. After the account is created, you will be prompted to download the JSON key file that the library uses to authorize your requests.
- If you want to generate a new key for an existing service account, click on Generate new JSON key and download the JSON key file.
// Authorizing on a global basis.
var projectId = process.env.GCLOUD_PROJECT_ID; // E.g. 'grape-spaceship-123'
var gcloud = require('gcloud')({
projectId: projectId,
keyFilename: '/path/to/keyfile.json'
});
// ...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.
var gcloud = require('gcloud');
// Authorizing on a per-API-basis. You don't need to do this if you auth on a
// global basis (see Authorization section above).
var bigquery = gcloud.bigquery({
projectId: 'my-project',
keyFilename: '/path/to/keyfile.json'
});
// Access an existing dataset.
var schoolsDataset = bigquery.dataset('schools');
// Import data into a dataset.
schoolsDataset.import('/local/file.json', function(err, job) {});
// Get results from a query job.
var job = bigquery.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) {});Follow the activation instructions to use the Google Cloud Datastore API with your project.
var gcloud = require('gcloud');
// Authorizing on a per-API-basis. You don't need to do this if you auth on a
// global basis (see Authorization section above).
var dataset = gcloud.datastore.dataset({
projectId: 'my-project',
keyFilename: '/path/to/keyfile.json'
});
dataset.get(dataset.key(['Product', 'Computer']), function(err, entity) {
console.log(err || entity);
});
// Save data to your dataset.
var blogPostData = {
title: 'How to make the perfect homemade pasta',
author: 'Andrew Chilton',
isDraft: true
};
var blogPostKey = dataset.key('BlogPost');
dataset.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:
dataset.save({
key: blogPostKey,
data: {
isDraft: false
}
}, function(err) {
if (!err) {
// The blog post is now published!
}
});
});var fs = require('fs');
var gcloud = require('gcloud');
// Authorizing on a per-API-basis. You don't need to do this if you auth on a
// global basis (see Authorization section above).
var gcs = gcloud.storage({
keyFilename: '/path/to/keyfile.json',
projectId: 'my-project'
});
// Create a new bucket.
gcs.createBucket('my-new-bucket', function(err, bucket) {
if (!err) {
// "my-new-bucket" was successfully created.
}
});
// Reference an existing bucket.
var bucket = gcs.bucket('my-existing-bucket');
// Upload a local file to a new file to be created in your bucket.
var fileStream = fs.createReadStream('/local/file.txt');
fileStream.pipe(bucket.file('file.txt').createWriteStream());
// Download a remote file to a new local file.
var fileStream = bucket.file('photo.jpg').createReadStream();
fileStream.pipe(fs.createWriteStream('/local/photo.jpg'));This is a Beta release of Google Cloud Pub/Sub. This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes.
var gcloud = require('gcloud');
// Authorizing on a per-API-basis. You don't need to do this if you
// auth on a global basis (see Authorization section above).
var pubsub = gcloud.pubsub({
projectId: 'my-project',
keyFilename: '/path/to/keyfile.json'
});
// Reference a topic.
var topic = pubsub.topic('my-topic');
// Publish a message to the topic.
// The topic will be created if it doesn't exist.
topic.publish({
data: 'New message!'
}, function(err) {});
// Subscribe to the topic.
topic.subscribe('new-subscription', function(err, subscription) {
// Register listeners to start pulling for messages.
function onError(err) {}
function onMessage(message) {}
subscription.on('error', onError);
subscription.on('message', onMessage);
// Remove listeners to stop pulling for messages.
subscription.removeListener('message', onMessage);
subscription.removeListener('error', onError);
});This is an Alpha release of Google Cloud Search. This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes.
var gcloud = require('gcloud');
// Authorizing on a per-API-basis. You don't need to do this if you auth on a
// global basis (see Authorization section above).
var search = gcloud.search({
keyFilename: '/path/to/keyfile.json',
projectId: 'my-project'
});
// Create a document in a new index.
var index = search.index('memberData');
var document = index.document('member-id-34211');
document.addField('preferredContactForm').addTextValue('phone');
index.createDocument(document, function(err, document) {
console.log(err || document);
});
// Search an index and get the results as a readable object stream.
var index = search.index('memberData');
index.search('preferredContactForm:phone')
.on('error', console.error)
.on('data', function(document) {
// document.id = 'member-id-34211';
})
.on('end', function() {
// All results consumed.
});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.