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)

Google 試算表外掛程式設定。

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 動作只能使用具有 HTTPSMAILTOTEL 配置的網址。如果是 HTTPS 連結,網址也必須符合許可清單中指定的前置字串。如果前置字元省略了架構,系統會假設為 HTTPSHTTP 連結會自動改寫為 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 適用於外掛程式撰寫使用者介面的 Gmail 外掛程式動作。

HomepageExtensionPoint

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

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

string

必要欄位。這個擴充功能點啟動時要執行的端點。

enabled

boolean

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

如果未設定,則預設值為 true

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

UniversalActionExtensionPoint

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

JSON 表示法
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
欄位
label

string

必要欄位。使用者可見的文字,說明啟用這個擴充點後執行的動作,例如「新增聯絡人」。

聯集欄位 action_type。必要欄位。通用動作選單項目支援的動作類型。可以是開啟的連結,也可以是執行的端點。action_type 只能是下列其中一項:
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,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
欄位
onTriggerFunction

string

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

聯集欄位 trigger。觸發條件類型會決定 Gmail 顯示外掛程式的條件。trigger 只能是下列其中一項:
unconditional

object (UnconditionalTrigger)

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

UnconditionalTrigger

這個類型沒有任何欄位。

只要開啟任何電子郵件,就會觸發這項條件。

UniversalAction

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

JSON 表示法
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
欄位
text

string

必要欄位。向使用者顯示的動作說明文字,例如「新增聯絡人」。

聯集欄位 action_type。動作類型會決定使用者叫用動作時,Gmail 的行為。action_type 只能是下列其中一項:
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)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

定義在與已宣告的脈絡觸發條件不符的脈絡中執行的端點。這項功能產生的任何資訊卡都會提供給使用者,但如果外掛程式宣告更多目標觸發條件,資訊卡可能會被情境內容遮住。

如有的話,這項屬性會覆寫 addons.common.homepageTrigger 中的設定。

conferenceSolution[]

object (ConferenceSolution)

定義這個外掛程式提供的會議解決方案。第三方會議外掛程式只能在 Apps Script 中建構。

createSettingsUrlFunction

string

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

eventOpenTrigger

object (CalendarExtensionPoint)

當事件開啟以供查看或編輯時,系統會觸發這個端點。

eventUpdateTrigger

object (CalendarExtensionPoint)

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

eventAttachmentTrigger

object (MenuItemExtensionPoint)

當使用者點選日曆下拉式選單中的外掛程式附件供應商時,會觸發內容相關觸發條件的設定。

currentEventAccess

enum (EventAccess)

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

ConferenceSolution

定義會議相關值。第三方會議外掛程式只能在 Apps Script 中建構。

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.comanother.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

外掛程式是否支援彈出至瀏覽器 PiP 體驗。

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 請勿傳送 Authentication 標頭。

GranularOauthPermissionSupport

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

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

方法

create

建立具有指定名稱和設定的部署。

delete

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

get

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

getInstallStatus

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

install

將部署項目安裝至帳戶以進行測試。

list

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

replaceDeployment

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

uninstall

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