Objek peristiwa

Halaman ini menguraikan struktur objek peristiwa add-on Google Workspace.

Objek peristiwa adalah struktur JSON yang dibuat secara otomatis dan diteruskan sebagai parameter untuk memicu atau memanggil balik fungsi 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 berikut:

  • Pemicu halaman beranda. Setiap fungsi homepageTrigger yang Anda tentukan akan otomatis diteruskan 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 kumpulan pemicu kontekstual yang berbeda yang diaktifkan saat pengguna memasuki konteks tertentu. Contoh:

    Saat pemicu kontekstual diaktifkan, aplikasi host akan memanggil runFunction yang sesuai yang tercantum dalam manifes add-on, yang meneruskan objek peristiwa sebagai parameter. Objek peristiwa yang dibuat saat pemicu kontekstual diaktifkan berisi semua kolom yang disertakan dalam objek peristiwa pemicu halaman beranda, ditambah kolom yang berisi informasi kontekstual.

  • Tindakan widget. Objek peristiwa juga digunakan untuk memberikan interaktivitas widget, 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, di add-on Google Workspace, objek peristiwa tindakan menyertakan lebih banyak informasi 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, ditambah kolom yang berisi informasi widget.

  • Pratinjau pemicu link. 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 akan diaktifkan dan objek peristiwa yang berisi link akan diteruskan ke fungsi callback pemicu. Add-on Anda dapat menggunakan objek peristiwa ini untuk membuat chip dan kartu pintar yang menampilkan informasi tentang link dalam aplikasi host. Anda juga dapat mem-build tindakan widget untuk memungkinkan pengguna berinteraksi dengan kartu pratinjau dan kontennya.

  • Pemicu aplikasi Google Chat (Pratinjau Developer). Di Google Chat, add-on Anda akan muncul kepada pengguna sebagai aplikasi Chat, dan pengguna dapat berinteraksi dengannya dengan menambahkannya ke ruang, mengirim pesan, menggunakan perintah garis miring, dan lainnya. Untuk mem-build fitur interaktif, Anda menyiapkan dan menggunakan berbagai pemicu aplikasi Chat. Setiap pemicu mengirimkan payload objek peristiwa yang berbeda yang membantu Anda memproses atau merespons setiap jenis interaksi.

Struktur objek peristiwa

Tabel berikut menjelaskan struktur tingkat atas objek peristiwa add-on Google Workspace. Struktur objek peristiwa mencakup kolom level atas commonEventObject untuk informasi yang tidak bergantung pada host. Setiap objek peristiwa juga dapat memiliki salah satu kolom tingkat teratas khusus host berikut, yang ditentukan oleh aplikasi host 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 dalam 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 host.
eventObject.calendar Calendar event object
Hanya ada jika penyelenggara panggilan adalah Google Kalender. Objek yang berisi informasi kalender dan acara.
eventObject.chat Chat event object
Hanya ada jika host panggilan adalah Google Chat. Objek yang berisi informasi Chat.
eventObject.drive Drive event object
Hanya ada jika host panggilan adalah Google Drive. Objek yang berisi informasi Drive.
eventObject.gmail Gmail event object
Hanya ada jika host panggilan adalah Gmail. Objek yang berisi informasi Gmail.
eventObject.docs Docs event object
Hanya ada jika host panggilan adalah Google Dokumen. Objek yang berisi informasi Dokumen.
eventObject.sheets Sheets event object
Hanya ada jika host panggilan adalah Google Spreadsheet. Objek yang berisi informasi Spreadsheet.
eventObject.slides Slides event object
Hanya ada 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.gmail.accessToken.

eventObject.messageMetadata.messageId string
Tidak digunakan lagi. ID pesan rangkaian pesan yang terbuka di UI Gmail.

Untuk add-on Google Workspace, temukan informasi ini di kolom eventObject.gmail.messageId.

eventObject.clientPlatform string
Tidak digunakan lagi. Menunjukkan tempat peristiwa berasal (web, iOS, atau Android).

