Node.js 快速入門導覽課程

快速入門導覽課程說明如何設定及執行會呼叫 Google Workspace API

Google Workspace 快速入門導覽課程會使用 API 用戶端程式庫 驗證和授權流程的詳細資訊建議做法 您為自己的應用程式使用用戶端程式庫本快速入門導覽課程會使用 適合用於測試的簡易驗證方式 環境。在正式環境中，建議您瞭解 驗證與授權 再 選擇存取認證 挑選適合您應用程式的語言版本

建立 Node.js 指令列應用程式，向 Google Classroom API。

目標

• 設定環境。
• 安裝用戶端程式庫。
• 設定範例。
• 執行範例。

必要條件

如要執行本快速入門導覽課程，您必須具備下列先決條件：

• Node.js 與npm。
• Google Cloud 專案。

• 擁有已啟用 Google Classroom 的 Google for Education 帳戶。

設定環境

如要完成本快速入門導覽課程，請設定環境。

啟用 API

您必須先在 Google Cloud 專案中啟用這些 Google API，才能使用這些 API。 您可以在單一 Google Cloud 專案中啟用一或多個 API。

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

  啟用 API

設定 OAuth 同意畫面

如要使用新的 Google Cloud 專案完成本快速入門導覽課程，請設定 將自己新增為測試使用者。如果您已 為 Cloud 專案完成這個步驟，請直接跳到下一節。

1. 在 Google Cloud 控制台中，前往「選單」圖示 > API 與服務 >「OAuth 同意畫面」。

   前往 OAuth 同意畫面

2. 在「使用者類型」部分選取「內部」，然後按一下「建立」。
3. 填寫應用程式註冊表單，然後按一下「儲存並繼續」。

4. 您現在可以略過新增範圍的步驟，然後按一下「儲存並繼續」。 日後您可以製作並使用應用程式 Google Workspace 機構，您必須將「使用者類型」變更為「外部」， 新增應用程式所需的授權範圍。

5. 查看應用程式註冊摘要。如要修改資訊，請按一下「編輯」。如果應用程式 註冊看起來沒有問題，請按一下 [返回資訊主頁]。

授權電腦版應用程式憑證

如要驗證使用者及存取應用程式中的使用者資料，您必須： 建立一或多個 OAuth 2.0 用戶端 ID。用戶端 ID 可用來識別 單一應用程式傳送至 Google 的 OAuth 伺服器。如果您的應用程式在多個平台上運作 您都必須為每個平台分別建立用戶端 ID。

注意： 本快速入門導覽課程必須在本機執行，且必須能夠存取瀏覽器。這項服務 如果執行於遠端終端機 (例如 Cloud Shell 或 SSH) 時無法正常運作。

1. 在 Google Cloud 控制台中，依序點選「選單」圖示 > 「API 與」「服務」 >「憑證」。

   前往「憑證」

2. 依序點選「建立憑證」>「OAuth 用戶端 ID」。
3. 依序按一下「應用程式類型」>「電腦版應用程式」。
4. 在「名稱」欄位中輸入憑證的名稱。這個名稱只會顯示在 Google Cloud 控制台中。
5. 按一下「建立」，系統隨即會顯示已建立 OAuth 用戶端的畫面，並顯示您的新用戶端 ID 和用戶端密鑰。
6. 按一下「OK」(確定)。新建立的憑證會顯示在「OAuth 2.0 用戶端 ID」之下。
7. 將下載的 JSON 檔案儲存為 credentials.json，然後移動 檔案複製到工作目錄

安裝用戶端程式庫

• 使用 npm 安裝程式庫：

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

設定範例

1. 在工作目錄中，建立名為 index.js 的檔案。

2. 在檔案中貼上下列程式碼：

   classroom/quickstart/index.js

   前往 GitHub 查看

   const fs = require('fs').promises;
   const path = require('path');
   const process = require('process');
   const {authenticate} = require('@google-cloud/local-auth');
   const {google} = require('googleapis');
   
   // If modifying these scopes, delete token.json.
   const SCOPES = ['https://www.googleapis.com/auth/classroom.courses.readonly'];
   // 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.
   const TOKEN_PATH = path.join(process.cwd(), 'token.json');
   const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');
   
   /**
    * Reads previously authorized credentials from the save file.
    *
    * @return {Promise<OAuth2Client|null>}
    */
   async function loadSavedCredentialsIfExist() {
     try {
       const content = await fs.readFile(TOKEN_PATH);
       const credentials = JSON.parse(content);
       return google.auth.fromJSON(credentials);
     } catch (err) {
       return null;
     }
   }
   
   /**
    * Serializes credentials to a file compatible with GoogleAuth.fromJSON.
    *
    * @param {OAuth2Client} client
    * @return {Promise<void>}
    */
   async function saveCredentials(client) {
     const content = await fs.readFile(CREDENTIALS_PATH);
     const keys = JSON.parse(content);
     const key = keys.installed || keys.web;
     const payload = JSON.stringify({
       type: 'authorized_user',
       client_id: key.client_id,
       client_secret: key.client_secret,
       refresh_token: client.credentials.refresh_token,
     });
     await fs.writeFile(TOKEN_PATH, payload);
   }
   
   /**
    * Load or request or authorization to call APIs.
    *
    */
   async function authorize() {
     let client = await loadSavedCredentialsIfExist();
     if (client) {
       return client;
     }
     client = await authenticate({
       scopes: SCOPES,
       keyfilePath: CREDENTIALS_PATH,
     });
     if (client.credentials) {
       await saveCredentials(client);
     }
     return client;
   }
   
   /**
    * Lists the first 10 courses the user has access to.
    *
    * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
    */
   async function listCourses(auth) {
     const classroom = google.classroom({version: 'v1', auth});
     const res = await classroom.courses.list({
       pageSize: 10,
     });
     const courses = res.data.courses;
     if (!courses || courses.length === 0) {
       console.log('No courses found.');
       return;
     }
     console.log('Courses:');
     courses.forEach((course) => {
       console.log(`${course.name} (${course.id})`);
     });
   }
   
   authorize().then(listCourses).catch(console.error);

執行範例

1. 在工作目錄中執行範例：

   node .
   

2. 第一次執行範例時，系統會提示您授予存取權：
   1. 如果尚未登入 Google 帳戶，請在系統提示時登入。如果 您已登入多個帳戶，請選取一個用於授權的帳戶。
   2. 然後點選 [Accept]。

   您的 Nodejs 應用程式會執行並呼叫 Google Classroom API。

   授權資訊會儲存在檔案系統中，因此下次您執行範例時 這樣系統就不會提示您授權

後續步驟

• 排解驗證和授權問題
• Classroom API 參考說明文件
• GitHub 的「google-api-nodejs-client」部分