Package apps.extensions.markup

索引

CalendarClientActionMarkup

欄位
editAttendeesActionMarkup

EditAttendeesActionMarkup

將與會者新增至 Google 日曆活動的操作。
editConferenceDataActionMarkup

EditConferenceDataActionMarkup

將會議資料新增至 Google 日曆活動的操作。第三方會議外掛程式只能在 Apps Script 中建構。
addAttachmentsActionMarkup

AddAttachmentsActionMarkup

在 Google 日曆活動中新增附件。
createConferenceDataActionMarkup

CreateConferenceDataActionMarkup

建立 Google 日曆活動時，顯示會議資料的操作。
createConferenceSettingUrlActionMarkup

CreateConferenceSettingUrlActionMarkup

產生「建立會議設定」網址的動作。
calendarSubscriptionActionMarkup

CalendarSubscriptionActionMarkup

管理日曆訂閱項目的動作。僅支援在 HTTP 端點外掛程式中建立訂閱項目。不適用於 Apps Script 外掛程式。

AddAttachmentsActionMarkup

欄位
addonAttachments[]

AddonAttachment

AddonAttachment

欄位
resourceUrl

string
title

string

附件標題。
mimeType

string

resourceUrl 中內容的 MIME 類型。
iconUrl

string

資源圖示的連結。

CalendarSubscriptionActionMarkup

管理目前使用者日曆訂閱項目的動作。

建立訂閱項目具有冪等性：如果使用者已透過這個外掛程式部署項目訂閱指定日曆，傳回這項動作可確保訂閱項目保持有效，不會建立重複訂閱或重複的事件通知。傳回這個動作前，不必檢查現有訂閱項目。

僅支援在 HTTP 端點外掛程式中建立訂閱項目。不適用於 Apps Script 外掛程式。

欄位
operation

Operation

要執行的作業。目前僅支援 CREATE。建立訂閱項目具有冪等性。
calendarId

string

要訂閱的日曆 ID。

作業

列舉
OPERATION_UNSPECIFIED
CREATE

ConferenceDataMarkup

定義與 Google 日曆活動相關聯的會議資料標記。第三方會議外掛程式只能在 Apps Script 中建構。

欄位
conferenceId

string

這項會議資料的專屬 ID。長度上限為 512 個半形字元。
entryPoints[]

EntryPointMarkup

會議的進入點。最多只能有 300 個進入點。
parameters[]

Parameter

其他外掛程式參數。最多只能有 300 個參數。
error

Error

如果設定，表示建立會議時發生錯誤。
note

string

向使用者顯示的其他附註 (例如管理員的操作說明、法律聲明)。可包含 HTML。長度上限為 2048 個半形字元。
conferenceSolutionId

string

會議解決方案的 ID。必須與部署作業 calendar.conferenceSolution.id 欄位中的值相符。

EntryPointMarkup

加入會議的方式。第三方會議外掛程式只能在 Apps Script 中建構。

欄位
type

Type

進入點的類型。必填。
uri

string

加入會議的 URI。支援 tel: 和 http(s):，長度不得超過 1300 個字元。必填。
label

string

向使用者顯示的進入點標籤。長度上限為 512 個半形字元。
meetingCode

string

用於存取會議的會議代碼。長度上限為 128 個半形字元。
accessCode

string

存取會議的存取碼。長度上限為 128 個半形字元。
passcode

string

存取會議的密碼。長度上限為 128 個字元。
password

string

存取會議所需的密碼。長度上限為 128 個半形字元。
pin

string

存取會議的 PIN 碼。長度上限為 128 個半形字元。
regionCode

string

與這個進入點相關聯的國家/地區 CLDR/ISO 3166 區域代碼。僅適用於 Type.PHONE。
features[]

Feature

入口點的特徵，例如是否收費。一個進入點可以有多個功能。

功能

進入點的功能。部分功能可能僅適用於特定進入點。

