Google Cloud 專案設定

本頁麵包含建立和運作時 為 Classroom 外掛程式設定 Google Cloud 專案 Google Cloud 專案可用來透過 OAuth 2.0 導入 Google 單一登入 (Google 單一登入) 功能，以便授權外掛程式提出的要求，以及管理 Google Workspace Marketplace 中的外掛程式資訊 也就是經過處理且會導入模型的資料 接著再透過特徵儲存庫與他人分享

如需進一步說明如何將外掛程式發布到 Marketplace 請參閱「發布應用程式」。

建立 Google Cloud 專案

您可建立的專案有兩種類型：私人專案， 使用者可以找到自己的應用程式及公開專案。「公開」和 「私人」標籤指的是您的應用程式在 Google Workspace Marketplace；私人 Marketplace 應用程式只能由位於該應用程式所屬網域內的使用者安裝 而公開的 Marketplace 應用程式 適用於任何 Google Workspace 網域這兩個項目必須 專案不能同時設為公開和私人。公開應用程式 必須先通過審查並獲得核准，才能在市集中上架。

如需一般 Google Cloud 專案建立資訊，請參閱建立 Google Cloud 專案

建立公開的 Google Cloud 專案

這項專案代表的是 管理員、老師和學生。公開專案必須接受審查 已通過 Google Workspace Marketplace 團隊的核准，才能在 Google Workspace Marketplace 推出，或是 已安裝。

  1. 在實際工作環境網域中建立新的 Google Cloud 專案。

    建立 Google Cloud 專案

  2. 在 Cloud 專案中啟用 Classroom API。

    啟用 Classroom API

  3. 在 Cloud 專案中啟用 Google Workspace Marketplace SDK。

    啟用 Google Workspace Marketplace SDK

  4. 設定 Marketplace SDK 應用程式設定 「應用程式瀏覽權限」設為「公開」，然後勾選「不公開」方塊。

  5. 填寫 Marketplace SDK 中的必填欄位 「商店資訊」頁面，然後點選 發布：

  6. Google Workspace Marketplace 團隊將會審查您的應用程式。他們 將會透過 市集 SDK。應用程式獲得核准後，請清除 「不公開」方塊，方便老師和管理員在 市集：

建立私人 Google Cloud 專案

這項 private 專案代表用於開發作業的外掛程式應用程式。 網域外的使用者無法存取其建立資料夾，但 在安裝前無須獲得核准。因此，Google 會推薦 使用這項專案在受控管的環境中開發及測試外掛程式。

您需要存取 Google Workspace for Education 網域使用 Teaching &學習或 Plus 來建立私人專案如果目前沒有 網域，請按照下列步驟設定 Google Workspace for Education 示範網域，並將網域升級至 加上授權，並允許這個應用程式存取 Classroom 外掛程式 API：

  1. 完成取得開發人員測試網域的步驟。

  2. 以示範網域的管理員身分登入時，請建立新的 存取 Google Cloud 專案

    建立 Google Cloud 專案

    如果您無法存取 Google Cloud 控制台，或是 Cloud 專案，請在 管理控制台：

    • 前往「帳戶設定」頁面。以年齡為依據的存取權設定頁面和 選取「這個群組或機構單位中的所有使用者均年滿 18 歲」選項， 或更早的日期。
    • 前往 [應用程式] >額外的 Google 服務：
    • Google Cloud Platform 已為所有人啟用。
    • 專案建立設定是「允許使用者建立專案」。
    • Cloud Shell 存取權設定已設為「允許存取 Cloud Shell」。

  3. 填寫並提交示範網域升級申請表。提交這張資訊卡 Google 提出表單申請，要求 Google 將示範網域升級至 Google Workspace for Education Plus， 授權，並讓您的 Cloud 專案 Classroom 外掛程式 API。

    升級和許可清單程序完成時，您會收到電子郵件通知 完成。為「」中的測試老師帳戶指派 Plus 授權 管理控制台。低於 目錄 >使用者，請建立或選取測試老師帳戶。在 老師的「授權」：確認 Google Workspace for Education Plus 已已指派。

  4. 在 Cloud 專案中啟用 Classroom API。

    啟用 Classroom API

  5. 在 Cloud 專案中啟用 Google Workspace Marketplace SDK。

    啟用 Google Workspace Marketplace SDK

  6. 設定 Marketplace SDK 應用程式設定 「應用程式瀏覽權限」為「私人」。

  7. 填寫 Marketplace SDK 中的必填欄位 「商店資訊」頁面，然後點選 發布：應用程式資訊發布後，網域中的使用者 可以在 Google Workspace Marketplace 中找到並安裝應用程式。 前往「商店資訊」頁面中顯示的「應用程式網址」。

