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

Objectives

  • Create the script.
  • Enable the People 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:

people/quickstart/quickstart.gs
/**
 * Print the display name if available for 10 connections.
 */
function listConnectionNames() {
  try {
    /**
     * List the 10 connections/contacts of user
     * @see https://developers.google.com/people/api/rest/v1/people.connections/list
     */
    const connections = People.People.Connections.list('people/me', {
      pageSize: 10,
      personFields: 'names,emailAddresses'
      // use other query parameter here if needed.
    });
    connections.connections.forEach((person) => {
      // if contacts/connections is available, print the name of person.
      if (person.names && person.names.length === 0) {
        console.log('No display name found for connection.');
        return;
      }
      console.log(person.names[0].displayName);
    });
  } catch (err) {
    // TODO (developer) - Handle exception from People API
    console.log('Failed with error %s', err.message);
  }
}

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

Enable the People API

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