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 Directory API.

Prerequisites

To run this quickstart, you need the following prerequisites:

  • A G Suite domain with API access enabled
  • A Google account in that domain with administrator privileges
  • 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:

    adminSDK/directory/quickstart.gs
    /**
     * Lists users in a G Suite domain.
     */
    function listUsers() {
      var optionalArgs = {
        customer: 'my_customer',
        maxResults: 10,
        orderBy: 'email'
      };
      var response = AdminDirectory.Users.list(optionalArgs);
      var users = response.users;
      if (users && users.length > 0) {
        Logger.log('Users:');
        for (i = 0; i < users.length; i++) {
          var user = users[i];
          Logger.log('%s (%s)', user.primaryEmail, user.name.fullName);
        }
      } else {
        Logger.log('No users found.');
      }
    }

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

    Step 2: Turn on the Directory API

    Enable the Admin Directory API advanced service in your script.

    Step 3: Run the sample

    In the Apps Script editor, click Run > listUsers.

    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.

    Further reading

    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).

    Send feedback about...

    Directory API
    Directory API
    Need help? Visit our support page.