Halaman ini menguraikan struktur objek peristiwa Add-on Google Workspace.
Objek peristiwa adalah struktur JSON yang otomatis dibuat dan diteruskan sebagai parameter untuk memicu atau fungsi callback saat pengguna berinteraksi dengan add-on. Objek peristiwa membawa informasi sisi klien tentang aplikasi host dan konteks saat ini ke fungsi callback sisi server add-on.
Add-on Google Workspace menggunakan objek peristiwa di tempat-tempat berikut:
Pemicu halaman beranda. Setiap fungsi
homepageTrigger
yang Anda tentukan akan otomatis diteruskan ke objek peristiwa saat fungsi pemicu halaman beranda diaktifkan. Anda dapat menggunakan objek ini di fungsi pemicu halaman beranda untuk mengidentifikasi aplikasi host aktif, platform klien, lokalitas pengguna, dan informasi lainnya.Objek peristiwa yang dibuat saat pemicu halaman beranda diaktifkan tidak berisi semua kolom yang disertakan dalam dua kasus lainnya; kolom yang berkaitan dengan widget dan informasi kontekstual dihilangkan.
Pemicu kontekstual. Setiap aplikasi host menyediakan serangkaian pemicu kontekstual berbeda yang akan aktif saat pengguna memasuki konteks tertentu. Contoh:
- Gmail menyediakan pemicu kontekstual ketika pengguna membuka pesan dan pemicu kontekstual lain saat pengguna menulis pesan.
- Google Kalender memberikan pemicu kontekstual saat pengguna membuka acara.
- Google Drive memberikan pemicu kontekstual saat pengguna memilih file Drive.
Saat pemicu kontekstual diaktifkan, aplikasi host akan memanggil
runFunction
terkait yang tercantum dalam manifes add-on, lalu meneruskan objek peristiwa sebagai parameter. Objek peristiwa yang dibuat saat pemicu kontekstual diaktifkan berisi semua kolom yang disertakan dalam objek peristiwa pemicu halaman beranda, serta kolom yang berisi informasi kontekstual.Tindakan widget. Objek peristiwa juga digunakan untuk menyediakan interaktivitas widget, dengan menggunakan model tindakan yang sama dengan yang digunakan add-on Gmail. Add-on Google Workspace menggunakan semua fungsi pengendali widget, objek
Action
, dan respons tindakan yang sama. Namun, dalam Add-on Google Workspace, objek peristiwa tindakan menyertakan informasi lebih lanjut yang dapat ditindaklanjuti oleh fungsi callback.Objek peristiwa yang dibuat sebagai hasil dari tindakan widget berisi semua kolom yang disertakan dalam objek peristiwa pemicu kontekstual, serta kolom yang berisi informasi widget.
Pemicu link pratinjau. Di Google Dokumen, Spreadsheet, dan Slide, Anda dapat mengonfigurasi pratinjau link untuk layanan pihak ketiga berdasarkan pola URL tertentu. Saat pengguna berinteraksi dengan link yang memenuhi pola tersebut,
linkPreviewTriggers
akan diaktifkan dan objek peristiwa yang berisi link tersebut akan diteruskan ke fungsi callback pemicu. Add-on Anda dapat menggunakan objek peristiwa ini untuk membuat smart chip dan kartu yang menampilkan informasi tentang link dalam aplikasi host. Anda juga dapat membuat tindakan widget agar pengguna dapat berinteraksi dengan kartu pratinjau dan kontennya.
Struktur objek peristiwa
Tabel berikut menjelaskan struktur tingkat atas objek peristiwa Add-on Google Workspace. Struktur objek peristiwa menyertakan kolom tingkat atas commonEventObject
untuk informasi yang tidak bergantung pada host. Setiap objek peristiwa juga dapat memiliki salah satu kolom level teratas khusus host berikut, yang ditentukan oleh aplikasi host yang aktif: gmailEventObject
, calendarEventObject
, atau driveEventObject
.
Untuk kompatibilitas mundur, objek peristiwa Add-on Google Workspace juga menyertakan semua kolom asli yang digunakan dalam objek peristiwa tindakan add-on Gmail. Kolom ini tercantum dalam tabel di bawah di bagian "Kolom add-on Gmail asli"; informasi di kolom ini direproduksi dalam struktur objek baru.
Objek peristiwa | |
---|---|
eventObject.commonEventObject |
Common fields object
Objek yang berisi informasi umum untuk semua objek peristiwa, terlepas dari aplikasi host. |
eventObject.calendar |
Calendar event object
Hanya lakukan presentasi jika penyelenggara panggilan adalah Google Kalender. Objek yang berisi informasi kalender dan acara. |
eventObject.drive |
Drive event object
Hanya lakukan presentasi jika host panggilan adalah Google Drive. Objek yang berisi informasi Drive. |
eventObject.gmail |
Gmail event object
Hanya lakukan panggilan jika penyelenggara panggilan adalah Gmail. Objek yang berisi informasi Gmail. |
eventObject.docs |
Docs event object
Hanya lakukan presentasi jika host panggilan adalah Google Dokumen. Objek yang berisi informasi Dokumen. |
eventObject.sheets |
Sheets event object
Hanya lakukan presentasi jika host panggilan adalah Google Spreadsheet. Objek yang berisi informasi Spreadsheet. |
eventObject.slides |
Slides event object
Hanya lakukan presentasi jika host panggilan adalah Google Slide. Objek yang berisi informasi Slide. |
Kolom add-on Gmail asli | |
eventObject.messageMetadata.accessToken |
string Tidak digunakan lagi. Token akses. Anda dapat menggunakannya untuk mengaktifkan akses ke data pengguna menggunakan cakupan add-on Gmail sementara.
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
eventObject.messageMetadata.messageId |
string Tidak digunakan lagi. ID pesan dari rangkaian pesan akan terbuka di UI Gmail.
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
eventObject.clientPlatform |
string Tidak digunakan lagi. Menunjukkan asal peristiwa (web, iOS, atau Android).
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
eventObject.formInput |
object Tidak digunakan lagi. Peta nilai saat ini dari semua widget formulir pada kartu, yang dibatasi untuk satu nilai per widget. Kuncinya adalah ID string yang terkait dengan widget, dan nilainya adalah string. Objek peristiwa memberikan formInput
untuk memudahkan Anda saat perlu membaca data dari beberapa widget dengan
nilai tunggal yang diharapkan, seperti input dan tombol teks. Untuk widget multi-nilai seperti kotak centang, Anda dapat membaca setiap nilai dari formInputs .
Untuk Add-on Google Workspace, temukan informasi ini di kolom |
eventObject.formInputs |
object Tidak digunakan lagi. Peta nilai widget saat ini dalam kartu, disajikan sebagai daftar string. Kunci adalah ID string yang terkait dengan widget. Untuk widget bernilai tunggal, nilai tersebut disajikan dalam array elemen tunggal. Untuk widget multi-nilai seperti grup kotak centang, semua nilai ditampilkan dalam daftar.
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
eventObject.parameters |
object Tidak digunakan lagi. Peta parameter tambahan yang Anda berikan ke Action menggunakan
Action.setParameters() . Kunci dan nilai peta berupa string.
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
eventObject.userCountry |
string Tidak digunakan lagi dan dinonaktifkan secara default. Kode dua huruf yang menunjukkan negara atau wilayah pengguna. Nilai ini juga dapat berupa kode negara UN M49 numerik.
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
eventObject.userLocale |
string Tidak digunakan lagi dan dinonaktifkan secara default. Kode ISO 639 dua huruf yang menunjukkan bahasa pengguna. Lihat Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya.
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
eventObject.userTimezone.id |
string Tidak digunakan lagi dan dinonaktifkan secara default. ID zona waktu dari zona waktu pengguna. Contohnya mencakup: America/New_York , Europe/Vienna , dan
Asia/Seoul . Lihat
Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya.
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
eventObject.userTimezone.offset |
string Tidak digunakan lagi dan dinonaktifkan secara default. Offset waktu dari Waktu Universal Terkoordinasi (UTC) pada zona waktu pengguna, yang diukur dalam milidetik. Lihat Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya.
Untuk Add-on Google Workspace, temukan informasi ini di kolom
|
Objek peristiwa umum
Objek peristiwa umum adalah bagian dari keseluruhan objek peristiwa yang membawa informasi umum yang tidak bergantung pada host ke add-on dari klien pengguna. Informasi ini mencakup detail seperti lokalitas, aplikasi host, dan platform pengguna.
Selain pemicu halaman beranda dan kontekstual, add-on membuat dan meneruskan
objek peristiwa ke fungsi callback tindakan
saat pengguna berinteraksi dengan widget. Fungsi callback add-on Anda dapat mengkueri objek peristiwa umum untuk menentukan konten widget yang terbuka di klien pengguna. Misalnya, add-on Anda dapat menemukan teks yang telah dimasukkan pengguna ke
widget TextInput
di
objek eventObject.commentEventObject.formInputs
.
Kolom objek peristiwa umum | |
---|---|
commonEventObject.platform |
string Menunjukkan asal peristiwa (`WEB`, `IOS`, atau `ANDROID`). |
commonEventObject.formInputs |
object Peta yang berisi nilai widget saat ini di kartu yang ditampilkan. Kunci peta adalah ID string yang ditetapkan untuk setiap widget. Struktur objek nilai peta bergantung pada jenis widget:
|
commonEventObject.hostApp |
string Menunjukkan aplikasi host tempat add-on aktif saat objek peristiwa dibuat. Nilai yang memungkinkan mencakup berikut ini:
|
commonEventObject.parameters |
object Parameter tambahan apa pun yang Anda berikan ke
Action menggunakan
Action.setParameters() .
|
commonEventObject.userLocale |
string Dinonaktifkan secara default. Bahasa dan ID negara/wilayah pengguna dalam format kode bahasa ISO 639-ISO 3166 kode negara/wilayah. Misalnya, en-US .
Untuk mengaktifkan kolom ini, Anda harus menetapkan |
commonEventObject.timeZone |
string Dinonaktifkan secara default. ID dan offset zona waktu. Untuk mengaktifkan kolom ini, Anda harus menetapkan addOns.common.useLocaleFromApp ke true dalam manifes add-on Anda.
Daftar cakupan add-on Anda juga harus menyertakan
https://www.googleapis.com/auth/script.locale .
Lihat
Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya.
|
commonEventObject.timeZone.id |
string ID zona waktu dari zona waktu pengguna. Contohnya mencakup: America/New_York , Europe/Vienna , dan
Asia/Seoul . Untuk mengaktifkan kolom ini, Anda harus menetapkan
addOns.common.useLocaleFromApp ke true dalam manifes add-on Anda.
Daftar cakupan add-on Anda juga harus menyertakan
https://www.googleapis.com/auth/script.locale . Lihat
Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya.
|
commonEventObject.timeZone.offset |
string Offset waktu dari Waktu Universal Terkoordinasi (UTC) pada zona waktu pengguna, yang diukur dalam milidetik. Lihat Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya. |
Input formulir pemilih tanggal-waktu
Fungsi callback tindakan
dapat menerima nilai widget saat ini di kolom commonEventObject.formInputs
.
Hal ini mencakup nilai tanggal atau waktu yang dipilih pengguna di widget pemilih tanggal atau
waktu.
Namun, struktur informasinya berbeda-beda, bergantung pada apakah
widget dikonfigurasi sebagai pemilih tanggal-waktu, pemilih khusus tanggal, atau alat pilih
khusus waktu. Perbedaan struktural dijelaskan dalam tabel berikut:
Objek acara Kalender
Objek acara Kalender adalah bagian dari objek acara keseluruhan yang membawa informasi tentang kalender dan acara kalender pengguna. Elemen ini hanya ada dalam objek acara jika aplikasi host adalah Google Kalender.
Tabel berikut mencantumkan kolom yang ada di kolom calendarEventObject
objek peristiwa. Kolom yang ditandai sebagai Data buatan pengguna
ada dalam objek peristiwa jika dan hanya jika data ada di peristiwa Kalender
dan add-on menetapkan kolom
manifes
addOns.calendar.currentEventAccess
ke
READ
atau READ_WRITE
.
Objek acara Kalender | |
---|---|
calendar.attendees[] |
list of attendee objects Data buatan pengguna. Daftar tamu acara kalender. |
calendar.calendarId |
string ID kalender. |
calendar.capabilities |
object Data buatan pengguna. Objek yang menjelaskan kemampuan add-on untuk melihat atau memperbarui informasi peristiwa. |
calendar.capabilities.canAddAttendees |
boolean Data buatan pengguna. true
jika add-on dapat menambahkan tamu baru ke daftar tamu acara;
false jika tidak. |
calendar.capabilities.canSeeAttendees |
boolean Data buatan pengguna. true
jika add-on dapat membaca daftar tamu acara; false
jika tidak. |
calendar.capabilities.canSeeConferenceData |
boolean Data buatan pengguna. true
jika add-on dapat membaca data konferensi acara; false
jika tidak. |
calendar.capabilities.canSetConferenceData |
boolean Data buatan pengguna. true
jika add-on dapat memperbarui data konferensi acara; false
jika tidak. |
calendar.capabilities.canAddAttachments |
boolean Data buatan pengguna. true
jika add-on dapat menambahkan lampiran baru ke acara;
false jika tidak.
|
calendar.conferenceData |
Conference data object Data buatan pengguna. Objek yang mewakili data konferensi apa pun yang terkait dengan acara ini, seperti detail konferensi Google Meet. |
calendar.id |
string ID acara. |
calendar.organizer |
object Objek yang mewakili penyelenggara acara. |
calendar.organizer.email |
string Alamat email penyelenggara acara. |
calendar.recurringEventId |
string ID acara rutin. |
Peserta
Objek peserta membawa informasi tentang masing-masing peserta ke acara
Google Kalender. Informasi ini ditampilkan dalam objek acara jika dan hanya jika data
ada dalam acara Kalender dan add-on menetapkan
kolom
manifes
addOns.calendar.currentEventAccess
ke
READ
atau READ_WRITE
.
Objek peserta | |
---|---|
attendee.additionalGuests |
number Jumlah tamu tambahan yang dinyatakan peserta yang mereka bawa. Nilai defaultnya adalah nol. |
attendee.comment |
string Komentar respons peserta, jika ada. |
attendee.displayName |
string Nama tamu yang ditampilkan. |
attendee.email |
string Alamat email tamu. |
attendee.optional |
boolean true jika kehadiran untuk
tamu ini ditandai sebagai opsional; false jika tidak.
|
attendee.organizer |
boolean true jika peserta adalah
penyelenggara acara ini.
|
attendee.resource |
boolean true jika peserta mewakili
fasilitas, seperti ruangan atau perlengkapan; false
sebaliknya.
|
attendee.responseStatus |
string Status respons peserta. Nilai yang memungkinkan mencakup:
|
attendee.self |
boolean true jika tamu ini mewakili
kalender tempat acara ini muncul; false jika tidak.
|
Data konferensi
Objek data konferensi membawa informasi tentang konferensi yang dilampirkan
ke acara Google Kalender. Hal ini dapat berupa solusi konferensi Google, seperti
Google Meet, atau konferensi pihak ketiga. Informasi ini ada dalam
objek peristiwa jika dan hanya jika data ada dalam acara Kalender dan
add-on menetapkan kolom
manifes addOns.calendar.currentEventAccess
ke
READ
atau READ_WRITE
.
Objek data konferensi | |
---|---|
conferenceData.conferenceId |
string ID konferensi. ID ini dimaksudkan agar aplikasi dapat melacak konferensi; Anda tidak boleh menampilkan ID ini kepada pengguna. |
conferenceData.conferenceSolution |
object Objek yang mewakili solusi konferensi, seperti Hangouts atau Google Meet. |
conferenceData.conferenceSolution.iconUri |
string URI untuk ikon yang terlihat oleh pengguna yang merepresentasikan solusi konferensi ini. |
conferenceData.conferenceSolution.key |
object Kunci yang mengidentifikasi solusi konferensi secara unik untuk acara ini. |
conferenceData.conferenceSolution.key.type |
string Jenis solusi konferensi. Nilai yang memungkinkan mencakup:
|
conferenceData.conferenceSolution.name |
string Nama yang dilihat pengguna dari solusi konferensi ini (tidak dilokalkan). |
conferenceData.entryPoints[] |
list of entry point objects
Daftar titik entri konferensi, seperti URL atau nomor telepon. |
conferenceData.notes |
string Catatan tambahan (seperti petunjuk dari administrator domain atau pemberitahuan hukum) tentang konferensi yang akan ditampilkan kepada pengguna. Dapat berisi HTML. Panjang maksimum adalah 2.048 karakter. |
conferenceData.parameters |
object Objek yang berisi peta data parameter yang ditentukan untuk digunakan oleh add-on. |
conferenceData.parameters.addOnParameters |
object Peta kunci dan nilai string parameter. Kunci dan nilai ini ditentukan oleh developer add-on untuk melampirkan informasi ke konferensi tertentu untuk digunakan oleh add-on. |
Titik entri
Objek titik entri membawa informasi tentang sarana yang digunakan untuk mengakses
konferensi tertentu, seperti melalui telepon atau video. Informasi ini ada dalam
objek peristiwa jika dan hanya jika data ada dalam acara Kalender dan
add-on menetapkan kolom
manifes
addOns.calendar.currentEventAccess
ke
READ
atau READ_WRITE
.
Objek titik entri | |
---|---|
entryPoint.accessCode |
string Kode akses yang digunakan untuk mengakses konferensi. Panjang maksimum adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan subset { accessCode , meetingCode ,
passcode , password , pin } untuk
menyediakan akses ke konferensi. Cocokkan dan hanya tampilkan kolom
yang digunakan penyedia konferensi.
|
entryPoint.entryPointFeatures |
list Fitur titik entri. Saat ini fitur ini hanya berlaku untuk titik entri phone :
|
entryPoint.entryPointType |
string Jenis titik entri. Nilai yang memungkinkan adalah sebagai berikut:
|
entryPoint.label |
string Label yang terlihat oleh pengguna untuk URI titik entri (tidak dilokalkan). |
entryPoint.meetingCode |
string Kode rapat yang digunakan untuk mengakses konferensi. Panjang maksimum adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan subset { accessCode , meetingCode ,
passcode , password , pin } untuk
menyediakan akses ke konferensi. Cocokkan dan hanya tampilkan kolom
yang digunakan penyedia konferensi.
|
entryPoint.passcode |
string Kode sandi yang digunakan untuk mengakses konferensi. Panjang maksimum adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan subset { accessCode , meetingCode ,
passcode , password , pin } untuk
menyediakan akses ke konferensi. Cocokkan dan hanya tampilkan kolom
yang digunakan penyedia konferensi.
|
entryPoint.password |
string Sandi yang digunakan untuk mengakses konferensi. Panjang maksimum adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan subset { accessCode , meetingCode ,
passcode , password , pin } untuk
menyediakan akses ke konferensi. Cocokkan dan hanya tampilkan kolom
yang digunakan penyedia konferensi.
|
entryPoint.pin |
string PIN yang digunakan untuk mengakses konferensi. Panjang maksimum adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan subset { accessCode , meetingCode ,
passcode , password , pin } untuk
menyediakan akses ke konferensi. Cocokkan dan hanya tampilkan kolom
yang digunakan penyedia konferensi.
|
entryPoint.regionCode |
string Kode wilayah nomor telepon. Diperlukan oleh pengguna jika URI tidak menyertakan kode negara. Nilai didasarkan pada daftar kode wilayah CLDR publik. |
entryPoint.uri |
string URI titik entri. Panjang maksimum adalah 1.300 karakter. Pemformatan bergantung pada jenis titik entri:
|
Objek peristiwa Drive
Objek peristiwa Drive adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang Google Drive pengguna dan kontennya. Elemen ini hanya ada dalam objek peristiwa jika aplikasi host adalah Google Drive.
Objek peristiwa Drive | |
---|---|
drive.activeCursorItem |
Drive item object Item Drive saat ini aktif. |
drive.selectedItems[] |
list of Drive item objects Daftar item (file atau folder) yang dipilih di Drive. |
Item Drive
Objek item Drive membawa informasi tentang item Drive tertentu, seperti file atau folder.
Objek item Drive | |
---|---|
item.addonHasFileScopePermission |
boolean Jika true , add-on telah meminta
dan menerima otorisasi cakupan https://www.googleapis.com/auth/drive.file
untuk item ini; jika tidak, kolom ini adalah
false .
|
item.id |
string ID item yang dipilih. |
item.iconUrl |
string URL ikon yang mewakili item yang dipilih. |
item.mimeType |
string Jenis MIME item yang dipilih. |
item.title |
string Judul item yang dipilih. |
Objek peristiwa Gmail
Objek peristiwa Gmail adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang pesan Gmail pengguna. Elemen ini hanya ada dalam objek peristiwa jika aplikasi host adalah Gmail.
Objek peristiwa Gmail | |
---|---|
gmail.accessToken |
string Token akses khusus Gmail. Anda dapat menggunakan token ini dengan metode GmailApp.setCurrentMessageAccessToken(accessToken) untuk memberikan add-on Anda akses sementara ke pesan Gmail pengguna yang saat ini terbuka atau mengizinkan add-on Anda membuat draf baru.
|
gmail.bccRecipients[] |
list of strings Dinonaktifkan secara default. Daftar alamat email penerima "BCC" yang saat ini disertakan dalam draf yang dibuat oleh add-on. Untuk mengaktifkan kolom ini, Anda harus menetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes ke
METADATA .
|
gmail.ccRecipients[] |
list of strings Dinonaktifkan secara default. Daftar alamat email penerima "CC:" yang saat ini disertakan dalam draf yang dibuat oleh add-on. Untuk mengaktifkan kolom ini, Anda harus menetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes ke
METADATA .
|
gmail.messageId |
string ID pesan Gmail yang saat ini terbuka. |
gmail.threadId |
string ID rangkaian pesan Gmail yang saat ini terbuka. |
gmail.toRecipients[] |
list of strings Dinonaktifkan secara default. Daftar alamat email penerima "Kepada:" yang saat ini disertakan dalam draf yang dibuat oleh add-on. Untuk mengaktifkan kolom ini, Anda harus menetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes ke
METADATA .
|
Objek peristiwa Dokumen
Objek peristiwa Dokumen adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang dokumen pengguna dan kontennya. Fragmen hanya ada dalam objek peristiwa jika aplikasi host adalah Google Dokumen.
Objek peristiwa Dokumen | |
---|---|
docs.id |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diotorisasi oleh pengguna.ID dokumen yang dibuka di UI Dokumen. |
docs.title |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna.Judul dokumen yang dibuka di UI Dokumen. |
docs.addonHasFileScopePermission |
boolean Jika true , add-on telah meminta
dan menerima otorisasi cakupan https://www.googleapis.com/auth/drive.file
untuk dokumen yang dibuka di UI Dokumen; jika tidak, kolom
ini adalah false .
|
docs.matchedUrl.url |
string
Hanya ada jika kondisi berikut terpenuhi:
URL link yang menghasilkan pratinjau di Google Dokumen. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers di manifes add-on Anda. Lihat Melihat pratinjau link dengan smart chip untuk mengetahui detail selengkapnya.
Contoh payload saat pengguna melihat pratinjau link "docs" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |
Objek peristiwa Spreadsheet
Objek peristiwa Spreadsheet adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang dokumen pengguna dan kontennya. Elemen ini hanya ada dalam objek peristiwa jika aplikasi host adalah Google Spreadsheet.
Objek peristiwa Spreadsheet | |
---|---|
sheets.id |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna. ID spreadsheet akan terbuka di UI Spreadsheet.
|
sheets.title |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna. Judul spreadsheet akan terbuka di UI
Spreadsheet.
|
sheets.addonHasFileScopePermission |
boolean Jika true , add-on telah meminta
dan menerima otorisasi cakupan https://www.googleapis.com/auth/drive.file
untuk spreadsheet yang terbuka di UI Spreadsheet; jika tidak,
kolom ini adalah false .
|
sheets.matchedUrl.url |
string
Hanya ada jika kondisi berikut terpenuhi:
URL link yang menghasilkan pratinjau di Google Spreadsheet. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers di manifes add-on Anda. Lihat Melihat pratinjau link dengan smart chip untuk mengetahui detail selengkapnya.
Contoh payload saat pengguna melihat pratinjau link "sheets" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |
Objek peristiwa Slide
Objek peristiwa Slide adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang dokumen pengguna dan kontennya. Elemen ini hanya ada dalam objek peristiwa jika aplikasi host adalah Google Slide.
Objek peristiwa Slide | |
---|---|
slides.id |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna. ID presentasi yang terbuka di UI
Slide.
|
slides.title |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna. Judul presentasi yang terbuka di
UI Slide.
|
slides.addonHasFileScopePermission |
boolean Jika true , add-on telah meminta
dan menerima otorisasi cakupan https://www.googleapis.com/auth/drive.file
untuk presentasi yang terbuka di UI Slide; jika tidak,
kolom ini adalah false .
|
slides.matchedUrl.url |
string
Hanya ada jika kondisi berikut terpenuhi:
URL link yang menghasilkan pratinjau di Google Slide. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers di manifes add-on Anda.
Lihat Melihat pratinjau link dengan smart chip untuk mengetahui detail selengkapnya.
Contoh payload saat pengguna melihat pratinjau link "slides" : { "matchedUrl" : { "url" : "https://www.example.com/12345" } } |