本頁面概略說明 Google Workspace 外掛程式事件物件的結構。
事件物件是 JSON 結構,會自動建構並做為參數傳遞,以便在使用者與外掛程式互動時觸發或回呼函式。事件物件會將主機應用程式的用戶端資訊與目前結構定義資訊帶入外掛程式的伺服器端回呼函式。
Google Workspace 外掛程式會在下列位置使用事件物件:
首頁觸發條件:首頁觸發函式觸發時,您定義的每個
homepageTrigger
函式都會自動傳遞事件物件。您可以在首頁觸發條件函式中使用這個物件來識別啟用中的主機應用程式、用戶端平台、使用者語言代碼和其他資訊。首頁觸發事件啟動時建立的事件物件,不包含其他兩種情況中的所有欄位;與小工具和情境資訊相關的欄位會遭到省略。
內容比對觸發條件:每個主機應用程式都提供一組不同的內容相關觸發條件,會在使用者進入特定情境時觸發。例如:
- 當使用者開啟郵件,以及使用者撰寫郵件時,Gmail 會提供內容比對觸發條件。
- Google 日曆會針對使用者開啟活動時提供內容比對觸發條件。
- 使用者選取雲端硬碟檔案時,Google 雲端硬碟會提供關聯觸發條件。
內容相關觸發條件啟動時,主機應用程式會呼叫外掛程式資訊清單中列出的對應
runFunction
,並將事件物件做為參數傳遞。內容比對觸發條件觸發時建立的事件物件,包含首頁觸發事件物件中包含的所有欄位,以及包含情境資訊的欄位。小工具動作。事件物件也能使用與 Gmail 外掛程式相同的動作模型,提供小工具互動。Google Workspace 外掛程式使用相同的小工具處理常式函式、
Action
物件和動作回應,不過,在 Google Workspace 外掛程式中,動作事件物件會提供更多資訊,讓回呼函式可執行動作。因為小工具動作而建立的事件物件,會包含相關觸發事件物件中的所有欄位,以及包含小工具資訊的欄位。
預覽連結觸發條件:在 Google 文件、試算表和簡報中,您可以根據特定網址模式設定第三方服務的連結預覽。當使用者與符合模式的連結互動時,系統會觸發
linkPreviewTriggers
,並將含有連結的事件物件傳遞至觸發條件的回呼函式。外掛程式可以使用這個事件物件建構智慧型方塊和資訊卡,在主機應用程式內顯示該連結的相關資訊。您也可以建構小工具動作,讓使用者能與預覽資訊卡和內容互動。
事件物件結構
下表說明 Google Workspace 外掛程式事件物件的頂層結構。事件物件結構包含 commonEventObject
頂層欄位,用來提供主機獨立資訊。每個事件物件也可能有下列其中一個主機專用頂層欄位 (由使用中的主機應用程式決定):gmailEventObject
、calendarEventObject
或 driveEventObject
。
為了回溯相容,Google Workspace 外掛程式事件物件也會包含 Gmail 外掛程式動作事件物件中使用的所有原始欄位。「原始 Gmail 外掛程式欄位」下方的表格列出這些欄位,這些欄位中的資訊都是以新的物件結構呈現。
事件物件 | |
---|---|
eventObject.commonEventObject |
Common fields object
包含所有事件物件通用資訊的物件,無論主機應用程式為何。 |
eventObject.calendar |
Calendar event object
只有在通話主辦人是 Google 日曆時才會顯示。包含日曆和活動資訊的物件。 |
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 試算表時才會顯示。包含試算表資訊的物件。 |
eventObject.slides |
Slides event object
只有在通話主辦人是 Google 簡報時才會顯示。包含簡報資訊的物件。 |
原始 Gmail 外掛程式欄位 | |
eventObject.messageMetadata.accessToken |
string 已淘汰。存取權杖。您可以使用這項功能,透過臨時 Gmail 外掛程式範圍啟用使用者資料的存取權。
如果是 Google Workspace 外掛程式,請在 |
eventObject.messageMetadata.messageId |
string 已淘汰。在 Gmail UI 中開啟的討論串訊息 ID。
如果是 Google Workspace 外掛程式,請在 |
eventObject.clientPlatform |
string 已淘汰。表示事件的來源 (網頁、iOS 或 Android)。
如果是 Google Workspace 外掛程式,請在 |
eventObject.formInput |
object 已淘汰。資訊卡中所有表單小工具目前值的對應,每個小工具只能有一個值。索引鍵是與小工具相關聯的字串 ID,值則是字串。當您需要從多個含有預期單一值的小工具 (例如文字輸入和切換按鈕) 讀取資料時,事件物件提供 formInput 方便您使用。如果是核取方塊等多值小工具,您可以改為讀取 formInputs 中的每個值。
如果是 Google Workspace 外掛程式,請改為在 |
eventObject.formInputs |
object 已淘汰。資訊卡中小工具目前值的對應,以字串清單呈現。這些索引鍵是與小工具相關聯的字串 ID。如果是單一值小工具,這個值會顯示在單一元素陣列中。如果是多值小工具 (例如核取方塊群組),所有值都會顯示在清單中。
如果是 Google Workspace 外掛程式,請在 |
eventObject.parameters |
object 已淘汰。您使用 Action.setParameters() 提供給
Action 的任何其他參數對應。對應鍵和值為字串。
如果是 Google Workspace 外掛程式,請在 |
eventObject.userCountry |
string 已淘汰並預設為停用。以雙字母代碼表示使用者所在的國家/地區。也可以使用數字的 UN M49 國家/地區代碼。
如果是 Google Workspace 外掛程式,請在 |
eventObject.userLocale |
string 已淘汰並預設為停用。由兩個字母組成的 ISO 639 代碼,用來表示使用者的語言。詳情請參閱「存取使用者的語言代碼和時區」。
如果是 Google Workspace 外掛程式,請在 |
eventObject.userTimezone.id |
string 已淘汰並預設為停用。使用者時區的 時區 ID。例如: America/New_York 、Europe/Vienna 和 Asia/Seoul 。詳情請參閱「
存取使用者的語言代碼和時區」。
如果是 Google Workspace 外掛程式,請在 |
eventObject.userTimezone.offset |
string 已淘汰並預設為停用。使用者時區的 時間偏移 (UTC),以毫秒為單位。詳情請參閱「 存取使用者的語言代碼和時區」。
如果是 Google Workspace 外掛程式,請在 |
常見事件物件
常見事件物件是整個事件物件的一部分,會將主機獨立資訊收集自使用者用戶端的外掛程式。這類資訊包括使用者的語言代碼、主機應用程式和平台等詳細資料。
除了首頁和內容相關觸發條件外,外掛程式也會在使用者與小工具互動時,建構事件物件並傳送至動作回呼函式。外掛程式的回呼函式可查詢一般事件物件,以判斷使用者用戶端中開啟的小工具內容。舉例來說,外掛程式可以找出使用者在 eventObject.commentEventObject.formInputs
物件中的 TextInput
小工具中輸入的文字。
常見事件物件欄位 | |
---|---|
commonEventObject.platform |
string 表示事件的來源 (「WEB」、「IOS」或「ANDROID」)。 |
commonEventObject.formInputs |
object 包含顯示資訊卡中小工具目前值的地圖。這些對應鍵是指派給各個小工具的字串 ID。 對應值物件的結構取決於小工具類型:
|
commonEventObject.hostApp |
string 表示在產生事件物件時,外掛程式是否已啟用。可能的值如下:
|
commonEventObject.parameters |
object 您使用
Action.setParameters() 提供給
Action 的任何其他參數。 |
commonEventObject.userLocale |
string 預設為停用。使用者的語言和國家/地區 ID,格式為 ISO 639 語言代碼、ISO 3166 國家/地區代碼。例如 en-US 。
如要啟用這個欄位,您必須在外掛程式的資訊清單中,將 |
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
欄位中接收目前的小工具值。這包括使用者在日期或時間挑選器小工具中選取的日期或時間值。但是,資訊結構會因小工具設定為日期時間挑選器、僅限日期挑選器或僅限時間的挑選器而不同。下表說明其結構差異:
日曆活動物件
日曆活動物件是整個事件物件的一部分,包含使用者日曆和日曆活動的相關資訊。它只有在主機應用程式為 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
manifest 欄位設為 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 參與者的回覆狀態。可能的值如下:
|
attendee.self |
boolean true :如果這位參與者代表活動所屬的日曆,則傳回 false 。
|
會議資料
會議資料物件包含在 Google 日曆活動中附加的會議相關資訊。這些解決方案可能是 Google 會議解決方案,例如 Google Meet 或第三方會議。只有在日曆活動中存在資料,且外掛程式會將其 addOns.calendar.currentEventAccess
manifest 欄位設為 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 會議解決方案類型。可能的值如下:
|
conferenceData.conferenceSolution.name |
string 使用者看到的會議解決方案名稱 (未本地化)。 |
conferenceData.entryPoints[] |
list of entry point objects
會議進入點清單,例如網址或電話號碼。 |
conferenceData.notes |
string 要向使用者顯示會議的其他附註 (例如來自網域管理員或法律聲明的指示)。可以包含 HTML。長度上限為 2,048 個半形字元。 |
conferenceData.parameters |
object 包含已定義參數資料地圖的物件,可供外掛程式使用。 |
conferenceData.parameters.addOnParameters |
object 參數字串鍵和值的對應表。這些鍵和值是由外掛程式開發人員定義,可在特定會議中附加供外掛程式使用的資訊。 |
進入點
進入點物件會提供存取特定會議建立方式的相關資訊,例如透過電話或視訊。只有在日曆活動中存在資料,且外掛程式將其 addOns.calendar.currentEventAccess
manifest 欄位設為 READ
或 READ_WRITE
時,事件物件中才會顯示這項資訊。
進入點物件 | |
---|---|
entryPoint.accessCode |
string 用來存取會議的存取碼。 長度上限為 128 個半形字元。會議服務供應商通常只使用 { accessCode 、meetingCode 、passcode 、password 、pin } 的子集提供會議存取權。比對,而且一律只顯示會議服務供應商使用的欄位。 |
entryPoint.entryPointFeatures |
list 進入點的功能。這些功能目前僅適用於 phone 進入點:
|
entryPoint.entryPointType |
string 進入點的類型。可能的值如下:
|
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 個半形字元。格式設定視進入點類型而定:
|
雲端硬碟事件物件
雲端硬碟事件物件是整個事件物件的一部分,包含使用者的 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 。 |
文件事件物件
文件事件物件是整體事件物件的一部分,包含使用者文件及其內容的相關資訊。只有在主機應用程式為 Google 文件時,才會出現在事件物件中。
文件事件物件 | |
---|---|
docs.id |
string 只有在使用者授權
https://www.googleapis.com/auth/drive.file 範圍時才會顯示。文件 ID 會在文件 UI 中開啟。 |
docs.title |
string 只有在使用者授權
https://www.googleapis.com/auth/drive.file 範圍時才會顯示。文件標題會在文件 UI 中開啟。 |
docs.addonHasFileScopePermission |
boolean 如果設為 true ,外掛程式已要求並收到 https://www.googleapis.com/auth/drive.file 範圍授權,以便在文件 UI 中開啟的文件,否則這個欄位會是 false 。 |
docs.matchedUrl.url |
string
只有在符合下列條件時才會顯示:
可在 Google 文件中產生預覽畫面的連結網址。如要使用這個欄位,您必須在外掛程式的資訊清單中設定 LinkPreviewTriggers 。詳情請參閱「預覽含有智慧型方塊的連結」一文。
使用者預覽 "docs" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |
試算表事件物件
試算表事件物件是整體事件物件的一部分,包含使用者文件及其內容的相關資訊。只有在主機應用程式為 Google 試算表時,這個物件才會出現在事件物件中。
試算表事件物件 | |
---|---|
sheets.id |
string 只有在使用者授權
https://www.googleapis.com/auth/drive.file 範圍時才會顯示。在試算表 UI 中開啟的試算表 ID。
|
sheets.title |
string 只有在使用者授權
https://www.googleapis.com/auth/drive.file 範圍時才會顯示。系統會在試算表 UI 中開啟試算表標題。 |
sheets.addonHasFileScopePermission |
boolean 如果設為 true ,外掛程式已要求並收到 https://www.googleapis.com/auth/drive.file 範圍授權,以便在試算表 UI 中開啟的試算表;否則,這個欄位為 false 。 |
sheets.matchedUrl.url |
string
只有在符合下列條件時才會顯示:
在 Google 試算表中產生預覽畫面的連結網址。如要使用這個欄位,您必須在外掛程式的資訊清單中設定 LinkPreviewTriggers 。詳情請參閱「預覽含有智慧型方塊的連結」一文。
使用者預覽 "sheets" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |
簡報事件物件
簡報事件物件是整體事件物件的一部分,包含使用者文件及其內容的相關資訊。只有在主機應用程式為 Google 簡報時,才會出現在事件物件中。
簡報事件物件 | |
---|---|
slides.id |
string 只有在使用者授權
https://www.googleapis.com/auth/drive.file 範圍時才會顯示。在簡報 UI 中開啟簡報的 ID。 |
slides.title |
string 只有在使用者授權
https://www.googleapis.com/auth/drive.file 範圍時才會顯示。簡報標題會在簡報 UI 中開啟。 |
slides.addonHasFileScopePermission |
boolean 如果設為 true ,外掛程式會要求並收到 https://www.googleapis.com/auth/drive.file 範圍授權,以便在簡報 UI 中開啟簡報;否則,這個欄位為 false 。 |
slides.matchedUrl.url |
string
只有在符合下列條件時才會顯示:
產生 Google 簡報預覽畫面的連結網址。如要使用這個欄位,您必須在外掛程式的資訊清單中設定 LinkPreviewTriggers 。詳情請參閱「預覽含有智慧型方塊的連結」一文。
使用者預覽 "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |