Node.js client library for using Google APIs. Support for authorization and authentication with OAuth 2.0, API Keys and JWT tokens is included.
- Google APIs
- Getting started
- Authentication and authorization
- Usage
- License
- Contributing
- Questions/problems?
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.
Supported APIs are listed on the Google APIs Explorer.
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.
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.
This library is distributed on npm. In order to add it as a dependency, run the following command:
$ npm install googleapisThis is a very simple example. This creates a Blogger client and retrieves the details of a blog given the blog Id:
const {google} = require('googleapis');
// Each API may support multiple version. With this sample, we're getting
// v3 of the blogger API, and using an API key to authenticate.
const blogger = google.blogger({
version: 'v3',
auth: 'YOUR API KEY'
});
const params = {
blogId: 3213900
};
// get the blog details
blogger.blogs.get(params, (err, res) => {
if (err) {
console.error(err);
throw err;
}
console.log(`The blog url is ${res.data.url}`);
});Instead of using callbacks you can also use promises!
blogger.blogs.get(params)
.then(res => {
console.log(`The blog url is ${res.data.url}`);
})
.catch(error => {
console.error(error);
});Or async/await:
async function runSample() {
const res = await blogger.blogs.get(params);
console.log(`The blog url is ${res.data.url}`);
}
runSample().catch(console.error);There are a lot of samples 🤗 If you're trying to figure out how to use an API ... look there first! If there's a sample you need missing, feel free to file an issue.
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.
To learn more about the authentication client, see the Google Auth Library.
This client comes with an OAuth2 client that allows you to retrieve an access token and refreshes the token and retry the request seamlessly 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.
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:
const {google} = require('googleapis');
const oauth2Client = new google.auth.OAuth2(
YOUR_CLIENT_ID,
YOUR_CLIENT_SECRET,
YOUR_REDIRECT_URL
);
// generate a url that asks permissions for Google+ and Google Calendar scopes
const scopes = [
'https://www.googleapis.com/auth/plus.me',
'https://www.googleapis.com/auth/calendar'
];
const 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
});IMPORTANT NOTE - The refresh_token is only returned on the first authorization. More details here.
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}
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} = await oauth2Client.getToken(code)
oauth2Client.setCredentials(tokens);With the credentials set on your OAuth2 client - you're ready to go!
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:
oauth2client.on('tokens', (tokens) => {
if (tokens.refresh_token) {
// store the refresh_token in my database!
console.log(tokens.refresh_token);
}
console.log(tokens.access_token);
});To set the refresh_token at a later time, you can use the setCredentials method:
oauth2client.setCredentials({
refresh_token: `STORED_REFRESH_TOKEN`
});Once the client has a refresh token, access tokens will be acquired and refreshed automatically in the next call to the API.
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:
const {google} = require('googleapis');
const plus = google.plus({
version: 'v1',
auth: 'YOUR_API_KEY' // specify your API key here
});
async function main() {
const res = await plus.people.get({ userId: 'me' });
console.log(`Hello ${res.data.displayName}!`);
};
main().catch(console.error);To learn more about API keys, please see the documentation.
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.
async function main () {
// This method looks for the GCLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS
// environment variables.
const auth = await google.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 Id
const project = await google.auth.getProjectId();
// Fetch the list of GCE zones within a project.
const res = await compute.zones.list({ project, auth });
console.log(res.data);
}
main().catch(console.error);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:
const {google} = require('googleapis');
const oauth2Client = new google.auth.OAuth2(
YOUR_CLIENT_ID,
YOUR_CLIENT_SECRET,
YOUR_REDIRECT_URL
);
// set auth as a global default
google.options({
auth: oauth2Client
});Instead of setting the option globally, you can also set the authentication client at the service-level:
const {google} = require('googleapis');
const oauth2Client = new google.auth.OAuth2(
YOUR_CLIENT_ID,
YOUR_CLIENT_SECRET,
YOUR_REDIRECT_URL
);
const drive = google.drive({
version: 'v2',
auth: oauth2Client
});See the Options section for more information.
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:
const res = await gmail.users.watch({
userId: 'me',
requestBody: {
// Replace with `projects/${PROJECT_ID}/topics/${TOPIC_NAME}`
topicName: `projects/el-gato/topics/gmail`
}
});
console.log(res.data);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".
const drive = google.drive({
version: 'v3',
auth: oauth2Client
});
const res = await drive.files.create({
requestBody: {
name: 'Test',
mimeType: 'text/plain'
},
media: {
mimeType: 'text/plain',
body: 'Hello World'
}
});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.
const fs = require('fs');
const drive = google.drive({
version: 'v3',
auth: oauth2Client
});
async function main() {
const res = await drive.files.create({
requestBody: {
name: 'testimage.png',
mimeType: 'image/png'
},
media: {
mimeType: 'image/png',
body: fs.createReadStream('awesome.png')
}
});
console.log(res.data);
}
main().catch(console.error);For more examples of creation and modification requests with media attachments, take a look at the samples/drive/upload.js sample.
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.
A full list of supported options can be found here.
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: '[email protected]'
}
});You can also specify options when creating a service client.
const blogger = 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:
const blogger = google.blogger({
version: 'v3',
// All requests made with this service client will contain the
// blogId query parameter unless overridden in individual API calls.
params: {
blogId: 3213900
}
});
// Calls with this drive client will NOT contain the blogId query parameter.
const drive = google.drive('v3');
...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:
const {google} = require('googleapis');
const bigquery = google.bigquery('v2');
async function main() {
// This method looks for the GCLOUD_PROJECT and GOOGLE_APPLICATION_CREDENTIALS
// environment variables.
const client = await google.auth.getClient({
scopes: ['https://www.googleapis.com/auth/cloud-platform']
});
const projectId = await google.auth.getProjectId();
const request = {
projectId,
datasetId: '<YOUR_DATASET_ID>',
// This is a "request-level" option
auth: client
};
const res = await bigquery.datasets.delete(request);
console.log(res.data);
}
main().catch(console.error);You can also override axios options per request, such as url, method, and encoding.
For example:
const res = await drive.files.export({
fileId: 'asxKJod9s79', // A Google Doc
mimeType: 'application/pdf'
}, {
// Make sure we get the binary data
encoding: null
});You can use the following environment variables to proxy HTTP and HTTPS requests:
HTTP_PROXY/http_proxyHTTPS_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.
You can programatically obtain the list of supported APIs, and all available versions:
const {google} = require('googleapis');
const apis = google.getSupportedAPIs();This will return an object with the API name as object property names, and an array of version strings as the object values;
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';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 :)
This library is licensed under Apache 2.0. Full license text is available in COPYING.
We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see CONTRIBUTING.
- Ask your development related questions on Stackoverflow.
- If you've found an bug/issue, please file it on GitHub.