使用者必須先安裝並授權外掛程式,才能開啟並使用外掛程式。由於這些步驟是外掛程式使用者體驗的第一部分,因此請先瞭解這些步驟,再開始建立自己的外掛程式。
本文件的這一節說明使用者如何安裝、授權及開始使用外掛程式。
安裝外掛程式
您必須先安裝外掛程式,才能使用。安裝完畢後,外掛程式就會在其擴充的 Google Workspace 主機應用程式中提供。
您可以透過 Google Workspace 主機應用程式或 Google Workspace Marketplace 安裝已發布的外掛程式。網域管理員也可以代表使用者從 Google Workspace Marketplace 安裝外掛程式。您也可以安裝未發布的外掛程式,以便測試您正在開發的產品。您必須先授權,才能首次使用已安裝的擴充功能。
詳情請參閱「發布外掛程式」。
授權外掛程式
安裝外掛程式後,即可在擴充的 Google Workspace 主機應用程式中使用。使用者首次嘗試使用外掛程式時,主機應用程式會向他們顯示授權資訊卡或對話方塊。這個資訊卡會說明外掛程式需要哪些權限才能為使用者執行某些操作,例如存取目前 Google 試算表的內容。使用者可以授予這些權限,讓外掛程式繼續執行。如果使用者拒絕授權,就無法使用外掛程式。
編輯器外掛程式使用的授權模式與 Google Workspace 外掛程式不同。由於編輯器外掛程式會在 Google 雲端硬碟檔案上運作,因此編輯器授權模式會定義各種授權模式,這些模式會在使用外掛程式處理個別檔案時產生。開發編輯器外掛程式時,請務必瞭解不同的模式,以及外掛程式如何在各模式之間移動。
授權已發布的外掛程式
安裝已發布的外掛程式後,授權流程就會立即開始:
- 系統會提示你選擇要安裝外掛程式的帳戶。
- 接著,系統會顯示外掛程式運作所需的授權清單,讓您瞭解外掛程式嘗試執行的動作。請仔細查看這份清單,如果仍要授予授權,請按一下「允許」。這樣就能啟用外掛程式。
- 您現在可以從擴充的主機應用程式執行它。如果應用程式已在瀏覽器分頁中開啟,您可能需要重新整理分頁,才能使用外掛程式。
如果您安裝的外掛程式日後更新,並需要您尚未授予的額外授權,系統會在您下次使用外掛程式時,提示您提供這些權限。
授權未發布的 Google Workspace 外掛程式
未發布的外掛程式與已發布的外掛程式具有不同的授權流程,因為前者尚未列於 Google Workspace Marketplace 中。安裝未發布的外掛程式後,系統不會立即要求您授權。相反地,授權流程會在您首次嘗試使用外掛程式時啟動。
執行外掛程式時,系統會判斷是否需要使用者授權。如果需要授權,外掛程式會顯示授權卡。附加元件首次執行時一律需要授權,如果新版附加元件使用先前未授權的服務,也可能需要授權。「Authorize Access」按鈕會顯示對話方塊,讓使用者允許或拒絕外掛程式授權。
授權 Google Workspace 外掛程式使用非 Google 服務
Google Workspace 外掛程式可以連線至需要授權的第三方服務。連結至這類服務的 Google Workspace 外掛程式需要使用者執行兩項不同的動作:
- 在安裝或首次啟動外掛程式時,授權外掛程式本身。
- 首次存取非 Google 服務時的授權。
如果您正在開發的 Google Workspace 外掛程式需要使用 OAuth 存取非 Google 服務,則在建構外掛程式時,您必須為該服務設定連線。
詳情請參閱「將 Google Workspace 外掛程式連結至第三方服務」。
第三方會議系統
擴充 Google 日曆的 Google Workspace 外掛程式也可以新增其他會議解決方案,讓使用者在編輯 Google 日曆活動時選取第三方會議系統。如果您的外掛程式提供需要使用者登入的會議選項,則必須讓使用者能夠登入。
如果使用者嘗試透過外掛程式建立會議,但未完成必要的登入程序,會議解決方案的 onCreateFunction
方法 應會傳回 ConferenceData
物件,其中包含含有驗證網址的 ConferenceError
。
收到這個物件後,Google 日曆會在活動編輯 UI 中建立「LOG IN」按鈕,連結至外掛程式提供的驗證網址。使用者可以使用這個按鈕登入第三方系統,再繼續使用外掛程式。
如要進一步瞭解如何使用 ConferenceError
處理授權,請參閱「建立第三方會議」。
授權未發布的編輯器外掛程式
最佳做法是在開發時測試編輯器外掛程式。授權流程與已發布的編輯器外掛程式相同,唯一的差異在於流程會在您首次嘗試測試外掛程式時啟動。如果日後重新測試相同的擴充功能,系統就不會再要求您授權。
取消授權外掛程式
開發外掛程式時,您可以取消授權,以便重新測試授權流程。
如要取消授權外掛程式,請按照下列步驟操作:
- 開啟帳戶安全性控制台。
- 找出要取消授權的外掛程式,然後按一下該外掛程式。
- 按一下「移除存取權」。
取消授權後再次執行外掛程式時,系統會再次顯示授權流程。
解除安裝外掛程式
如要解除安裝從 Google Workspace Marketplace 安裝的外掛程式,請參閱「解除安裝 Marketplace 中的應用程式或外掛程式」。
如要解除安裝 Apps Script 中未發布的外掛程式,請參閱「解除安裝未發布的外掛程式」一文。