REST Resource: projects.deployments

資源:Deployment

Google Workspace 外掛程式部署作業

JSON 表示法
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
欄位
name

string

部署作業資源名稱。範例:projects/123/deployments/my_deployment。

oauthScopes[]

string

執行外掛程式端點前,向使用者要求同意聲明的 Google OAuth 範圍清單。

addOns

object (AddOns)

Google Workspace 外掛程式設定。

etag

string

這個值是由伺服器根據儲存空間中的部署作業版本計算得出,可能會在更新和刪除要求中傳送,確保用戶端在繼續操作前取得最新值。

AddOns

Google Workspace 外掛程式設定。

JSON 表示法
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
欄位
common

object (CommonAddOnManifest)

所有 Google Workspace 外掛程式通用的設定。

gmail

object (GmailAddOnManifest)

Gmail 外掛程式設定。

drive

object (DriveAddOnManifest)

雲端硬碟外掛程式設定。

calendar

object (CalendarAddOnManifest)

Google 日曆外掛程式設定。

docs

object (DocsAddOnManifest)

Google 文件外掛程式設定。

meet

object (MeetAddOnManifest)

Meet 外掛程式設定。

sheets

object (SheetsAddOnManifest)

試算表外掛程式設定。

slides

object (SlidesAddOnManifest)

Google 簡報外掛程式設定。

httpOptions

object (HttpOptions)

將要求傳送至外掛程式 HTTP 端點的選項

CommonAddOnManifest

所有外掛程式代管應用程式共用的外掛程式設定。

JSON 表示法
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
欄位
name

string

必填。外掛程式的顯示名稱。

logoUrl

string

必填。外掛程式工具列中顯示的標誌圖片網址。

layoutProperties

object (LayoutProperties)

外掛程式資訊卡的常見版面配置屬性。

addOnWidgetSet

object (AddOnWidgetSet)

外掛程式中使用的小工具。如未指定這個欄位,則會使用預設組合。

useLocaleFromApp

boolean

是否要從主機應用程式傳遞語言代碼資訊。

homepageTrigger

object (HomepageExtensionPoint)

定義可在任何主機、任何情境中執行的端點。這個函式產生的資訊卡一律可供使用者查看,但如果這個外掛程式宣告了更具針對性的觸發條件,則可能會被情境內容遮蓋。

universalActions[]

object (UniversalActionExtensionPoint)

定義通用動作選單中的擴充點清單,做為外掛程式的設定選單。擴充點可以是開啟連結網址,或執行表單提交的端點。

openLinkUrlPrefixes

array (ListValue format)

OpenLink 動作只能使用包含 HTTPS、MAILTO 或 TEL 配置的網址。如果是 HTTPS 連結,網址也必須與許可清單中指定的其中一個前置字串相符。如果前置字元省略配置,系統會假設為 HTTPS。HTTP 連結會自動重寫為 HTTPS 連結。

LayoutProperties

所有外掛程式代管應用程式共用的資訊卡版面配置屬性。

JSON 表示法
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
欄位
primaryColor

string

外掛程式的主要顏色。這會設定工具列的顏色。如未設定主要顏色,系統會使用架構提供的預設值。

secondaryColor

string

外掛程式的次要顏色。用於設定按鈕的顏色。如果已設定主要顏色,但未設定次要顏色,則次要顏色會與主要顏色相同。如果未設定主要顏色或次要顏色,系統會使用架構提供的預設值。

useNewMaterialDesign
(deprecated)

boolean

啟用卡片的 Material Design。

AddOnWidgetSet

外掛程式使用的小工具子集。

JSON 表示法
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
欄位
usedWidgets[]

enum (WidgetType)

外掛程式中使用的小工具清單。

WidgetType

小工具類型。WIDGET_TYPE_UNSPECIFIED 是基本小工具組合。

列舉
WIDGET_TYPE_UNSPECIFIED 預設小工具組合。
DATE_PICKER 日期挑選器。
STYLED_BUTTONS 樣式按鈕包括填滿按鈕和停用按鈕。
PERSISTENT_FORMS 永久表單可在執行動作期間保留表單值。
UPDATE_SUBJECT_AND_RECIPIENTS 更新草稿的主旨和收件者。
GRID_WIDGET 格狀小工具。
ADDON_COMPOSE_UI_ACTION 適用於外掛程式撰寫 UI 的 Gmail 外掛程式動作。

HomepageExtensionPoint

宣告外掛程式首頁檢視畫面的常見格式。

