事件物件

本頁面說明 Google Workspace 外掛程式事件物件的結構。

事件物件是自動建構的 JSON 結構，使用者與外掛程式互動時，系統會將這些物件做為參數傳遞至觸發或回呼函式。事件物件會將主機應用程式和目前環境的用戶端資訊，傳送至外掛程式的伺服器端回呼函式。

Google Workspace 外掛程式會在下列位置使用事件物件：

  • 首頁觸發條件。 首頁觸發函式觸發時，系統會自動將事件物件傳遞至您定義的每個 homepageTrigger 函式。您可以在首頁觸發函式中使用這個物件，識別使用中的主機應用程式、用戶端平台、使用者語言代碼和其他資訊。

    首頁觸發時建立的事件物件不會包含其他兩種情況的所有欄位，而是會省略與小工具和情境資訊相關的欄位。

  • 內容觸發條件。 每個主機應用程式都會提供一組不同的情境觸發條件，使用者進入特定情境時就會觸發這些條件。例如：

    • Gmail 會在使用者開啟郵件時提供內容比對觸發條件，並在使用者撰寫郵件時提供另一個觸發條件。
    • Google 日曆會在使用者開啟活動時，提供情境觸發條件。
    • Google 雲端硬碟提供內容比對觸發條件，在使用者選取雲端硬碟檔案時觸發。

    當情境觸發條件觸發時，主機應用程式會呼叫外掛程式資訊清單中列出的對應 runFunction，並將事件物件做為參數傳遞。情境觸發條件觸發時建立的事件物件，包含首頁觸發事件物件中的所有欄位，以及包含情境資訊的欄位。

  • 小工具動作：活動物件也用於提供小工具互動功能，使用的動作模型與 Gmail 外掛程式相同。Google Workspace 外掛程式會使用所有相同的控制項處理函式、Action物件和動作回應。不過，在 Google Workspace 外掛程式中，動作事件物件包含更多回呼函式可執行的資訊。

    因小工具動作而建立的事件物件，包含背景觸發事件物件中的所有欄位，以及含有小工具資訊的欄位。

  • 預覽連結觸發條件。 在 Google 文件、試算表和簡報中，您可以根據特定網址模式，設定第三方服務的連結預覽畫面。當使用者與符合模式的連結互動時，linkPreviewTriggers 會觸發，且含有連結的事件物件會傳遞至觸發條件的回呼函式。外掛程式可以使用這個事件物件建構智慧型晶片和資訊卡，在主機應用程式中顯示連結相關資訊。您也可以建立小工具動作，讓使用者與預覽資訊卡及其內容互動。

  • Google Chat 應用程式觸發條件。 在 Google Chat 中，外掛程式會顯示為 Chat 應用程式，使用者可以將外掛程式新增至聊天室、傳送訊息及使用斜線指令等方式與外掛程式互動。如要建構互動式功能，請設定及使用各種 Chat 應用程式觸發條件。每個觸發條件都會傳送不同的事件物件酬載，協助您處理或回應每種互動。

事件物件結構

下表說明 Google Workspace 外掛程式事件物件的頂層結構。事件物件結構包含主機獨立資訊的 commonEventObject 頂層欄位。每個事件物件也可以有下列其中一個主機專屬的頂層欄位，具體取決於有效的主機應用程式：gmailEventObject、calendarEventObject 或 driveEventObject。

為確保回溯相容性，Google Workspace 外掛程式事件物件也包含 Gmail 外掛程式動作事件物件中使用的所有原始欄位。這些欄位列於下表「原始 Gmail 外掛程式欄位」下方； 這些欄位中的資訊會在新物件結構中重現。

事件物件
eventObject.commonEventObject Common fields object
物件，包含所有事件物件的通用資訊，無論主機應用程式為何。
eventObject.calendar Calendar event object
只有在通話主辦人是 Google 日曆時才會顯示。包含日曆和活動資訊的物件。
eventObject.chat Chat event object
只有在通話主辦人是 Google Chat 時才會顯示。包含 Chat 資訊的物件。
eventObject.drive Drive event object
只有在呼叫主機是 Google 雲端硬碟時才會顯示。包含雲端硬碟資訊的物件。
eventObject.gmail Gmail event object
只有在通話主辦人使用 Gmail 時才會顯示。包含 Gmail 資訊的物件。
eventObject.docs Docs event object
只有在呼叫主機是 Google 文件時才會顯示。包含文件資訊的物件。
eventObject.sheets Sheets event object
只有在呼叫主機是 Google 試算表時才會顯示。包含 Google 試算表資訊的物件。
eventObject.slides Slides event object
只有在通話發起者是 Google 簡報時才會顯示。包含 Google 簡報資訊的物件。
原始 Gmail 外掛程式欄位
eventObject.messageMetadata.accessToken string
已淘汰。存取權杖。您可以使用這項設定，透過暫時的 Gmail 外掛程式範圍啟用使用者資料存取權。

