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 {i>add-on<i}. 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 berikut:
Pemicu halaman beranda. Setiap fungsi
homepageTrigger
yang Anda tentukan akan otomatis menerima peristiwa saat fungsi pemicu halaman beranda diaktifkan. Anda dapat menggunakan objek ini pada fungsi pemicu halaman beranda untuk mengidentifikasi aplikasi {i>host<i} aktif, konfigurasi platform, lokalitas pengguna, dan informasi lainnya.Objek peristiwa yang dibuat saat halaman beranda memicu pengaktifan tidak berisi semua {i>field<i} yang ada di dua kasus lainnya; yang berkaitan dengan widget dan informasi kontekstual dihilangkan.
Pemicu kontekstual. Setiap aplikasi host menyediakan rangkaian pemicu kontekstual yang berbeda yang aktif saat pengguna memasuki konteks tertentu. Contoh:
- Gmail menyediakan pemicu kontekstual saat pengguna membuka pesan dan kejadian lainnya saat pengguna menulis pesan.
- Google Kalender menyediakan pemicu kontekstual saat pengguna membuka acara.
- Google Drive memberikan pemicu kontekstual saat pengguna memilih file Drive.
Saat pemicu kontekstual diaktifkan, aplikasi host akan memanggil metode
runFunction
terkait yang tercantum dalam manifes add-on, dengan meneruskan peristiwa sebagai parameter. Objek peristiwa yang dibuat saat kontekstual pengaktifan pemicu berisi semua kolom yang disertakan dalam peristiwa pemicu halaman beranda objek, ditambah kolom yang berisi informasi kontekstual.Tindakan widget. Objek peristiwa juga digunakan untuk menyediakan widget interaktivitas, menggunakan model tindakan yang ditambahkan add-on Gmail gunakan. Add-on Google Workspace menggunakan semua fungsi pengendali widget yang sama, Objek
Action
, dan tindakan yang dihasilkan. Namun, di Add-on Google Workspace objek peristiwa tindakan menyertakan lebih banyak informasi yang dapat ditindaklanjuti oleh fungsi callback.Objek peristiwa yang dibuat sebagai hasil 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,
linkPreviewTriggers
diaktifkan, dan objek peristiwa yang berisi link diteruskan ke fungsi callback. Add-on Anda dapat menggunakan objek peristiwa ini untuk membuat dan kartu yang menampilkan informasi tentang link dalam host aplikasi. Anda juga dapat membangun tindakan widget yang memungkinkan pengguna berinteraksi dengan kartu pratinjau dan isinya.
Struktur objek peristiwa
Tabel berikut menjelaskan
struktur tingkat atas dari
Objek peristiwa Add-on Google Workspace. Acara
struktur objek mencakup commonEventObject
{i>top-level<i} untuk informasi yang tidak bergantung pada {i>host<i}. Setiap objek peristiwa juga dapat
memiliki salah satu bidang tingkat teratas khusus host berikut, yang ditentukan oleh
aplikasi host aktif: gmailEventObject
,
calendarEventObject
, atau driveEventObject
.
Untuk kompatibilitas mundur, Add-on Google Workspace juga mencakup semua bidang 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 yang umum untuk semua objek peristiwa, terlepas dari aplikasi {i>host<i}. |
eventObject.calendar |
Calendar event object
Hanya hadir jika penyelenggara panggilan adalah Google Kalender. Objek
yang berisi informasi kalender dan acara.
|
eventObject.drive |
Drive event object
Hanya hadir jika host yang memanggil adalah Google Drive. Objek
yang berisi informasi Drive.
|
eventObject.gmail |
Gmail event object
Hanya hadir jika penyelenggara panggilan adalah Gmail. Objek
yang berisi informasi Gmail.
|
eventObject.docs |
Docs event object
Hanya hadir jika penyelenggara yang menelepon adalah Google Dokumen. Objek
yang berisi informasi Dokumen.
|
eventObject.sheets |
Sheets event object
Hanya hadir jika host panggilan adalah Google Spreadsheet. Objek
yang berisi informasi Spreadsheet.
|
eventObject.slides |
Slides event object
Hanya hadir jika host yang memanggil adalah Google Slide. Objek
yang berisi informasi Slide.
|
Kolom add-on Gmail asli | |
eventObject.messageMetadata.accessToken |
string Tidak digunakan lagi. Token akses. Anda dapat menggunakan ini untuk mengaktifkan akses ke data pengguna menggunakan cakupan add-on Gmail sementara.
Untuk Add-on Google Workspace, temukan informasi ini di
|
eventObject.messageMetadata.messageId |
string Tidak digunakan lagi. ID pesan rangkaian pesan terbuka di UI Gmail.
Untuk Add-on Google Workspace, temukan informasi ini di
|
eventObject.clientPlatform |
string Tidak digunakan lagi. Menunjukkan di mana peristiwa (web, iOS, atau Android).
Untuk Add-on Google Workspace, temukan informasi ini di
|
eventObject.formInput |
object Tidak digunakan lagi. Peta nilai saat ini dari semua widget formulir di kartu, dibatasi pada satu nilai per widget. Tujuan kunci adalah ID string yang terkait dengan widget, dan nilainya {i>string<i}. Objek peristiwa menyediakan formInput sebagai
kenyamanan saat Anda perlu membaca data dari beberapa widget dengan
nilai tunggal yang diharapkan, seperti
input teks dan tombol. Sebagai
widget multi-nilai seperti kotak centang, Anda dapat membaca setiap nilai dari
Sebagai gantinya, formInputs .
Untuk Add-on Google Workspace, temukan informasi ini di
|
eventObject.formInputs |
object Tidak digunakan lagi. Peta nilai saat ini dari widget di kartu, yang disajikan sebagai daftar string. Kunci tersebut adalah ID string yang terkait dengan widget. Untuk widget bernilai tunggal, metode disajikan dalam array elemen tunggal. Untuk widget multinilai seperti grup kotak centang, semua nilai disajikan dalam sebuah daftar.
Untuk Add-on Google Workspace, temukan informasi ini di
|
eventObject.parameters |
object Tidak digunakan lagi. Peta lokasi tambahan parameter yang Anda berikan ke Action menggunakan
Action.setParameters() . Kunci dan nilai peta tersebut
{i>string<i}.
Untuk Add-on Google Workspace, temukan informasi ini di
|
eventObject.userCountry |
string Tidak digunakan lagi dan dinonaktifkan secara default. Tujuan kode dua huruf yang menunjukkan negara atau wilayah pengguna. Bisa juga angka Kode negara UN M49.
Untuk Add-on Google Workspace, temukan informasi ini di
|
eventObject.userLocale |
string Tidak digunakan lagi dan dinonaktifkan secara default. Tujuan dua huruf ISO 639 kode yang menunjukkan bahasa pengguna. Lihat Mengakses pengguna lokal dan zona waktu untuk mengetahui detail selengkapnya.
Untuk Add-on Google Workspace, temukan informasi ini di
|
eventObject.userTimezone.id |
string Tidak digunakan lagi dan dinonaktifkan secara default. Tujuan ID zona waktu untuk zona waktu pengguna. Contohnya antara lain: 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
|
eventObject.userTimezone.offset |
string Tidak digunakan lagi dan dinonaktifkan secara default. Tujuan selisih waktu dari Waktu Universal Terkoordinasi (Coordinated Universal Time/UTC) dari zona waktu, diukur dalam milidetik. Lihat Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya.
Untuk Add-on Google Workspace, temukan informasi ini di
|
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. Ini mencakup detail seperti lokalitas, aplikasi host, dan platform pengguna.
Selain halaman beranda dan pemicu 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
dengan klien besar. Misalnya, add-on Anda dapat menemukan teks yang 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 saat ini dari widget pada kartu yang ditampilkan. Kunci peta adalah ID string yang ditetapkan untuk setiap widget. Struktur objek nilai peta ini 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 disuplai ke
Action menggunakan
Action.setParameters() .
|
commonEventObject.userLocale |
string Dinonaktifkan secara default. Bahasa pengguna dan ID negara/wilayah dalam format ISO 639 kode bahasa-ISO 3166 kode negara/wilayah. Misalnya, en-US .
Untuk mengaktifkan kolom ini, Anda harus menetapkan |
commonEventObject.timeZone |
string Dinonaktifkan secara default. ID zona waktu dan offset. Untuk mengaktifkan kolom ini, Anda harus menyetel addOns.common.useLocaleFromApp ke true dalam manifes add-on Anda.
Daftar cakupan add-on Anda juga harus mencakup
https://www.googleapis.com/auth/script.locale .
Lihat
Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya.
|
commonEventObject.timeZone.id |
string ID zona waktu untuk zona waktu pengguna. Contohnya antara lain: America/New_York , Europe/Vienna , dan
Asia/Seoul . Untuk mengaktifkan kolom ini, Anda harus menyetel
addOns.common.useLocaleFromApp ke true dalam manifes add-on Anda.
Daftar cakupan add-on Anda juga harus mencakup
https://www.googleapis.com/auth/script.locale . Lihat
Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya.
|
commonEventObject.timeZone.offset |
string selisih waktu dari Waktu Universal Terkoordinasi (Coordinated Universal Time/UTC) pengguna zona waktu, diukur dalam milidetik. Lihat Mengakses lokalitas dan zona waktu pengguna untuk detail selengkapnya. |
Input formulir pemilih tanggal dan waktu
Fungsi callback tindakan
dapat menerima nilai widget saat ini di kolom commonEventObject.formInputs
.
Ini mencakup nilai tanggal atau waktu yang dipilih pengguna di pemilih tanggal atau waktu
widget.
Namun, struktur informasinya berbeda tergantung pada apakah
telah dikonfigurasi sebagai pemilih tanggal-waktu, pemilih tanggal saja, atau time-only
pemilih. Perbedaan struktural dijelaskan dalam tabel berikut:
Objek acara Kalender
Objek acara Kalender adalah bagian dari keseluruhan objek acara yang membawa informasi tentang kalender dan acara kalender pengguna. Itu hanya ada dalam objek acara jika aplikasi host adalah Google Kalender.
Tabel berikut mencantumkan kolom yang ada di calendarEventObject
kolom objek peristiwa. Kolom yang ditandai sebagai Data buatan pengguna adalah
ada di objek acara jika dan hanya jika data tersebut ada di Kalender
peristiwa, dan add-on menetapkan addOns.calendar.currentEventAccess
manifes
kolom ke
READ
atau READ_WRITE
.
Objek acara Kalender | |
---|---|
calendar.attendees[] |
list of attendee objects
Data buatan pengguna. Daftar peserta kalender
peristiwa.
|
calendar.calendarId |
string ID kalender. |
calendar.capabilities |
object Data buatan pengguna. Objek menjelaskan kemampuan add-on untuk melihat atau memperbarui peristiwa tidak akurat atau tidak sesuai. |
calendar.capabilities.canAddAttendees |
boolean Data buatan pengguna. true
jika add-on dapat menambahkan tamu baru ke daftar peserta acara;
false sebaliknya. |
calendar.capabilities.canSeeAttendees |
boolean Data buatan pengguna. true
jika add-on dapat membaca daftar peserta acara; false
sebaliknya. |
calendar.capabilities.canSeeConferenceData |
boolean Data buatan pengguna. true
jika add-on dapat membaca data konferensi acara; false
sebaliknya. |
calendar.capabilities.canSetConferenceData |
boolean Data buatan pengguna. true
jika add-on dapat memperbarui data konferensi acara; false
sebaliknya. |
calendar.capabilities.canAddAttachments |
boolean Data buatan pengguna. true
jika add-on dapat menambahkan lampiran baru ke acara;
false sebaliknya.
|
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 peristiwa. |
calendar.organizer |
object Objek yang mewakili penyelenggara peristiwa. |
calendar.organizer.email |
string Alamat email penyelenggara acara. |
calendar.recurringEventId |
string ID acara rutin. |
Tamu
Objek tamu membawa informasi tentang masing-masing tamu ke Google Kalender
peristiwa. Informasi ini ada di objek peristiwa jika dan hanya jika data
ada di acara Kalender dan add-on menetapkan
addOns.calendar.currentEventAccess
manifes
kolom ke
READ
atau READ_WRITE
.
Objek peserta | |
---|---|
attendee.additionalGuests |
number Jumlah tamu tambahan yang hadir yang telah mereka indikasikan. Nilai defaultnya adalah nol. |
attendee.comment |
string Komentar respons peserta, jika ada. |
attendee.displayName |
string Nama yang ditampilkan oleh peserta. |
attendee.email |
string Alamat email tamu. |
attendee.optional |
boolean true jika kehadiran dalam acara ini
peserta ditandai sebagai opsional; false jika tidak.
|
attendee.organizer |
boolean true jika tamu adalah
untuk acara ini.
|
attendee.resource |
boolean true jika peserta mewakili
sumber daya, seperti ruangan atau peralatan; false
sebaliknya.
|
attendee.responseStatus |
string Status respons peserta. Mungkin nilai tersebut meliputi:
|
attendee.self |
boolean true jika peserta 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. Solusi ini bisa berupa solusi konferensi Google, seperti
Google Meet, atau konferensi pihak ketiga. Informasi ini tersedia di
jika dan hanya jika data ada dalam acara Kalender dan
add-on menetapkan addOns.calendar.currentEventAccess
manifes
kolom ke
READ
atau READ_WRITE
.
Objek data konferensi | |
---|---|
conferenceData.conferenceId |
string ID konferensi. ID ini dimaksudkan untuk mengizinkan aplikasi melacak konferensi; Anda tidak seharusnya menampilkan ID ini kepada pengguna. |
conferenceData.conferenceSolution |
object Objek yang mewakili 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 secara unik mengidentifikasi solusi konferensi untuk acara ini. |
conferenceData.conferenceSolution.key.type |
string Jenis solusi konferensi. Nilai yang mungkin meliputi hal berikut:
|
conferenceData.conferenceSolution.name |
string Nama konferensi ini yang terlihat oleh pengguna solusi (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 kepada ditampilkan kepada pengguna. Dapat berisi HTML. Panjang maksimum adalah 2048 karakter. |
conferenceData.parameters |
object Objek yang berisi peta yang ditentukan parameter data untuk digunakan oleh add-on. |
conferenceData.parameters.addOnParameters |
object Peta kunci dan nilai string parameter. Kunci dan nilai ini ditentukan oleh developer add-on yang akan dilampirkan ke konferensi tertentu untuk penggunaan add-on. |
Titik entri
Objek titik entri membawa informasi tentang cara yang ditetapkan untuk mengakses
konferensi tertentu, seperti melalui telepon atau video. Informasi ini tersedia di
objek acara jika dan hanya jika data ada dalam acara Kalender dan
add-on menetapkan addOns.calendar.currentEventAccess
-nya
manifes
kolom 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 gunakan subset dari { accessCode , meetingCode ,
passcode , password , pin } ke
menyediakan akses
ke konferensi. Mencocokkan dan hanya menampilkan kolom
yang digunakan oleh
penyedia konferensi.
|
entryPoint.entryPointFeatures |
list Fitur titik entri. Saat ini, fitur hanya berlaku untuk phone titik entri:
|
entryPoint.entryPointType |
string Jenis titik entri. Kemungkinan nilainya adalah hal 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 gunakan subset dari { accessCode , meetingCode ,
passcode , password , pin } ke
menyediakan akses
ke konferensi. Mencocokkan dan hanya menampilkan kolom
yang digunakan oleh
penyedia konferensi.
|
entryPoint.passcode |
string Kode sandi yang digunakan untuk mengakses konferensi. Panjang maksimum adalah 128 karakter. Penyedia konferensi biasanya hanya gunakan subset dari { accessCode , meetingCode ,
passcode , password , pin } ke
menyediakan akses
ke konferensi. Mencocokkan dan hanya menampilkan kolom
yang digunakan oleh
penyedia konferensi.
|
entryPoint.password |
string Sandi yang digunakan untuk mengakses konferensi. Panjang maksimum adalah 128 karakter. Penyedia konferensi biasanya hanya gunakan subset dari { accessCode , meetingCode ,
passcode , password , pin } ke
menyediakan akses
ke konferensi. Mencocokkan dan hanya menampilkan kolom
yang digunakan oleh
penyedia konferensi.
|
entryPoint.pin |
string PIN yang digunakan untuk mengakses konferensi. Panjang maksimum adalah 128 karakter. Penyedia konferensi biasanya hanya gunakan subset dari { accessCode , meetingCode ,
passcode , password , pin } ke
menyediakan akses
ke konferensi. Mencocokkan dan hanya menampilkan kolom
yang digunakan oleh
penyedia konferensi.
|
entryPoint.regionCode |
string Kode wilayah nomor telepon. Dibutuhkan oleh jika URI tidak menyertakan kode negara. Nilai didasarkan pada publik Daftar CLDR kode wilayah. |
entryPoint.uri |
string URI titik entri. Maksimum adalah 1.300 karakter. Formatnya bergantung pada titik entri jenis:
|
Objek peristiwa Drive
Objek peristiwa Drive adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang Google Drive pengguna beserta kontennya. Itu hanya ada di objek peristiwa jika aplikasi host adalah Google Drive.
Objek peristiwa Drive | |
---|---|
drive.activeCursorItem |
Drive item object
Item Drive sedang 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 https://www.googleapis.com/auth/drive.file
otorisasi cakupan untuk item ini; jika tidak, {i>field<i} ini
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. Hanya ada dalam objek peristiwa jika aplikasi {i>host<i} adalah Gmail.
Objek peristiwa Gmail | |
---|---|
gmail.accessToken |
string Token akses khusus Gmail. Anda dapat menggunakan token ini dengan GmailApp.setCurrentMessageAccessToken(accessToken)
untuk memberi add-on Anda akses sementara ke akun pengguna
membuka pesan Gmail atau membiarkan add-on membuat draf baru.
|
gmail.bccRecipients[] |
list of strings Dinonaktifkan secara default. Daftar dari "BCC:" alamat email penerima yang saat ini disertakan dalam draf sedang ditulis. Untuk mengaktifkan bidang ini, Anda harus menyetel atribut Kolom addOns.gmail.composeTrigger.draftAccess dalam manifes Anda untuk
METADATA .
|
gmail.ccRecipients[] |
list of strings Dinonaktifkan secara default. Daftar dari "CC:" alamat email penerima yang saat ini disertakan dalam draf sedang ditulis. Untuk mengaktifkan bidang ini, Anda harus menyetel atribut Kolom addOns.gmail.composeTrigger.draftAccess dalam manifes Anda untuk
METADATA .
|
gmail.messageId |
string ID pesan Gmail yang sedang dibuka. |
gmail.threadId |
string ID rangkaian pesan Gmail yang sedang terbuka. |
gmail.toRecipients[] |
list of strings Dinonaktifkan secara default. Daftar dari "Kepada:" alamat email penerima yang saat ini disertakan dalam draf sedang ditulis. Untuk mengaktifkan bidang ini, Anda harus menyetel atribut Kolom addOns.gmail.composeTrigger.draftAccess dalam manifes Anda untuk
METADATA .
|
Objek peristiwa Dokumen
Objek peristiwa Dokumen adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang dokumen pengguna dan isinya. Ini hanya ada di jika aplikasi host adalah Google Dokumen.
Objek peristiwa Dokumen | |
---|---|
docs.id |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna.ID dokumen akan terbuka di UI Dokumen. |
docs.title |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna.Judul dokumen akan terbuka di UI Dokumen. |
docs.addonHasFileScopePermission |
boolean Jika true , add-on telah meminta
dan menerima https://www.googleapis.com/auth/drive.file
otorisasi cakupan untuk dokumen yang terbuka di UI Dokumen; kalau tidak, ini
adalah false .
|
docs.matchedUrl.url |
string
Hanya ada jika ketentuan berikut terpenuhi:
URL link yang membuat pratinjau di Google Dokumen. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers dalam 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 isinya. Ini hanya ada di peristiwa jika aplikasi host adalah Google Sheets.
Objek peristiwa Spreadsheet | |
---|---|
sheets.id |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna. ID spreadsheet 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 Spreadsheet
UI.
|
sheets.addonHasFileScopePermission |
boolean Jika true , add-on telah meminta
dan menerima https://www.googleapis.com/auth/drive.file
otorisasi cakupan untuk spreadsheet yang terbuka di UI Spreadsheet; sebaliknya
kolom ini adalah false .
|
sheets.matchedUrl.url |
string
Hanya ada jika ketentuan berikut terpenuhi:
URL link yang membuat pratinjau di Google Spreadsheet. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers dalam 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 isinya. Ini hanya ada di peristiwa jika aplikasi host adalah Google Slides.
Objek peristiwa Slide | |
---|---|
slides.id |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna. ID presentasi terbuka di Slide
UI.
|
slides.title |
string Hanya ada jika cakupan
https://www.googleapis.com/auth/drive.file telah
diizinkan oleh pengguna. Judul presentasi terbuka di
UI Slide.
|
slides.addonHasFileScopePermission |
boolean Jika true , add-on telah meminta
dan menerima https://www.googleapis.com/auth/drive.file
otorisasi cakupan untuk presentasi yang terbuka di UI Slide; sebaliknya
kolom ini adalah false .
|
slides.matchedUrl.url |
string
Hanya ada jika ketentuan berikut terpenuhi:
URL link yang membuat pratinjau di Google Slide. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers dalam 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" } } |