Google Apps Script quickstart

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.

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

Objectives

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

Prerequisites

  • A Google for Education account with Google Classroom enabled.

  • 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:

classroom/quickstart/quickstart.gs
/**
 * Lists 10 course names and ids.
 */
function listCourses() {
  /**  here pass pageSize Query parameter as argument to get maximum number of result
   * @see https://developers.google.com/classroom/reference/rest/v1/courses/list
   */
  const optionalArgs = {
    pageSize: 10
    // Use other parameter here if needed
  };
  try {
    // call courses.list() method to list the courses in classroom
    const response = Classroom.Courses.list(optionalArgs);
    const courses = response.courses;
    if (!courses || courses.length === 0) {
      console.log('No courses found.');
      return;
    }
    // Print the course names and IDs of the courses
    for (const course of courses) {
      console.log('%s (%s)', course.name, course.id);
    }
  } catch (err) {
    // TODO (developer)- Handle Courses.list() exception from Classroom API
    // get errors like PERMISSION_DENIED/INVALID_ARGUMENT/NOT_FOUND
    console.log('Failed with error %s', err.message);
  }
}

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

Configure the script

Enable the Google Classroom API

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

Previous
Go
Next
Java