如果是 Google Workspace 外掛程式，請在 eventObject.gmail.accessToken 欄位中查看這項資訊。

eventObject.messageMetadata.messageId string
已淘汰。郵件串的郵件 ID， 在 Gmail 使用者介面中開啟。

如果是 Google Workspace 外掛程式，請在 eventObject.gmail.messageId 欄位中查看這項資訊。

eventObject.clientPlatform string
已淘汰。指出事件的來源 (網站、iOS 或 Android)。

如果是 Google Workspace 外掛程式，請在 eventObject.commonEventObject.platform 欄位中查看這項資訊。

eventObject.formInput object
已淘汰。卡片中所有表單小工具的目前值對應，每個小工具只能有一個值。索引鍵是與小工具相關聯的字串 ID，值則是字串。當您需要從多個具有預期單一值的 Widget (例如文字輸入和切換開關) 讀取資料時，事件物件會提供 formInput 做為便利的工具。如果是複選框等具有多個值的控制項，您可以改為從 formInputs 讀取每個值。

如果是 Google Workspace 外掛程式，請改為在eventObject.commonEventObject.formInputs欄位中尋找這項資訊；具有單一值的 widget 會以含有單一元素的陣列表示。

eventObject.formInputs object
已淘汰。資訊卡中目前小工具值的對應，以字串清單的形式呈現。這些鍵是與小工具相關聯的字串 ID。如果是單一值的小工具，值會以單一元素陣列呈現。如果是多值小工具 (例如核取方塊群組)，所有值都會顯示在清單中。

如果是 Google Workspace 外掛程式，請在 eventObject.commonEventObject.formInputs 欄位中查看這項資訊。

eventObject.parameters object
已淘汰。您提供給 Action 的任何其他參數對應，使用 Action.setParameters()。對應鍵和值為字串。

如果是 Google Workspace 外掛程式，請在 eventObject.commonEventObject.parameters 欄位中查看這項資訊。

eventObject.userCountry string
已淘汰，且預設為停用。由兩個字母組成的代碼，用來表示使用者的國家/地區。也可以是聯合國 M49 國家/地區代碼。

如果是 Google Workspace 外掛程式，請在「eventObject.commonEventObject.userLocale」欄位中查看這項資訊。
eventObject.userLocale string
已淘汰，且預設為停用。由兩個英文字母組成的 ISO 639 代碼，指出使用者的語言。詳情請參閱「存取使用者語言代碼和時區」。

如果是 Google Workspace 外掛程式，請在「eventObject.commonEventObject.userLocale」欄位中查看這項資訊。
eventObject.userTimezone.id string
已淘汰，且預設為停用。使用者時區的 時區 ID。例如：America/New_York、Europe/Vienna 和 Asia/Seoul。詳情請參閱「 存取使用者語言代碼和時區」。

如果是 Google Workspace 外掛程式，請在「eventObject.commonEventObject.timeZone.id」欄位中查看這項資訊。
eventObject.userTimezone.offset string
已淘汰，且預設為停用。使用者時區與世界標準時間 (UTC) 的時間差，以毫秒為單位。詳情請參閱「 存取使用者語言代碼和時區」。

如果是 Google Workspace 外掛程式，請在「eventObject.commonEventObject.timeZone.offset」欄位中查看這項資訊。

通用事件物件

通用事件物件是整體事件物件的一部分，可將一般資訊 (與主機無關) 從使用者用戶端傳送至外掛程式。這項資訊包括使用者的地區設定、主機應用程式和平台等詳細資料。

除了首頁和關聯觸發條件，外掛程式還會在使用者與小工具互動時，建構事件物件並傳遞至動作回呼函式。外掛程式的回呼函式可以查詢通用事件物件，判斷使用者用戶端中開啟的小工具內容。舉例來說，外掛程式可以找出使用者在 eventObject.commentEventObject.formInputs 物件的 TextInput 小工具中輸入的文字。

