Node.js 版快速入门

创建一个 Node.js 命令行应用，用于向 Google Classroom API 发出请求。

快速入门介绍了如何设置和运行调用 Google Workspace API 的应用。本快速入门使用一种简化的身份验证方法，适用于测试环境。对于生产环境，我们建议您先了解身份验证和授权，然后再选择适合您应用的访问凭据。

本快速入门使用 Google Workspace 推荐的 API 客户端库来处理身份验证和授权流程的一些详细信息。

目标

设置环境。
安装客户端库。
设置示例。
运行示例。

前提条件

如需运行本快速入门，您需要满足以下前提条件：

已安装 Node.js 和 npm。
Google Cloud 项目。

已启用 Google Classroom 的 Google for Education 账号。

设置环境

如需完成本快速入门，请设置您的环境。

启用 API

在使用 Google API 之前，您需要在 Google Cloud 项目中启用它们。您可以在单个 Google Cloud 项目中启用一个或多个 API。

在 Google Cloud 控制台中，启用 Google Classroom API。

启用 API

配置 OAuth 权限请求页面

如果您使用的是新的 Google Cloud 项目来完成本快速入门，请配置 OAuth 权限请求页面。如果您已为 Cloud 项目完成此步骤，请跳到下一部分。

在 Google API 控制台中，依次点击菜单 > Google Auth 平台 > 品牌塑造。
前往“品牌塑造”
如果您已配置 Google Auth 平台，则可以在品牌塑造、受众群体和数据访问权限中配置以下 OAuth 权限请求页面设置。如果您看到一条消息，提示尚未配置 Google Auth 平台，请点击开始使用：

在应用信息 下的应用名称 中，输入应用的名称。
在用户支持电子邮件中，选择一个支持电子邮件地址，以便用户在对权限请求有疑问时与您联系。
点击下一步 。
在受众群体 下，选择内部。
点击下一步 。
在联系信息 下，输入一个电子邮件地址 ，以便您接收有关项目变更的通知。
点击下一步 。
在完成部分，查看《Google API 服务用户数据政策》，如果您同意该政策，请选择我同意 Google API 服务：用户数据政策。
点击继续。
点击创建。

目前，您可以跳过添加范围。将来，当您创建的应用要在 Google Workspace 组织外部使用时，您必须将 用户类型 更改为外部。然后，添加应用所需的授权范围。如需了解详情，请参阅完整的配置 OAuth 权限请求页面指南。

为桌面应用授权凭据

如需对最终用户进行身份验证并访问应用中的用户数据，您需要创建一个或多个 OAuth 2.0 客户端 ID。客户端 ID 用于向 Google 的 OAuth 服务器标识单个应用。如果您的应用在多个平台上运行，您必须为每个平台创建一个单独的客户端 ID。

在 Google Cloud 控制台中，依次点击菜单 > Google Auth 平台 > 客户端。
前往“客户端”
点击创建客户端 。
依次点击应用类型 > 桌面应用。
在名称字段中，输入凭据的名称。此名称仅在 Google Cloud 控制台中显示。
点击创建。
新创建的凭据会显示在“OAuth 2.0 客户端 ID”下。
将下载的 JSON 文件另存为 credentials.json，然后将该文件移到您的工作目录。

安装客户端库

使用 npm 安装库：

npm install googleapis@95 @google-cloud/local-auth@2.1.0 --save

设置示例

在工作目录中，创建一个名为 index.js 的文件。

在该文件中，粘贴以下代码：

classroom/quickstart/index.js

在 GitHub 上查看

import path from 'node:path';
import process from 'node:process';
import {authenticate} from '@google-cloud/local-auth';
import {google} from 'googleapis';

// The scope for reading Classroom courses.
const SCOPES = ['https://www.googleapis.com/auth/classroom.courses.readonly'];
// The path to the credentials file.
const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');

/**
 * Lists the first 10 courses the user has access to.
 */
async function listCourses() {
  // Authenticate with Google and get an authorized client.
  const auth = await authenticate({
    scopes: SCOPES,
    keyfilePath: CREDENTIALS_PATH,
  });

  // Create a new Classroom API client.
  const classroom = google.classroom({version: 'v1', auth});
  // Get the list of courses.
  const result = await classroom.courses.list({
    pageSize: 10,
  });
  const courses = result.data.courses;
  if (!courses || courses.length === 0) {
    console.log('No courses found.');
    return;
  }
  console.log('Courses:');
  // Print the name and ID of each course.
  courses.forEach((course) => {
    console.log(`${course.name} (${course.id})`);
  });
}

await listCourses();

运行示例

在工作目录中，运行示例：
```
node .
```

首次运行该示例时，系统会提示您授权访问：
1. 如果您尚未登录 Google 账号，请在系统提示时登录。如果您登录了多个账号，请选择一个账号用于授权。
2. 点击接受。
您的 Nodejs 应用会运行并调用 Google Classroom API。

授权信息存储在文件系统中，因此下次运行示例代码时，系统不会提示您进行授权。

后续步骤

Java

Python