Package apps.extensions.markup

索引

CalendarClientActionMarkup

欄位
editAttendeesActionMarkup

EditAttendeesActionMarkup

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

editConferenceDataActionMarkup

EditConferenceDataActionMarkup

將會議資料新增至 Google 日曆活動的動作。第三方會議通訊外掛程式只能透過 Apps Script 建立。

addAttachmentsActionMarkup

AddAttachmentsActionMarkup

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

AddAttachmentsActionMarkup

欄位
addonAttachments[]

AddonAttachment

AddonAttachment

欄位
resourceUrl

string

title

string

附件的標題。

mimeType

string

resourceUrl 中內容的 MIME 類型。

iconUrl

string

資源圖示的連結。

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 個半形字元。必填。

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 聊天室項目做為項目。

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 關閉外掛程式 Compose 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 未設定 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

由 Google 日曆處理的動作。

driveAction

DriveClientActionMarkup

雲端硬碟處理的動作。

editorAction

EditorClientActionMarkup

由 Google 文件、試算表或簡報處理的操作

sheetsAction

SheetsClientActionMarkup

由試算表處理的動作。

HostAppDataSourceMarkup

針對使用複選選單的 SelectionInput 小工具,這是來自 Google Workspace 應用程式的資料來源。資料來源會填入複選選單的選項。

適用於 Google Chat 應用程式,但不適用於 Google Workspace 外掛程式。

欄位
聯集欄位 data_source。Google Workspace 應用程式,可為複選選單填入項目。data_source 只能是下列其中一項:
chatDataSource

ChatClientDataSourceMarkup

Google Chat 的資料來源。

SheetsClientActionMarkup

欄位
customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

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

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

Value

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

errorMessage

string

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