- 資源:部署
- AddOns
- CommonAddOnManifest
- LayoutProperties
- AddOnWidgetSet
- WidgetType
- HomepageExtensionPoint
- UniversalActionExtensionPoint
- GmailAddOnManifest
- ContextualTrigger
- UnconditionalTrigger
- UniversalAction
- ComposeTrigger
- MenuItemExtensionPoint
- DraftAccess
- DriveAddOnManifest
- DriveExtensionPoint
- CalendarAddOnManifest
- ConferenceSolution
- CalendarExtensionPoint
- EventAccess
- DocsAddOnManifest
- DocsExtensionPoint
- LinkPreviewExtensionPoint
- UriPattern
- CreateActionExtensionPoint
- SheetsAddOnManifest
- SheetsExtensionPoint
- SlidesAddOnManifest
- SlidesExtensionPoint
- HttpOptions
- HttpAuthorizationHeader
- 方法
資源:Deployment
Google Workspace 外掛程式部署作業
JSON 表示法 |
---|
{
"name": string,
"oauthScopes": [
string
],
"addOns": {
object ( |
欄位 | |
---|---|
name |
部署項目資源名稱。範例: |
oauth |
執行外掛程式端點前,需要向使用者索取同意聲明的 Google OAuth 範圍清單。 |
add |
Google Workspace 外掛程式設定。 |
etag |
這個值是由伺服器根據儲存空間中部署版本計算得出,並可能會在更新和刪除要求中傳送,以確保用戶端在繼續操作前擁有最新的值。 |
AddOns
Google Workspace 外掛程式設定。
JSON 表示法 |
---|
{ "common": { object ( |
欄位 | |
---|---|
common |
所有 Google Workspace 外掛程式都適用的設定。 |
gmail |
設定 Gmail 外掛程式。 |
drive |
雲端硬碟外掛程式設定。 |
calendar |
日曆外掛程式設定。 |
docs |
文件外掛程式設定。 |
sheets |
試算表外掛程式設定。 |
slides |
簡報外掛程式設定。 |
http |
傳送要求至外掛 HTTP 端點的選項 |
CommonAddOnManifest
所有外掛程式主機應用程式共用的外掛程式設定。
JSON 表示法 |
---|
{ "name": string, "logoUrl": string, "layoutProperties": { object ( |
欄位 | |
---|---|
name |
必要欄位。外掛程式的顯示名稱。 |
logo |
必要欄位。外掛程式工具列中顯示的標誌圖片網址。 |
layout |
外掛資訊卡的常見版面配置屬性。 |
add |
外掛程式中使用的小工具。如果未指定這個欄位,系統會使用預設的設定。 |
use |
是否從主機應用程式傳遞語言代碼資訊。 |
homepage |
定義在任何主機的任何情境下執行的端點。使用者一律可看到這項功能產生的任何資訊卡,但當這個外掛程式宣告更多指定觸發條件時,資訊卡可能會被內容比對功能遮蔽。 |
universal |
在通用動作選單中定義擴充功能點清單,做為外掛程式的設定選單。擴充功能點可以是要開啟的連結網址,也可以是做為表單提交執行的端點。 |
open |
OpenLink 動作只能使用採用 |
LayoutProperties
所有外掛程式主機應用程式共用的資訊卡版面配置屬性。
JSON 表示法 |
---|
{ "primaryColor": string, "secondaryColor": string, "useNewMaterialDesign": boolean } |
欄位 | |
---|---|
primary |
外掛程式的主要顏色。即可設定工具列的顏色。如果未設定主要顏色,系統會使用架構提供的預設值。 |
secondary |
外掛程式的次要顏色。可設定按鈕的顏色。如果已設定主要顏色,但未設定次要顏色,則次要顏色會與主要顏色相同。如果未設定主要顏色和次要顏色,則會使用架構提供的預設值。 |
use |
為資訊卡啟用 Material Design。 |
AddOnWidgetSet
外掛程式使用的小工具子集。
JSON 表示法 |
---|
{
"usedWidgets": [
enum ( |
欄位 | |
---|---|
used |
外掛程式中使用的小工具清單。 |
WidgetType
小工具類型。WIDGET_TYPE_UNSPECIFIED
是基本小工具組合。
列舉 | |
---|---|
WIDGET_TYPE_UNSPECIFIED |
已設定的預設小工具。 |
DATE_PICKER |
日期挑選器。 |
STYLED_BUTTONS |
樣式按鈕包括填滿型按鈕和停用按鈕。 |
PERSISTENT_FORMS |
永久表單允許在操作過程中保留表單值。 |
FIXED_FOOTER |
修正資訊卡中的頁尾。 |
UPDATE_SUBJECT_AND_RECIPIENTS |
更新草稿的主旨和收件者。 |
GRID_WIDGET |
格線小工具。 |
ADDON_COMPOSE_UI_ACTION |
適用於外掛程式撰寫 UI 的 Gmail 外掛程式動作。 |
HomepageExtensionPoint
宣告外掛程式的首頁檢視畫面的常用格式。
JSON 表示法 |
---|
{ "runFunction": string, "enabled": boolean } |
欄位 | |
---|---|
run |
必要欄位。啟用這個擴充點時要執行的端點。 |
enabled |
選用設定。如果設為 如果未設定,預設值為 如果停用外掛程式的自訂首頁檢視畫面,系統會改為向使用者顯示一般總覽資訊卡。 |
UniversalActionExtensionPoint
宣告通用動作選單項目擴充點的格式。
JSON 表示法 |
---|
{ "label": string, // Union field |
欄位 | |
---|---|
label |
必要欄位。使用者可見的文字,用於說明啟用此擴充點所採取的動作,例如「新增聯絡人」。 |
聯集欄位 action_type 。必要欄位。通用動作選單項目支援的動作類型。可以是開啟連結或執行的端點。action_type 只能是下列其中一項: |
|
open |
UniversalAction 開啟的網址。 |
run |
由 UniversalAction 執行的端點。 |
GmailAddOnManifest
屬性可自訂 Gmail 外掛程式的外觀和執行方式。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
欄位 | |
---|---|
homepage |
定義會在不符合宣告內容相關觸發條件的結構定義中執行的端點。這個函式產生的任何資訊卡都會一律向使用者顯示,但如果這個外掛程式宣告了更多指定的觸發條件,資訊卡就可能會被情境內容遮蔽。 如有的話,這會覆寫 |
contextual |
定義一組會觸發外掛程式的條件。 |
universal |
定義外掛程式的一組通用動作。使用者會透過外掛程式工具列選單觸發通用動作。 |
compose |
定義撰寫時間外掛程式的撰寫時間觸發條件。這個觸發條件會在使用者撰寫電子郵件時,讓外掛程式採取行動。所有撰寫時間外掛程式都必須具備 |
authorization |
端點的名稱,用來解析第三方 API,確認外掛程式具備所有必要的第三方授權。如果探針失敗,函式應擲回例外狀況,以便啟動授權流程。這個函式會在每次叫用外掛程式前呼叫,以確保使用者體驗流暢。 |
ContextualTrigger
定義在開啟的電子郵件符合特定條件時觸發的觸發條件。觸發條件啟動時,會執行特定端點,以建立新資訊卡及更新 UI。
JSON 表示法 |
---|
{ "onTriggerFunction": string, // Union field |
欄位 | |
---|---|
on |
必要欄位。訊息符合觸發條件時要呼叫的端點名稱。 |
聯集欄位 trigger 。觸發事件類型會決定 Gmail 顯示外掛程式的條件。trigger 只能是下列其中一項: |
|
unconditional |
只要開啟任何郵件,系統就會執行無條件觸發程序。 |
UnconditionalTrigger
這個類型沒有任何欄位。
當任何電子郵件訊息開啟時觸發的觸發條件。
UniversalAction
無論郵件內容為何,這個動作一律會顯示在外掛程式工具列選單中。
JSON 表示法 |
---|
{ "text": string, // Union field |
欄位 | |
---|---|
text |
必要欄位。使用者可見的文字,用於說明動作,例如「新增聯絡人」。 |
聯集欄位 action_type 。動作類型會決定使用者叫用動作時,Gmail 的行為。action_type 只能是下列其中一項: |
|
open |
使用者觸發動作時,Gmail 會開啟的連結。 |
run |
使用者觸發動作時呼叫的端點。詳情請參閱通用動作指南。 |
ComposeTrigger
觸發條件會在使用者撰寫電子郵件時啟動。
JSON 表示法 |
---|
{ "actions": [ { object ( |
欄位 | |
---|---|
actions[] |
定義組合時間外掛程式的一組動作。這些是使用者在撰寫時間外掛程式時可觸發的動作。 |
draft |
定義觸發編寫時間外掛程式時的資料存取層級。 |
MenuItemExtensionPoint
宣告主應用程式中顯示的選單項目或按鈕的常見格式。
JSON 表示法 |
---|
{ "runFunction": string, "label": string, "logoUrl": string } |
欄位 | |
---|---|
run |
必要欄位。在啟用此擴充功能點時要執行的端點。 |
label |
必要欄位。向使用者顯示的文字,說明啟用這個擴充點所執行的動作。例如「插入月結單」。 |
logo |
外掛程式工具列中顯示的標誌圖片網址。 如果未設定,則預設為外掛程式的主標誌網址。 |
DraftAccess
列舉用於定義 Compose 觸發條件所需的資料存取權級別。
列舉 | |
---|---|
UNSPECIFIED |
未設定草稿存取權時的預設值。 |
NONE |
觸發 Compose 外掛程式時,Compose 觸發事件無法存取草稿的任何資料。 |
METADATA |
在觸發組合新增功能時,授予組合觸發事件存取草稿中繼資料的權限。包括目標對象名單,例如郵件草稿的收件者和副本清單。 |
DriveAddOnManifest
用於自訂雲端硬碟外掛程式的外觀和執行方式的屬性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
欄位 | |
---|---|
homepage |
如有的話,這會覆寫 |
on |
對應至使用者在相關雲端硬碟檢視畫面中選取項目時的行為,例如「我的雲端硬碟」文件清單。 |
DriveExtensionPoint
用於宣告雲端硬碟外掛程式觸發條件的常見格式。
JSON 表示法 |
---|
{ "runFunction": string } |
欄位 | |
---|---|
run |
必要欄位。啟用擴充點時要執行的端點。 |
CalendarAddOnManifest
屬性可自訂日曆外掛程式的外觀和執行方式。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
欄位 | |
---|---|
homepage |
定義在與宣告的內容觸發事件不符的情況下執行的端點。這個外掛程式產生的任何資訊卡一律會對使用者使用,但如果這個外掛程式宣告更針對性觸發條件,但情境內容可能就會出現這類資訊卡。 如有的話,這會覆寫 |
conference |
定義此外掛程式提供的會議解決方案。第三方會議通訊外掛程式只能透過 Apps Script 建立。 |
create |
要執行的端點,會建立外掛程式設定頁面的網址。 |
event |
開放檢視或編輯事件時觸發的端點。 |
event |
公開事件更新時觸發的端點。 |
event |
情境觸發條件的設定,會在使用者點擊日曆下拉式選單中的外掛程式附件提供者時觸發。 |
current |
定義觸發事件外掛程式時的資料存取層級。 |
ConferenceSolution
定義會議相關價值。第三方會議通訊外掛程式只能透過 Apps Script 建立。
JSON 表示法 |
---|
{ "onCreateFunction": string, "id": string, "name": string, "logoUrl": string } |
欄位 | |
---|---|
on |
必要欄位。建立會議資料時要呼叫的端點。 |
id |
必要欄位。在一個外掛程式中,會議解決方案的 ID 應為唯一值,否則在觸發外掛程式時,可能會使用錯誤的會議解決方案。雖然你可以變更外掛程式的顯示名稱,但請勿更改。 |
name |
必要欄位。會議解決方案的顯示名稱。 |
logo |
必要欄位。會議解決方案的標誌圖片網址。 |
CalendarExtensionPoint
宣告日曆外掛程式觸發事件的常見格式。
JSON 表示法 |
---|
{ "runFunction": string } |
欄位 | |
---|---|
run |
必要欄位。啟用這個擴充點時要執行的端點。 |
EventAccess
列舉用來定義資料存取事件觸發條件所需的層級。
列舉 | |
---|---|
UNSPECIFIED |
未設定 eventAccess 時的預設值。 |
METADATA |
授予事件權限,讓觸發條件存取事件中繼資料 (例如活動 ID 和日曆 ID)。 |
READ |
讓事件觸發事件存取所有提供的事件欄位,包括中繼資料、與會者和會議資料。 |
WRITE |
允許事件觸發條件存取活動中繼資料及執行所有操作,包括新增與會者及設定會議資料。 |
READ_WRITE |
讓事件觸發事件存取所有提供的事件欄位,包括中繼資料、與會者和會議資料,並執行所有動作。 |
DocsAddOnManifest
用於自訂 Google 文件外掛程式外觀和執行方式的屬性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
欄位 | |
---|---|
homepage |
如有的話,這會覆寫 |
on |
為此文件/使用者組合授予檔案範圍授權時,要執行的端點。 |
link |
在 Google 文件中預覽連結的擴充點清單。詳情請參閱「使用智慧型方塊預覽連結」。 |
create |
這裡列出了在 Google Workspace 應用程式中建立第三方資源的擴充點。詳情請參閱「使用 @ 選單建立第三方資源」。 |
DocsExtensionPoint
用於宣告文件外掛程式觸發條件的常見格式。
JSON 表示法 |
---|
{ "runFunction": string } |
欄位 | |
---|---|
run |
必要欄位。啟用這個擴充點時要執行的端點。 |
LinkPreviewExtensionPoint
當使用者在 Google 文件、試算表或簡報檔案中輸入或貼上第三方或非 Google 服務的連結時,觸發事件就會觸發。
JSON 表示法 |
---|
{
"labelText": string,
"localizedLabelText": {
string: string,
...
},
"patterns": [
{
object ( |
欄位 | |
---|---|
label |
必要欄位。智慧型方塊範例的文字,可提示使用者預覽連結,例如 |
localized |
選用設定。將 如果地圖的鍵中含有使用者的語言代碼,使用者就會看到 這個物件中包含 |
patterns[] |
必要欄位。觸發預覽連結外掛程式的網址模式陣列。 |
run |
必要欄位。觸發連結預覽時要執行的端點。 |
logo |
選用設定。智慧型方塊和預覽資訊卡中的圖示。如果省略此資訊,外掛程式會使用工具列圖示 |
UriPattern
每個會觸發連結預覽的網址模式設定。
JSON 表示法 |
---|
{ "hostPattern": string, "pathPrefix": string } |
欄位 | |
---|---|
host |
必須為每個要預覽的網址格式設定。網址模式的網域。外掛程式預覽連結的網址會包含該網域。如要預覽特定子網域 (例如 舉例來說, |
path |
選用設定。附加 舉例來說,如果網址主機模式是 如要比對主機模式網域中的所有網址,請將 |
CreateActionExtensionPoint
這項觸發條件設定會在使用者於 Google Workspace 應用程式中叫用資源建立工作流程時觸發。詳情請參閱「使用 @ 選單建立第三方資源」。
JSON 表示法 |
---|
{ "id": string, "labelText": string, "localizedLabelText": { string: string, ... }, "runFunction": string, "logoUrl": string } |
欄位 | |
---|---|
id |
必要欄位。用於區分此擴充功能點的專屬 ID。ID 長度上限為 64 個半形字元,且格式應為 |
label |
必要欄位。顯示資源建立進入點圖示 (例如 |
localized |
選用設定。將 如果地圖的鍵中含有使用者的語言代碼,使用者就會看到 這個物件中包含 |
run |
必要欄位。資源建立工作流程被觸發以建立連結時要執行的端點。 |
logo |
選用設定。資源建立進入點顯示的圖示。如果省略此資訊,選單會使用外掛程式的工具列圖示 |
SheetsAddOnManifest
用於自訂 Google 試算表外掛程式的外觀和執行方式的屬性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
欄位 | |
---|---|
homepage |
如有的話,這會覆寫 |
on |
授予此文件/使用者組合的檔案範圍授權時,要執行的端點。 |
link |
在 Google 試算表文件中預覽連結的擴充點清單。詳情請參閱「使用智慧型方塊預覽連結」。 |
SheetsExtensionPoint
宣告試算表外掛程式觸發條件的常見格式。
JSON 表示法 |
---|
{ "runFunction": string } |
欄位 | |
---|---|
run |
必要欄位。啟用這個擴充點時要執行的端點。 |
SlidesAddOnManifest
用於自訂 Google 簡報外掛程式的外觀和執行方式的屬性。
JSON 表示法 |
---|
{ "homepageTrigger": { object ( |
欄位 | |
---|---|
homepage |
如有的話,這會覆寫 |
on |
授予此文件/使用者組合的檔案範圍授權時,要執行的端點。 |
link |
在 Google 簡報文件中預覽連結的擴充功能點清單。詳情請參閱「使用智慧型方塊預覽連結」。 |
SlidesExtensionPoint
用於宣告簡報外掛程式觸發條件的常見格式。
JSON 表示法 |
---|
{ "runFunction": string } |
欄位 | |
---|---|
run |
必要欄位。啟用這個擴充點時要執行的端點。 |
HttpOptions
將要求傳送至外掛程式 HTTP
端點的選項。
JSON 表示法 |
---|
{
"authorizationHeader": enum ( |
欄位 | |
---|---|
authorization |
透過 |
HttpAuthorizationHeader
透過外掛程式 HTTP
要求傳送 Authorization 標頭。
列舉 | |
---|---|
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED |
預設值,相當於 SYSTEM_ID_TOKEN 。 |
SYSTEM_ID_TOKEN |
傳送專屬於專案 Google Workspace 外掛程式的系統服務帳戶 ID 權杖 (預設)。 |
USER_ID_TOKEN |
傳送使用者的 ID 權杖。 |
NONE |
請勿傳送驗證標頭。 |
方法 |
|
---|---|
|
使用指定的名稱和設定建立部署作業。 |
|
刪除指定名稱的部署作業。 |
|
取得具有指定名稱的部署作業。 |
|
取得測試部署作業的安裝狀態。 |
|
在帳戶中安裝部署項目以進行測試。 |
|
列出特定專案中的所有部署項目。 |
|
以指定名稱建立或取代部署作業。 |
|
從使用者的帳戶解除安裝測試部署作業。 |