Package google.apps.script.type

索引

AddOnWidgetSet

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

欄位
usedWidgets[]

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 外掛程式動作。

CommonAddOnManifest

在所有外掛程式主機應用程式中共用的外掛程式設定。

欄位
name

string

必要欄位。外掛程式的顯示名稱。
logoUrl

string

必要欄位。在外掛程式工具列中顯示的標誌圖片網址。
layoutProperties

LayoutProperties

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

AddOnWidgetSet

外掛程式中使用的小工具。如果未指定這個欄位，系統會使用預設集合。
useLocaleFromApp

bool

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

HomepageExtensionPoint

定義在任何主機的任何情境下執行的端點。這個函式產生的任何資訊卡都會一律向使用者顯示，但如果這個外掛程式宣告更多指定的觸發條件，資訊卡就可能會被內容比對功能遮蔽。
universalActions[]

UniversalActionExtensionPoint

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

ListValue

OpenLink 動作只能使用含有 HTTPS、MAILTO 或 TEL 配置的網址。對於 HTTPS 連結，網址也必須相符許可清單中指定的前置字串。如果前置字元省略了配置，系統會假設為 HTTPS。HTTP 連結會自動改寫為 HTTPS 連結。

CreateActionExtensionPoint

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

欄位
id

string

必要欄位。用於區分此擴充功能點的專屬 ID。ID 長度上限為 64 個半形字元，且格式應為 [a-zA-Z0-9-]+。
labelText

string

必要欄位。資源建立進入點 (例如 Create support case) 圖示旁顯示的文字。這段文字為靜態文字，會在使用者執行外掛程式前顯示。
localizedLabelText

map<string, string>

(非必要) labelText 的地圖，用於將其本地化為其他語言。請使用 ISO 639 格式輸入語言，並以 ISO 3166 格式輸入國家/地區，中間以連字號 - 分隔。例如：en-US。

如果地圖的索引鍵中包含使用者的語言代碼，使用者就會看到 labelText 的本地化版本。
runFunction

string

必要欄位。觸發資源建立工作流程時要執行的端點，以建立連結。
logoUrl

string

(非必要) 資源建立進入點顯示的圖示。如果省略，系統會使用外掛程式的工具列圖示 logoUrl。

GranularOauthPermissionSupport

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

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

HomepageExtensionPoint

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

欄位
runFunction

string

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

BoolValue

(非必要) 如果設為 false，則會在這個情境中停用首頁檢視畫面。

如果未設定，預設值為 true。

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

HttpAuthorizationHeader

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

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

HttpOptions

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

欄位
authorizationHeader

HttpAuthorizationHeader

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

GranularOauthPermissionSupport

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

LayoutProperties

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

欄位
primaryColor

string

外掛程式的主色。這個屬性可設定工具列的顏色。如果未設定主要顏色，系統會使用架構提供的預設值。
secondaryColor

string

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

bool

為資訊卡啟用 Material Design。

LinkPreviewExtensionPoint

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

欄位
labelText

string

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

map<string, string>

(非必要) labelText 的地圖，用於將其本地化為其他語言。請使用 ISO 639 格式輸入語言，並以 ISO 3166 格式輸入國家/地區，中間以連字號 - 分隔。例如：en-US。

如果地圖的索引鍵中包含使用者的語言代碼，使用者就會看到 labelText 的本地化版本。
patterns[]

UriPattern

必要欄位。可觸發外掛程式預覽連結的網址模式陣列。
runFunction

string

必要欄位。觸發連結預覽時要執行的端點。
logoUrl

string

(非必要) 智慧方塊和預覽資訊卡中顯示的圖示。如果省略這個值，外掛程式會使用其工具列圖示 logoUrl。

用於宣告代管應用程式中顯示的選單項目或按鈕的常見格式。

欄位
runFunction

string

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

string

必要欄位。使用者可見的文字，說明啟用此擴充功能點所採取的動作。例如「插入發票」。
logoUrl

string

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

如果未設定，則預設為外掛程式的主標誌網址。

UniversalActionExtensionPoint

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

欄位
label

string

必要欄位。使用者可見的文字，說明啟用此擴充點所採取的動作，例如「新增聯絡人」。
聯集欄位 action_type。必要欄位。通用動作選單項目支援的動作類型。可以是連結或要執行的端點。action_type 只能是下列其中一項：
runFunction

string

由 UniversalAction 執行的端點。

UriPattern

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

欄位
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 留空。