Untuk add-on Google Workspace, temukan informasi ini di kolom eventObject.commonEventObject.platform.

eventObject.formInput object
Tidak digunakan lagi. Peta nilai saat ini dari semua widget formulir di kartu, dibatasi hingga satu nilai per widget. Kunci adalah ID string yang terkait dengan widget, dan nilainya adalah string. Objek peristiwa menyediakan formInput sebagai kemudahan saat Anda perlu membaca data dari beberapa widget dengan nilai tunggal yang diharapkan, seperti input teks dan tombol. Untuk widget berbilang nilai seperti kotak centang, Anda dapat membaca setiap nilai dari formInputs.

Untuk add-on Google Workspace, temukan informasi ini di kolom eventObject.commonEventObject.formInputs; widget dengan nilai tunggal direpresentasikan sebagai array dengan satu elemen.

eventObject.formInputs object
Tidak digunakan lagi. Peta nilai widget saat ini di kartu, yang ditampilkan sebagai daftar string. Kunci adalah ID string yang terkait dengan widget. Untuk widget bernilai tunggal, nilai ditampilkan dalam array elemen tunggal. Untuk widget multinilai seperti grup kotak centang, semua nilai ditampilkan dalam daftar.

Untuk add-on Google Workspace, temukan informasi ini di kolom eventObject.commonEventObject.formInputs.

eventObject.parameters object
Tidak digunakan lagi. Peta parameter tambahan apa pun yang Anda berikan ke Action menggunakan Action.setParameters(). Kunci dan nilai peta adalah string.

Untuk add-on Google Workspace, temukan informasi ini di kolom eventObject.commonEventObject.parameters.

eventObject.userCountry string
Tidak digunakan lagi dan dinonaktifkan secara default. Kode dua huruf yang menunjukkan negara atau wilayah pengguna. Kode ini juga dapat berupa kode negara UN M49 numerik.

Untuk add-on Google Workspace, temukan informasi ini di kolom eventObject.commonEventObject.userLocale.

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.commonEventObject.userLocale.

eventObject.userTimezone.id string
Tidak digunakan lagi dan dinonaktifkan secara default. ID zona waktu zona waktu pengguna. Contohnya meliputi: 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.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Tidak digunakan lagi dan dinonaktifkan secara default. Offset waktu dari Waktu Universal Terkoordinasi (UTC) 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 eventObject.commonEventObject.timeZone.offset.

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 membuat kueri objek peristiwa umum untuk menentukan konten widget yang terbuka di klien pengguna. Misalnya, add-on Anda dapat menemukan teks yang dimasukkan pengguna ke dalam widget TextInput di objek eventObject.commentEventObject.formInputs.

