Google Apps Script quickstart

Create aGoogle Apps Scriptthat makes requests to the Directory API.

Quickstarts explain how to set up and run an app that calls aGoogle Workspace API. This quickstart uses asimplified authentication approach that is appropriate for a testingenvironment. For a production environment, we recommend learning aboutauthentication and authorizationbeforechoosing the access credentialsthat are appropriate for your app.

In Apps Script, Google Workspacequickstarts useAdvanced Google services to callGoogle Workspace APIs and handle some details of the authenticationand authorization flow.

Objectives

  • Configure the environment.
  • Create and configure the script.
  • Run the script.

Prerequisites

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

  • Access to Google Drive

Create the script

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

adminSDK/directory/quickstart.gs
/** * Lists users in a Google Workspace domain. * @see https://developers.google.com/admin-sdk/directory/reference/rest/v1/users/list */functionlistUsers(){constoptionalArgs={customer:"my_customer",maxResults:10,orderBy:"email",};if(!AdminDirectory||!AdminDirectory.Users){thrownewError("Enable the AdminDirectory Advanced Service.");}constresponse=AdminDirectory.Users.list(optionalArgs);constusers=response.users;if(!users||users.length===0){console.log("No users found.");return;}// Print the list of user's full name and emailconsole.log("Users:");for(constuserofusers){if(user.primaryEmail){if(user.name?.fullName){console.log("%s (%s)",user.primaryEmail,user.name.fullName);}else{console.log("%s",user.primaryEmail);}}}}

  1. Click Save.
  2. ClickUntitled project, typeQuickstart, and clickRename.

Configure the script

Enable the Directory API

Open the Apps Script project.

  1. ClickEditor.
  2. Next toServices, click Add a service .
  3. Select Admin Directory APIand clickAdd.

Run the sample

In the Apps Script editor, clickRun.

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

  1. ClickReview permissions.
  2. Choose an account.
  3. ClickAllow.

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

Great! Check out the further reading section below to learn more.
Bummer, let us know what went wrong. Check out our troubleshooting section below for some common errors and solutions. If you have found a bug in the code, report the issue on GitHub or submit a pull request.

Next steps

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-11 UTC.