OAuth 2.0

您必須同意使用者資料存取權，才能使用 Classroom API。這些 要求 Google 存取登入的 OAuth 範圍後，即可取得此憑證。 並取得權杖，該權杖可用於後續對 Google Classroom您必須在 Google Workspace Marketplace 商店資訊，可讓網域管理員 可以在安裝外掛程式時，代表網域使用者提供同意聲明。

如需所有可用 API 的詳細清單，請參閱 Google API 的 OAuth 範圍頁面 範圍及用途請參閱 Workspace 說明文件中的「設定 OAuth 頁面」 以取得一般 OAuth 設定資訊

使用者權限

網頁應用程式應要求下列至少一個範圍：

  • https://www.googleapis.com/auth/userinfo.email，可讓您 應用程式來查看使用者的電子郵件地址。
  • https://www.googleapis.com/auth/userinfo.profile，可讓您 應用程式查看個人資訊，例如肖像、名字和姓氏 名稱以及使用者公開提供的其他個人資訊 廣告。

使用者在外掛程式中授予上述任一範圍的權限後， 由 login_hint 查詢參數識別。系統會將此參數傳遞給任何 加進網頁應用程式的網址 (iframe 開啟時)。如果使用者尚未授權 其中幾個範圍中，login_hint 將不會傳送。

login_hint 是標準 OpenID Connect 參數，您可視需要選擇是否使用 。這項服務 目的在於讓使用者享有更流暢的授權體驗。

Classroom 外掛程式範圍

以下是 Classroom 外掛程式的專屬範圍：

  • https://www.googleapis.com/auth/classroom.addons.teacher， 存取所有 API 方法
  • https://www.googleapis.com/auth/classroom.addons.student， 具備啟動驗證和附件讀取作業的權限。

即使擁有可表示使用者憑證的有效 OAuth 存取權杖，API 呼叫 需要遵守其他規定：

  • 所有方法的使用者都必須是課程的老師或學生 要求中 courseId 指定的位址。
  • 使用者必須建立附件、更新、刪除及傳送成績，才可以建立、更新、刪除及傳送成績 擔任老師
  • 撥打特定 Google Classroom 訊息時會受到下列管制： 檢查。
    • 如果外掛程式在貼文中至少有一個附件，就能 提出要求：
      • iframe 啟動驗證
      • 讀取、更新及刪除附件
      • 批改該訊息的最新動態
    • 附件探索 iframe 首次開啟時，外掛程式可能會 尚未在訊息中加入附件。addOnToken 查詢參數 的 ，可用來提出以下要求：
      • 在貼文底下建立附件 (需要 addOnToken)
      • 啟動驗證 (如果提供 addOnToken，就會通過驗證， 必須提供這項必要功能，因為外掛程式無法在 文章)

OAuth 驗證

Classroom 外掛程式會透過 Google API 存取 Google 使用者的資料。

請參閱「OAuth API 驗證常見問題」，進一步瞭解 驗證程序。

Google Workspace Marketplace 產品資訊

如需 Google Workspace Marketplace SDK 的一般設定資訊，請造訪 啟用並設定 Google Workspace Marketplace SDK 和 建立 Google Workspace Marketplace 商店資訊。

清單項目注意事項

公開 Google Cloud 專案的 Marketplace SDK Store 清單指定應用程式的名稱和 撰寫給使用者的說明您可以在 。

請在商家資訊中遵循下列規範：

  • 在「App Details」下方：

    • 避免在應用程式名稱中使用標點符號。例如，您可以使用「我的外掛程式 (由 My Company 製作)」而不是「My Company: My Add-on」或 公司」。

    • 「簡短說明」和「詳細說明」不應包含 文字完全相同

    + 確認您已為「價格」欄位選取值。這個 欄位提供以下選項：免費、須付費，和付款方式 免費功能和付費定價。您不必指定 金額。

    • 確認您已為「Category」欄位選取值。 您可以考慮選擇學術資源或老師和管理工具。 安裝 Classroom 外掛程式。

    • 查看 Marketplace「應用程式」中的項目 詳細說明。

  • 在「圖像資源」下方：

  • 在「支援連結」下方：

    • 請確認您已提供應用程式的《服務條款》連結 服務。

  • 請務必遵守 Google API 品牌宣傳指南。 包含允許的名稱和說明

  • 如果你提及商家資訊中的任何 Google 產品，請在 商標清單中提供的格式。請務必加入 商標 (TM) 符號 (如有指定)；請使用「Google DocsTM」，而不是「Google 文件"。

