@readdle/googleapis

Google APIs Node.js Client

Node.js client library for using Google APIs. Support for authorization and authentication with OAuth 2.0, API Keys and JWT (Service Tokens) is included.

Library maintenance

This client library is supported but in maintenance mode only. We are fixing necessary bugs and adding essential features to ensure this library continues to meet your needs for accessing Google APIs. Non-critical issues will be closed. Any issue may be reopened if it is causing ongoing problems.

Table of Contents

• Alpha
• Migrating to version 2.x of this library
• Supported APIs
• Questions/problems?
• Working with Google Cloud Platform APIs?
• Installation
• Usage
  • Create a service client
  • Authorizing and authenticating
    • OAuth2 client
      • Generating an authentication URL
      • Retrieve authorization code
      • Retrieve access token
      • Setting global or service-level auth
      • Making authenticated requests
      • Manually refreshing access token
    • Using API keys
    • Using JWT (Service Tokens)
    • Choosing the correct credential type automatically
  • Specifying request body
  • Media uploads
    • Example: Upload a plain text file to Google Drive
    • Example: Upload an image to Google Drive from a readable stream
  • Exposing request object
  • Options
    • Available options
    • Global options
      • Example: Specifying a default proxy and auth to be used for each request
      • Example: Specifying global request parameters
    • Service-client options
      • Example: Specifying a default auth option (API key or OAuth2 client)
      • Example: Specifying default service client query parameters
    • Request-level options
• License
• Contributing

Alpha

This library is in Alpha. We will make an effort to support the library, but we reserve the right to make incompatible changes when necessary.

Migrating to version 2.x of this library

If you've used this library before 1.x, see our Migration Guide to learn about migrating your code from 0.x.x to 1.x. It's pretty easy :)

If your code already works with a 1.x version of this library, no work is required to move to 2.x. However, note that return data of getToken has become an array. Furthermore, it is recommended that you update any direct links in your code, as explained in the Migration Guide.

Supported APIs

The full list of supported APIs can be found here. The API endpoints are automatically generated, so if the API is not in the list, it is currently not supported by this API client library.

Questions/problems?

• Ask your development related questions on
• If you've found an bug/issue, please file it on GitHub.

Working with Google Cloud Platform APIs?

If you're working with Google Cloud Platform APIs such as Datastore, Cloud Storage or Pub/Sub, consider using the google-cloud package, an idiomatic Node.js client for Google Cloud Platform services.

You can find the list of Google Cloud Platform APIs supported by google-cloud in the google-cloud docs.

Installation

This library is distributed on npm. In order to add it as a dependency, run the following command:

$ npm install googleapis --save

Usage

Example Creates a URL Shortener client and retrieves the long url of the given short url:

var google = require('googleapis');
var urlshortener = google.urlshortener('v1');

var params = {
  shortUrl: 'http://goo.gl/xKbRu3'
};

// get the long url of a shortened url
urlshortener.url.get(params, function (err, response) {
  if (err) {
    console.log('Encountered error', err);
  } else {
    console.log('Long url is', response.longUrl);
  }
});

Example Updates an email message's labels, using the resource parameter to specify the request body.

gmail.users.messages.modify({
  id: Number,
  resource: {
    addLabelIds: Array,
    removeLabelIds: Array
  },
  userId: 'me',
}, (err, response) => {
  // ...
});

Create a service client

To interact with the various Google APIs you need to create a service client for that particular API. These are immutable objects you use to make API calls.

Example: Creating a urlshortener client with version v1 of the API.

var google = require('googleapis');
var urlshortener = google.urlshortener('v1');

Supported APIs are listed on the Google APIs Explorer.

Authorizing and authenticating

OAuth2 client

This client comes with an OAuth2 client that allows you to retrieve an access token and refreshes the token and retry the request seamlessly if you also provide an expiry_date and the token is expired. The basics of Google's OAuth2 implementation is explained on Google Authorization and Authentication documentation.