常見的事件物件欄位
commonEventObject.platform string
指出事件來源 (`WEB`、`IOS` 或 `ANDROID`)。
commonEventObject.formInputs object
這個地圖包含顯示卡片中，小工具的目前值。地圖鍵是分配給每個小工具的字串 ID。

地圖值物件的結構取決於小工具類型：

  • 單一值小工具 (例如文字方塊)：字串清單 (只有一個元素)。

    範例：如果文字輸入小工具的 ID 為 employeeName，請使用 e.commonEventObject.formInputs.employeeName.stringInputs.value[0] 存取文字輸入值。

  • 多值小工具 (例如核取方塊群組)：字串清單。

    範例：對於 ID 為 participants 的多值小工具，請使用 e.commonEventObject.formInputs.participants.stringInputs.value 存取值陣列。

  • A date-time picker：a DateTimeInput object。

    範例：如要存取 ID 為 myDTPicker 的選擇器，請使用 e.commonEventObject.formInputs.myDTPicker.dateTimeInput 存取 DateTimeInput 物件。

  • A date-only picker：a DateInput object。

    範例：如要存取 ID 為 myDatePicker 的選取器，請使用 e.commonEventObject.formInputs.myDatePicker.dateInput 存取 DateInput 物件。

  • A time-only picker：a TimeInput object。

    範例：如要存取 ID 為 myTimePicker 的選取器，請使用 e.commonEventObject.formInputs.myTimePicker.timeInput 存取 TimeInput 物件。
commonEventObject.hostApp string
：指出產生事件物件時，外掛程式啟用的主機應用程式。可能的值包括：
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
您使用 actionParameters 或 Action.setParameters() 為動作提供的任何其他參數。

開發人員預覽版： 如要擴充 Google Chat 的外掛程式，請根據使用者在多選式選單中輸入的內容建議項目，使用 "autocomplete_widget_query" 鍵的值 (event.commonEventObject.parameters["autocomplete_widget_query"])。您可以利用這個值查詢資料庫，並在使用者輸入內容時建議可選取的項目。詳情請參閱「收集及處理 Google Chat 使用者的資訊」。
commonEventObject.userLocale string
預設為停用。使用者語言和國家/地區 ID，格式為 ISO 639 語言代碼 - ISO 3166 國家/地區代碼。例如：en-US。

如要開啟這個欄位，您必須在外掛程式的資訊清單中將 addOns.common.useLocaleFromApp 設為 true。外掛程式的範圍清單也必須包含 https://www.googleapis.com/auth/script.locale。 詳情請參閱「 存取使用者語言代碼和時區」。
commonEventObject.timeZone string
預設為停用。時區 ID 和時差。如要開啟這個欄位，您必須在外掛程式的資訊清單中將 addOns.common.useLocaleFromApp 設為 true。外掛程式的範圍清單也必須包含 https://www.googleapis.com/auth/script.locale。 詳情請參閱「 存取使用者語言代碼和時區」。
commonEventObject.timeZone.id string
使用者時區的時區 ID。例如：America/New_York、Europe/Vienna 和 Asia/Seoul。如要開啟這個欄位，您必須在外掛程式的資訊清單中將 addOns.common.useLocaleFromApp 設為 true。 外掛程式的範圍清單也必須包含 https://www.googleapis.com/auth/script.locale。詳情請參閱「 存取使用者語言代碼和時區」。
commonEventObject.timeZone.offset string
使用者時區與世界標準時間 (UTC) 的時間差，以毫秒為單位。詳情請參閱「 存取使用者語言代碼和時區」。

日期時間挑選器表單輸入內容

動作回呼函式可以在 commonEventObject.formInputs 欄位中接收目前的小工具值。包括使用者在日期或時間選擇器小工具中選取的日期或時間值。不過，資訊結構會因小工具設定為日期時間挑選器、僅限日期的挑選器或僅限時間的挑選器而異。下表說明結構差異：

