Package google.apps.script.type

索引

• AddOnWidgetSet (訊息)
• AddOnWidgetSet.WidgetType (列舉)
• CommonAddOnManifest (訊息)
• CreateActionExtensionPoint (訊息)
• HomepageExtensionPoint (訊息)
• HttpAuthorizationHeader (列舉)
• HttpOptions (訊息)
• LayoutProperties (訊息)
• LinkPreviewExtensionPoint (訊息)
• MenuItemExtensionPoint (訊息)
• UniversalActionExtensionPoint (訊息)
• UriPattern (訊息)

AddOnWidgetSet

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

欄位
usedWidgets[]	WidgetType 外掛程式中使用的小工具清單。

WidgetType

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

列舉
WIDGET_TYPE_UNSPECIFIED	設定預設小工具。
DATE_PICKER	日期挑選器。
STYLED_BUTTONS	樣式化按鈕包含填滿的按鈕和已停用的按鈕。
PERSISTENT_FORMS	永久表單允許在操作期間保留表單值。
FIXED_FOOTER	已修正資訊卡的頁尾。
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。

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 授權標頭傳送的權杖設定。

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。

MenuItemExtensionPoint

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

欄位
runFunction	string 必要欄位。啟用這個擴充點時要執行的端點。
label	string 必要欄位。向使用者顯示的文字，說明啟用這個擴充功能點所執行的動作。例如「插入月結單」。
logoUrl	string 外掛程式工具列中顯示的標誌圖片網址。 如未設定，則會預設為外掛程式的主要標誌網址。

UniversalActionExtensionPoint

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

欄位
label	string 必要欄位。向使用者顯示的文字，說明啟用這個擴充功能點後採取的動作，例如「新增聯絡人」。
聯集欄位 action_type。必要欄位。通用動作選單項目支援的動作類型。這可以是開啟連結或要執行的端點。action_type 只能是下列其中一項：
openLink	string 要由 UniversalAction 開啟的網址，
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 留空。