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 client libraries: single purpose idiomatic Node.js clients for Google Cloud Platform services.

Support and maintenance

These client libraries are official supported by Google. However, these libraries are considered complete and are in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features. For Google Cloud Platform APIs, we recommend using google-cloud-node which is under active development.

This library supports the maintenance LTS, active LTS, and current release of node.js. See the node.js release schedule for more information.

Getting started

Installation

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

$ npm install googleapis

First example

This is a very simple example. This creates a Blogger client and retrieves the details of a blog given the blog Id:

API Reference

Authentication and authorization

The are three primary ways to authenticate to Google APIs. Some service support all authentication methods, other may only support one or two.

OAuth2 - This allows you to make API calls on behalf of a given user. In this model, the user visits your application, signs in with their Google account, and provides your application with authorization against a set of scopes. Learn more.

Service <--> Service - In this model, your application talks directly to Google APIs using a Service Account. It's useful when you have a backend application that will talk directly to Google APIs from the backend. Learn more.

API Key - With an API key, you can access your service from a client or the server. Typically less secure, this is only available on a small subset of services with limited scopes. Learn more.

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.

IMPORTANT NOTE - The 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:

// This will provide an object with the access_token and refresh_token.// Save these somewhere safe so they can be used at a later time.const {tokens} =awaitoauth2Client.getToken(code)
oauth2Client.setCredentials(tokens);

With the credentials set on your OAuth2 client - you're ready to go!

Handling refresh tokens

Access tokens expire. This library will automatically use a refresh token to obtain a new access token if it is about to expire. An easy way to make sure you always store the most recent tokens is to use the tokens event:

Service to Service Authentication

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.

asyncfunctionmain () {
// This method looks for the GCLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS// environment variables.constauth=awaitgoogle.auth.getClient({
// Scopes can be specified either as an array or as a single, space-delimited string.
scopes: ['https://www.googleapis.com/auth/compute']
});
// obtain the current project Idconstproject=awaitgoogle.auth.getProjectId();
// Fetch the list of GCE zones within a project.constres=awaitcompute.zones.list({ project, auth });
console.log(res.data);
}
main().catch(console.error);

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. For example, you can set auth as a global option:

Usage

Specifying request body

The body of the request is specified in the requestBody parameter object of the request. The body is specified as a JavaScript object with key/value pairs. For example, this sample creates a watcher that posts notifications to a Google Cloud Pub/Sub topic when emails are sent to a gmail account:

Media uploads

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

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

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

Request 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 'axios' 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. The options you specify are attached to the axios object so whatever axios supports, this library supports. You may also specify global or per-service request parameters that will be attached to all API calls you make.

Global options

You can choose default options that will be sent with each request. These options will be used for every service instantiated by the google client. In this example, the timeout property of AxiosRequestConfig will be set for every request:

const {google} =require('googleapis');
google.options({
// All requests made with this object will use these settings unless overridden.
timeout:1000,
auth: auth
});

You can also modify the parameters sent with each request:

const {google} =require('googleapis');
google.options({
// All requests from all services will contain the above query parameter// unless overridden either in a service client or in individual API calls.
params: {
quotaUser:'user123@example.com'
}
});

Service-client options

You can also specify options when creating a service client.

constblogger=google.blogger({
version:'v3',
// All requests made with this object will use the specified auth.
auth:'API KEY';
});

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.

Similar to the examples above, you can also modify the parameters used for every call of a given service:

Using a Proxy

You can use the following environment variables to proxy HTTP and HTTPS requests:

HTTP_PROXY / http_proxy

HTTPS_PROXY / https_proxy

When HTTP_PROXY / http_proxy are set, they will be used to proxy non-SSL requests that do not have an explicit proxy configuration option present. Similarly, HTTPS_PROXY / https_proxy will be respected for SSL requests that do not have an explicit proxy configuration option. It is valid to define a proxy in one of the environment variables, but then override it for a specific request, using the proxy configuration option.

Getting Supported APIs

You can programatically obtain the list of supported APIs, and all available versions:

This will return an object with the API name as object property names, and an array of version strings as the object values;

TypeScript

This library is written in TypeScript, and provides types out of the box. All classes and interfaces generated for each API are exported under the ${apiName}_${version} namespace. For example, the Drive v3 API types are are all available from the drive_v3 namespace:

import { drive_v3 } from'googleapis';

Release Notes & Breaking Changes

You can find a detailed list of breaking changes and new features in our Release Notes. If you've used this library before 25.x, see our Release Notes to learn about migrating your code from 24.x.x to 25.x.x. It's pretty easy :)

License

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

Contributing

We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see CONTRIBUTING.