Google Apps Script quickstart

Stay organized with collections Save and categorize content based on your preferences.

Quickstarts explain how to set up and run an app that calls a Google Workspace API.

Google Workspace quickstarts use the API client libraries to handle some details of the authentication and authorization flow. We recommend that you use the client libraries for your own apps. Before you can run the sample app, each quickstart requires that you turn on authentication and authorization. If you're unfamiliar with authentication and authorization for Google Workspace APIs, read the Authentication and authorization overview.

Create a Google Apps Script that makes requests to the Google Sheets API.

Objectives

  • Create the script.
  • Enable the Google Sheets API.
  • Run the sample.

Prerequisites

  • A Google Account
  • Access to Google Drive

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:

sheets/quickstart/quickstart.gs
/**
 * Creates a Sheets API service object and prints the names and majors of
 * students in a sample spreadsheet:
 * https://docs.google.com/spreadsheets/d/1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms/edit
 * @see https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get
 */
function logNamesAndMajors() {
  const spreadsheetId = '1BxiMVs0XRA5nFMdKvBdBZjgmUUqptlbs74OgvE2upms';
  const rangeName = 'Class Data!A2:E';
  try {
    // Get the values from the spreadsheet using spreadsheetId and range.
    const values = Sheets.Spreadsheets.Values.get(spreadsheetId, rangeName).values;
    //  Print the values from spreadsheet if values are available.
    if (!values) {
      Logger.log('No data found.');
      return;
    }
    Logger.log('Name, Major:');
    for (const row in values) {
      // Print columns A and E, which correspond to indices 0 and 4.
      Logger.log(' - %s, %s', values[row][0], values[row][4]);
    }
  } catch (err) {
    // TODO (developer) - Handle Values.get() exception from Sheet API
    Logger.log(err.message);
  }
}

  1. Click Save .
  2. Click Untitled project, type Quickstart, and click Rename.

Enable the Google Sheets API

  1. Open the Apps Script project.
  2. Click Editor .
  3. Next to Services, click Add a service .
  4. Select Google Sheets API and click Add.

Run the sample

In the Apps Script editor, click Run.

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

  1. Click Review permissions.
  2. Choose an account.
  3. Click Allow.

The script's execution log appears at the bottom of the window.

Next steps