In the following examples, you may need a CLIENT_ID, CLIENT_SECRET and REDIRECT_URL. You can find these pieces of information by going to the Developer Console, clicking your project --> APIs & auth --> credentials.

For more information about OAuth2 and how it works, see here.

A complete sample application that authorizes and authenticates with the OAuth2 client is available at samples/oauth2.js.

Generating an authentication URL

To ask for permissions from a user to retrieve an access token, you redirect them to a consent page. To create a consent page URL:

var google = require('googleapis');
var OAuth2 = google.auth.OAuth2;

var oauth2Client = new OAuth2(
  YOUR_CLIENT_ID,
  YOUR_CLIENT_SECRET,
  YOUR_REDIRECT_URL
);

// generate a url that asks permissions for Google+ and Google Calendar scopes
var scopes = [
  'https://www.googleapis.com/auth/plus.me',
  'https://www.googleapis.com/auth/calendar'
];

var url = oauth2Client.generateAuthUrl({
  // 'online' (default) or 'offline' (gets refresh_token)
  access_type: 'offline',

  // If you only need one scope you can pass it as a string
  scope: scopes,

  // Optional property that passes state parameters to redirect URI
  // state: 'foo'
});

IMPORTANT NOTE

refresh_token is only returned on the first authorization. More details here

Retrieve authorization code

Once a user has given permissions on the consent page, Google will redirect the page to the redirect URL you have provided with a code query parameter.

GET /oauthcallback?code={authorizationCode}

Retrieve access token

With the code returned, you can ask for an access token as shown below:

oauth2Client.getToken(code, function (err, tokens) {
  // Now tokens contains an access_token and an optional refresh_token. Save them.
  if (!err) {
    oauth2Client.setCredentials(tokens);
  }
});

Setting global or service-level auth

You can set the auth as a global or service-level option so you don't need to specify it every request.

Example: Setting a global auth option.

var google = require('googleapis');
var OAuth2 = google.auth.OAuth2;
var oauth2Client = new OAuth2(
  YOUR_CLIENT_ID,
  YOUR_CLIENT_SECRET,
  YOUR_REDIRECT_URL
);

// set auth as a global default
google.options({
  auth: oauth2Client
});

Example: Setting a service-level auth option.

var google = require('googleapis');
var OAuth2 = google.auth.OAuth2;
var oauth2Client = new OAuth2(
  YOUR_CLIENT_ID,
  YOUR_CLIENT_SECRET,
  YOUR_REDIRECT_URL
);

var drive = google.drive({
  version: 'v2',
  auth: oauth2Client
});

See the Options section for more information.

Making authenticated requests

You can start using OAuth2 to authorize and authenticate your requests to Google APIs with the retrieved tokens. If you provide a refresh_token and expiry_date (milliseconds since the Unix Epoch) and the access_token has expired, the access_token will be automatically refreshed and the request is replayed (with the except of requests with a media body, as we cannot reliably restart your media stream). Set expiry_date to true to force a refresh.

The following sample retrieves Google+ profile of the authenticated user.

var google = require('googleapis');
var plus = google.plus('v1');
var OAuth2 = google.auth.OAuth2;
var oauth2Client = new OAuth2(
  YOUR_CLIENT_ID,
  YOUR_CLIENT_SECRET,
  YOUR_REDIRECT_URL
);

// Retrieve tokens via token exchange explained above or set them:
oauth2Client.setCredentials({
  access_token: 'ACCESS TOKEN HERE',
  refresh_token: 'REFRESH TOKEN HERE'
  // Optional, provide an expiry_date (milliseconds since the Unix Epoch)
  // expiry_date: (new Date()).getTime() + (1000 * 60 * 60 * 24 * 7)
});

plus.people.get({
  userId: 'me',
  auth: oauth2Client
}, function (err, response) {
  // handle err and response
});

Manually refreshing access token

