建構 Google 雲端硬碟介面

使用者使用 Google 雲端硬碟時,Google Workspace 外掛程式可提供自訂介面。您可以藉此提供使用者其他相關資訊、自動執行工作,以及將第三方系統連結至 Google 雲端硬碟。

存取外掛程式 UI

如果 Google 雲端硬碟使用者介面右側的圖示欄中顯示 Google Workspace 外掛程式的圖示,Google Workspace 外掛程式可以定義首頁介面、項目選取介面,或同時定義這兩者:

  • 如果使用者在 Google 雲端硬碟中點選外掛程式圖示,外掛程式會執行對應的 drive.homepageTrigger 函式 (如有)。這個函式會建構並傳回首頁資訊卡,供 Google 雲端硬碟顯示。如果未定義任何 drive.homepageTrigger 函式,系統會改為顯示一般首頁資訊卡。
  • 如果使用者在 Google 雲端硬碟中選取一或多個項目,然後點按外掛程式圖示,或是在外掛程式開啟時選取項目,外掛程式就會執行對應的 drive.onItemsSelectedTrigger 情境函式 (如有)。這個函式會建構外掛程式的 Google 雲端硬碟「已選取項目」情境介面,並傳回 Google 雲端硬碟顯示。

建構外掛程式的雲端硬碟介面

如要建構擴充 Google 雲端硬碟的介面,請按照下列一般步驟操作:

  1. 決定是否要讓外掛程式擁有專屬的雲端硬碟首頁。 此外,您也可以決定是否要在使用者選取雲端硬碟項目時,提供內容相關介面。
  2. 在外掛程式指令碼專案的資訊清單中,加入適當的 addOns.commonaddOns.drive 欄位,包括任何必要的 Google 雲端硬碟範圍
  3. 如果您提供專為 Google 雲端硬碟設計的首頁,請實作 drive.homepageTrigger 函式來建構這個介面。您也可以選擇使用 common.homepageTrigger 介面,管理多個 Google Workspace 主機。
  4. 如果您提供 Google 雲端硬碟情境項目選取介面,就必須實作 drive.onItemsSelectedTrigger 情境觸發函式,才能建構這個介面。詳情請參閱「選取項目時的雲端硬碟情境介面」。
  5. 實作相關聯的回呼函式,以便回應使用者的 UI 互動,例如點選按鈕。

雲端硬碟首頁

Google 雲端硬碟支援顯示 Google Workspace 外掛程式的首頁。如要在 Google 雲端硬碟中顯示外掛程式的通用首頁,請確保外掛程式的資訊清單中有 addOns.drive 欄位。

或者,您也可以在外掛程式資訊清單中新增 drive.homepageTrigger,提供 Google 雲端硬碟專用的首頁。

無論選擇哪一種做法,您都必須在外掛程式的指令碼專案中提供首頁觸發函式的名稱。系統會在需要時自動呼叫這個函式,以建構雲端硬碟首頁。您必須實作這個函式,才能建構並傳回單一 Card 或組成首頁的 Card 物件陣列。首頁觸發函式會將事件物件當做參數傳遞,其中包含用戶端平台等一般資訊。您可以運用事件物件資料,量身打造首頁。

根據所選項目顯示相關介面

Google 雲端硬碟會根據內容比��觸發���件,������使用者選取一或多個 Google 雲端硬碟項目時,應顯示哪個介面 (如有)。觸發條件觸發時,會執行外掛程式資訊清單drive.onItemsSelectedTrigger.runFunction 欄位指定的內容相關觸發條件函式。

如要為 Google 雲端硬碟建立內容相關項目選取介面,請完成下列步驟:

  1. 確認外掛程式的資訊清單包含 https://www.googleapis.com/auth/drive.addons.metadata.readonly scope

  2. 確認資訊清單包含 drive.onItemsSelectedTrigger 區段。

  3. 實作「drive.onItemsSelectedTrigger」欄位中指定的函式。這個函式會接受 事件物件做為引數,且必須傳回單一 Card 物件或 Card 物件陣列。

  4. 與任何資訊卡一樣,您必須實作所有用於提供介面小工具互動的任何回呼函式。舉例來說,如果您在介面中加入按鈕,該按鈕應附加 Action,並實作點選按鈕時執行的回呼函式。

事件物件

系統會建立事件物件,並在呼叫 drive.homepageTriggerdrive.onItemsSelectedTrigger 觸發函式時,將該物件傳遞至這些函式。觸發函式可以使用這個事件物件中的資訊,判斷如何建構外掛程式資訊卡,或以其他方式控制外掛程式行為。

如要瞭解事件物件的完整結構,請參閱「事件物件」。如果雲端硬碟是外掛程式的實際主機應用程式,背景事件物件會包含「雲端硬碟事件物件」欄位,其中含有雲端硬碟專屬的用戶端資訊。

項目選取觸發條件的內容相關雲端硬碟事件物件,包含觸發條件觸發時使用者選取的項目資訊。使用者在雲端硬碟中選取多個項目時,其中一個項目會被視為主要感興趣的項目,這個項目稱為「游標所在項目」

以下範例顯示傳遞至 drive.onItemsSelectedTrigger 函式的 Google 雲端硬碟事件物件

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }