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)
  },
  "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)

文件外掛程式設定。
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

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 觸發撰寫外掛程式時，撰寫觸發條件無法存取草稿的任何資料。
METADATA 允許 Compose 在觸發撰寫外掛程式時存取草稿中繼資料的權限。包括目標對象名單，例如郵件草稿的「收件者」和「副本」清單。

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)
  },
  "currentEventAccess": enum (EventAccess)
}
欄位
homepageTrigger

object (HomepageExtensionPoint)

定義在結構定義與宣告內容相關觸發條件不符的情況下執行的端點。使用者隨時都可使用這個函式產生的任何資訊卡，但當外掛程式宣告的目標更明確觸發事件時，相關內容可能會遭到覆寫。

如有的話，這會覆寫 addons.common.homepageTrigger 的設定。
conferenceSolution[]

object (ConferenceSolution)

定義這個外掛程式提供的會議解決方案。
createSettingsUrlFunction

string

要執行的端點，用於建立外掛程式設定頁面的網址。
eventOpenTrigger

object (CalendarExtensionPoint)

開放使用者檢視或編輯事件時觸發的端點。
eventUpdateTrigger

object (CalendarExtensionPoint)

更新開放式事件時會觸發的端點。
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

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

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

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

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)
}
欄位
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

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