REST Resource: projects.deployments

資源：部署

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)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
欄位
common

object (CommonAddOnManifest)

所有 Google Workspace 外掛程式都適用的設定。
gmail

object (GmailAddOnManifest)

Gmail 外掛程式設定。
drive

object (DriveAddOnManifest)

雲端硬碟外掛程式設定。
calendar

object (CalendarAddOnManifest)

日曆外掛程式設定。
docs

object (DocsAddOnManifest)

Google 文件外掛程式設定。
sheets

object (SheetsAddOnManifest)

試算表外掛程式設定。
slides

object (SlidesAddOnManifest)

簡報外掛程式設定。
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

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,

  // 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

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

列舉
UNSPECIFIED 未設定草稿存取權時的預設值。
NONE 觸發 Compose 外掛程式時，Compose 觸發事件無法存取草稿的任何資料。
METADATA 在觸發組合加外掛時，授予組合觸發事件存取草稿中繼資料的權限。包括收件者名單，例如草稿訊息的「收件者」和「副本」名單。

DriveAddOnManifest

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

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

object (HomepageExtensionPoint)

如有的話，這會覆寫 addons.common.homepageTrigger 中的設定。
onItemsSelectedTrigger

object (DriveExtensionPoint)

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

DriveExtensionPoint

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

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

string

必要欄位。在擴充功能點啟用時執行的端點。

CalendarAddOnManifest

用於自訂 Google 日曆外掛程式外觀和執行作業的屬性。

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

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

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。

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

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

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

string

必要欄位。在啟用此擴充功能點時要執行的端點。

HttpOptions

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

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

enum (HttpAuthorizationHeader)

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

HttpAuthorizationHeader

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

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

方法

create

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

delete

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

get

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

getInstallStatus

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

install

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

list

 列出特定專案中的所有部署項目。

replaceDeployment

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

uninstall

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