列舉
UNKNOWN_FEATURE 不明功能。
TOLL 適用於 PHONE 進入點。撥打付費號碼時，費用由撥號方支付。號碼不能同時為付費和免付費。
TOLL_FREE 適用於 PHONE 進入點。撥打免付費號碼無須支付費用。號碼不能同時為付費和免付費號碼。

類型

進入點的類型。第三方會議外掛程式只能在 Apps Script 中建構。

列舉
UNKNOWN 會議類型不明。
VIDEO 視訊會議。
PHONE 電話會議。
MORE 用於提供連結，以便進一步瞭解會議加入資訊。
SIP 使用對話啟動協定的會議

錯誤

代表建立會議時發生的錯誤。第三方會議外掛程式只能在 Apps Script 中建構。

欄位
type

Type

錯誤類型。必填。
authenticationUrl

string

如果錯誤類型為 AUTHENTICATION，外掛程式可以提供網址，讓使用者登入。長度上限為 1300 個半形字元。

類型

列舉
UNKNOWN 發生不明錯誤。
AUTHENTICATION 驗證錯誤。
TEMPORARY 暫時性錯誤。
PERMANENT 永久性錯誤。
PERMISSION_DENIED 使用者無法在第三方會議系統中執行某些動作。
CONFERENCE_SOLUTION_FORBIDDEN 使用者無法使用所選會議解決方案，但可能可以使用外掛程式提供的其他解決方案。

參數

與事件資料一併保留的解決方案專屬參數，如有需要更新或刪除，則會傳遞至外掛程式。例如：[{key: 'sessionKey', value: '123'}, {key: 'meetingId', value: '456'}]

欄位
key

string

參數的鍵。長度上限為 50 個半形字元。必填。
value

string

參數的值。長度上限為 1024 個半形字元。必填。

CreateConferenceDataActionMarkup

欄位
createConferenceData

ConferenceDataMarkup

建立 Google 日曆活動時，要新增的會議資料。

CreateConferenceSettingUrlActionMarkup

欄位
settingsUrl

string

外掛程式產生的設定頁面 URI。

EditAttendeesActionMarkup

欄位
addAttendeeEmails[]

string

要新增至 Google 日曆活動的與會者清單。

EditConferenceDataActionMarkup

欄位

聯集欄位 conference。

conference 只能是下列其中一個設定：
conferenceData

ConferenceDataMarkup

要新增至 Google 日曆活動的會議資料。第三方會議外掛程式只能在 Apps Script 中建構。

ChatClientDataSourceMarkup

使用複選選單的 SelectionInput 小工具，資料來源為 Google Chat。資料來源會填入多選選單的選項。例如，使用者可以選取自己加入的 Google Chat 聊天室。

適用於 Google Chat 擴充應用程式，不適用於 Google Workspace 外掛程式。

欄位
聯集欄位 source。Google Chat 資料來源。source 只能是下列其中一項：
spaceDataSource

SpaceDataSource

使用者加入的 Google Chat 聊天室。

SpaceDataSource

這個資料來源會將 Google Chat 聊天室填入多選選單，做為選項。只會填入使用者所屬的聊天室。

適用於 Google Chat 擴充應用程式，不適用於 Google Workspace 外掛程式。

欄位
defaultToCurrentSpace

bool

如果設為 true，多選選單預設會選取目前的 Google Chat 聊天室做為項目。

ChatDataActionMarkup

在 Google Chat 建立或更新訊息。詳情請參閱「建構 Google Chat 介面」。

欄位
聯集欄位 action。Google Chat 動作。action 只能是下列其中一個設定：
createMessageAction

CreateMessageAction

以 Google Chat 擴充應用程式的身分傳送訊息。
updateMessageAction

UpdateMessageAction

更新 Google Chat 應用程式的訊息。
updateInlinePreviewAction

UpdateInlinePreviewAction