DateTimeInput 物件
dateTimeInput.hasDate 如果輸入的日期時間包含日期，則為 boolean
true；如果 false 只包含時間，則為 false。
dateTimeInput.hasTime 如果輸入的日期時間包含時間，則為 boolean
true；如果 false 只包含日期，則為 false。
dateTimeInput.msSinceEpoch string
使用者選取的時間，以自 Epoch 紀元時間 (1970 年 1 月 1 日世界標準時間 00:00:00) 起算的毫秒為單位。
DateInput 物件
dateInput.msSinceEpoch string
使用者選取的時間，以自 Epoch 紀元時間 (1970 年 1 月 1 日世界標準時間 00:00:00) 起算的毫秒為單位。
TimeInput 物件
timeInput.hours number
使用者選取的小時數。
timeInput.minutes number
使用者選取的分鐘數。

Chat 事件物件

Chat 事件物件是整體事件物件的一部分，其中包含使用者與 Chat 擴充應用程式互動的相關資訊。只有在外掛程式擴充 Google Chat 時，事件物件中才會出現這個物件。

即時通訊
chat.user object (User)
與 Chat 應用程式互動的 Chat 使用者。
chat.space object (Space)
使用者與 Chat 應用程式互動的 Chat 聊天室。
chat.eventTime

string (Timestamp format)

互動發生的時間。

聯集欄位 payload。

payload 只能是下列其中一項：
chat.messagePayload

object (MessagePayload)

Chat 應用程式從訊息觸發條件收到的酬載。
chat.addedToSpacePayload

object (AddedToSpacePayload)

Chat 應用程式從「已新增至聊天室」觸發條件收到的酬載。
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Chat 應用程式從「從聊天室中移除」觸發條件收到的酬載。
chat.buttonClickedPayload

object (ButtonClickedPayload)

使用者點選訊息或資訊卡中的按鈕時，Chat 應用程式收到的酬載。如果使用者點選按鈕提交資訊，commonEventObject.formInputs 物件會包含從使用者收集的值。詳情請參閱「 收集 Google Chat 使用者的資訊」。
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

當使用者在 selectionInput 小工具的多選選單中輸入文字時，Chat 應用程式會收到的酬載。聊天應用程式可以使用這個事件物件，從動態資料來源填入建議項目。舉例來說，如要從外部資料來源填入支援案件，Chat 應用程式可以根據使用者在選單中輸入的內容查詢資料來源，然後傳回任何相符的支援案件做為可選取的項目。

CommonEventObject.parameters['autocomplete_widget_query'] 物件包含使用者在選單中輸入的字串值。

chat.appCommandPayload

object (AppCommandPayload)

使用者透過 Chat 應用程式下達指令時，Chat 應用程式收到的酬載。

酬載

視 Chat 應用程式互動類型而定，事件會包含一或多個 Chat API 資源的酬載。

訊息酬載
MessagePayload
chat.messagePayload.message object (Message)
觸發事件的 Chat 訊息。
chat.messagePayload.space object (Space)
使用者傳送訊息的 Chat 聊天室，該訊息會叫用 Chat 應用程式。
chat.messagePayload.configCompleteRedirectUri string
使用者在 Google Chat 以外完成授權或設定流程後，Chat 應用程式應將使用者重新導向至這個網址。詳情請參閱將 Google Workspace 外掛程式連結至第三方服務。

已新增至聊天室酬載
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
使用者新增或安裝 Chat 應用程式的 Chat 聊天室。

管理員安裝 Chat 擴充應用程式時， space.adminInstalled 欄位會設為 true。

chat.addedToSpacePayload.interactionAdd boolean
使用者是否透過訊息將 Chat 應用程式新增至聊天室。例如 @提及 Chat 應用程式或使用指令。 如果 true，Chat 會傳送另一個事件物件，其中包含訊息相關資訊的 messagePayload。
chat.addedToSpacePayload.configCompleteRedirectUri string
使用者在 Google Chat 以外完成授權或設定流程後，Chat 應用程式應將使用者重新導向至這個網址。詳情請參閱將 Google Workspace 外掛程式連結至第三方服務。

從聊天室酬載中移除
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
使用者移除或解除安裝 Chat 應用程式的 Chat 聊天室。

管理員解除安裝 Chat 應用程式時，space.adminInstalled 欄位會設為 false。

已點選按鈕的酬載
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
使用者點選的按鈕所在的即時通訊訊息。
chat.buttonClickedPayload.space object (Space)
使用者在 Chat 應用程式訊息中點選按鈕的 Chat 聊天室。
chat.buttonClickedPayload.isDialogEvent boolean
使用者是否點選按鈕與對話方塊互動。
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
如果 isDialogEvent 為 true，則為對話方塊中的互動類型。

列舉 DialogEventType。

