Complete the steps described in the rest of this page to create a simple Node.js
command-line application that makes requests to the Google Apps Script API.
Prerequisites
To run this quickstart, you need the following prerequisites:
const fs = require('fs');
const readline = require('readline');
const {google} = require('googleapis');
// If modifying these scopes, delete token.json.
const SCOPES = ['https://www.googleapis.com/auth/script.projects'];
// The file token.json stores the user's access and refresh tokens, and is
// created automatically when the authorization flow completes for the first
// time.
const TOKEN_PATH = 'token.json';
// Load client secrets from a local file.
fs.readFile('credentials.json', (err, content) => {
if (err) return console.log('Error loading client secret file:', err);
// Authorize a client with credentials, then call the Google Apps Script API.
authorize(JSON.parse(content), callAppsScript);
});
/**
* Create an OAuth2 client with the given credentials, and then execute the
* given callback function.
* @param {Object} credentials The authorization client credentials.
* @param {function} callback The callback to call with the authorized client.
*/
function authorize(credentials, callback) {
const {client_secret, client_id, redirect_uris} = credentials.installed;
const oAuth2Client = new google.auth.OAuth2(
client_id, client_secret, redirect_uris[0]);
// Check if we have previously stored a token.
fs.readFile(TOKEN_PATH, (err, token) => {
if (err) return getAccessToken(oAuth2Client, callback);
oAuth2Client.setCredentials(JSON.parse(token));
callback(oAuth2Client);
});
}
/**
* Get and store new token after prompting for user authorization, and then
* execute the given callback with the authorized OAuth2 client.
* @param {google.auth.OAuth2} oAuth2Client The OAuth2 client to get token for.
* @param {getEventsCallback} callback The callback for the authorized client.
*/
function getAccessToken(oAuth2Client, callback) {
const authUrl = oAuth2Client.generateAuthUrl({
access_type: 'offline',
scope: SCOPES,
});
console.log('Authorize this app by visiting this url:', authUrl);
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
});
rl.question('Enter the code from that page here: ', (code) => {
rl.close();
oAuth2Client.getToken(code, (err, token) => {
if (err) return console.error('Error retrieving access token', err);
oAuth2Client.setCredentials(token);
// Store the token to disk for later program executions
fs.writeFile(TOKEN_PATH, JSON.stringify(token), (err) => {
if (err) return console.error(err);
console.log('Token stored to', TOKEN_PATH);
});
callback(oAuth2Client);
});
});
}
/**
* Creates a new script project, upload a file, and log the script's URL.
* @param {google.auth.OAuth2} auth An authorized OAuth2 client.
*/
function callAppsScript(auth) {
const script = google.script({version: 'v1', auth});
script.projects.create({
resource: {
title: 'My Script',
},
}, (err, res) => {
if (err) return console.log(`The API create method returned an error: ${err}`);
script.projects.updateContent({
scriptId: res.data.scriptId,
auth,
resource: {
files: [{
name: 'hello',
type: 'SERVER_JS',
source: 'function helloWorld() {\n console.log("Hello, world!");\n}',
}, {
name: 'appsscript',
type: 'JSON',
source: '{\"timeZone\":\"America/New_York\",\"exceptionLogging\":' +
'\"CLOUD\"}',
}],
},
}, {}, (err, res) => {
if (err) return console.log(`The API updateContent method returned an error: ${err}`);
console.log(`https://script.google.com/d/${res.data.scriptId}/edit`);
});
});
}
Step 3: Run the sample
Run the sample using the following command:
node .
The first time you run the sample, it prompts you to authorize access:
Browse to the provided URL in your web browser. If you are not already signed in to your Google account, you are
prompted to sign in. If you are signed in to multiple Google accounts, you
are asked to select one account to use for the authorization.
If you don't have a browser on the machine running the code, and you've
selected "Desktop app" when creating the OAuth client, you can browse to the
URL provided on another machine, and then copy the authorization code back to
the running sample.
Click the Accept button.
Copy the code you're given, paste it into the command-line prompt, and press
Enter.
Notes
Authorization information is stored on the file system, so subsequent
executions don't prompt for authorization.
The authorization flow in this example is designed for a command line
application. For information on how to perform authorization in other contexts,
see the
Authorizing and Authenticating.
section of the library's README.
Troubleshooting
This section describes some common issues that you may encounter while
attempting to run this quickstart and suggests possible solutions.
This app isn't verified
If the OAuth consent screen displays the warning "This app isn't verified," your
app is requesting scopes that provide access to sensitive user data. If your
application uses sensitive scopes, your app must go through the
verification process
to remove that warning and other limitations. During the development phase, you
can continue past this warning by selecting Advanced > Go to {Project Name}
(unsafe).
File not found error for credentials.json
When running the sample, you might receive a file not found or no such file error regarding credentials.json.
This error occurs when you have not authorized the desktop application credentials
as detailed in the Prerequisites section above. To learn how to create credentials
for a desktop application, go to Create credentials.
Once you create the credentials, make sure the downloaded JSON file is saved as
credentials.json. Then move the file to your working directory with the rest of the
sample quickstart code.