如要預覽連結，請在 Google Chat 使用者的訊息中新增一或多張資訊卡。

CreateMessageAction

Chat 擴充應用程式傳送訊息。詳情請參閱「傳送 Google Chat 即時通訊訊息」。

欄位
message

Message

Google Chat 即時通訊訊息。

UpdateInlinePreviewAction

Chat 擴充應用程式會新增或更新一或多張資訊卡，在訊息中預覽連結。詳情請參閱「預覽 Google Chat 即時通訊訊息中的連結」。

欄位
cardsV2[]

CardWithId

一或多張資訊卡的陣列。

UpdateMessageAction

Chat 擴充應用程式會更新訊息中的文字或資訊卡。詳情請參閱「傳送 Google Chat 即時通訊訊息」。

欄位
message

Message

更新後的訊息。

DriveClientActionMarkup

欄位
requestFileScope

RequestFileScope

RequestFileScope

欄位
itemId

string

EditorClientActionMarkup

欄位

聯集欄位 action。

action 只能是下列其中一個設定：
requestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

RequestFileScopeForActiveDocument

這個類型沒有任何欄位。

GmailClientActionMarkup

欄位

聯集欄位 type。

type 只能是下列其中一個設定：
taskAction

TaskActionMarkup
updateDraftActionMarkup

UpdateDraftActionMarkup
openCreatedDraftActionMarkup

OpenCreatedDraftActionMarkup
addonComposeUiActionMarkup

AddonComposeUiActionMarkup

AddonComposeUiActionMarkup

欄位
type

AddonComposeUiActionType

AddonComposeUiActionType

列舉
UNSPECIFIED 預設。如未指定，則不採取任何行動。
DISMISS 關閉外掛程式撰寫 UI。

OpenCreatedDraftActionMarkup

欄位
draftId

string

新建立草稿的 ID，格式為「r123」。
draftStorageId

string

伺服器儲存空間 ID (十六進位格式)，例如「15e9fa622ce1029d」。
draftThreadServerPermId

string

草稿執行緒的伺服器永久 ID。這個欄位不會在任何地方設定，且在處理 OpenCreatedDraftActionMarkup 時會遭到忽略。請改為提供並使用 draftThreadStorageId。
draftThreadId

string

含有新建立草稿的討論串 ID，例如「15e9fa622ce1029d」。

TaskActionMarkup

欄位
reloadTasks

bool

UpdateDraftActionMarkup

欄位
updateBody

UpdateBody

這個欄位包含一系列更新動作，可對使用者目前編輯的草稿內文執行。
updateToRecipients

UpdateToRecipients

如果設定，則會取代使用者目前編輯的草稿中現有的收件者。
updateCcRecipients

UpdateCcRecipients

如果設定，則會取代使用者目前編輯草稿的現有副本收件者。
updateBccRecipients

UpdateBccRecipients

如果設定，則會取代使用者目前編輯的草稿中現有的密件副本收件者。
updateSubject

UpdateSubject

如果設定，則會取代使用者目前編輯的草稿現有主旨。

收件者

欄位
email

string

UpdateBccRecipients

欄位
bccRecipients[]

Recipient

UpdateBody

欄位
insertContents[]

InsertContent

重複欄位，包含要插入使用者目前編輯草稿的一系列內容。內容可以包含 HTML 內容或純文字內容。
type

Type

ContentType

列舉
UNSPECIFIED_CONTENT_TYPE 未設定 ContentType 時的預設值。
TEXT 指定內容為純文字。
MUTABLE_HTML 指定內容為 HTML 格式，且可變動 (可編輯)。
IMMUTABLE_HTML 指定內容為 HTML 格式且不可變更 (無法編輯)。

EmailMimeType

EmailMimeType 已淘汰。請使用 ContentType。

列舉
UNSPECIFIED_EMAIL_MIME_TYPE 未設定 EmailMimeType 時的預設值。
PLAIN_TEXT 指定插入的內容為純文字。
HTML 指定插入的內容為 HTML。

