Google Apps Script Quickstart

Complete the steps described in the rest of this page, and in about five minutes you'll have a simple Google Apps Script that makes requests to the Classroom API.

Prerequisites

To run this quickstart, you'll need:

  • A G Suite for Education account with Google Classroom enabled.
  • Access to Google Drive.
  • Step 1: 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() {
      var optionalArgs = {
        pageSize: 10
      };
      var response = Classroom.Courses.list(optionalArgs);
      var courses = response.courses;
      if (courses && courses.length > 0) {
        for (i = 0; i < courses.length; i++) {
          var course = courses[i];
          Logger.log('%s (%s)', course.name, course.id);
        }
      } else {
        Logger.log('No courses found.');
      }
    }

    1. Click File > Save, name your project “Quickstart”, and click OK.

    Step 2: Turn on the Classroom API

    1. In the Apps Script editor, click Resources > Advanced Google Services.
    2. Locate Google Classroom API in the dialog and click the corresponding toggle, setting it to on.
    3. Click the Google API Console link.
    4. Enter "Google Classroom API" into the search box and click on the corresponding entry in the results.
    5. Click the Enable API button.
    6. Return to the Apps Script editor and click the OK button on the Advanced Google Services dialog.

    Step 3: Run the sample

    In the Apps Script editor, click Run > listCourses.

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

    1. Click the Continue button.
    2. Click the Accept button.

    To view the script's output, click View > Logs.

    Further reading

    Troubleshooting

    ReferenceError: "[API NAME]" is not defined

    This error occurs when the API hasn't been toggled on in the Apps Script code editor. Revisit Step 2.b and ensure the corresponding toggle is set to on.

    发送以下问题的反馈:

    此网页
    Classroom API
    Classroom API
    需要帮助?请访问我们的支持页面