dialogEventType 的值只能是下列其中一項：
TYPE_UNSPECIFIED 預設值。未指明
REQUEST_DIALOG 使用者要求對話。舉例來說，他們使用指令或點選訊息中的按鈕。
SUBMIT_DIALOG 使用者點選對話方塊中的互動式元素。舉例來說，使用者在對話方塊中填寫資訊，然後點選按鈕提交資訊。

小工具更新酬載
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
發生互動的 Chat 聊天室。

應用程式指令酬載
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
使用者使用的指令，以及觸發指令的方式等中繼資料。
chat.appCommandPayload.space object (Space)
使用者下達指令的 Chat 聊天室。
chat.appCommandPayload.thread object (Thread)
如果互動發生在討論串中，則為使用者下達指令的 Chat 討論串。
chat.appCommandPayload.message object (Message)
如果是斜線指令，則為包含斜線指令的訊息。
chat.appCommandPayload.configCompleteRedirectUri string
如果指令需要授權或設定，使用者在 Google Chat 以外完成程序後，系統會將他們重新導向至這個網址。
chat.appCommandPayload.isDialogEvent boolean
指令是否會開啟對話方塊。
chat.appCommandPayload.dialogEventType enum (DialogEventType)
與對話方塊的互動類型。

列舉 DialogEventType。

dialogEventType 的值只能是下列其中一項：
TYPE_UNSPECIFIED 預設值。未指明
REQUEST_DIALOG 使用者要求對話。舉例來說，他們使用指令或點選訊息中的按鈕。
SUBMIT_DIALOG 使用者點選對話方塊中的互動式元素。舉例來說，使用者在對話方塊中填寫資訊，然後點選按鈕提交資訊。
應用程式指令中繼資料
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

指令 ID。
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
指令類型。

列舉 AppCommandType。

AppCommandType 的值只能是下列其中一項：
APP_COMMAND_TYPE_UNSPECIFIED 預設值。未指明
SLASH_COMMAND 使用者傳送以斜線 / 開頭的訊息，即可使用指令。
QUICK_COMMAND 使用者在訊息回覆區的 Chat 選單中選取指令。

日曆活動物件

日曆活動物件是整體活動物件的一部分，可攜帶使用者日曆和日曆活動的相關資訊。只有在外掛程式擴充 Google 日曆時，活動物件中才會出現這個屬性。

下表列出事件物件 calendarEventObject 欄位中的欄位。如果日曆活動中含有資料，且外掛程式將其addOns.calendar.currentEventAccess 資訊清單欄位設為 READ 或 READ_WRITE，則事件物件中會顯示標示為「使用者產生的資料」的欄位。

的資訊為準。
日曆活動物件
calendar.attendees[] list of attendee objects
使用者自製內容。日曆活動的參與者清單。
calendar.calendarId string
日曆 ID。
calendar.capabilities object
使用者自製內容。物件，說明外掛程式查看或更新活動資訊的功能。
calendar.capabilities.canAddAttendees boolean
使用者自製內容。true 如果外掛程式可將新參與者新增至活動參與者清單； false 否則。
calendar.capabilities.canSeeAttendees boolean
使用者自製內容。true 如果外掛程式可以讀取活動出席者名單；false 否則。
calendar.capabilities.canSeeConferenceData boolean
使用者自製內容。true 如果外掛程式可以讀取活動會議資料；false 否則。
calendar.capabilities.canSetConferenceData boolean
使用者自製內容。true 如果外掛程式可以更新活動會議資料；false 否則。
calendar.capabilities.canAddAttachments boolean
使用者自製內容。true 如果外掛程式可以在活動中新增附件； 否則為 false。
calendar.conferenceData Conference data object
使用者自製內容。代表與此活動相關聯的任何會議資料的物件，例如 Google Meet 會議詳細資料。
calendar.id string
活動 ID。
calendar.organizer object
代表活動主辦者的物件。
calendar.organizer.email string
活動主辦人的電子郵件地址。
calendar.recurringEventId string
週期性活動的 ID。

與會者

與會者物件會將個別與會者的資訊傳送至 Google 日曆活動。只有在日曆活動中提供資料，且外掛程式將其addOns.calendar.currentEventAccess 資訊清單欄位設為 READ 或 READ_WRITE 時，活動物件中才會顯示這項資訊。