JSON 表示法
{
  "runFunction": string,
  "enabled": boolean
}
欄位
runFunction

string

必填。這個擴充點啟用時要執行的端點。

enabled

boolean

(選用步驟) 如果設為 false,則會停用這個情境中的首頁檢視畫面。

如未設定,預設值為 true。

如果外掛程式的自訂首頁檢視畫面已停用,系統會改為向使用者提供一般總覽資訊卡。

UniversalActionExtensionPoint

宣告通用動作選單項目擴充點的格式。

JSON 表示法
{
  "label": string,

  "openLink": string,
  "runFunction": string
}
欄位
label

string

必填。向使用者顯示的文字,說明啟用這個擴充點後會執行的動作,例如「新增聯絡人」。

必填。通用動作選單項目支援的動作類型。可以是開啟連結或執行端點。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
runFunction

string

UniversalAction 要執行的端點。

互斥欄位結束。

GmailAddOnManifest

自訂 Gmail 外掛程式外觀和執行方式的屬性。

JSON 表示法
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

定義在與宣告的情境觸發條件不符的情境中執行的端點。使用者一律可以查看這個函式產生的任何資訊卡,但如果這個外掛程式宣告更明確的觸發條件,則可能會被情境內容遮蓋。

如有,則會覆寫 addons.common.homepageTrigger 的設定。

contextualTriggers[]

object (ContextualTrigger)

定義觸發外掛程式的一組條件。

universalActions[]

object (UniversalAction)

定義外掛程式的一組通用動作。使用者從外掛程式工具列選單觸發通用動作。

composeTrigger

object (ComposeTrigger)

定義撰寫時外掛程式的撰寫時觸發條件。當使用者撰寫電子郵件時,這個觸發條件會讓外掛程式執行動作。所有撰寫時外掛程式都必須具備 gmail.addons.current.action.compose 範圍,即使外掛程式可能不會編輯草稿也一樣。

authorizationCheckFunction

string

端點名稱,用於探測第三方 API,驗證外掛程式是否具備所有必要的第三方授權。如果探測失敗,函式應擲回例外狀況,啟動授權流程。每次叫用外掛程式前,系統都會呼叫這個函式,確保使用者體驗順暢。

ContextualTrigger

定義觸發條件,在開啟的電子郵件符合特定條件時觸發。觸發條件啟動時,會執行特定端點,通常是為了建立新資訊卡及更新 UI。

