當使用者使用 Google 雲端硬碟時,Google Workspace 外掛程式可提供自訂介面。這可讓您為使用者提供其他相關資訊、自動執行工作,以及將第三方系統連結至 Google 雲端硬碟。
存取外掛程式 UI
如果 Google Workspace 外掛程式的圖示顯示在雲端硬碟使用者介面右側的圖示欄中,您就可以在 Google 雲端硬碟中開啟外掛程式。Google Workspace 外掛程式可以定義首頁介面、項目選取介面,或同時定義兩者:
- 如果使用者在 Google 雲端硬碟中點選外掛程式圖示,外掛程式會執行對應的
drive.homepageTrigger
函式 (如有)。這個函式會建構首頁資訊卡,並傳回至 Google 雲端硬碟以供顯示。如未定義drive.homepageTrigger
函式,系統會改為顯示一般首頁資訊卡。 - 如果使用者在 Google 雲端硬碟中選取一或多個項目,然後點擊外掛程式圖示,或是在外掛程式開啟時選取項目,外掛程式會執行對應的
drive.onItemsSelectedTrigger
關聯函式 (如有)。這個函式會建構外掛程式的 Google 雲端硬碟內容相關「所選項目」介面,並傳回至 Google 雲端硬碟來顯示。
建立雲端硬碟外掛程式介面
您可以按照下列步驟建構介面來擴充 Google 雲端硬碟:
- 決定是否要讓外掛程式建立雲端硬碟專屬首頁。此外,也請決定是否要在使用者選取雲端硬碟項目時提供內容相關介面。
- 將適當的
addOns.common
和addOns.drive
欄位新增至外掛程式指令碼專案資訊清單,包括任何必要的雲端硬碟範圍。 - 如果您提供的是雲端硬碟專屬首頁,請實作
drive.homepageTrigger
函式來建構此介面。您也可以選擇將common.homepageTrigger
介面用於多個 Google Workspace 主機。 - 如果您提供雲端硬碟內容相關項目選取介面,您必須實作
drive.onItemsSelectedTrigger
內容相關觸發條件函式,才能建構此介面。詳情請參閱所選項目的雲端硬碟結構定義介面)。 - 實作回應使用者 UI 互動 (例如按鈕點擊) 所需的相關聯的回呼函式。
雲端硬碟首頁
Google 雲端硬碟支援顯示 Google Workspace 外掛程式首頁。如要在 Google 雲端硬碟顯示外掛程式的通用首頁,只要確認外掛程式資訊清單中有 addOns.drive
欄位即可。
您也可以在外掛程式資訊清單中新增 drive.homepageTrigger
,提供雲端硬碟專屬的首頁。
不論是哪一種情況,都必須在外掛程式的指令碼專案中提供首頁觸發函式的名稱。系統會在需要時自動呼叫此函式,建構雲端硬碟首頁。您必須實作這個函式,才能建構並傳回單一 Card
,或構成首頁的 Card
物件陣列。首頁觸發函式會將事件物件傳遞為參數,其中包含一些一般資訊 (例如用戶端平台)。您可以使用事件物件資料來調整首頁的結構。
所選項目的雲端硬碟關聯介面
當使用者選取一或多個 Google 雲端硬碟項目時,Google 雲端硬碟會使用內容相關觸發條件,決定要顯示哪個介面 (如果有的話)。觸發條件啟動時,就會執行外掛程式資訊清單中 drive.onItemsSelectedTrigger.runFunction
欄位指定的關聯觸發條件函式。
如要為雲端硬碟建立內容相關項目選取介面,您必須執行下列操作:
確認外掛程式的資訊清單包含
https://www.googleapis.com/auth/drive.addons.metadata.readonly
範圍確認資訊清單包含
drive.onItemsSelectedTrigger
區段。實作
drive.onItemsSelectedTrigger
欄位中命名的函式。這個函式接受事件物件做為引數,且必須傳回單一Card
物件或Card
物件的陣列。和所有資訊卡一樣,您必須實作任何回呼函式,為介面提供小工具互動。舉例來說,如果您在介面中加入按鈕,按鈕應含有 Action,以及系統在使用者點選按鈕時執行的回呼函式。
事件物件
呼叫這些函式時,系統會建立事件物件,並傳遞至 drive.homepageTrigger
或 drive.onItemsSelectedTrigger
觸發條件函式。觸發函式可利用這個事件物件中的資訊,決定如何建構外掛程式資訊卡或控制外掛程式行為。
如需事件物件的完整結構,請參閱「事件物件」一文。如果雲端硬碟是外掛程式運作的主機應用程式,比對內容事件物件會包含雲端硬碟事件物件欄位,其中包含雲端硬碟專屬用戶端資訊。
項目選取觸發條件的雲端硬碟事件物件包括使用者在觸發條件啟動時所選項目的相關資訊。當使用者在雲端硬碟中選取多個項目時,系統會將其中一個項目視為主要興趣之一;此項目稱為「使用中的遊標項目」。
以下範例顯示傳遞至 drive.onItemsSelectedTrigger
函式的雲端硬碟事件物件:
{
"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"
},
...
]
},
...
}