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. 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.
/**
* Lists all labels in the user's mailbox
* @see https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list
*/
function listLabels() {
try {
// Gmail.Users.Labels.list() API returns the list of all Labels in user's mailbox
const response = Gmail.Users.Labels.list('me');
if (!response || response.labels.length === 0) {
// TODO (developer) - No labels are returned from the response
console.log('No labels found.');
return;
}
// Print the Labels that are available.
console.log('Labels:');
for (const label of response.labels ) {
console.log('- %s', label.name);
}
} catch (err) {
// TODO (developer) - Handle exception on Labels.list() API
console.log('Labels.list() API failed with error %s', err.toString());
}
}
Click Save .
Click Untitled project, type
Quickstart, and click Rename.
Configure the script
Enable the Gmail API
Open the Apps Script project.
Click Editorcode.
Next to Services, click Add a service
add .
Select
Gmail 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:
Click Review permissions.
Choose an account.
Click Allow.
The script's execution log appears at the bottom of the window.