If you need to manually refresh the access_token associated with your OAuth2 client, make sure you have a refresh_token set in your credentials first and then call:

oauth2Client.refreshAccessToken(function(err, tokens) {
  // your access_token is now refreshed and stored in oauth2Client
  // store these new tokens in a safe place (e.g. database)
});

Using API keys

You may need to send an API key with the request you are going to make. The following uses an API key to make a request to the Google+ API service to retrieve a person's profile given a userId:

var google = require('googleapis');
var plus = google.plus('v1');

var API_KEY = 'ABC123'; // specify your API key here

plus.people.get({
  auth: API_KEY,
  userId: '+google'
}, function (err, user) {
  console.log('Result: ' + (err ? err.message : user.displayName));
});

Alternatively, you can specify the key parameter and it will get used:

plus.people.get({
  key: API_KEY,
  userId: '+google'
}, function (err, user) {
  console.log('Result: ' + (err ? err.message : user.displayName));
});

To learn more about API keys, please see the documentation.

Using JWT (Service Tokens)

The Google Developers Console provides .json file that you can use to configure a JWT auth client and authenticate your requests, for example when using a service account.

var google = require('googleapis');
var drive = google.drive('v2');

var key = require('/path/to/key.json');
var jwtClient = new google.auth.JWT(
  key.client_email,
  null,
  key.private_key,
  ['https://www.googleapis.com/auth/drive'], // an array of auth scopes
  null
);

jwtClient.authorize(function (err, tokens) {
  if (err) {
    console.log(err);
    return;
  }

  // Make an authorized request to list Drive files.
  drive.files.list({
    auth: jwtClient
  }, function (err, resp) {
    // handle err and response
  });
});

The parameters for the JWT auth client including how to use it with a .pem file are explained in samples/jwt.js.

Choosing the correct credential type automatically

Rather than manually creating an OAuth2 client, JWT client, or Compute client, the auth library can create the correct credential type for you, depending upon the environment your code is running under.

For example, a JWT auth client will be created when your code is running on your local developer machine, and a Compute client will be created when the same code is running on a configured instance of Google Compute Engine.

The code below shows how to retrieve a default credential type, depending upon the runtime environment. The createScopedRequired must be called to determine when you need to pass in the scopes manually, and when they have been set for you automatically based on the configured runtime environment.

// This method looks for the GCLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS
// environment variables.
google.auth.getApplicationDefault(function (err, authClient, projectId) {
  if (err) {
    throw err;
  }

  // The createScopedRequired method returns true when running on GAE or a local developer
  // machine. In that case, the desired scopes must be passed in manually. When the code is
  // running in GCE or a Managed VM, the scopes are pulled from the GCE metadata server.
  // See https://cloud.google.com/compute/docs/authentication for more information.
  if (authClient.createScopedRequired && authClient.createScopedRequired()) {
    // Scopes can be specified either as an array or as a single, space-delimited string.
    authClient = authClient.createScoped([
      'https://www.googleapis.com/auth/compute'
    ]);
  }

  // Fetch the list of GCE zones within a project.
  // NOTE: You must fill in your valid project ID before running this sample!
  var compute = google.compute({
    version: 'v1',
    auth: authClient
  });
  var projectId = 'YOUR_PROJECT_ID';

  compute.zones.list({
    project: projectId,
    auth: authClient
  }, function (err, result) {
    console.log(err, result);
  });
});

Specifying request body

The body of the request is specified in the resource parameter object of the request. The resource/body is specified as a JavaScript object with key/value pairs. See the example in the next section below for an example on how it is specified.

Media uploads

This client supports multipart media uploads. The resource parameters are specified in the resource parameter object, and the media itself is specified in the media.body parameter with mime-type specified in media.mimeType.

Example: Upload a plain text file to Google Drive

This example uploads a plain text file to Google Drive with the title "Test" and contents "Hello World".

var drive = google.drive({ version: 'v3', auth: oauth2Client });