JSON 表示法
{
  "onTriggerFunction": string,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
欄位
onTriggerFunction

string

必填。訊息符合觸發條件時要呼叫的端點名稱。

觸發條件類型會決定 Gmail 顯示外掛程式的條件。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
unconditional

object (UnconditionalTrigger)

開啟任何郵件時,系統都會執行無條件觸發條件。

互斥欄位結束。

UnconditionalTrigger

這個類型沒有任何欄位。

在開啟任何電子郵件訊息時觸發。

UniversalAction

無論郵件內容為何,外掛程式工具列選單中一律會顯示這項動作。

JSON 表示法
{
  "text": string,

  "openLink": string,
  "runFunction": string
}
欄位
text

string

必填。向使用者顯示的文字,用於描述動作,例如「新增聯絡人」。

動作類型會決定使用者叫用動作時 Gmail 的行為。以下是互斥欄位清單。回應中最多會設定下列其中一個欄位:
runFunction

string

使用者觸發動作時呼叫的端點。詳情請參閱通用動作指南。

互斥欄位結束。

ComposeTrigger

在使用者撰寫電子郵件時啟動的觸發條件。

JSON 表示法
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
欄位
actions[]

object (MenuItemExtensionPoint)

定義撰寫時外掛程式的一組動作。這些是使用者可在撰寫時外掛程式上觸發的動作。

draftAccess

enum (DraftAccess)

定義觸發撰寫時外掛程式時的資料存取層級。

DraftAccess

定義撰寫觸發條件所需資料存取層級的列舉。

列舉
UNSPECIFIED 未設定 draftaccess 時的預設值。
NONE 觸發撰寫外掛程式時,撰寫觸發條件無法存取草稿的任何資料。
METADATA 授予撰寫觸發條件權限,以便在觸發撰寫外掛程式時,存取草稿的中繼資料。包括目標對象名單,例如草稿郵件的「收件者」和「副本」名單。

DriveAddOnManifest

自訂雲端硬碟外掛程式外觀和執行方式的屬性。

JSON 表示法
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

如有,則會覆寫 addons.common.homepageTrigger 的設定。

onItemsSelectedTrigger

object (DriveExtensionPoint)

對應至在相關雲端硬碟檢視畫面 (例如「我的雲端硬碟」文件清單) 中選取項目時執行的行為。

DriveExtensionPoint

宣告雲端硬碟外掛程式觸發條件的常見格式。

JSON 表示法
{
  "runFunction": string
}
欄位
runFunction

string

必填。擴充點啟用時要執行的端點。

CalendarAddOnManifest

自訂日曆外掛程式外觀和執行方式的屬性。

JSON 表示法
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

(選用步驟) 定義在不符合宣告情境觸發條件的情境中執行的端點。這個函式產生的任何資訊卡一律可供使用者使用,但如果這個外掛程式宣告更多指定觸發條件,則可能會被情境內容遮蓋。

如有,則會覆寫 addons.common.homepageTrigger 的設定。

conferenceSolution[]

object (ConferenceSolution)

(選用步驟) 定義此外掛程式提供的會議解決方案。

createSettingsUrlFunction

string

要執行的端點,可建立外掛程式設定頁面的網址。

eventOpenTrigger

object (CalendarExtensionPoint)

開啟活動進行查看或編輯時,會觸發這個端點。

eventUpdateTrigger

object (CalendarExtensionPoint)

在開啟事件更新時觸發的端點。

calendarNotificationTrigger

object (CalendarExtensionPoint)

(選用步驟) 當使用者訂閱的日曆建立或更新活動時,就會觸發。僅適用於 HTTP endpoints 使用 CalendarSubscriptionActionMarkup 建立的觸發條件。

為避免遞迴通知迴圈,如果外掛程式使用 Calendar API 修改 Google 日曆活動,且驗證憑證來自託管外掛程式部署作業的同一個 Google Cloud 專案,平台就會抑制修改通知。不支援自行觸發專案的 Calendar API 呼叫。

不適用於Apps Script add-ons和Apps Script installable triggers。

eventAttachmentTrigger

object (MenuItemExtensionPoint)

情境觸發條件的設定,會在使用者點選日曆下拉式選單中的外掛程式附件供應商時觸發。

currentEventAccess

enum (EventAccess)

定義觸發事件外掛程式時的資料存取層級。

ConferenceSolution

定義會議相關值。

JSON 表示法
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
欄位
onCreateFunction

string

必填。建立會議資料時要呼叫的端點。

id

string

必填。在單一外掛程式中,各個會議解決方案應指派不重複的 ID,否則外掛程式觸發時可能會使用錯誤的會議解決方案。您可以變更外掛程式的顯示名稱,但請勿變更 ID。

name

string

必填。會議解決方案的顯示名稱。

logoUrl

string

必填。會議解決方案標誌圖片的網址。

CalendarExtensionPoint

宣告日曆外掛程式觸發條件的常見格式。

JSON 表示法
{
  "runFunction": string
}
欄位
runFunction

string

必填。這個擴充點啟用時要執行的端點。

EventAccess

定義事件觸發條件所需資料存取層級的列舉。

列舉
UNSPECIFIED 未設定 eventAccess 時的預設值。
METADATA 授予事件觸發條件存取事件中繼資料的權限,例如事件 ID 和日曆 ID。
READ 授予事件觸發條件存取權,可存取所有提供的事件欄位,包括中繼資料、與會者和會議資料。
WRITE 授予事件觸發條件存取事件中繼資料的權限,以及執行所有動作的能力,包括新增與會者和設定會議資料。
READ_WRITE 可讓事件觸發條件存取所有提供的事件欄位,包括中繼資料、與會者和會議資料,並可執行所有動作。

DocsAddOnManifest

自訂 Google 文件外掛程式外觀和執行方式的屬性。

JSON 表示法
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

如有,則會覆寫 addons.common.homepageTrigger 的設定。

onFileScopeGrantedTrigger

object (DocsExtensionPoint)

當這個文件/使用者組合獲得檔案範圍授權時,要執行的端點。

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

在 Google 文件中預覽連結的擴充點清單。詳情請參閱「使用智慧型方塊預覽連結」。

createActionTriggers[]

object (CreateActionExtensionPoint)

擴充點清單,用於在 Google Workspace 應用程式中建立第三方資源。詳情請參閱「透過 @ 選單建立第三方資源」。

DocsExtensionPoint

宣告 Google 文件外掛程式觸發條件的常見格式。

JSON 表示法
{
  "runFunction": string
}
欄位
runFunction

string

必填。這個擴充點啟用時要執行的端點。

LinkPreviewExtensionPoint

觸發條件設定:當使用者在 Google 文件、試算表或簡報檔案中,輸入或貼上第三方或非 Google 服務的連結時,就會觸發。

JSON 表示法
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "patterns": [
    {
      object (UriPattern)
    }
  ],
  "runFunction": string,
  "logoUrl": string
}
欄位
labelText