整合 Google 的授權和計費服務

如要允許您使用 Google Workspace Marketplace 應用程式 與 Google 的授權和帳單服務整合，請造訪 Marketplace API。

安裝設定

外掛程式除了允許管理員以外，也可以允許「個人」安裝 安裝。本頁將重點說明這兩種安裝作業之間的一些差異 。不適用於這兩種安裝類型。您可以選擇 是否允許在 Google Workspace Marketplace SDK 中個別安裝 應用程式設定頁面：

管理員安裝

管理員安裝可讓管理員替 或特定存取權群組/機構單位的帳戶僅限 網域管理員可執行管理員安裝作業 管理員可選擇代表所有使用者，同意存取所有存取權範圍 。系統不會在使用者 由管理員決定。

以下是安裝管理員時的一些注意事項。

  • 更嚴格的控制選項：管理員可以限制哪些使用者 外掛程式。
  • 與授權的相容性。如果您的應用程式需要授權 管理員均能透過管理員的身分安裝應用程式，或許能確保 授權均適當搭配相應的 機構。
  • 減輕使用者的負擔管理員安裝能減少 能為師生帶來莫大的負擔這可以增加使用者的流暢度 能減少點擊和造成混淆的機會

如要進一步瞭解如何在網域內安裝 Marketplace 中的應用程式，請參閱「在網域內安裝 Marketplace 中的應用程式」。 執行管理員安裝作業以及機構架構如何運作 ，進一步瞭解機構單位和存取權群組。

個人安裝

個人安裝可以在使用者自己的帳戶中新增外掛程式。該使用者 安裝期間，系統會提示您同意外掛程式的存取權範圍。

以下是個別安裝時的注意事項。

  • 協助採用。更多使用者可在 Google Workspace Marketplace。如果允許個別安裝，系統可能會提示 更多老師採用或推薦您的產品。
  • 管理員測試。管理員可能會個別安裝 以便進行測試或評估，再決定是否核准或安裝 更廣大的群體

除了代表使用者安裝外掛程式外 維護許可清單，允許使用者安裝允許個別存取的外掛程式 安裝。如果外掛程式不在許可清單中，使用者仍可看到 Google Workspace Marketplace 的外掛程式清單，但無法安裝 add-on;這時系統會顯示訊息，說明外掛程式 管理員允許安裝。請參閱管理 Google Workspace 已加入許可清單的 Marketplace 應用程式：進一步瞭解這項行為。

請參閱以下的 Google Workspace Marketplace 安裝設定說明文件： 瞭解詳情

應用程式整合功能

您必須在「附件設定 URI」欄位中提供啟動 iframe 網址。這個 網址會用作「附件探索 iframe」的 iframe src 值。 附件探索 iframe 可讓老師尋找要用於以下內容的內容或活動： 附加至自己的作業

您也必須指定允許附件的所有 URI 前置字串 。這項功能會防止附件 未經授權的來源。

若要進一步瞭解這些欄位，請參閱 iframe 指南頁面。

測試帳戶

在示範網域上建立測試帳戶，以便驗證應用程式的正確行為 私人外掛程式。必須要有兩個學生帳戶，才能測試在各帳戶間切換 學生作業評量 iframe 中的學生作業。

建議的測試帳戶：

  • Tammy 老師，tammy.teacher@<您的示範網域>
  • Sam Student, sam.student@<您的示範網域>
  • Sally Student, sally.student@<您的示範網域>

請按照下列步驟建立新的測試帳戶：

  1. 登入管理控制台。
  2. 前往「使用者」。
  3. 按一下「新增使用者」 (如圖 1 所示)。
  4. 輸入使用者資訊，並指派適當角色。

按一下「新增使用者」 圖 1.「新增使用者」連結的位置 管理控制台。

請按照以下程序建立新的測試群組：

  1. 登入管理控制台。
  2. 前往「群組」。
  3. 按一下「建立群組」 (請見圖 2)。
  4. 輸入群組成員和擁有者。

按一下「建立群組」 圖 2.「建立群組」連結的位置 管理控制台。