Google Apps Script Quickstart

Complete the steps described in the rest of this page to create a simple Google Apps Script that makes requests to the Gmail API.

Prerequisites

To run this quickstart, you need the following prerequisites:

A Google account with Gmail enabled

Access to Google Drive

Step 1: Create the script

1. Create a new script by going to script.google.com/create.
2. Replace the contents of the script editor with the following code:

gmail/quickstart/quickstart.gs

View on GitHub

/**
 * Lists the labels in the user's account.
 */
function listLabels() {
  var response = Gmail.Users.Labels.list('me');
  if (response.labels.length == 0) {
    Logger.log('No labels found.');
  } else {
    Logger.log('Labels:');
    for (var i = 0; i < response.labels.length; i++) {
      var label = response.labels[i];
      Logger.log('- %s', label.name);
    }
  }
}

3. Click File > Save, name your project “Quickstart”, and click OK.

Step 2: Turn on the Gmail API

Enable the Gmail API advanced service in your script.

Step 3: Run the sample

In the Apps Script editor, click Run > listLabels.

The first time you run the sample, it will prompt you to authorize access:

1. Click the Continue button.
2. Click the Accept button.

To view the script's output, click View > Logs.

It worked!

Great! Check out the further reading section below to learn more.

I got an error

Bummer. Check out our troubleshooting section below for some common errors and solutions. Report the issue on GitHub and we'll work to fix this quickstart.

Further reading

• Google Apps Script Advanced Services documentation
• Gmail API reference documentation

Troubleshooting

This section describes some common issues that you may encounter while attempting to run this quickstart and suggests possible solutions.

ReferenceError: "[API NAME]" is not defined

This error occurs when the API hasn't been toggled on in the Apps Script code editor. Revisit Step 2.b and ensure the corresponding toggle is set to on.

This app isn't verified.

The OAuth consent screen that is presented to the user may show the warning "This app isn't verified" if it is requesting scopes that provide access to sensitive user data. These applications must eventually go through the verification process to remove that warning and other limitations. During the development phase you can continue past this warning by clicking Advanced > Go to {Project Name} (unsafe).