string

必填。智慧型方塊範例的文字,提示使用者預覽連結,例如 Example: Support case。這段文字是靜態的,會在使用者執行外掛程式前顯示。

localizedLabelText

map (key: string, value: string)

(選用步驟) labeltext 的對應,用於本地化為其他語言。語言請採用 ISO 639 格式,國家/地區則採用 ISO 3166 格式,並以連字號 - 分隔。例如:en-US。

如果使用者的語言代碼存在於對應的鍵中,使用者就會看到本地化版本的 labeltext。

這個物件中包含 "key": value 組合的清單,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

patterns[]

object (UriPattern)

必填。觸發外掛程式預覽連結的網址模式陣列。

runFunction

string

必填。觸發連結預覽時要執行的端點。

logoUrl

string

(選用步驟) 智慧型方塊和預覽資訊卡中顯示的圖示。如果省略,外掛程式會使用工具列圖示 logourl。

UriPattern

觸發連結預覽的各個網址模式設定。

JSON 表示法
{
  "hostPattern": string,
  "pathPrefix": string
}
欄位
hostPattern

string

每個要預覽的網址模式都必須提供。網址模式的網域。外掛程式會預覽網址中包含這個網域的連結。如要預覽特定子網域 (例如 subdomain.example.com) 的連結,請加入子網域。如要預覽整個網域的連結,請使用星號 (*) 做為子網域的萬用字元。

舉例來說,*.example.com 符合 subdomain.example.com 和 another.subdomain.example.com。

pathPrefix

string

(選用步驟) 附加 hostpattern 網域的路徑。

舉例來說,如果網址主機模式為 support.example.com,如要比對託管於 support.example.com/cases/ 的案件網址,請輸入 cases。

如要比對主機模式網域中的所有網址,請將 pathprefix 留空。

CreateActionExtensionPoint

當使用者在 Google Workspace 應用程式中叫用資源建立工作流程時,觸發條件的設定。詳情請參閱「透過 @ 選單建立第三方資源」。

JSON 表示法
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string
}
欄位
id

string

必填。用於區分這個擴充點的專屬 ID。ID 最多可包含 64 個字元,且格式應為 [a-zA-Z0-9-]+。

labelText

string

必填。資源建立進入點圖示旁顯示的文字,例如 Create support case。這段文字是靜態的,會在使用者執行外掛程式前顯示。

localizedLabelText

map (key: string, value: string)

(選用步驟) labeltext 的對應,用於本地化為其他語言。語言請採用 ISO 639 格式,國家/地區則採用 ISO 3166 格式,並以連字號 - 分隔。例如:en-US。

如果使用者的語言代碼存在於對應的鍵中,使用者就會看到本地化版本的 labeltext。

這個物件中包含 "key": value 組合的清單,範例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }。

runFunction

string

必填。觸發資源建立工作流程來建立連結時,要執行的端點。

logoUrl

string

(選用步驟) 資源建立進入點顯示的圖示。如省略,選單會使用外掛程式的工具列圖示 logourl。

MeetAddOnManifest

Meet 外掛程式資訊清單。

JSON 表示法
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

如有,則會覆寫 addons.common.homepageTrigger 的設定。

web

object (Web)

強化 Meet 網頁用戶端的外掛程式詳細資料。

supportsCollaboration

boolean

外掛程式是否支援協作,或邀請他人加入外掛程式體驗。

termsUri

string

外掛程式服務條款的連結 (如有)。

網頁

Meet 網頁用戶端強化外掛程式的詳細資料。

JSON 表示法
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
欄位
sidePanelUri
(deprecated)

string

側邊面板 iframe 的 URI。

sidePanelUrl

string

側邊面板 iframe 的網址。

mainStageUri
(deprecated)

string

「主要階段」iframe 的 URI。

supportsScreenSharing

boolean

外掛程式是否支援在主舞台分享螢幕畫面。

supportsCollaboration
(deprecated)

boolean

外掛程式是否支援協作,或邀請他人加入外掛程式體驗。這個欄位現已淘汰,請使用 MeetAddOnManifest 中的頂層欄位。