InsertContent

欄位
content

string

要插入的內容。
mimeType
(deprecated)

EmailMimeType
contentType

ContentType

插入內容的類型。

類型

列舉
UNSPECIFIED_ACTION_TYPE 未設定類型時的預設值。
IN_PLACE_INSERT 表示這項動作是要執行就地插入。根據預設，內容會插入目前游標位置，如果已選取內容，則會取代所選內容。
INSERT_AT_START 表示這項動作是在郵件內文開頭插入文字。
INSERT_AT_END 表示這項動作是在郵件內文結尾插入內容。
REPLACE 表示這項動作會取代郵件內文。

UpdateCcRecipients

欄位
ccRecipients[]

Recipient

UpdateSubject

欄位
subject

string

UpdateToRecipients

欄位
toRecipients[]

Recipient

HostAppActionMarkup

由個別主機應用程式處理的動作。

欄位

聯集欄位 action。

action 只能是下列其中一個設定：
gmailAction

GmailClientActionMarkup

由 Gmail 處理的動作。
calendarAction

CalendarClientActionMarkup

由日曆處理的動作。
driveAction

DriveClientActionMarkup

由雲端硬碟處理的動作。
editorAction

EditorClientActionMarkup

由 Google 文件、試算表或簡報處理的動作。
sheetsAction

SheetsClientActionMarkup

由 Google 試算表處理的動作。
workflowAction

WorkflowClientActionMarkup

由 Workspace Studio 處理的動作。

HostAppDataActionMarkup

定義如何更新 Google Workspace 資料。

欄位
聯集欄位 action。特定 Google Workspace 代管應用程式的外掛程式動作。action 只能是下列其中一項：
chatDataAction

ChatDataActionMarkup

Google Chat 動作：建立或更新訊息中的文字或資訊卡。

HostAppDataSourceMarkup

Google Workspace 應用程式的資料來源。資料來源會填入小工具的可用項目。

欄位
聯集欄位 data_source。這個 Google Workspace 應用程式會填入小工具的可用項目。data_source 只能是下列其中一項：
chatDataSource

ChatClientDataSourceMarkup

Google Chat 的資料來源。
workflowDataSource

WorkflowDataSourceMarkup

Google Workflow 的資料來源。

SheetsClientActionMarkup

下一個 ID：5。

欄位

聯集欄位 action。

action 只能是下列其中一個設定：
customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

使用者執行自訂函式的結果。

欄位
聯集欄位 result。自訂函式的執行結果。result 只能是下列其中一項：
value

Value

執行自訂函式後產生的值。
errorMessage

string

發生錯誤時向使用者顯示的錯誤訊息。

WorkflowClientActionMarkup

Workspace Studio 外掛程式的用戶端動作。

欄位

聯集欄位 action。

action 只能是下列其中一個設定：
saveWorkflowAction

SaveWorkflowAction

啟動儲存工作流程的動作。
returnOutputVariablesAction

ReturnOutputVariablesAction

包含輸出變數的動作，由已執行的工作流程動作產生。
resourceRetrievedAction

ResourceRetrievedAction

包含擷取資源的動作。
resourceFieldsDefinitionRetrievedAction

ResourceFieldsDefinitionRetrievedAction

包含資源欄位定義的操作。
returnElementErrorAction

ReturnElementErrorAction

表示叫用元素時發生錯誤的動作。
workflowValidationErrorAction

WorkflowValidationErrorAction

表示工作流程驗證錯誤的操作。

ResourceData

應用程式專屬資源值。

欄位
fields

map<string, VariableData>

資源欄位的對應，以欄位名稱為索引鍵。
sourceResourceReference
(deprecated)

SourceResourceReference

已淘汰，請改用 VariableData.variable_source_data。

ResourceFieldsDefinitionRetrievedAction

