googleapis/google-api-nodejs-client 1.0.0

on GitHub

Many changes and improvements have been made to the google-api-nodejs-client
library to bring it to 1.x. If you are starting a new project or haven't used
this library before version 1.x, see the README to get started
as you won't need to migrate anything.

Discovery

In 0.x.x the library would "discover" APIs on the fly, introducing
additional network calls and instability. That has been fixed in 1.0.

To get the drive client in 0.x.x required this:

var google = require('googleapis');
google.discover('drive', 'v2').execute(function(err, client) {
  if(err) {
    // handle error
  } else {
    // client.drive.files.insert...
  }
});

In 1.0 the same thing can be accomplished like this:

var google = require('googleapis');
var drive = google.drive('v2'); // no network call! :)
// drive.files.insert...

All APIs are immediately accessible without requiring discovery.

Moved resource

We moved resource object from the second parameter to the resource property
in the first parameter object:

In 0.x.x, a resource was specified this way:

var resourceObj = { title: 'updated title' };
client.drive.files.update({ fileId: 'abc' }, resourceObj).execute();

New way in 1.0:

var resourceObj = { title: 'updated title' };
drive.files.update({ fileId: 'abc', resource: resourceObj })

Removed .execute everywhere

Now callbacks are specified in the second parameter and .execute is always
implied.

The 0.x.x way to specify a callback:

client.drive.files.get({ fileId: 'abc' }).execute(function(err, resp) {
  // handle err, resp
});

How to specify callback in 1.0 (in the second parameter):

drive.files.get({ fileId: 'abc' }, function(err, resp) {
  // handle err, resp
});

Note: Prior to 1.0, the library would not execute your requests until you
specifically called .execute. Because this was removed in 1.0, all requests
now immediately execute, even if a callback is not specified.

Media uploads

Media data is now specified in a media parameter instead of in withMedia().

The old 0.x.x way of uploading media:

client.drive.files.insert({ title: 'Test', mimeType: 'text/plain' })
  .withMedia('text/plain', 'Hello World')
  .execute(callback);

The fancy new way in 1.0 using resource and media parameters:

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

Bonus: Media uploads now also support readable streams. Simply specify media as a
readable stream like this:

var fs = require('fs');

drive.files.insert({
  resource: {
    title: 'Test',
    mimeType: 'text/plain'
  },
  media: {
    mimeType: 'text/plain',
    body: fs.createReadStream('hello.txt')
  }
}, callback);

Authentication

In 1.0 the ability to auth with .withAuthClient() and
.withApiKey(API_KEY) is removed. Now just simply specify your OAuth2
client or API key in the auth parameter of any API call.
You can additionally specify it in global or service specific options to set
it as a default. See here for more information.

In 0.x.x an OAuth2 client was specified like this:

var googleapis = require('googleapis');
var OAuth2Client = googleapis.OAuth2Client;

var oauth2Client = new OAuth2Client(/* .. */);

// ... discover plus api and get client object here ...

client
  .plus.people.get({ userId: 'me' })
  .withAuthClient(oauth2Client)
  .execute(callback);

In 1.0, OAuth2Client is now available at google.auth.OAuth2 and now you can
just put your oauth2Client right in the auth parameter. It's as easy as:

var google = require('googleapis');
var OAuth2 = google.auth.OAuth2; // changed from google.OAuth2Client
var plus = google.plus('v1');

var oauth2Client = new OAuth2(/* .. */); // initialized the same way
plus.people.get({ userId: 'me', auth: oauth2Client }, callback);

You can also specify an API key instead:

plus.people.get({ userId: 'me', auth: 'api key here' }, callback);

Batch Requests

Batch requests were experimental before 1.0. We have removed support for batch
requests in 1.0 due to their unpopularity and instability.