Google Apps Script quickstart

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 Admin SDK API.

Objectives

  • Create the script.
  • Enable the Admin SDK API.
  • Run the sample.

Prerequisites

  • A Google Workspace domain with API access enabled.
  • A Google Account in that domain with administrator privileges.

  • 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:

adminSDK/directory/quickstart.gs
/**
 * Lists users in a G Suite domain.
 * @see https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list
 */
function listUsers() {
  const optionalArgs = {
    customer: 'my_customer',
    maxResults: 10,
    orderBy: 'email'
  };
  try {
    const response = AdminDirectory.Users.list(optionalArgs);
    const users = response.users;
    if (!users || users.length === 0) {
      Logger.log('No users found.');
      return;
    }
    // Print the list of user's full name and email
    Logger.log('Users:');
    for (const user of users) {
      Logger.log('%s (%s)', user.primaryEmail, user.name.fullName);
    }
  } catch (err) {
    // TODO (developer)- Handle exception from the Directory API
    Logger.log('Failed with error %s', err.message);
  }
}

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

Enable the Admin SDK API

  1. Open the Apps Script project.
  2. Click Editor .
  3. Next to Services, click Add a service .
  4. Select Admin Directory 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