包含資源支援的各個欄位定義。

欄位
dynamicResourceDefinitions[]

DynamicResourceDefinition

動態資源定義。

DynamicResourceDefinition

包含動態資源支援的各個欄位定義。

欄位
resourceId

string

動態資源類型的專屬 ID，例如「FORM_RESPONSE_VALUES」
fields[]

ResourceField

這項動態資源支援的欄位清單。

ResourceField

欄位
selector

string

欄位的參照鍵，用於擷取相關聯的值。
displayText

string

使用者選取變數時，系統會顯示這個欄位的人類可讀說明。
dataType

DataType

欄位的資料類型。
cardinality

Cardinality

欄位的基數。

ResourceRetrievedAction

包含傳回的資源。

欄位
resourceData

ResourceData

採用 proto 格式的自訂資料。

ReturnElementErrorAction

表示叫用元素時發生錯誤。

欄位
developerErrorMessage

string

向開發人員顯示的錯誤訊息。
errorLog

WorkflowTextFormatMarkup

向使用者顯示的人類可讀錯誤訊息。
errorActionability

ErrorActionability

使用者是否可對錯誤採取行動。
retryability

Retryability

是否可重試錯誤。

ErrorActionability

使用者是否可以嘗試修正錯誤。

列舉
ERROR_ACTIONABILITY_UNSPECIFIED 不明錯誤可操作性。請勿使用。
ACTIONABLE 使用者可以嘗試修正錯誤。
NOT_ACTIONABLE 使用者無法修正這項錯誤。

重試能力

是否可重試錯誤。

列舉
RETRYABILITY_UNSPECIFIED 未指定重試能力。請勿使用。
RETRYABLE 這項錯誤可以重試。
NOT_RETRYABLE 無法重試。

ReturnOutputVariablesAction

包含執行工作流程動作產生的輸出變數。

欄位
variables

map<string, VariableData>

變數對應，以變數 ID 為索引鍵。
log

WorkflowTextFormatMarkup

已執行工作流程動作的記錄。

SaveWorkflowAction

這個類型沒有任何欄位。

表示建立工具應開始儲存工作流程。

SourceResourceReference

參照 Workspace 資源的特定執行個體

欄位
sourceResourceType

SourceResourceType

來源資源的類型。
resourceId

string

資源的專屬 ID (例如雲端硬碟檔案 ID、Gmail 郵件 ID)。

SourceResourceType

來源資源的類型。這項資訊可用於識別資源類型，以及擁有該資源類型的工作流程套件。

欄位
workflowBundleId

string

擁有這項資源類型的工作流程套件 ID。
resourceDefinitionId

string

套件中資源定義的 ID (例如「spreadsheet」、「gmailMessage」)。

VariableData

代表變數資料，可保留不同類型的多個值。

欄位
booleanValues[]

bool

布林值。
integerValues[]

int64

整數值。
stringValues[]

string

字串值。
timestampValues[]

Timestamp

時間戳記值。
resourceReferences[]

string

資源 ID 清單 (例如「spaces/123」)。
resourceDataValues[]

ResourceData

資源資料。
emailAddressValues[]

string

電子郵件地址值。
googleUserValues[]

string

Google 使用者值，格式為 users/{user}。
textFormatValues[]

WorkflowTextFormatMarkup

工作流程文字格式值。

WorkflowValidationErrorAction

表示工作流程元素驗證失敗，並指出嚴重性。

欄位
severity

Severity

驗證錯誤的嚴重程度。

嚴重性

列舉
SEVERITY_UNSPECIFIED 未指定嚴重性。請勿使用。
WARNING 這項錯誤不嚴重，不會阻礙發布。
CRITICAL 這個錯誤相當嚴重，必須先修正才能發布。

WorkflowDataSourceMarkup

* 僅支援 Google Workspace Workflow，不支援 Google Chat 應用程式或 Google Workspace 外掛程式。

