Google Apps 脚本快速入门

快速入门介绍了如何设置和运行调用 Google Workspace API 的应用。

Google Workspace 快速入门使用 API 客户端库来处理身份验证和授权流程的某些详细信息。我们建议您在自己的应用中使用客户端库。本快速入门使用适用于测试环境的简化身份验证方法。对于生产环境，我们建议您先了解身份验证和授权，然后再选择适合您应用的访问凭据。

创建 Google Apps 脚本以向 GoogleClassroom API 发出请求。

目标

  • 创建脚本。
  • 启用 GoogleClassroom API。
  • 运行示例。

前提条件

  • 拥有已启用 Google 课堂的 Google for Education 帐号。

  • 访问 Google 云端硬盘

创建脚本

  1. 转到 script.google.com/create 创建新脚本。
  2. 将脚本编辑器的内容替换为以下代码：

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. 点击“保存”。
  2. 点击未命名项目，输入 quickstart，然后点击 Rename。

启用 GoogleClassroom API

  1. 打开 Apps 脚本项目。
  2. 点击编辑器 。
  3. 点击服务旁边的“添加服务”图标 。
  4. 选择 GoogleClassroom API，然后点击添加。

运行示例

在 Apps 脚本编辑器中，点击运行。

首次运行示例时，它会提示您授予访问权限：

  1. 点击查看权限。
  2. 选择账号。
  3. 点击允许。

脚本的执行日志会显示在窗口底部。

后续步骤