Objek peristiwa

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

Objek peristiwa adalah struktur JSON yang otomatis dibuat dan diteruskan sebagai parameter ke fungsi pemicu 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 berikut:

  • Pemicu halaman beranda. Setiap fungsi homepageTrigger yang Anda tentukan akan otomatis meneruskan objek peristiwa saat fungsi pemicu halaman beranda diaktifkan. Anda dapat menggunakan objek ini dalam fungsi pemicu halaman beranda untuk mengidentifikasi aplikasi host yang aktif, platform klien, lokalitas pengguna, dan informasi lainnya.

    Objek peristiwa yang dibuat saat pemicu halaman beranda diaktifkan tidak berisi semua kolom yang disertakan dalam kasus lain; kolom yang berkaitan dengan widget dan informasi kontekstual dihilangkan.

  • Pemicu kontekstual. Setiap aplikasi host menyediakan kumpulan pemicu kontekstual yang berbeda yang aktif saat pengguna memasuki konteks tertentu:

    Saat pemicu kontekstual diaktifkan, aplikasi host akan memanggil runFunction terkait yang tercantum dalam manifes add-on, dengan 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 menyediakan interaktivitas widget, menggunakan model tindakan yang sama dengan yang digunakan add-on Gmail. Add-on Google Workspace menggunakan fungsi pengendali widget, objek Action, dan respons tindakan yang sama. Di add-on Google Workspace, objek peristiwa tindakan menyertakan lebih banyak informasi yang dapat ditindaklanjuti oleh fungsi callback.

    Objek peristiwa yang dibuat dari tindakan widget berisi semua kolom yang disertakan dalam objek peristiwa pemicu kontekstual, ditambah 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 sesuai dengan 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 cerdas 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.

  • Pemicu aplikasi Google Chat. Di Google Chat, add-on Anda akan muncul kepada pengguna sebagai aplikasi Chat, dan pengguna dapat berinteraksi dengan add-on tersebut dengan menambahkannya ke ruang, mengirim pesan, menggunakan perintah garis miring, dan lainnya. Untuk membangun fitur interaktif, Anda perlu 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 teratas objek peristiwa add-on Google Workspace. Struktur ini mencakup kolom level teratas 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 menyertakan kolom asli yang digunakan dalam objek peristiwa tindakan add-on Gmail. Kolom ini berada di bagian "Kolom add-on Gmail asli" dan bukan bagian dari commonEventObject.

