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

欄位
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 介面」。

欄位
聯集欄位 actionGoogle 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 關閉外掛程式的 Compose UI。

OpenCreatedDraftActionMarkup

欄位
draftId

string

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

draftStorageId

string

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

draftThreadServerPermId

string

草稿執行緒的伺服器永久 ID。這個欄位不會在任何地方設定,處理 OpenCreatedDraftActionMarkup 時也會遭到忽略。請改為提供及使用草稿執行緒儲存空間 ID。

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

Google 日曆處理的動作。

driveAction

DriveClientActionMarkup

雲端硬碟處理的動作。

editorAction

EditorClientActionMarkup

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

sheetsAction

SheetsClientActionMarkup

由 Google 試算表處理的動作。

HostAppDataActionMarkup

定義如何更新 Google Workspace 資料。

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

ChatDataActionMarkup

Google Chat 動作,可在訊息中建立或更新文字或資訊卡。

HostAppDataSourceMarkup

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

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

ChatClientDataSourceMarkup

Google Chat 的資料來源。

SheetsClientActionMarkup

下一個 ID:5。

欄位

聯集欄位 action

action 只能是下列其中一項:

customFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

CustomFunctionReturnValueMarkup

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

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

Value

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

errorMessage

string

如果發生錯誤,要向使用者顯示的錯誤訊息。