最佳做法

請按照下列 Google Meet 外掛程式設計指南,改善使用者的整體體驗。

授權最佳做法

建議您針對所有需要驗證或授權的 Google Meet 外掛程式,採用下列最佳做法。

使用 Google 登入

許多 Google Workspace 外掛程式使用者在加入會議前,就會先登入 Google 帳戶。因此,提供 Google One Tap 做為選項,可讓使用者在進行登入流程時減少點按次數。詳情請參閱「管理外掛程式的登入方式」。

在新視窗中開啟第三方登入頁面

除了 Google 登入機制之外,您的應用程式可能會提供其他登入機制。如果是這樣,請使用對話方塊,而不是在新分頁中開啟登入頁面。這樣一來,使用者仍可查看及返回 Meet 通話,整體點擊次數也會減少。

為 Google API 適當要求範圍

如果 Meet 外掛程式呼叫 Google API,您必須提供外掛程式所需的 OAuth 範圍完整清單。這項操作可在 Google Workspace Marketplace 應用程式設定頁面中完成。新增這些範圍後,使用者在安裝 Meet 外掛程式時,系統會顯示提示,告知使用者允許應用程式存取哪些資料。

發布外掛程式前,您也必須設定 OAuth 同意畫面。這項操作需要完全從 Google Workspace Marketplace 應用程式設定中新增相同的授權範圍。設定 OAuth 同意畫面時,您也必須設定品牌資訊、隱私權政策和服務條款,這些資訊會在要求權限時顯示。如要公開發布,您必須提交所有資訊進行驗證

如要編寫呼叫 Google Workspace API 的程式碼,最簡單的方法就是按照 JavaScript 快速入門的說明進行。這個方法遵循使用 Google 登入和對話方塊的最佳做法。請注意,在 JavaScript 中初始化權杖用戶端時,需要另外要求應用程式在執行階段實際使用的範圍。為了提供最佳使用者體驗,這些要求的權限範圍應與 Google Workspace Marketplace 應用程式設定頁面中的權限範圍相符。這項備援機制可提供備用方案,用於處理使用者已撤銷範圍的情況。

維護最佳做法

以下最佳做法適用於撰寫可維護的網路應用程式,但在撰寫任何 Meet 外掛程式時,這些做法尤其重要。

使用最新版 Google Meet 外掛程式 SDK

Meet 外掛程式 SDK 會定期更新。SDK 採用語意化版本管理。如要查看最新版本,請按照下列步驟操作:

  • 使用 gstatic:最新 SDK 版本包含在 使用 SDK 的操作說明中找到的 gstatic URL 中。
  • 使用 npm:針對代管 Meet 外掛程式的網站,在包含 package.json 的目錄中執行 npm update @googleworkspace/meet-add-ons

建立 Google Cloud 專案測試環境

只要 Google Meet 外掛程式發布至 Google Workspace Marketplace,Meet 使用者就能立即使用任何新的 Google Meet 外掛程式部署。使用者清空快取或快取過期後,就會看到這些更新。因此,建議您在變更經過徹底測試後,再將變更內容推送至實際網站。

為避免直接部署至實際工作環境,建議您建立獨立的 Google Cloud 專案,並將該專案私下發布給貴機構。這項 Cloud 專案會代管 Meet 外掛程式的測試環境和開發環境。這個 Cloud 專案的存取權應限制給直接負責開發外掛程式的小型團隊。

如要為外掛程式建立這些替代環境,您必須先在自有網域中代管含有外掛程式的網頁應用程式替代環境。接著,您可以為 Meet 外掛程式建立其他環境,方法是將額外的 部署作業新增至 Google Cloud 專案的測試環境。這些新的部署作業應包含指向網頁應用程式替代環境的資訊清單。接著,建議您按照下列方式安裝每個外掛程式環境:

  • 測試環境私人發布測試環境版本,讓貴機構的任何使用者都能協助測試。
  • 開發:按一下「動作」欄下方的「安裝」,即可將 Meet 外掛程式開發版本安裝到自己的帳戶。

編寫測試

建議您在將 Meet 外掛程式部署至開發環境前,先撰寫單元測試。單元測試應包含:

  • 模擬 Meet 外掛程式 SDK,然後驗證 Meet 外掛程式是否如預期呼叫 SDK 函式。
  • 使用偏好的網路測試架構,對外掛程式的所有非 SDK 相關功能進行單元測試。

使用者體驗最佳做法

下列最佳做法可協助您打造更直覺且精緻的 Meet 外掛程式。

在側邊面板中管理所有起始狀態

強烈建議您根據側邊面板中顯示的使用者動作設定外掛程式。方法是在 JavaScript 中設定活動啟動狀態。所有進入 ActivityStartingState 的資料,都應由外掛程式發起者 (通常是會議主持人) 在側邊面板中設定。您可以將側邊面板的第一個檢視畫面視為控制外掛程式設定的表單。

未使用時關閉側邊面板

呼叫 startActivity() 方法後,您應該只在 Google Meet 外掛程式使用者體驗中,將側邊面板保持開啟狀態。只要呼叫 unloadSidePanel() 方法,即可在主畫面開啟後關閉側邊面板。

透過分享螢幕畫面宣傳 Meet 外掛程式

Meet 外掛程式提供的體驗比螢幕分享更豐富。不過,許多使用者都習慣使用 Meet 的螢幕分享功能。如果使用者分享顯示 Meet 外掛程式代管網站的分頁,Meet 可設定為向所有通話參與者顯示橫幅,提示他們安裝或使用對應的 Meet 外掛程式。詳情請參閱「透過螢幕分享功能宣傳外掛程式」。

標誌設計指南

設計 Meet 專屬標誌時,請遵循下列規範,確保標誌能呈現最佳效果:

請使用 PNG 檔案格式,大小為 256 像素 x 256 像素。

使用透明度。

請使用 Meet 外掛程式的開發人員工具,確認深色模式的標誌在深色模式下顯示良好。

請務必遵守特定應用程式整合功能的圖形規定

請勿在圖片中加入邊框間距。請改為將圖片延伸至檔案邊界。