Kolom add-on Gmail asli tidak digunakan lagi. Saat mengembangkan atau memigrasikan add-on Google Workspace, gunakan struktur objek peristiwa yang lebih baru. Kolom ini mungkin akan dihapus dalam update mendatang.

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 ada jika host 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 asal peristiwa (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 dalam kartu, dibatasi hingga satu nilai per widget. Kuncinya 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 bernilai banyak seperti kotak centang, baca 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 saat ini dari widget dalam kartu, yang ditampilkan sebagai daftar string. Kuncinya 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. Nilai 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 mengetahui 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 dari zona waktu pengguna. Contohnya meliputi: America/New_York, Europe/Vienna, dan Asia/Seoul. Lihat Mengakses lokalitas dan zona waktu pengguna untuk mengetahui 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. Selisih waktu dari Waktu Universal Terkoordinasi (UTC) dari zona waktu pengguna, diukur dalam milidetik. Lihat Mengakses lokalitas dan zona waktu pengguna untuk mengetahui 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 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 dari mana peristiwa berasal (`WEB`, `IOS`, atau `ANDROID`).
commonEventObject.formInputs object
Peta yang berisi nilai saat ini dari widget di kartu yang ditampilkan. Kunci peta adalah ID string yang ditetapkan dengan setiap widget.

Struktur objek nilai peta bergantung pada jenis widget:

  • Widget bernilai 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 bernilai banyak (misalnya, grup kotak centang): daftar string.

    Contoh: untuk widget multinilai 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 aplikasi Google Chat, untuk menyarankan item berdasarkan apa yang diketik pengguna di menu multi-pilihan, gunakan nilai kunci "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Anda dapat menggunakan nilai ini untuk mengkueri 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-kode negara/wilayah ISO 3166. 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 mengetahui detail selengkapnya.

commonEventObject.timeZone string
Dinonaktifkan secara default. ID dan selisih zona waktu. 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 dari 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 mengetahui detail selengkapnya.
commonEventObject.timeZone.offset string
Selisih waktu dari Waktu Universal Terkoordinasi (UTC) dari 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. Struktur informasi 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 tanggal waktu input menyertakan tanggal; jika false hanya waktu yang disertakan.
dateTimeInput.hasTime boolean
true jika tanggal dan waktu 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
Angka jam yang dipilih oleh pengguna.
timeInput.minutes number
Angka menit yang dipilih oleh pengguna.

Objek peristiwa chat

Objek peristiwa Chat adalah bagian dari objek peristiwa keseluruhan yang membawa informasi tentang interaksi pengguna dengan aplikasi Chat. Objek ini hanya ada dalam objek peristiwa jika add-on memperluas Google Chat.

Chat
chat.user object (User)
Pengguna Chat yang berinteraksi dengan aplikasi Chat.
chat.space object (Space)
Ruang Chat tempat pengguna berinteraksi dengan aplikasi Chat.
chat.eventTime

string (Timestamp format)

Waktu interaksi terjadi.

Kolom union payload. Untuk pemicu Beranda Aplikasi (saat pengguna membuka tab Beranda), payload tidak ditetapkan dan chat berisi chat.user dan chat.eventTime.

payload hanya dapat berupa salah satu dari hal berikut:
chat.messagePayload

object (MessagePayload)

Payload yang diterima aplikasi Chat dari pemicu Pesan.
chat.addedToSpacePayload

object (AddedToSpacePayload)

Payload yang diterima aplikasi Chat dari pemicu Ditambahkan ke ruang.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

Payload yang diterima aplikasi Chat dari pemicu Dihapus dari ruang.
chat.buttonClickedPayload

object (ButtonClickedPayload)

Payload yang diterima aplikasi Chat saat pengguna mengklik tombol dari pesan atau kartu. Jika pengguna mengklik tombol untuk mengirimkan informasi, objek commonEventObject.formInputs akan berisi nilai yang dikumpulkan dari pengguna. Untuk mengetahui detailnya, lihat Mengumpulkan informasi dari pengguna Google Chat.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

Payload yang diterima aplikasi Chat saat pengguna mengetik teks ke dalam menu multipilih dari widget selectionInput. Aplikasi Chat dapat menggunakan objek peristiwa ini untuk mengisi item yang disarankan dari sumber data dinamis. Misalnya, untuk mengisi kasus dukungan dari sumber data eksternal, aplikasi Chat dapat mengkueri sumber data berdasarkan apa yang diketik pengguna ke dalam menu, lalu menampilkan kasus dukungan yang cocok sebagai item yang dapat dipilih.

Objek CommonEventObject.parameters['autocomplete_widget_query'] berisi nilai string yang diketik pengguna ke dalam menu.

chat.appCommandPayload

object (AppCommandPayload)

Payload yang diterima aplikasi Chat saat pengguna menggunakan perintah dari aplikasi Chat.

Payload

Bergantung pada jenis interaksi aplikasi Chat, peristiwa tersebut berisi payload dengan satu atau beberapa resource Chat API.

Payload pesan
MessagePayload
chat.messagePayload.message object (Message)
Pesan Chat yang memicu peristiwa.
chat.messagePayload.space object (Space)
Ruang Chat tempat pengguna mengirim pesan yang memanggil aplikasi Chat.
chat.messagePayload.configCompleteRedirectUri string
URL yang harus digunakan aplikasi Chat untuk mengalihkan pengguna setelah mereka menyelesaikan alur otorisasi atau konfigurasi di luar Google Chat. Untuk mengetahui informasi selengkapnya, lihat Menghubungkan add-on Google Workspace ke layanan pihak ketiga.
Payload ditambahkan ke ruang
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
Ruang Chat tempat pengguna menambahkan atau menginstal aplikasi Chat.

Saat administrator menginstal aplikasi Chat, kolom space.adminInstalled ditetapkan ke true.

chat.addedToSpacePayload.interactionAdd boolean
Apakah pengguna menambahkan aplikasi Chat ke ruang menggunakan pesan. Misalnya, @menyebutkan aplikasi Chat atau menggunakan perintah. Jika true, Chat akan mengirim objek peristiwa lain dengan messagePayload yang berisi informasi tentang pesan.
chat.addedToSpacePayload.configCompleteRedirectUri string
URL yang harus digunakan aplikasi Chat untuk mengalihkan pengguna setelah mereka menyelesaikan alur otorisasi atau konfigurasi di luar Google Chat. Untuk mengetahui informasi selengkapnya, lihat Menghubungkan add-on Google Workspace ke layanan pihak ketiga.
Payload dihapus dari ruang
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
Ruang Chat tempat pengguna menghapus atau meng-uninstal aplikasi Chat.

Saat administrator meng-uninstal aplikasi Chat, kolom space.adminInstalled ditetapkan ke false.

Payload tombol diklik
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
Pesan Chat yang berisi tombol yang diklik pengguna.
chat.buttonClickedPayload.space object (Space)
Ruang Chat tempat pengguna mengklik tombol dari pesan aplikasi Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Apakah pengguna mengklik tombol untuk berinteraksi dengan dialog.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Jika isDialogEvent adalah true, jenis interaksi dalam dialog.

Enum DialogEventType.

Nilai dialogEventType hanya dapat berupa salah satu dari hal berikut:
TYPE_UNSPECIFIED Nilai default. Tidak ditentukan.
REQUEST_DIALOG Pengguna meminta dialog. Misalnya, mereka menggunakan perintah atau mengklik tombol dari pesan.
SUBMIT_DIALOG Pengguna mengklik elemen interaktif dalam dialog. Misalnya, pengguna mengisi informasi dalam dialog dan mengklik tombol untuk mengirimkan informasi.
Payload widget yang diperbarui
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
Ruang Chat tempat interaksi terjadi.
Payload perintah aplikasi
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Metadata tentang perintah yang digunakan pengguna dan cara mereka memicunya.
chat.appCommandPayload.space object (Space)
Ruang Chat tempat pengguna menggunakan perintah.
chat.appCommandPayload.thread object (Thread)
Jika interaksi terjadi dalam rangkaian pesan, rangkaian pesan Chat tempat pengguna menggunakan perintah.
chat.appCommandPayload.message object (Message)
Untuk perintah garis miring, pesan dengan perintah garis miring.
chat.appCommandPayload.configCompleteRedirectUri string
Jika otorisasi atau konfigurasi diperlukan untuk perintah, URL untuk mengarahkan pengguna setelah mereka menyelesaikan proses di luar Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Apakah perintah membuka dialog.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
Jenis interaksi dengan dialog.

Enum DialogEventType.

Nilai dialogEventType hanya dapat berupa salah satu dari hal berikut:
TYPE_UNSPECIFIED Nilai default. Tidak ditentukan.
REQUEST_DIALOG Pengguna meminta dialog. Misalnya, mereka menggunakan perintah atau mengklik tombol dari pesan.
SUBMIT_DIALOG Pengguna mengklik elemen interaktif dalam dialog. Misalnya, pengguna mengisi informasi dalam dialog dan mengklik tombol untuk mengirimkan informasi.
Metadata Perintah Aplikasi
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

ID perintah.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
Jenis perintah.

Enum AppCommandType.

Nilai AppCommandType hanya dapat berupa salah satu dari hal berikut:
APP_COMMAND_TYPE_UNSPECIFIED Nilai default. Tidak ditentukan.
SLASH_COMMAND Pengguna menggunakan perintah dengan mengirim pesan yang diawali dengan garis miring /.
QUICK_COMMAND Pengguna memilih perintah dari menu Chat di area balasan pesan.

Objek acara kalender

Objek acara Kalender adalah bagian dari objek acara keseluruhan yang membawa informasi tentang kalender dan acara kalender pengguna. Objek ini hanya ada dalam objek peristiwa jika add-on memperluas 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 dalam peristiwa Kalender dan add-on menetapkan kolom addOns.calendar.currentEventAccess manifes-nya ke READ atau READ_WRITE.

Untuk banyak kolom dalam objek ini dan substrukturnya, ada pemetaan langsung ke kolom resource Acara Calendar API dengan nama yang sama. Jika deskripsi kolom berbeda, informasi dalam tabel berikut adalah yang benar.

Objek acara kalender
calendar.attendees[] list of attendee objects
Data buatan pengguna. Daftar peserta acara kalender.
calendar.calendarId string
ID kalender.
calendar.capabilities object
Data buatan pengguna. Objek yang menjelaskan kemampuan add-on untuk melihat atau memperbarui informasi acara.
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 peristiwa.
calendar.organizer object
Objek yang mewakili penyelenggara acara.
calendar.organizer.email string
Alamat email penyelenggara acara.
calendar.recurringEventId string
ID acara rutin.

Tamu

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

Objek peserta
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 tampilan peserta.
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 tamu adalah penyelenggara acara ini.
attendee.resource boolean
true jika tamu mewakili fasilitas, seperti ruang atau peralatan; false jika tidak.
attendee.responseStatus string
Status respons tamu. Nilai yang memungkinkan mencakup:
  • accepted: Peserta telah menerima undangan acara.
  • declined: Peserta telah menolak undangan acara.
  • needsAction: Peserta belum merespons undangan acara.
  • tentative: Peserta telah menerima undangan acara untuk sementara.
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. Solusi 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 addOns.calendar.currentEventAccess manifes-nya 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 dapat dilihat pengguna yang mewakili 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 memungkinkan mencakup hal berikut:
  • 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 ini yang terlihat oleh 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 dalam objek acara jika dan hanya jika data ada dalam acara Kalender dan add-on menetapkan kolom addOns.calendar.currentEventAccess manifest-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. 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:
  • toll: Titik entri adalah panggilan telepon berbayar.
  • toll_free: Titik entri adalah panggilan telepon bebas pulsa.
entryPoint.entryPointType string
Jenis titik entri. Nilai yang memungkinkan adalah sebagai 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. Satu konferensi dapat memiliki maksimal satu titik entri sip.
  • video: Bergabung ke konferensi melalui HTTP. Satu konferensi dapat memiliki maksimal satu titik entri video.
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 maksimumnya adalah 128 karakter. Penyedia konferensi biasanya hanya menggunakan subset {accessCode, meetingCode, passcode, password, pin} untuk memberikan akses ke konferensi. Cocokkan dan hanya tampilkan 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 subset {accessCode, meetingCode, passcode, password, pin} untuk memberikan akses ke konferensi. Cocokkan dan hanya tampilkan 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. Cocokkan dan hanya tampilkan kolom yang digunakan penyedia konferensi.
entryPoint.pin string
PIN 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. 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 maksimumnya adalah 1.300 karakter. Pemformatan 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.

Objek peristiwa Drive

Objek peristiwa Drive adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang Google Drive pengguna dan kontennya. Objek ini hanya ada dalam objek peristiwa jika add-on memperluas Google Drive.

Objek peristiwa Drive
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. Objek ini hanya ada dalam objek peristiwa jika aplikasi host-nya adalah Gmail.

Objek peristiwa Gmail
gmail.accessToken string
Token akses khusus Gmail. Gunakan token ini dengan metode GmailApp.setCurrentMessageAccessToken untuk memberikan akses sementara ke pesan Gmail pengguna yang sedang 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 dibuat oleh add-on. Untuk mengaktifkan kolom ini, tetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes Anda ke METADATA.
gmail.ccRecipients[] list of strings
Dinonaktifkan secara default. Daftar alamat email penerima "CC:" yang saat ini disertakan dalam draf yang sedang dibuat oleh add-on. Untuk mengaktifkan kolom ini, tetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes Anda 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 dibuat oleh add-on. Untuk mengaktifkan kolom ini, tetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes Anda ke METADATA.

Objek peristiwa Dokumen

Objek peristiwa Dokumen adalah bagian dari keseluruhan objek peristiwa yang membawa informasi tentang dokumen pengguna dan kontennya. Objek ini hanya ada dalam objek peristiwa jika add-on memperluas 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 diizinkan 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 dalam manifes add-on. Lihat Melihat pratinjau link dengan chip cerdas 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. Parameter ini hanya ada dalam objek peristiwa jika add-on memperluas 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 yang terbuka di UI Spreadsheet.
sheets.title string
Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diizinkan 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 diizinkan oleh pengguna.
  • URL cocok dengan pola host yang ditentukan dalam pemicu LinkPreviewTriggers.

URL link yang menghasilkan pratinjau di Google Spreadsheet. Untuk menggunakan kolom ini, konfigurasikan LinkPreviewTriggers di manifes add-on Anda. Lihat Melihat pratinjau link dengan chip cerdas 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 objek peristiwa keseluruhan yang membawa informasi tentang dokumen pengguna dan kontennya. Objek ini hanya ada dalam objek peristiwa jika add-on memperluas 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:
  • https://www.googleapis.com/auth/workspace.linkpreview telah diizinkan oleh pengguna.
  • URL cocok dengan pola host yang ditentukan dalam pemicu LinkPreviewTriggers.

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

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

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