Go 版快速入门

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

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

创建一个 Go 命令行应用，用于向 GoogleClassroom API 发出请求。

目标

• 设置环境。
• 设置示例。
• 运行示例。

前提条件

• 最新版本的 Go。
• 最新版本的 Git。
• Google Cloud 项目。

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

设置您的环境

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

启用 API

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

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

  启用 API

配置 OAuth 权限请求页面

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

1. 在 Google Cloud 控制台中，依次点击“菜单”图标 > API 和服务 > OAuth 同意屏幕。

   转到 OAuth 同意屏幕

2. 为您的应用选择用户类型，然后点击创建。
3. 填写应用注册表单，然后点击保存并继续。

4. 目前，您可以跳过添加范围的步骤，点击 Save and Continue（保存并继续）。 将来，当您创建要在 Google Workspace 组织外部使用的应用时，必须添加并验证该应用所需的授权范围。

5. 如果您选择外部作为用户类型，请添加测试用户：
   1. 在测试用户下，点击添加用户。
   2. 输入您的电子邮件地址和任何其他已获授权的测试用户，然后点击保存并继续。
6. 查看您的应用注册摘要。若要进行更改，请点击修改。如果应用注册看起来正常，请点击 Back to Dashboard。

为桌面应用授权凭据

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

1. 在 Google Cloud 控制台中，依次点击“菜单”图标 > API 和服务 > 凭据。

   进入“凭据”页面

2. 依次点击创建凭据 > OAuth 客户端 ID。
3. 点击应用类型 > 桌面应用。
4. 在名称字段中，输入凭据的名称。此名称只会在 Google Cloud 控制台中显示。
5. 点击创建。系统会显示 OAuth 客户端已创建的屏幕，其中显示了您的新客户端 ID 和客户端密钥。
6. 点击 OK。新创建的凭据会显示在 OAuth 2.0 客户端 ID 下方。
7. 将下载的 JSON 文件另存为 credentials.json，然后将该文件移动到工作目录。

准备工作区

1. 创建工作目录：

   mkdir quickstart
   

2. 切换到工作目录：

   cd quickstart
   

3. 初始化新模块：

   go mod init quickstart
   

4. 获取 GoogleClassroom API Go 客户端库和 OAuth2.0 软件包：

   go get google.golang.org/api/classroom/v1
   go get golang.org/x/oauth2/google
   

设置示例

1. 在您的工作目录中，创建一个名为 quickstart.go 的文件。

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

   classroom/quickstart/quickstart.go

   在 GitHub 上查看

   package main
   
   import (
   	"context"
   	"encoding/json"
   	"fmt"
   	"log"
   	"net/http"
   	"os"
   
   	"golang.org/x/oauth2"
   	"golang.org/x/oauth2/google"
   	"google.golang.org/api/classroom/v1"
   	"google.golang.org/api/option"
   )
   
   // Retrieve a token, saves the token, then returns the generated client.
   func getClient(config *oauth2.Config) *http.Client {
   	// The file token.json stores the user's access and refresh tokens, and is
   	// created automatically when the authorization flow completes for the first
   	// time.
   	tokFile := "token.json"
   	tok, err := tokenFromFile(tokFile)
   	if err != nil {
   		tok = getTokenFromWeb(config)
   		saveToken(tokFile, tok)
   	}
   	return config.Client(context.Background(), tok)
   }
   
   // Request a token from the web, then returns the retrieved token.
   func getTokenFromWeb(config *oauth2.Config) *oauth2.Token {
   	authURL := config.AuthCodeURL("state-token", oauth2.AccessTypeOffline)
   	fmt.Printf("Go to the following link in your browser then type the "+
   		"authorization code: \n%v\n", authURL)
   
   	var authCode string
   	if _, err := fmt.Scan(&authCode); err != nil {
   		log.Fatalf("Unable to read authorization code: %v", err)
   	}
   
   	tok, err := config.Exchange(context.TODO(), authCode)
   	if err != nil {
   		log.Fatalf("Unable to retrieve token from web: %v", err)
   	}
   	return tok
   }
   
   // Retrieves a token from a local file.
   func tokenFromFile(file string) (*oauth2.Token, error) {
   	f, err := os.Open(file)
   	if err != nil {
   		return nil, err
   	}
   	defer f.Close()
   	tok := &oauth2.Token{}
   	err = json.NewDecoder(f).Decode(tok)
   	return tok, err
   }
   
   // Saves a token to a file path.
   func saveToken(path string, token *oauth2.Token) {
   	fmt.Printf("Saving credential file to: %s\n", path)
   	f, err := os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0600)
   	if err != nil {
   		log.Fatalf("Unable to cache oauth token: %v", err)
   	}
   	defer f.Close()
   	json.NewEncoder(f).Encode(token)
   }
   
   func main() {
   	ctx := context.Background()
   	b, err := os.ReadFile("credentials.json")
   	if err != nil {
   		log.Fatalf("Unable to read credentials file: %v", err)
   	}
   
   	// If modifying these scopes, delete your previously saved token.json.
   	config, err := google.ConfigFromJSON(b, classroom.ClassroomCoursesReadonlyScope)
   	if err != nil {
   		log.Fatalf("Unable to parse client secret file to config: %v", err)
   	}
   	client := getClient(config)
   
   	srv, err := classroom.NewService(ctx, option.WithHTTPClient(client))
   	if err != nil {
   		log.Fatalf("Unable to create classroom Client %v", err)
   	}
   
   	r, err := srv.Courses.List().PageSize(10).Do()
   	if err != nil {
   		log.Fatalf("Unable to retrieve courses. %v", err)
   	}
   	if len(r.Courses) > 0 {
   		fmt.Print("Courses:\n")
   		for _, c := range r.Courses {
   			fmt.Printf("%s (%s)\n", c.Name, c.Id)
   		}
   	} else {
   		fmt.Print("No courses found.")
   	}
   }
   

运行示例

1. 在您的工作目录中，构建并运行示例：

   go run quickstart.go
   

2. 首次运行示例时，它会提示您授予访问权限：
   1. 如果您尚未登录 Google 帐号，请在系统提示时登录。如果您登录了多个帐号，请选择一个用于授权的帐号。
   2. 点击接受。

   您的 Go 应用运行并调用 Google 课堂 API。

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

后续步骤

• 排查身份验证和授权问题
• Classroom API 参考文档
• GitHub 的 google-api-go-client 部分