supportsPopOut

boolean

外掛程式是否支援彈出至瀏覽器子母畫面體驗。

hostOrigins[]
(deprecated)

string

已淘汰的舊版名稱。應新增至 iframe (包含第三方網站) frame-src 屬性的來源。請改用 addonorigins。

addOnOrigins[]

string

應新增至 iframe (包含第三方網站) frame-src 屬性的來源。

openState

enum (State)

外掛程式開啟時的初始狀態。

supportsCollaborationHostControls

boolean

協作外掛程式是否支援主辦人控制項。

logoUrl

string

外掛程式顯示的標誌網址。如未指定,則預設為資訊清單一般部分中的標誌。

darkModeLogoUrl

string

深色模式版本的 logourl。

displayFlow
(deprecated)

enum (DisplayFlow)

外掛程式啟動時會遵循的顯示流程。

州

用於指定外掛程式初始開啟狀態的列舉。

列舉
STATE_UNSPECIFIED 未指定外掛程式的初始狀態。
SIDE_PANEL_ONLY 外掛程式開啟時,只有側邊面板處於啟用狀態。
MAIN_STAGE_ONLY 外掛程式開啟時,只有主要視訊畫面會啟用。
SIDE_PANEL_AND_MAIN_STAGE 外掛程式開啟時,側邊面板和主要視訊畫面都會啟用。

DisplayFlow

列舉,用於指定外掛程式啟動時遵循的顯示流程

列舉
DISPLAY_FLOW_UNSPECIFIED 未指定顯示流程。
FOCUS 外掛程式應在「焦點」顯示流程中啟動。
AUGMENT 外掛程式應在「擴增」顯示流程中啟動。

SheetsAddOnManifest

自訂 Google 試算表外掛程式外觀和執行方式的屬性。

JSON 表示法
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

如有,則會覆寫 addons.common.homepageTrigger 的設定。

onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

當這個文件/使用者組合獲得檔案範圍授權時,要執行的端點。

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

在 Google 試算表文件中預覽連結的擴充點清單。詳情請參閱「使用智慧型方塊預覽連結」。

SheetsExtensionPoint

宣告 Google 試算表外掛程式觸發條件的常見格式。

JSON 表示法
{
  "runFunction": string
}
欄位
runFunction

string

必填。這個擴充點啟用時要執行的端點。

SlidesAddOnManifest

自訂 Google 簡報外掛程式外觀和執行方式的屬性。

JSON 表示法
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

如有,則會覆寫 addons.common.homepageTrigger 的設定。

onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

當這個文件/使用者組合獲得檔案範圍授權時,要執行的端點。

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

在 Google 簡報文件中預覽連結的擴充點清單。詳情請參閱「使用智慧型方塊預覽連結」。

SlidesExtensionPoint

宣告 Google 簡報外掛程式觸發條件的常見格式。

JSON 表示法
{
  "runFunction": string
}
欄位
runFunction

string

必填。這個擴充點啟用時要執行的端點。

HttpOptions

將要求傳送至外掛程式 HTTP 端點的選項。

JSON 表示法
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
欄位
authorizationHeader

enum (HttpAuthorizationHeader)

在 HTTP 授權標頭中傳送的權杖設定。

granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

外掛程式是否已啟用精細 OAuth 同意聲明。

HttpAuthorizationHeader

在外掛程式 HTTP 要求中傳送的授權標頭。

列舉
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED 預設值,相當於 SYSTEM_ID_TOKEN。
SYSTEM_ID_TOKEN 為專案專屬 Google Workspace 外掛程式的系統服務帳戶 (預設) 傳送 ID 權杖。
USER_ID_TOKEN 傳送使用者的 ID 權杖。
NONE 請勿傳送驗證標頭。

GranularOauthPermissionSupport

外掛程式是否已啟用精細 OAuth 同意聲明。

列舉
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED 預設值,不應使用。
OPT_IN 外掛程式已選擇加入精細 OAuth 同意聲明。
OPT_OUT 外掛程式未採用精細 OAuth 同意聲明。

方法

create

使用指定名稱和設定建立部署作業。

delete

刪除指定名稱的部署作業。

get

取得指定名稱的部署作業。

getInstallStatus

取得測試部署作業的安裝狀態。

install

在帳戶中安裝部署項目,以便進行測試。

list

列出特定專案中的所有部署作業。

replaceDeployment

建立或取代具有指定名稱的部署作業。

uninstall

從使用者帳戶解除安裝測試部署作業。