Kolom objek peristiwa umum
commonEventObject.platform string
Menunjukkan tempat peristiwa berasal (`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 dengan setiap widget.

Struktur objek nilai peta bergantung pada jenis widget:

  • Widget nilai tunggal (misalnya, kotak teks): daftar string (hanya satu elemen).

    Contoh: untuk widget input teks dengan employeeName sebagai ID-nya, akses nilai input teks dengan: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

  • Widget multi-nilai (misalnya, grup kotak centang): daftar string.

    Contoh: untuk widget multi-nilai dengan participants sebagai ID-nya, akses array nilai dengan: e.commonEventObject.formInputs.participants.stringInputs.value.

  • A date-time picker: DateTimeInput object.

    Contoh: Untuk pemilih dengan ID myDTPicker, akses objek DateTimeInput menggunakan e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: DateInput object.

    Contoh: Untuk pemilih dengan ID myDatePicker, akses objek DateInput menggunakan e.commonEventObject.formInputs.myDatePicker.dateInput.

  • A time-only picker: TimeInput object.

    Contoh: Untuk pemilih dengan ID myTimePicker, akses objek TimeInput menggunakan e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Menunjukkan aplikasi host tempat add-on aktif saat objek peristiwa dibuat. Nilai yang memungkinkan mencakup hal berikut:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Parameter tambahan apa pun yang Anda berikan ke tindakan menggunakan actionParameters atau Action.setParameters().

Pratinjau Developer: Untuk add-on yang memperluas Google Chat, guna menyarankan item berdasarkan apa yang diketik pengguna di menu multipilih, gunakan nilai kunci "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Anda dapat menggunakan nilai ini untuk membuat kueri database dan menyarankan item yang dapat dipilih kepada pengguna saat mereka mengetik. Untuk mengetahui detailnya, lihat Mengumpulkan dan memproses informasi dari pengguna Google Chat.
commonEventObject.userLocale string
Dinonaktifkan secara default. ID bahasa dan negara/wilayah pengguna dalam format kode bahasa ISO 639-ISO 3166 kode negara/wilayah. Misalnya, en-US.

Untuk mengaktifkan kolom ini, Anda harus menetapkan addOns.common.useLocaleFromApp ke true dalam manifes add-on. 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 string
Dinonaktifkan secara default. ID zona waktu dan offset. Untuk mengaktifkan kolom ini, Anda harus menetapkan addOns.common.useLocaleFromApp ke true dalam manifes add-on. Daftar cakupan add-on Anda juga harus menyertakan https://www.googleapis.com/auth/script.locale. Lihat Mengakses lokalitas dan zona waktu pengguna untuk mengetahui detail selengkapnya.
commonEventObject.timeZone.id string
ID zona waktu zona waktu pengguna. Contohnya meliputi: America/New_York, Europe/Vienna, dan Asia/Seoul. Untuk mengaktifkan kolom ini, Anda harus menetapkan addOns.common.useLocaleFromApp ke true dalam manifes add-on. 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) zona waktu pengguna, diukur dalam milidetik. Lihat Mengakses lokalitas dan zona waktu pengguna untuk mengetahui 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 pemilih khusus waktu. Perbedaan struktural dijelaskan dalam tabel berikut:

Objek DateTimeInput
dateTimeInput.hasDate boolean
true jika waktu tanggal input menyertakan tanggal; jika false, hanya waktu yang disertakan.
dateTimeInput.hasTime boolean
true jika waktu tanggal input menyertakan waktu; jika false, hanya tanggal yang disertakan.
dateTimeInput.msSinceEpoch string
Waktu yang dipilih oleh pengguna, dalam milidetik sejak epoch (00:00:00 UTC pada 1 Januari 1970).
Objek DateInput
dateInput.msSinceEpoch string
Waktu yang dipilih oleh pengguna, dalam milidetik sejak epoch (00:00:00 UTC pada 1 Januari 1970).
Objek TimeInput
timeInput.hours number
Nomor jam yang dipilih oleh pengguna.
timeInput.minutes number
Jumlah menit yang dipilih oleh pengguna.

Objek acara kalender

Objek acara Kalender adalah bagian dari keseluruhan objek acara yang membawa informasi tentang kalender dan acara kalender pengguna. Properti ini hanya ada dalam objek peristiwa 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 di objek peristiwa jika dan hanya jika data ada di peristiwa Kalender dan add-on menetapkan kolom addOns.calendar.currentEventAccess manifest 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 peserta baru ke daftar peserta 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 peristiwa ini, seperti detail konferensi Google Meet.
calendar.id string
ID peristiwa.
calendar.organizer object
Objek yang mewakili penyelenggara acara.
calendar.organizer.email string
Alamat email penyelenggara acara.
calendar.recurringEventId string
ID acara berulang.

Tamu

Objek peserta membawa informasi tentang setiap peserta ke acara Google Kalender. Informasi ini ada di objek peristiwa jika dan hanya jika data ada di peristiwa Kalender dan add-on menetapkan kolom manifest addOns.calendar.currentEventAccess-nya ke READ atau READ_WRITE.

Objek tamu
attendee.additionalGuests number
Jumlah tamu tambahan yang telah ditunjukkan oleh peserta bahwa mereka akan membawanya. Nilai defaultnya adalah nol.
attendee.comment string
Komentar respons peserta, jika ada.
attendee.displayName string
Nama peserta yang ditampilkan.
attendee.email string
Alamat email peserta.
attendee.optional boolean
true jika kehadiran untuk peserta 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 peralatan; false jika tidak.
attendee.responseStatus string
Status respons peserta. Nilai yang memungkinkan mencakup hal berikut:
  • accepted: Peserta telah menerima undangan acara.
  • declined: Peserta telah menolak undangan acara.
  • needsAction: Peserta belum merespons undangan acara.
  • tentative: Peserta telah menerima sementara undangan acara.
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. Ini dapat berupa solusi konferensi Google, seperti Google Meet, atau konferensi pihak ketiga. Informasi ini ada di objek peristiwa jika dan hanya jika data ada di peristiwa Kalender dan add-on menetapkan kolom manifest addOns.calendar.currentEventAccess ke READ atau READ_WRITE.

Objek data konferensi
conferenceData.conferenceId string
ID konferensi. ID ini dimaksudkan untuk memungkinkan aplikasi 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 pengguna yang mewakili solusi konferensi ini.
conferenceData.conferenceSolution.key object
Kunci yang secara unik mengidentifikasi solusi konferensi untuk peristiwa ini.
conferenceData.conferenceSolution.key.type string
Jenis solusi konferensi. Nilai yang memungkinkan mencakup:
  • eventHangout untuk Hangouts bagi konsumen (http://hangouts.google.com).
  • eventNamedHangout untuk Hangouts klasik bagi pengguna Google Workspace (http://hangouts.google.com).
  • hangoutsMeet untuk Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
Nama solusi konferensi yang dapat dilihat pengguna (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 maksimumnya adalah 2048 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 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 ada di objek peristiwa jika dan hanya jika data ada di peristiwa Kalender dan add-on menetapkan kolom manifest addOns.calendar.currentEventAccess-nya ke READ atau READ_WRITE.

Objek titik entri
entryPoint.accessCode string
Kode akses yang digunakan untuk mengakses konferensi. Panjang maksimumnya adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan subset {accessCode, meetingCode, passcode, password, pin} untuk memberikan akses ke konferensi. Mencocokkan dan hanya menampilkan kolom yang digunakan penyedia konferensi.
entryPoint.entryPointFeatures list
Fitur titik entri. Saat ini, fitur ini hanya berlaku untuk titik entri phone:
  • toll: Titik entrinya adalah panggilan telepon berbayar.
  • toll_free: Titik entri adalah panggilan telepon bebas pulsa.
entryPoint.entryPointType string
Jenis titik entri. Kemungkinan nilainya adalah berikut:
  • more: Petunjuk tambahan untuk bergabung ke konferensi, seperti nomor telepon alternatif. Konferensi hanya dapat memiliki satu titik entri more; jika ada, setidaknya satu jenis titik entri lain juga diperlukan.
  • phone: Bergabung ke konferensi melalui nomor telepon. Konferensi dapat memiliki nol atau beberapa titik entri phone. Google Kalender hanya menampilkan dua titik entri telepon pertama, setelah memformat dan mengurutkan menurut abjad.
  • sip: Bergabung ke konferensi melalui SIP. Konferensi dapat memiliki maksimal satu titik entri sip.
  • video: Bergabung ke konferensi melalui HTTP. Konferensi dapat memiliki maksimal satu titik entri video.
entryPoint.label string
Label yang terlihat pengguna untuk URI titik entri (tidak dilokalkan).
entryPoint.meetingCode string
Kode rapat yang digunakan untuk mengakses konferensi. Panjang maksimumnya adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan sebagian dari {accessCode, meetingCode, passcode, password, pin} untuk memberikan akses ke konferensi. Mencocokkan dan hanya menampilkan kolom yang digunakan penyedia konferensi.
entryPoint.passcode string
Kode sandi yang digunakan untuk mengakses konferensi. Panjang maksimumnya adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan sebagian dari {accessCode, meetingCode, passcode, password, pin} untuk memberikan akses ke konferensi. Mencocokkan dan hanya menampilkan kolom yang digunakan penyedia konferensi.
entryPoint.password string
Sandi yang digunakan untuk mengakses konferensi. Panjang maksimumnya adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan subset {accessCode, meetingCode, passcode, password, pin} untuk memberikan akses ke konferensi. Mencocokkan dan hanya menampilkan kolom yang digunakan penyedia konferensi.
entryPoint.pin string
PIN yang digunakan untuk mengakses konferensi. Panjang maksimumnya adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan sebagian dari {accessCode, meetingCode, passcode, password, pin} untuk memberikan akses ke konferensi. Mencocokkan dan hanya menampilkan 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 maksimumnya adalah 1.300 karakter. Formatnya bergantung pada jenis titik entri:
  • more: Skema http: atau https: diperlukan.
  • phone: Skema tel: diperlukan. URI harus menyertakan seluruh urutan panggilan (misalnya, "tel:+12345678900,,,12345678;1234").
  • sip: Skema sip: atau sips: diperlukan. Misalnya "sip:12345678@myprovider.com".
  • video: Skema http: atau https: diperlukan.

Mendorong objek peristiwa

Objek peristiwa Drive adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang Google Drive pengguna dan kontennya. Atribut ini hanya ada dalam objek peristiwa jika aplikasi host adalah Google Drive.

Mendorong objek peristiwa
drive.activeCursorItem Drive item object
Item Drive yang 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. 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 akses sementara ke pesan Gmail pengguna yang saat ini terbuka atau mengizinkan add-on Anda menulis draf baru.
gmail.bccRecipients[] list of strings
Dinonaktifkan secara default. Daftar alamat email penerima "BCC:" yang saat ini disertakan dalam draf yang sedang ditulis 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 sedang ditulis 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 sedang ditulis 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. Ini hanya ada di 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 terbuka di UI Dokumen.
docs.title string
Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diotorisasi oleh pengguna.
Judul dokumen yang terbuka 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 terbuka di UI Dokumen; jika tidak, kolom ini adalah false.
docs.matchedUrl.url string
Hanya ada jika kondisi berikut terpenuhi:
  • https://www.googleapis.com/auth/workspace.linkpreview telah diotorisasi oleh pengguna.
  • URL cocok dengan pola host yang ditentukan dalam pemicu LinkPreviewTriggers.

URL link yang menghasilkan pratinjau di Google Dokumen. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers di manifes add-on. Lihat Melihat pratinjau link dengan smart chip untuk mengetahui detail selengkapnya.

Contoh payload saat pengguna melihat pratinjau link https://www.example.com/12345: 

"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. Ini hanya ada di 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 diotorisasi oleh pengguna. ID spreadsheet yang terbuka di UI Spreadsheet.
sheets.title string
Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diotorisasi oleh pengguna. Judul spreadsheet yang 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:
  • https://www.googleapis.com/auth/workspace.linkpreview telah diotorisasi oleh pengguna.
  • URL cocok dengan pola host yang ditentukan dalam pemicu LinkPreviewTriggers.

URL link yang menghasilkan pratinjau di Google Spreadsheet. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers di manifes add-on. Lihat Melihat pratinjau link dengan smart chip untuk mengetahui detail selengkapnya.

Contoh payload saat pengguna melihat pratinjau link https://www.example.com/12345:

"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. Ini hanya ada di 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 diotorisasi oleh pengguna. ID presentasi yang terbuka di UI Slide.
slides.title string
Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diotorisasi oleh pengguna. Judul presentasi 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:
  • https://www.googleapis.com/auth/workspace.linkpreview telah diotorisasi oleh pengguna.
  • URL cocok dengan pola host yang ditentukan dalam pemicu LinkPreviewTriggers.

URL link yang menghasilkan pratinjau di Google Slide. Untuk menggunakan kolom ini, Anda harus mengonfigurasi LinkPreviewTriggers di manifes add-on. Lihat Melihat pratinjau link dengan smart chip untuk mengetahui detail selengkapnya.

Contoh payload saat pengguna melihat pratinjau link https://www.example.com/12345:

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