drive.files.create({
  resource: {
    name: 'Test',
    mimeType: 'text/plain'
  },
  media: {
    mimeType: 'text/plain',
    body: 'Hello World'
  }
}, callback);

You can also upload media by specifying media.body as a Readable stream. This can allow you to upload very large files that cannot fit into memory.

Note: Your readable stream may be unstable. Use at your own risk.

Example: Upload an image to Google Drive from a readable stream

var fs = require('fs');
var drive = google.drive({ version: 'v3', auth: oauth2Client });

drive.files.create({
  resource: {
    name: 'testimage.png',
    mimeType: 'image/png'
  },
  media: {
    mimeType: 'image/png',
    body: fs.createReadStream('awesome.png') // read streams are awesome!
  }
}, callback);

For more examples of creation and modification requests with media attachments, take a look at the samples/mediaupload.js sample.

Exposing request object

Every request to the API returns a request object, allowing you to track the request's progress or general information about the request.

var req = drive.files.create(/* ... */);
console.log(req.uri.href); // print out the request's URL.

Options

For more fine-tuned control over how your API calls are made, we provide you with the ability to specify additional options that can be applied directly to the mikeal/request object used in this library to make network calls to the API.

You may specify additional options either in the global google object or on a service client basis.

Available options

The options you specify are attached to the request object so whatever request supports, this library supports. You may also specify global or per-service request parameters that will be attached to all API calls you make.

A full list of supported options can be found here.

Global options

Example: Specifying a default proxy and auth to be used for each request

var google = require('googleapis');
google.options({ proxy: 'http://proxy.example.com', auth: auth });

// All requests made with this object will use these settings unless overridden.

Example: Specifying global request parameters

var google = require('googleapis');
google.options({ params: { quotaUser: '[e-mail]' } });

// All requests from all services will contain the above query parameter
// unless overridden either in a service client or in individual API calls.

Service-client options

You can also specify options when creating a service client.

Example: Specifying a default auth option (API key or OAuth2 client)

var auth = 'API KEY'; // or you could use oauth2Client
var urlshortener = google.urlshortener({ version: 'v1', auth: auth });

// All requests made with this object will use the specified auth.

By doing this, every API call made with this service client will use 'API KEY' to authenticate.

Note: Created clients are immutable so you must create a new one if you want to specify different options.

Example: Specifying default service client query parameters

var urlshortener = google.urlshortener({
  version: 'v1',
  params: { quotaUser: '[e-mail]' }
});
// All requests made with this service client will contain the
// quotaUser query parameter unless overridden in individual API calls.

// Calls with this drive client will NOT contain the quotaUser query parameter.
var drive = google.drive('v2');

Request-level options

You can specify an auth object to be used per request. Each request also inherits the options specified at the service level and global level.

For example:

var google = require('googleapis');
var bigquery = google.bigquery('v2');

// This method looks for the GCLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS
// environment variables.
google.auth.getApplicationDefault(function (err, authClient, projectId) {
  if (err) {
    console.log('Authentication failed because of ', err);
    return;
  }
  if (authClient.createScopedRequired && authClient.createScopedRequired()) {
    var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
    authClient = authClient.createScoped(scopes);
  }

  var request = {
    projectId: projectId,
    datasetId: '<YOUR_DATASET_ID>',

    // This is a "request-level" option
    auth: authClient
  };

  bigquery.datasets.delete(request, function (err, result) {
    if (err) {
      console.log(err);
    } else {
      console.log(result);
    }
  });
});

You can also override request options per request, such as url, method, and encoding.

For example:

drive.files.export({
  fileId: 'asxKJod9s79', // A Google Doc
  mimeType: 'application/pdf'
}, {
  encoding: null // Make sure we get the binary data
}, function (err, buffer) {
  // ...
});

License

This library is licensed under Apache 2.0. Full license text is available in COPYING.

Contributing

See CONTRIBUTING.