參與者物件
attendee.additionalGuests number
受邀者表示會攜伴出席的人數。預設值為零。
attendee.comment string
與會者的回覆留言 (如有)。
attendee.displayName string
與會者的顯示名稱。
attendee.email string
出席者的電子郵件地址。
attendee.optional 如果將這位出席者的出席狀態標示為可不出席，則為 boolean
true；否則為 false。
attendee.organizer boolean
true 如果與會者是這項活動的發起人。
attendee.resource boolean
true 如果出席者代表資源 (例如會議室或設備)；false 否則。
attendee.responseStatus string
出席者的回覆狀態。可能的值包括：
  • accepted：與會者已接受活動邀請。
  • declined：與會者已拒絕活動邀請。
  • needsAction：受邀者尚未回覆活動邀請。
  • tentative：受邀者已暫時接受活動邀請。
attendee.self boolean
true 如果這個參與者代表這個活動顯示的日曆；false否則。

會議資料

會議資料物件會攜帶附加至 Google 日曆活動的會議資訊。可以是 Google 會議解決方案 (例如 Google Meet)，也可以是第三方會議。只有在日曆活動中提供資料，且外掛程式將 addOns.calendar.currentEventAccess 資訊清單欄位設為 READ 或 READ_WRITE 時，活動物件中才會顯示這項資訊。

