Google Apps Script quickstart

  • This quickstart demonstrates how to use Google Apps Script to access the People API and retrieve a list of connections.

  • Before starting, ensure you have a Google Workspace domain with API access enabled and a Google Account with administrator privileges.

  • The guide walks you through creating, configuring, and running a script that prints the display names of your connections.

  • You'll need to enable the People API in your Apps Script project and authorize the script to access your Google account.

  • For production environments, Google recommends reviewing authentication and authorization best practices.

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

Quickstarts explain how to set up and run an app that calls a Google Workspace API. This quickstart uses a simplified authentication approach that is appropriate for a testing environment. For a production environment, we recommend learning about authentication and authorization before choosing the access credentials that are appropriate for your app.

In Apps Script, Google Workspace quickstarts use Advanced Google services to call Google Workspace APIs and handle some details of the authentication and authorization flow.

Objectives

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

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 in the Apps Script editor by going to script.google.com/create.
  2. Replace the contents of the script editor with the following code:

people/quickstart/quickstart.gs
/**
 * @typedef {Object} EmailAddress
 * @see https://developers.google.com/people/api/rest/v1/people#Person
 * @property {string} value
 * Note: This is a partial definition.
 */

/**
 * @typedef {Object} Name
 * @see https://developers.google.com/people/api/rest/v1/people#Person
 * @property {string} displayName
 * Note: This is a partial definition.
 */

/**
 * @typedef {Object} Person
 * @see https://developers.google.com/people/api/rest/v1/people#Person
 * @property {Name[]} names
 * @property {EmailAddress[]} [emailAddresses]
 * Note: This is a partial definition.
 */

/**
 * @typedef {Object} Connection
 * @see https://developers.google.com/people/api/rest/v1/people.connections/list
 * @property {Person[]} connections
 * Note: This is a partial definition.
 */

/**
 * Print the display name if available for 10 connections.
 */
function listConnectionNames() {
  // Use the People API to list the connections of the logged in user.
  // See: https://developers.google.com/people/api/rest/v1/people.connections/list
  if (!People || !People.People || !People.People.Connections) {
    throw new Error("People service not enabled.");
  }
  const connections = People.People.Connections.list("people/me", {