In a TextInput or SelectionInput widget with MULTI_SELECT type or a DateTimePicker, provide data source from Google.

欄位
includeVariables

bool

是否要在資料來源中加入上一個步驟的變數。
type

Type

資料來源類型。

類型

代表工作流程資料來源類型的列舉。

列舉
UNKNOWN 預設值。請勿使用。
USER Google Workspace 使用者。使用者只能查看及選取 Google Workspace 組織中的使用者。
SPACE 使用者加入的 Google Chat 聊天室。
USER_WITH_FREE_FORM 使用者可以選擇查看及選取 Google Workspace 組織中的現有成員，也可以手動輸入電子郵件地址或有效網域。

WorkflowTextFormatMarkup

包含多種格式選項的文字區塊，包括樣式、超連結和互動元素。

欄位
textFormatElements[]

TextFormatElement

文字格式元素集合。

方塊

文字格式的可點選方塊。

欄位
icon

Icon

方塊中顯示的圖示。
label

string

方塊中顯示的文字。
url

string

點選方塊後會前往的網址。

圖示

方塊中的圖示。

欄位
聯集欄位 icons。方塊中顯示的圖示。icons 只能是下列其中一項：
iconUrl

string

顯示託管於 HTTPS 網址的自訂圖示。

例如：

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

支援的檔案類型包括 .png 和 .jpg。
materialIconName

string

Google Material Design 圖示中定義的圖示名稱，例如 check_box。任何無效名稱都會遭到捨棄，並替換為空白字串，導致圖示無法顯示。

TextFormatElement

WorkflowTextFormatMarkup 訊息中的單一元素，可以是方塊、樣式文字、超連結或清單容器。

欄位
聯集欄位 element。此元素代表多個可能文字格式元素中的其中一個。element 只能是下列其中一項：
text

string

文字格式的文字。
chip

Chip

文字格式的可點選方塊。
styledText

StyledText

文字格式的樣式文字。
listContainer

ListContainer

文字格式的清單容器。

ListContainer

清單項目的容器，每個清單項目可包含多個 TextFormatElement。

欄位
listNestLevel

int64

清單的巢狀層級。頂層從 0 開始，每增加一個巢狀清單，值就會增加 1。
listType

ListType

清單類型。
listItems[]

ListItem

清單項目集合。

ListItem

清單項目。

欄位
textFormatElements[]

TextFormatElement

文字格式元素集合。

ListType

不同清單類型的列舉。

列舉
LIST_TYPE_UNSPECIFIED 未指定清單類型。
ORDERED 已排序的清單。
UNORDERED 未排序的清單。
BLOCKQUOTE 段落式引文清單。

StyledText

文字元素，具有粗體、斜體和顏色等樣式。

欄位
text

string

文字的主要內容。
styles[]

Style

套用至文字的樣式集合。
fontWeight

FontWeight

文字的字型粗細。
color

Color

文字的顏色。
wrapStyle

WrapStyle

文字的換行樣式。

FontWeight

不同字型粗細的列舉。

列舉
FONT_WEIGHT_UNSPECIFIED 標準粗細，厚度正常。
LIGHT 重量更輕，厚度更薄。
MEDIUM 介於細體和粗體之間的字重。
BOLD 重量更重，厚度更厚。

樣式

不同文字樣式的列舉，例如斜體、底線等。

列舉
STYLE_UNSPECIFIED 未套用任何樣式。
ITALIC 斜體樣式。
UNDERLINE 底線樣式。
STRIKETHROUGH 刪除線樣式。
LINE_BREAK 換行。
UPPERCASE 大寫樣式。
CODE Code.
CODE_BLOCK 程式碼區塊。

WrapStyle

不同換行樣式的列舉。

列舉
WRAP_STYLE_UNSPECIFIED 未指定換行樣式。
NO_WRAP 無換行樣式。