會議資料物件
conferenceData.conferenceId string
會議的 ID。這個 ID 可供應用程式追蹤會議，請勿向使用者顯示這個 ID。
conferenceData.conferenceSolution object
代表會議解決方案的物件，例如 Hangouts 或 Google Meet。
conferenceData.conferenceSolution.iconUri string
使用者可見的圖示 URI，代表這個會議解決方案。
conferenceData.conferenceSolution.key object
可專屬識別此活動會議解決方案的金鑰。
conferenceData.conferenceSolution.key.type string
會議解決方案類型。可能的值包括：
  • eventHangout 消費者版 Hangouts (http://hangouts.google.com)。
  • eventNamedHangout，供 Google Workspace 使用者使用傳統版 Hangouts (http://hangouts.google.com)。
  • hangoutsMeet (http://meet.google.com)。
conferenceData.conferenceSolution.name string
使用者看到的會議解決方案名稱 (未本地化)。
conferenceData.entryPoints[] list of entry point objects
會議進入點清單，例如網址或電話號碼。
conferenceData.notes string
要向使用者顯示的會議相關附註 (例如網域管理員的指示或法律聲明)。可包含 HTML。長度上限為 2048 個字元。
conferenceData.parameters object
物件：內含定義的參數資料對應表，供外掛程式使用。
conferenceData.parameters.addOnParameters object
參數字串鍵和值的對應。 外掛程式開發人員會定義這些鍵和值，以便將資訊附加至特定會議，供外掛程式使用。

進入點

進入點物件會攜帶有關既定會議存取方式的資訊，例如透過電話或視訊存取。只有在日曆活動中提供資料，且外掛程式將 addOns.calendar.currentEventAccess 資訊清單欄位設為 READ 或 READ_WRITE 時，活動物件中才會顯示這項資訊。

進入點物件
entryPoint.accessCode string
用來存取會議的存取代碼。 長度上限為 128 個半形字元。會議服務供應商通常只會使用 {accessCode、meetingCode、passcode、password、pin} 的子集，提供會議存取權。比對會議供應商使用的欄位，並只顯示這些欄位。
entryPoint.entryPointFeatures list
進入點的特徵。目前這些功能僅適用於 phone 進入點：
  • toll：進入點是付費電話通話。
  • toll_free：進入點是免付費電話。
entryPoint.entryPointType string
進入點類型。可能的值包括： 下列值：
  • more：其他會議加入說明，例如備用電話號碼。會議只能有一個 more 進入點；如果存在，則至少還需要另一種進入點。
  • phone：透過電話號碼加入會議。會議可以有零或多個 phone 進入點。Google 日曆只會顯示前兩個電話號碼， 且會先格式化並依字母順序排序。
  • sip：透過 SIP 加入會議。一場會議最多只能有一個 sip 進入點。
  • video：透過 HTTP 加入會議。一場會議最多只能有一個 video 進入點。
entryPoint.label string
進入點 URI 的使用者可見標籤 (未本地化)。
entryPoint.meetingCode string
用於存取會議的會議代碼。 長度上限為 128 個半形字元。會議服務供應商通常只會使用 {accessCode、meetingCode、passcode、password、pin} 的子集，提供會議存取權。比對會議供應商使用的欄位，並只顯示這些欄位。
entryPoint.passcode string
用於存取會議的密碼。 長度上限為 128 個半形字元。會議服務供應商通常只會使用 {accessCode、meetingCode、passcode、password、pin} 的子集，提供會議存取權。比對會議供應商使用的欄位，並只顯示這些欄位。
entryPoint.password string
用於存取會議的密碼。 長度上限為 128 個半形字元。會議服務供應商通常只會使用 {accessCode、meetingCode、passcode、password、pin} 的子集，提供會議存取權。比對會議供應商使用的欄位，並只顯示這些欄位。
entryPoint.pin string
用來存取電話會議的 PIN 碼。 長度上限為 128 個半形字元。會議服務供應商通常只會使用 {accessCode、meetingCode、passcode、password、pin} 的子集，提供會議存取權。比對會議供應商使用的欄位，並只顯示這些欄位。
entryPoint.regionCode string
電話號碼的區域代碼。如果 URI 未包含國家/地區代碼，使用者就必須提供此資訊。值是根據 公開 CLDR 地區代碼清單而定。
entryPoint.uri string
進入點的 URI。長度上限為 1300 個半形字元。格式會因進入點類型而異：
  • more：必須提供 http: 或 https: 結構定義。
  • phone：必須提供 tel: 架構。URI 應包含完整撥號順序 (例如「tel:+12345678900,,,12345678;1234」)。
  • sip：必須使用 sip: 或 sips: 結構定義。例如「sip:[email protected]」。
  • video：必須提供 http: 或 https: 結構定義。

雲端硬碟事件物件

Google 雲端硬碟事件物件是整體事件物件的一部分，可攜帶使用者的 Google 雲端硬碟及其內容相關資訊。只有在外掛程式擴充 Google 雲端硬碟時，事件物件中才會出現這個屬性。

雲端硬碟事件物件
drive.activeCursorItem Drive item object
目前已啟用雲端硬碟項目。
drive.selectedItems[] list of Drive item objects
在雲端硬碟中選取的項目 (檔案或資料夾) 清單。

雲端硬碟項目

雲端硬碟項目物件會攜帶特定雲端硬碟項目的相關資訊，例如檔案或資料夾。

雲端硬碟項目物件
item.addonHasFileScopePermission boolean
如果 true，外掛程式已要求並取得這個項目的 https://www.googleapis.com/auth/drive.file 範圍授權；否則這個欄位為 false。
item.id string
所選項目的 ID。
item.iconUrl string
代表所選項目的圖示網址。
item.mimeType string
所選項目的 MIME 類型。
item.title string
所選項目的標題。

Gmail 事件物件

Gmail 事件物件是整體事件物件的一部分，其中包含使用者 Gmail 郵件的相關資訊。只有在主機應用程式為 Gmail 時，活動物件中才會出現這項屬性。

Gmail 事件物件
gmail.accessToken string
Gmail 專用的存取權杖。您可以搭配 GmailApp.setCurrentMessageAccessToken(accessToken) 方法使用這個權杖，授予外掛程式暫時存取權，讓外掛程式存取使用者目前開啟的 Gmail 郵件，或讓外掛程式撰寫新的草稿。
gmail.bccRecipients[] list of strings
預設為停用。外掛程式目前正在撰寫的草稿中，包含「密件副本：」收件者電子郵件地址的清單。如要開啟這個欄位，請在資訊清單中將 addOns.gmail.composeTrigger.draftAccess 欄位設為 METADATA。
gmail.ccRecipients[] list of strings
預設為停用。外掛程式目前正在撰寫的草稿中，包含「副本：」收件者的電子郵件地址清單。如要開啟這個欄位，請在資訊清單中將 addOns.gmail.composeTrigger.draftAccess 欄位設為 METADATA。
gmail.messageId string
目前開啟的 Gmail 郵件 ID。
gmail.threadId string
目前開啟的 Gmail 郵件串 ID。
gmail.toRecipients[] list of strings
預設為停用。外掛程式目前正在撰寫草稿，其中包含「收件者」電子郵件地址清單。如要開啟這個欄位，請在資訊清單中將 addOns.gmail.composeTrigger.draftAccess 欄位設為 METADATA。

文件事件物件

Docs 事件物件是整體事件物件的一部分，其中包含使用者文件及其內容的相關資訊。只有在外掛程式擴充 Google 文件時，事件物件中才會出現這項屬性。

文件事件物件
docs.id string
只有在 https://www.googleapis.com/auth/drive.file範圍已獲得使用者授權時才會顯示。
在 Google 文件使用者介面中開啟的文件 ID。
docs.title string
只有在使用者授權 https://www.googleapis.com/auth/drive.file 範圍時才會顯示。
在 Google 文件使用者介面中開啟的文件標題。
docs.addonHasFileScopePermission boolean
如果 true，外掛程式已要求並收到 https://www.googleapis.com/auth/drive.file，表示已獲得在 Google 文件使用者介面中開啟文件的授權；否則這個欄位為 false。true
docs.matchedUrl.url string
只有在符合下列條件時才會顯示：
  • https://www.googleapis.com/auth/workspace.linkpreview 已獲得使用者授權。
  • 網址符合 LinkPreviewTriggers 觸發條件中指定的主機模式。

這個連結的網址會在 Google 文件中產生預覽畫面。如要使用這個欄位，請在外掛程式的資訊清單中設定 LinkPreviewTriggers。詳情請參閱「使用智慧型方塊預覽連結」。

使用者預覽連結 https://www.example.com/12345 時的酬載範例： 

"docs" : {   "matchedUrl" : {       "url" : "https://www.example.com/12345"   } }

Google 試算表事件物件

Sheets 事件物件是整體事件物件的一部分，其中包含使用者文件及其內容的相關資訊。只有在外掛程式擴充 Google 試算表時，事件物件中才會顯示這項屬性。

Google 試算表事件物件
sheets.id string
只有在使用者授權 https://www.googleapis.com/auth/drive.file 範圍時才會顯示。在 Google 試算表使用者介面中開啟的試算表 ID。
sheets.title string
只有在使用者授權 https://www.googleapis.com/auth/drive.file 範圍時才會顯示。在 Google 試算表 UI 中開啟的試算表標題。
sheets.addonHasFileScopePermission boolean
如果 true，外掛程式已要求並取得 https://www.googleapis.com/auth/drive.file 範圍授權，可存取在 Google 試算表使用者介面中開啟的試算表；否則這個欄位為 false。
sheets.matchedUrl.url string
只有在符合下列條件時才會顯示：
  • https://www.googleapis.com/auth/workspace.linkpreview 已獲得使用者授權。
  • 網址符合 LinkPreviewTriggers 觸發條件中指定的主機模式。

在 Google 試算表中產生預覽畫面的連結網址。如要使用這個欄位，請在外掛程式的資訊清單中設定 LinkPreviewTriggers。詳情請參閱「使用智慧型方塊預覽連結」。

使用者預覽連結 https://www.example.com/12345 時的酬載範例：

"sheets" : {   "matchedUrl" : {       "url" : "https://www.example.com/12345"   } }

Google 簡報事件物件

「Google 簡報」事件物件是整體事件物件的一部分，其中包含使用者文件及其內容的相關資訊。只有在外掛程式擴充 Google 簡報時，事件物件中才會出現這個屬性。

Google 簡報事件物件
slides.id string
只有在使用者授權 https://www.googleapis.com/auth/drive.file 範圍時才會顯示。在 Google 簡報使用者介面中開啟的簡報 ID。
slides.title string
只有在使用者授權 https://www.googleapis.com/auth/drive.file 範圍時才會顯示。在 Google 簡報使用者介面中開啟的簡報標題。
slides.addonHasFileScopePermission boolean
如果 true，外掛程式已要求並收到 https://www.googleapis.com/auth/drive.file 簡報範圍授權，可存取在 Google 簡報使用者介面中開啟的簡報；否則這個欄位為 false。
slides.matchedUrl.url string
只有在符合下列條件時才會顯示：
  • https://www.googleapis.com/auth/workspace.linkpreview 已獲得使用者授權。
  • 網址符合 LinkPreviewTriggers 觸發條件中指定的主機模式。

這個連結的網址會在 Google 簡報中產生預覽畫面。如要使用這個欄位，您必須在外掛程式的資訊清單中設定 LinkPreviewTriggers。 詳情請參閱「使用智慧型方塊預覽連結」。

使用者預覽連結 https://www.example.com/12345 時的酬載範例：

"slides" : {   "matchedUrl" : {       "url" : "https://www.example.com/12345"   } }