EventObject

EventObject

Peristiwa interaksi add-on Google yang berisi data tentang interaksi pengguna dengan add-on dalam aplikasi host.

Objek peristiwa diteruskan sebagai JSON ke fungsi callback atau pemicu add-on (untuk AppsScript), atau endpoint https (untuk HTTP), saat pengguna berinteraksi dengan add-on dalam aplikasi host. Objek peristiwa menyimpan objek peristiwa aplikasi host yang ditentukan oleh setiap aplikasi host, serta objek peristiwa umum yang berisi beberapa kolom umum yang terkait dengan peristiwa tersebut.

Untuk informasi selengkapnya, lihat Objek peristiwa.

Representasi JSON
{
  "commonEventObject": {
    object (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
Kolom
commonEventObject

object (CommonEventObject)

Objek yang berisi informasi umum untuk semua objek peristiwa, terlepas dari aplikasi host.

authorizationEventObject

object (AuthorizationEventObject)

Hanya ditetapkan untuk permintaan ke endpoint HTTP

Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
calendar

object (CalendarEventObject)

Hanya ada jika host panggilan adalah Google Kalender. Objek yang berisi informasi kalender dan acara.

drive

object (DriveEventObject)

Hanya ada jika host panggilan adalah Google Drive. Objek yang berisi informasi Drive.

gmail

object (GmailEventObject)

Hanya ada jika host panggilan adalah Gmail. Objek yang berisi informasi Gmail.

sheets

object (SheetsEventObject)

Hanya ada jika host panggilan adalah Google Spreadsheet. Objek yang berisi informasi Spreadsheet.

slides

object (SlidesEventObject)

Hanya ada jika host panggilan adalah Google Slide. Objek yang berisi informasi Slide.

docs

object (DocsEventObject)

Hanya ada jika host panggilan adalah Google Dokumen. Objek yang berisi informasi Dokumen.

chat

object (ChatEventObject)

Hanya ada jika host panggilan adalah Google Chat. Objek yang berisi informasi Chat.

workflow

object (WorkflowEventObject)

Hanya ada jika host panggilan adalah Google Workspace Studio. Objek yang berisi informasi alur kerja.

Akhir kolom yang saling eksklusif.

CommonEventObject

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.

Untuk aplikasi Chat, nama fungsi yang dipanggil pengguna saat berinteraksi dengan widget.

Representasi JSON
{
  "userLocale": string,
  "hostApp": enum (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Kolom
userLocale

string

Dinonaktifkan secara default. ID bahasa dan negara/wilayah pengguna dalam format kode bahasa ISO 639-kode negara/wilayah ISO 3166. Contoh, 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.

hostApp

enum (HostApp)

Menunjukkan aplikasi host tempat add-on aktif saat objek peristiwa dibuat. Nilai yang memungkinkan mencakup:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

Enum platform yang menunjukkan platform tempat peristiwa berasal (WEB, IOS, atau ANDROID). Tidak didukung oleh aplikasi Chat.

timeZone

object (TimeZone)

Dinonaktifkan secara default. ID zona waktu dan selisih dari Waktu Universal Terkoordinasi (UTC). 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.

Hanya didukung untuk jenis peristiwa CARD_CLICKED dan SUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

Peta yang berisi nilai saat ini dari widget di kartu yang ditampilkan. Kunci peta adalah nilai name string yang ditetapkan ke setiap widget input (seperti TextInput.name, SelectionInput.name, DateTimePicker.name, atau DecoratedText.SwitchControl.name).

Struktur objek nilai peta bergantung pada jenis widget:

Catatan: Contoh berikut diformat untuk runtime V8 Apps Script. Jika Anda menggunakan runtime Rhino, Anda harus menambahkan [""] setelah nilai. Misalnya, format objek peristiwa sebagai e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0], bukan e.commonEventObject.formInputs.employeeName.stringInputs.value[0]. Untuk mempelajari lebih lanjut runtime di Apps Script, lihat Ringkasan Runtime V8.

  • Widget bernilai tunggal (misalnya, widget TextInput, atau widget SelectionInput dari jenis DROPDOWN atau RADIO_BUTTON): objek StringInputs yang berisi daftar elemen tunggal (atau daftar kosong jika tidak ada pilihan yang dibuat).

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

  • Widget bernilai banyak (misalnya, widget SelectionInput dari jenis CHECK_BOX, SWITCH, atau MULTI_SELECT): objek StringInputs yang berisi daftar string value item yang dipilih.

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

  • Widget DecoratedText.SwitchControl: objek StringInputs. Jika selected adalah true, stringInputs.value akan berisi kolom value tombol (atau "" jika value tidak ditentukan; jika beberapa tombol memiliki name yang sama, value setiap tombol yang dipilih akan disertakan dalam daftar). Jika selected adalah false, value tombol akan dihilangkan dari stringInputs.value.

  • Pemilih tanggal-waktu (DateTimePickerType.DATE_AND_TIME): DateTimeInput object.

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

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

Contoh: Untuk pemilih dengan name dari myTimePicker, akses objek TimeInput menggunakan e.commonEventObject.formInputs.myTimePicker.timeInput.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

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

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Nama fungsi yang akan dipanggil.

Kolom ini tidak diisi untuk Add-on Google Workspace yang memperluas Google Chat. Sebagai gantinya, untuk menerima data fungsi seperti ID, add-on yang memperluas Chat harus menggunakan kolom parameters. Lihat Membangun antarmuka interaktif untuk aplikasi Chat.

HostApp

Aplikasi Google Workspace untuk add-on Google Workspace atau aplikasi Google Chat.

Untuk add-on, aplikasi Workspace tempat add-on Google Workspace diluncurkan. Untuk aplikasi Chat, aplikasi host-nya selalu CHAT.

Enum
UNSPECIFIED_HOST_APP Google tidak dapat mengidentifikasi aplikasi host.
GMAIL Add-on diluncurkan dari Gmail.
CALENDAR Add-on diluncurkan dari Google Kalender.
DRIVE Add-on diluncurkan dari Google Drive.
DEMO Tidak digunakan.
DOCS Add-on akan diluncurkan dari Google Dokumen.
MEET Add-on diluncurkan dari Google Meet.
SHEETS Add-on akan diluncurkan dari Google Spreadsheet.
SLIDES Add-on akan diluncurkan dari Google Slide.
DRAWINGS Add-on diluncurkan dari Google Gambar.
CHAT Aplikasi Google Chat.

Platform

Mengidentifikasi platform asal panggilan ini.

Enum
UNKNOWN_PLATFORM
WEB
IOS
ANDROID

TimeZone

ID zona waktu dan selisih dari Waktu Universal Terkoordinasi (UTC). Hanya didukung untuk jenis peristiwa CARD_CLICKED dan SUBMIT_DIALOG.

Representasi JSON
{
  "id": string,
  "offset": integer
}
Kolom
id

string

Kode database zona waktu IANA TZ, seperti "America/Toronto".

offset

integer

Offset zona waktu pengguna, dalam milidetik, dari Waktu Universal Terkoordinasi (UTC).

Input

Jenis data yang dapat dimasukkan pengguna di kartu atau dialog. Jenis input bergantung pada jenis nilai yang diterima widget.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringInputs": {
    object (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
Kolom
Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
stringInputs

object (StringInputs)

Daftar string yang mewakili nilai yang dimasukkan pengguna dalam widget.

Jika widget hanya menerima satu nilai, seperti widget TextInput, daftar akan berisi satu objek string. Jika widget menerima beberapa nilai, seperti widget SelectionInput kotak centang, daftar akan berisi objek string untuk setiap nilai yang dimasukkan atau dipilih pengguna.

dateTimeInput

object (DateTimeInput)

Nilai input tanggal dan waktu dari widget DateTimePicker yang menerima tanggal dan waktu.

dateInput

object (DateInput)

Nilai input tanggal dari widget DateTimePicker yang hanya menerima nilai tanggal.

timeInput

object (TimeInput)

Nilai input waktu dari widget DateTimePicker yang hanya menerima nilai waktu.

Akhir kolom yang saling eksklusif.

StringInputs

Parameter input untuk widget reguler. Untuk widget bernilai tunggal, ini adalah daftar nilai tunggal. Untuk widget multinilai, seperti kotak centang, semua nilai akan ditampilkan.

Representasi JSON
{
  "value": [
    string
  ]
}
Kolom
value[]

string

Daftar string yang dimasukkan oleh pengguna.

DateTimeInput

Nilai input tanggal dan waktu.

Representasi JSON
{
  "msSinceEpoch": string,
  "hasDate": boolean,
  "hasTime": boolean
}
Kolom
msSinceEpoch

string (int64 format)

Waktu sejak waktu epoch, dalam milidetik.

hasDate

boolean

Apakah input datetime menyertakan tanggal kalender.

hasTime

boolean

Apakah input datetime menyertakan stempel waktu.

DateInput

Nilai input tanggal.

Representasi JSON
{
  "msSinceEpoch": string
}
Kolom
msSinceEpoch

string (int64 format)

Waktu sejak waktu epoch, dalam milidetik.

TimeInput

Nilai input waktu.

Representasi JSON
{
  "hours": integer,
  "minutes": integer
}
Kolom
hours

integer

Jam dalam format 24 jam.

minutes

integer

Jumlah menit setelah satu jam. Nilai yang valid adalah 0 hingga 59.

AuthorizationEventObject

Menggabungkan informasi otorisasi untuk permintaan add-on

Representasi JSON
{
  "userOAuthToken": string,
  "userIdToken": string,
  "systemIdToken": string,
  "authorizedScopes": [
    string
  ]
}
Kolom
userOAuthToken

string

Token akses OAuth pengguna akhir, yang diizinkan dengan cakupan yang diminta. (Setelah pemisahan izin oAuth, tindakan ini akan diizinkan dengan cakupan yang diizinkan pengguna akhir)

userIdToken

string

Token ID pengguna akhir, jika cakupan ID yang sesuai diminta

systemIdToken

string

Token ID untuk akun layanan Add-on G Suite untuk deployment ini

authorizedScopes[]

string

Daftar cakupan OAuth yang diizinkan oleh pengguna.

CalendarEventObject

Objek peristiwa Kalender adalah bagian dari objek peristiwa keseluruhan yang membawa informasi tentang kalender dan acara kalender pengguna. Objek ini hanya ada dalam objek peristiwa jika aplikasi host-nya adalah Google Kalender.

Tabel berikut mencantumkan kolom yang ada di kolom calendar objek peristiwa. Kolom yang ditandai sebagai Data buatan pengguna ada di objek peristiwa jika dan hanya jika data ada di acara Kalender dan add-on menetapkan kolom manifes addOns.calendar.currentEventAccess-nya ke READ atau READ_WRITE.

Representasi JSON
{
  "id": string,
  "recurringEventId": string,
  "calendarId": string,
  "organizer": {
    object (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
Kolom
id

string

ID peristiwa.

recurringEventId

string

ID acara rutin.

calendarId

string

ID kalender.

organizer

object (Organizer)

Objek yang mewakili penyelenggara acara.

attendees[]

object (Attendee)

Data buatan pengguna. Daftar peserta acara kalender.

conferenceData

object (ConferenceData)

Data buatan pengguna. Objek yang mewakili data konferensi apa pun yang terkait dengan acara ini, seperti detail konferensi Google Meet.

capabilities

object (Capabilities)

Data buatan pengguna. Objek yang menjelaskan kemampuan add-on untuk melihat atau memperbarui informasi acara.

Penyelenggara

Representasi JSON
{
  "email": string
}
Kolom
email

string

Alamat email penyelenggara acara.

Tamu

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

Representasi JSON
{
  "email": string,
  "displayName": string,
  "organizer": boolean,
  "self": boolean,
  "resource": boolean,
  "optional": boolean,
  "responseStatus": string,
  "comment": string,
  "additionalGuests": integer
}
Kolom
email

string

Alamat email peserta.

displayName

string

Nama tampilan peserta.

organizer

boolean

true jika tamu adalah penyelenggara untuk acara ini.

self

boolean

true jika tamu ini mewakili kalender tempat acara ini muncul; false jika tidak.

resource

boolean

true jika peserta mewakili fasilitas, seperti ruang atau peralatan; false jika tidak.

optional

boolean

true jika kehadiran untuk peserta ini ditandai sebagai opsional; false jika tidak.

responseStatus

string

Status respons peserta. 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.
comment

string

Komentar respons peserta, jika ada.

additionalGuests

integer

Jumlah tamu tambahan yang telah dinyatakan oleh peserta akan dibawa. Nilai defaultnya adalah nol.

ConferenceData

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.

Representasi JSON
{
  "conferenceId": string,
  "conferenceSolution": {
    object (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
Kolom
conferenceId

string

ID konferensi. ID ini dimaksudkan untuk memungkinkan aplikasi melacak konferensi; Anda tidak boleh menampilkan ID ini kepada pengguna.

conferenceSolution

object (ConferenceSolution)

Objek yang mewakili solusi konferensi, seperti Hangouts atau Google Meet.

entryPoints[]

object (EntryPoint)

Daftar titik entri konferensi, seperti URL atau nomor telepon.

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.

parameters

object (Parameters)

Objek yang berisi peta data parameter yang ditentukan untuk digunakan oleh add-on.

ConferenceSolution

Representasi JSON
{
  "iconUri": string,
  "key": {
    object (Key)
  },
  "name": string
}
Kolom
iconUri

string

URI untuk ikon yang dapat dilihat pengguna yang mewakili solusi konferensi ini.

key

object (Key)

Kunci yang secara unik mengidentifikasi solusi konferensi untuk acara ini.

name

string

Nama solusi konferensi ini yang terlihat oleh pengguna (tidak dilokalkan).

Kunci

Representasi JSON
{
  "type": string
}
Kolom
type

string

Jenis solusi konferensi. Nilai yang memungkinkan mencakup:

EntryPoint

Objek titik entri membawa informasi tentang cara yang ditetapkan untuk mengakses konferensi tertentu, seperti melalui telepon atau video. Informasi ini ada dalam objek peristiwa jika dan hanya jika data ada dalam acara Kalender dan add-on menetapkan kolom manifes addOns.calendar.currentEventAccess-nya ke READ atau READ_WRITE.

Representasi JSON
{
  "accessCode": string,
  "entryPointType": string,
  "label": string,
  "meetingCode": string,
  "passcode": string,
  "password": string,
  "pin": string,
  "uri": string,
  "regionCode": string,
  "entryPointFeatures": [
    string
  ]
}
Kolom
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.

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 lainnya; 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 telepon. 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.
label

string

Label yang terlihat oleh pengguna untuk URI titik entri (tidak dilokalkan).

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.

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.

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.

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.

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.
regionCode

string

Kode wilayah nomor telepon. Diperlukan oleh pengguna jika URI tidak menyertakan kode negara. Nilai didasarkan pada daftar kode wilayah CLDR publik.

entryPointFeatures[]

string

Fitur titik entri. Saat ini, fitur ini hanya berlaku untuk titik entri telepon:

  • toll: Titik entri adalah panggilan telepon berbayar.
  • toll_free: Titik entri adalah panggilan telepon bebas pulsa.

Parameter

Representasi JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
Kolom
addOnParameters

object (AddOnParameters)

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.

AddOnParameters

Representasi JSON
{
  "parameters": {
    string: string,
    ...
  }
}
Kolom
parameters

map (key: string, value: string)

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Kemampuan

Representasi JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
Kolom
canSeeAttendees

boolean

Data buatan pengguna. true jika add-on dapat membaca daftar tamu acara; false jika tidak.

canAddAttendees

boolean

Data buatan pengguna. true jika add-on dapat menambahkan tamu baru ke daftar tamu acara; false jika tidak.

canSeeConferenceData

boolean

Data buatan pengguna. true jika add-on dapat membaca data konferensi acara; false jika tidak.

canSetConferenceData

boolean

Data buatan pengguna. true jika add-on dapat memperbarui data konferensi acara; false jika tidak.

canAddAttachments

boolean

Data buatan pengguna. true jika add-on dapat menambahkan lampiran baru ke acara; false jika tidak.

DriveEventObject

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

Representasi JSON
{
  "selectedItems": [
    {
      object (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
Kolom
selectedItems[]

object (DriveItemMetadata)

Daftar item (file atau folder) yang dipilih di Drive.

activeCursorItem

object (DriveItemMetadata)

Item Drive yang saat ini aktif.

DriveItemMetadata

Objek item Drive membawa informasi tentang item Drive tertentu, seperti file atau folder.

Representasi JSON
{
  "id": string,
  "iconUrl": string,
  "mimeType": string,
  "title": string,
  "addonHasFileScopePermission": boolean
}
Kolom
id

string

ID item yang dipilih.

iconUrl

string

URL ikon yang mewakili item yang dipilih.

mimeType

string

Jenis MIME item yang dipilih.

title

string

Judul item yang dipilih.

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 bernilai false.

Jika add-on menggunakan cakupan yang lebih permisif seperti https://www.googleapis.com/auth/drive atau https://www.googleapis.com/auth/drive.readonly, kolom ini tidak relevan. Selalu gunakan cakupan yang paling tidak permisif saat mendesain add-on untuk melindungi informasi pengguna.

GmailEventObject

Objek peristiwa Gmail adalah bagian dari objek peristiwa keseluruhan yang membawa informasi tentang pesan Gmail pengguna. Objek ini hanya ada dalam objek peristiwa jika aplikasi host-nya adalah Gmail.

Representasi JSON
{
  "messageId": string,
  "threadId": string,
  "accessToken": string,
  "toRecipients": [
    string
  ],
  "ccRecipients": [
    string
  ],
  "bccRecipients": [
    string
  ]
}
Kolom
messageId

string

ID pesan Gmail yang saat ini terbuka.

threadId

string

ID rangkaian pesan Gmail yang saat ini terbuka.

accessToken

string

Token akses khusus Gmail. Anda dapat menggunakan token ini dengan metode GmailApp.setCurrentMessageAccessToken(accessToken) untuk memberi add-on Anda akses sementara ke pesan Gmail pengguna yang saat ini terbuka atau mengizinkan add-on Anda menulis draf baru.

toRecipients[]

string

Dinonaktifkan secara default. Daftar alamat email penerima "Kepada:" yang saat ini disertakan dalam draf yang sedang dibuat oleh add-on. Untuk mengaktifkan kolom ini, Anda harus menetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes ke METADATA.

ccRecipients[]

string

Dinonaktifkan secara default. Daftar alamat email penerima "CC:" yang saat ini disertakan dalam draf yang sedang dibuat oleh add-on. Untuk mengaktifkan kolom ini, Anda harus menetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes ke METADATA.

bccRecipients[]

string

Dinonaktifkan secara default. Daftar alamat email penerima "BCC:" yang saat ini disertakan dalam draf yang sedang dibuat oleh add-on. Untuk mengaktifkan kolom ini, Anda harus menetapkan kolom addOns.gmail.composeTrigger.draftAccess dalam manifes ke METADATA.

SheetsEventObject

Objek peristiwa Spreadsheet 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 Spreadsheet.

Representasi JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Kolom
id

string

Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diizinkan oleh pengguna. ID spreadsheet yang terbuka di UI Spreadsheet.

title

string

Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diizinkan oleh pengguna. Judul spreadsheet yang terbuka di UI Spreadsheet.

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.

matchedUrl

object (MatchedUrl)

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, 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:

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

MatchedUrl

Objek peristiwa yang ditampilkan dengan permintaan pratinjau link.

Representasi JSON
{
  "url": string
}
Kolom
url

string

URL yang cocok.

SlidesEventObject

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.

Representasi JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Kolom
id

string

Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diizinkan oleh pengguna. ID presentasi yang terbuka di UI Slide.

title

string

Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diizinkan oleh pengguna. Judul presentasi yang terbuka di UI Slide.

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.

matchedUrl

object (MatchedUrl)

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, 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:

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

DocsEventObject

Objek peristiwa Dokumen 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 Dokumen.

Representasi JSON
{
  "id": string,
  "title": string,
  "addonHasFileScopePermission": boolean,
  "matchedUrl": {
    object (MatchedUrl)
  }
}
Kolom
id

string

Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diizinkan oleh pengguna. ID dokumen yang terbuka di UI Dokumen.

title

string

Hanya ada jika cakupan https://www.googleapis.com/auth/drive.file telah diizinkan oleh pengguna. Judul dokumen yang terbuka di UI Dokumen.

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.

matchedUrl

object (MatchedUrl)

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"
  }
}

ChatEventObject

Payload objek peristiwa aplikasi Google Chat yang dikirim dari server Google ke add-on. Payload dapat digunakan untuk mengidentifikasi jenis peristiwa.

Representasi JSON
{
  "type": enum (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
Kolom
type

enum (EventType)

Jenis peristiwa, hanya diisi untuk peristiwa Beranda Aplikasi di aplikasi Chat yang bukan add-on.

user

object (User)

Pengguna yang berinteraksi dengan aplikasi Chat.

space

object (Space)

Ruang tempat peristiwa terjadi, hanya diisi untuk peristiwa Beranda Aplikasi di aplikasi Chat yang bukan add-on.

eventTime

string (Timestamp format)

Stempel waktu yang menunjukkan kapan objek peristiwa terjadi.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

Payload objek peristiwa. Payload bergantung pada jenis objek peristiwa. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
messagePayload

object (MessagePayload)

Pengguna mengirim pesan ke aplikasi Chat, atau @menyebut aplikasi Chat di ruang. Pemanggilan perintah aplikasi (seperti perintah garis miring dan perintah cepat) dikirimkan dalam appCommandPayload.

addedToSpacePayload

object (AddedToSpacePayload)

Pengguna menambahkan aplikasi Chat ke ruang Chat, atau administrator Google Workspace menginstal aplikasi Chat di ruang pesan langsung untuk pengguna di organisasinya.

removedFromSpacePayload

object (RemovedFromSpacePayload)

Pengguna menghapus aplikasi Chat dari ruang.

buttonClickedPayload

object (ButtonClickedPayload)

Merepresentasikan data payload saat pengguna berinteraksi dengan elemen interaktif kartu atau dialog yang memicu callback Action. Meskipun namanya demikian, payload ini diisi untuk semua callback Action kartu dan dialog—tidak hanya klik tombol, tetapi juga pemicu onChangeAction, tindakan onClick, klik CardAction, dan pengiriman atau pembatalan dialog (SUBMIT_DIALOG dan CANCEL_DIALOG).

Jika pengguna berinteraksi dengan dialog, kolom isDialogEvent ButtonClickedPayload akan ditetapkan ke true dan menyertakan DialogEventType.

Payload lengkap juga mencakup commonEventObject.formInputs dan commonEventObject.parameters.

widgetUpdatedPayload

object (WidgetUpdatedPayload)

Pengguna memperbarui widget di kartu dalam streaming atau dalam dialog.

Payload lengkap juga menyertakan CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

Pengguna memanggil perintah aplikasi.

systemCommandPayload

object (SystemCommandPayload)

Pengguna memanggil perintah sistem.

Akhir kolom yang saling eksklusif.

EventType

Jenis peristiwa, hanya diisi untuk peristiwa Beranda Aplikasi di aplikasi Chat yang bukan add-on.

Enum
EVENT_TYPE_UNSPECIFIED Nilai default untuk enum. JANGAN GUNAKAN.
APP_HOME Pengguna membuka pesan langsung dari aplikasi Chat yang menggunakan beranda aplikasi. Hanya kolom type, user, dan space yang disertakan untuk peristiwa jenis ini. Untuk mengetahui informasi selengkapnya, lihat Membuat halaman beranda untuk aplikasi Google Chat.
SUBMIT_FORM Pengguna mengirimkan informasi di kartu beranda aplikasi. Hanya kolom type, user, dan space yang disertakan untuk peristiwa jenis ini. Untuk mengetahui informasi selengkapnya, lihat [Membuat halaman beranda untuk aplikasi Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message).

MessagePayload

Pengguna mengirim pesan ke aplikasi Chat, atau @menyebut aplikasi Chat di ruang. Pemanggilan perintah aplikasi (seperti perintah garis miring dan perintah cepat) menggunakan AppCommandPayload.

Representasi JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
Kolom
space

object (Space)

Wajib. Ruang Chat tempat objek peristiwa terjadi.

message

object (Message)

Pesan yang memicu objek peristiwa.

configCompleteRedirectUri

string

Opsional. 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 aplikasi Chat dengan layanan & alat lainnya.

AddedToSpacePayload

Pengguna menambahkan aplikasi Chat ke ruang, atau DM antara aplikasi dan pengguna dibuat.

Representasi JSON
{
  "space": {
    object (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
Kolom
space

object (Space)

Wajib. Ruang Chat tempat objek peristiwa terjadi.

interactionAdd

boolean

Apakah aplikasi ditambahkan ke ruang dengan interaksi pengguna (misalnya, dengan @ menyebut aplikasi Chat atau memanggil dengan perintah garis miring). Jika disetel ke benar (true), akan ada objek peristiwa terpisah yang terkait dengan interaksi itu sendiri yang dikirim ke aplikasi Chat.

configCompleteRedirectUri

string

Opsional. 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 aplikasi Chat dengan layanan & alat lainnya.

RemovedFromSpacePayload

Pengguna menghapus aplikasi Chat dari ruang.

Representasi JSON
{
  "space": {
    object (Space)
  }
}
Kolom
space

object (Space)

Wajib. Ruang Chat tempat objek peristiwa terjadi.

ButtonClickedPayload

Pengguna berinteraksi dengan elemen interaktif kartu atau dialog dari Add-on Chat yang memicu callback Action. Meskipun namanya demikian, payload ini diisi untuk semua callback Action kartu dan dialog, termasuk klik tombol, pemicu onChangeAction, tindakan onClick, klik CardAction, dan pengiriman atau pembatalan dialog (SUBMIT_DIALOG dan CANCEL_DIALOG).

Jika pengguna berinteraksi dengan dialog, kolom isDialogEvent ButtonClickedPayload akan ditetapkan ke true dan menyertakan DialogEventType. Payload ini dipetakan ke jenis peristiwa SUBMIT_FORM dan CARD_CLICKED untuk aplikasi Chat yang bukan add-on.

Payload lengkap juga mencakup CommonEventObject.form_inputs dan CommonEventObject.parameters.

Representasi JSON
{
  "space": {
    object (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Kolom
space

object (Space)

Wajib. Ruang Chat tempat objek peristiwa terjadi.

message

object (Message)

Pesan yang memicu objek peristiwa.

isDialogEvent

boolean

Untuk objek peristiwa ButtonClicked dan Message, apakah pengguna sedang berinteraksi atau akan berinteraksi dengan dialog.

dialogEventType

enum (DialogEventType)

Jenis objek peristiwa dialog yang diterima.

DialogEventType

Untuk objek peristiwa yang berisi payload peristiwa ButtonClicked atau AppCommand, jenis interaksi dengan dialog.

Untuk mempelajari lebih lanjut objek peristiwa aplikasi Google Chat, lihat Menerima dan merespons interaksi dengan aplikasi Google Chat Anda.

Enum
DIALOG_EVENT_TYPE_UNSPECIFIED Nilai default. Tidak ditentukan.
REQUEST_DIALOG Pengguna membuka dialog.
SUBMIT_DIALOG Pengguna mengklik elemen interaktif dialog. Misalnya, pengguna mengisi informasi dalam dialog dan mengklik tombol untuk mengirimkan informasi.
CANCEL_DIALOG Pengguna menutup dialog tanpa mengirimkan informasi, atau dialog dibatalkan.

WidgetUpdatedPayload

Pengguna memperbarui widget dalam kartu atau dialog in-stream.

Payload lengkap juga menyertakan CommonEventObject.parameters['autocomplete_widget_query'].

Representasi JSON
{
  "space": {
    object (Space)
  }
}
Kolom
space

object (Space)

Wajib. Ruang Chat tempat objek peristiwa terjadi.

AppCommandPayload

Pengguna memanggil perintah aplikasi.

Representasi JSON
{
  "appCommandMetadata": {
    object (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Kolom
appCommandMetadata

object (AppCommandMetadata)

Diisi untuk perintah aplikasi, termasuk perintah garis miring dan perintah cepat.

space

object (Space)

Opsional. Ruang Chat tempat objek peristiwa terjadi.

thread

object (Thread)

Opsional. Thread tempat objek peristiwa terjadi, jika ada. Kolom ini diisi jika objek peristiwa dikaitkan dengan pesan atau rangkaian pesan tertentu.

message

object (Message)

Opsional. Pesan yang memicu objek peristiwa, jika ada. Kolom ini hanya diisi untuk perintah garis miring.

configCompleteRedirectUri

string

Opsional. URL yang harus dituju pengguna setelah mereka menyelesaikan alur otorisasi atau konfigurasi di luar Google Chat. Untuk mengetahui informasi selengkapnya, lihat Menghubungkan aplikasi Chat dengan layanan & alat lainnya.

isDialogEvent

boolean

Opsional. Apakah pengguna sedang berinteraksi atau akan berinteraksi dengan dialog.

dialogEventType

enum (DialogEventType)

Opsional. Jenis objek peristiwa dialog yang diterima. Kolom ini hanya berlaku jika isDialogEvent adalah true.

AppCommandMetadata

Metadata tentang perintah aplikasi Chat.

Representasi JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Kolom
appCommandId

integer

ID untuk perintah yang ditentukan dalam konfigurasi Chat API.

appCommandType

enum (AppCommandType)

Jenis perintah aplikasi Chat.

AppCommandType

Jenis perintah aplikasi Chat. Untuk mengetahui detailnya, lihat Jenis perintah aplikasi Chat.

Enum
APP_COMMAND_TYPE_UNSPECIFIED Nilai default. Tidak ditentukan.
SLASH_COMMAND Perintah garis miring. Pengguna mengirim perintah dalam pesan Chat.
QUICK_COMMAND Perintah cepat. Pengguna memilih perintah dari menu Chat di area balasan pesan.
MESSAGE_ACTION Tindakan pesan. Pengguna memilih perintah dari menu konteks pesan di Chat.

SystemCommandPayload

Pengguna memanggil perintah sistem.

Representasi JSON
{
  "systemCommandMetadata": {
    object (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
Kolom
systemCommandMetadata

object (SystemCommandMetadata)

Metadata tentang perintah sistem yang dipanggil.

space

string

Opsional. Ruang Chat tempat objek peristiwa terjadi.

thread

object (Thread)

Opsional. Thread tempat objek peristiwa terjadi, jika ada. Kolom ini diisi jika objek peristiwa dikaitkan dengan pesan atau rangkaian pesan tertentu.

SystemCommandMetadata

Metadata tentang perintah sistem yang dipicu oleh pengguna.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "cancelStream": {
    object (CancelStream)
  }
  // End of mutually exclusive fields.
}
Kolom
Perintah sistem dipanggil. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
cancelStream

object (CancelStream)

Perintah untuk membatalkan pesan streaming aktif.

Akhir kolom yang saling eksklusif.

CancelStream

Perintah untuk membatalkan pesan streaming aktif.

Representasi JSON
{
  "streamMessage": string
}
Kolom
streamMessage

string

Wajib. Nama resource pesan streaming tempat perintah pembatalan dijalankan.

Format: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange Objek peristiwa yang diteruskan ke add-on Workflow.

Representasi JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
Kolom
executionMetadata

object (ExecutionMetadata)

Metadata tentang eksekusi alur kerja.

triggerEventSource

enum (TriggerEventSource)

Sumber peristiwa pemicu.

Jenis payload peristiwa alur kerja. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
actionInvocation

object (ActionInvocation)

Pemanggilan tindakan alur kerja.

triggerCreation

object (TriggerCreation)

Pembuatan pemicu alur kerja.

triggerDeletion

object (TriggerDeletion)

Penghapusan pemicu alur kerja.

resourceRetrieval

object (ResourceRetrieval)

Pengambilan resource (digunakan untuk inflasi variabel).

elementConfiguration

object (ElementConfiguration)

Konfigurasi elemen alur kerja.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

Pengambilan definisi kolom yang didukung oleh resource.

elementUiAutocomplete

object (ElementUiAutocomplete)

Saran pelengkapan otomatis untuk kartu yang saat ini dirender.

Akhir kolom yang saling eksklusif.

ActionInvocation

Pemanggilan tindakan alur kerja.

Representasi JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
Kolom
inputs

map (key: string, value: object (VariableData))

Peta variabel input yang di-key berdasarkan nama variabel input.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

ID pemicu yang akan digunakan untuk respons tindakan asinkron.

flowLevelContext

object (FlowLevelContext)

Opsional. Konteks tingkat alur dari langkah-langkah sebelumnya.

VariableData

Merepresentasikan data variabel, yang dapat menyimpan beberapa nilai dari berbagai jenis.

Representasi JSON
{
  "booleanValues": [
    boolean
  ],
  "integerValues": [
    string
  ],
  "floatValues": [
    number
  ],
  "stringValues": [
    string
  ],
  "timestampValues": [
    string
  ],
  "resourceReferences": [
    {
      object (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
Kolom
booleanValues[]

boolean

Nilai boolean.

integerValues[]

string (int64 format)

Nilai bilangan bulat.

floatValues[]

number

Nilai float.

stringValues[]

string

Nilai string.

timestampValues[]

string (Timestamp format)

Nilai stempel waktu.

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

Referensi resource (ID).

emailAddressValues[]

string

Nilai alamat email.

googleUserValues[]

string

Nilai pengguna Google dalam format users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

Nilai Format Teks Alur Kerja.

ResourceReference

Nilai ID resource khusus aplikasi.

Representasi JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
Kolom
resourceType

object (ResourceType)

Jenis resource yang ditunjuk oleh ID ini.

resourceId

string

ID resource.

ResourceType

Nama jenis resource kustom.

Representasi JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
Kolom
workflowBundleId

string

ID paket alur kerja yang memiliki jenis resource ini. Kolom ini bersifat opsional dan jika kosong, akan dianggap sebagai paket yang sama dengan tempat penggunaannya.

workflowResourceDefinitionId

string

ID unik resource. ID ini hanya perlu bersifat unik dalam paket yang sama.

WorkflowTextFormat

Blok teks dengan opsi pemformatan lengkap, termasuk gaya, hyperlink, dan elemen interaktif.

Representasi JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Kolom
textFormatElements[]

object (TextFormatElement)

Kumpulan elemen format teks.

TextFormatElement

Satu elemen dalam pesan WorkflowTextFormat, yang dapat berupa chip, teks bergaya, hyperlink, atau penampung daftar.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "chip": {
    object (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
Kolom
Elemen yang mewakili salah satu dari beberapa kemungkinan elemen format teks. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
text

string

Teks dalam format teks.

chip

object (Chip)

Chip yang dapat diklik dalam format teks.

styledText

object (StyledText)

Teks bergaya dalam format teks.

listContainer

object (ListContainer)

Mencantumkan container dalam format teks.

Akhir kolom yang saling eksklusif.

Chip

Chip yang dapat diklik dalam format teks.

Representasi JSON
{
  "icon": {
    object (Icon)
  },
  "label": string,
  "url": string
}
Kolom
icon

object (Icon)

Ikon yang ditampilkan di chip.

label

string

Teks yang ditampilkan di chip.

url

string

URL yang akan dibuka saat chip diklik.

Ikon

Ikon di chip.

Representasi JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "iconUrl": string,
  "materialIconName": string
  // End of mutually exclusive fields.
}
Kolom
Ikon yang ditampilkan di chip. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
iconUrl

string

Menampilkan ikon kustom yang dihosting di URL HTTPS.

Contoh:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Jenis file yang didukung mencakup .png dan .jpg.

materialIconName

string

Nama ikon yang ditentukan di Ikon Material Google, misalnya, check_box. Nama yang tidak valid akan diabaikan dan diganti dengan string kosong, sehingga ikon gagal dirender.

Akhir kolom yang saling eksklusif.

StyledText

Elemen teks dengan gaya seperti tebal, miring, dan warna.

Representasi JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
Kolom
text

string

Konten utama teks.

styles[]

enum (Style)

Kumpulan gaya yang diterapkan ke teks.

fontWeight

enum (FontWeight)

Ketebalan font teks.

color

object (Color)

Warna teks.

wrapStyle

enum (WrapStyle)

Gaya penggabungan teks.

Gaya

Enum untuk berbagai gaya teks seperti miring, garis bawah, dll.

Enum
STYLE_UNSPECIFIED Tidak ada gaya yang diterapkan. JANGAN GUNAKAN.
ITALIC Gaya miring.
UNDERLINE Gaya garis bawah.
STRIKETHROUGH Gaya coret.
LINE_BREAK Jeda baris.
UPPERCASE Gaya huruf besar.
CODE Kembangkan.
CODE_BLOCK Blok kode.

FontWeight

Enum untuk berbagai ketebalan font.

Enum
FONT_WEIGHT_UNSPECIFIED Ketebalan standar dengan ketebalan normal. JANGAN GUNAKAN.
LIGHT Lebih ringan dengan ketebalan yang lebih tipis.
MEDIUM Ketebalan sedang antara tipis dan tebal.
BOLD Lebih berat dengan ketebalan yang ditingkatkan.

WrapStyle

Enum untuk berbagai gaya pengemasan.

Enum
WRAP_STYLE_UNSPECIFIED Tidak ada gaya pengemasan yang ditentukan.
NO_WRAP Tanpa gaya pengemasan.

ListContainer

Penampung untuk item daftar, dengan setiap item daftar dapat berisi beberapa TextFormatElement.

Representasi JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Kolom
listNestLevel

string (int64 format)

Tingkat bertingkat daftar. Dimulai dari 0 untuk tingkat teratas, dan bertambah 1 untuk setiap daftar bertingkat.

listType

enum (ListType)

Jenis daftar.

listItems[]

object (ListItem)

Kumpulan item daftar.

ListType

Enum untuk berbagai jenis daftar.

Enum
LIST_TYPE_UNSPECIFIED Tidak ada jenis daftar yang ditentukan. JANGAN GUNAKAN.
ORDERED Daftar yang diurutkan.
UNORDERED Daftar yang tidak diurutkan.
BLOCKQUOTE Mewakili daftar kutipan blok.

ListItem

Item daftar.

Representasi JSON
{
  "textFormatElements": [
    {
      object (TextFormatElement)
    }
  ]
}
Kolom
textFormatElements[]

object (TextFormatElement)

Kumpulan elemen format teks.

FlowLevelContext

Konteks tingkat alur yang berisi output dari langkah-langkah sebelumnya.

Representasi JSON
{
  "stepContexts": [
    {
      object (StepContext)
    }
  ]
}
Kolom
stepContexts[]

object (StepContext)

Opsional. Daftar langkah sebelumnya. Urutan itu penting, jadi pastikan urutan eksekusi dipertahankan dalam daftar ini.

StepContext

Metadata konteks langkah dan output untuk konteks tingkat alur.

Representasi JSON
{
  "stepId": string,
  "outputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Kolom
stepId

string

Opsional. ID unik langkah dalam grafik alur kerja.

outputs

map (key: string, value: object (VariableData))

Opsional. Peta variabel output yang dihasilkan oleh langkah ini, yang di-key berdasarkan nama variabel.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

Pembuatan pemicu alur kerja.

Representasi JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
Kolom
triggerId

string

ID unik pemicu yang diberikan selama pembuatan.

triggerType

enum (TriggerType)

Jenis pemicu.

inputs

map (key: string, value: object (VariableData))

Peta variabel input yang di-key berdasarkan nama variabel input.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

Endpoint yang akan dipanggil saat pemicu diaktifkan.

TriggerType

Jenis pemicu.

Enum
TRIGGER_TYPE_UNDEFINED Nilai default. JANGAN GUNAKAN.
REPEATING Pemicu akan diaktifkan setiap kali kondisi input terpenuhi.

TriggerDeletion

Penghapusan pemicu alur kerja.

Representasi JSON
{
  "triggerId": string
}
Kolom
triggerId

string

ID unik pemicu yang diberikan selama pembuatan.

ResourceRetrieval

Pengambilan resource.

Representasi JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
Kolom
resourceReference

object (ResourceReference)

Jenis dan ID resource yang akan diambil.

ElementConfiguration

Pemanggilan saat mengonfigurasi elemen alur kerja.

Representasi JSON
{
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
Kolom
inputs

map (key: string, value: object (VariableData))

Peta variabel input yang di-key berdasarkan nama variabel input. Peta ini mungkin kosong. Digunakan saat mengonfigurasi satu elemen alur kerja (pemicu atau tindakan) di beranda alur kerja.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (DisplayDestination)

Tujuan kartu konfigurasi elemen. Elemen dapat menggunakan kolom ini untuk menampilkan tata letak kartu konfigurasi yang berbeda berdasarkan tujuan.

nodeId

string

ID node konfigurasi primitif yang sedang dirender.

workflowId

string

ID alur kerja konfigurasi primitif yang sedang dirender.

availableVariables[]

object (VariableReference)

Variabel yang tersedia diurutkan berdasarkan posisi node.

DisplayDestination

Menunjukkan tempat kartu konfigurasi elemen yang ditampilkan akan ditampilkan.

Enum
DISPLAY_DESTINATION_UNSPECIFIED Nilai default. JANGAN GUNAKAN.
DISPLAY_DESTINATION_SIDE_PANEL Kartu konfigurasi akan ditampilkan di Panel Samping.
DISPLAY_DESTINATION_FULL_SCREEN Kartu konfigurasi akan ditampilkan di aplikasi Layar Penuh.

VariableReference

Referensi variabel ke variabel dalam alur kerja.

Representasi JSON
{
  "parentElementId": string,
  "nodeId": string,
  "path": string,
  "dataType": {
    object (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
Kolom
parentElementId

string

ID primitif elemen yang menghasilkan variabel. Kita dapat memperluasnya ke WorkflowElement atau proto metadata yang lebih mendetail jika diperlukan.

nodeId

string

ID referensi node

path

string

Tanda tangan jalur pemilih variabel

dataType

object (DataType)

Jenis data variabel

iconUrl

string

URL ikon primitif yang menghasilkan variabel ini.

stepNumber

integer

Nomor langkah primitif yang menghasilkan variabel ini.

descriptionText

string

Deskripsi variabel.

displayText

string

Teks tampilan chip variabel.

DataType

Jenis variabel.

Representasi JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
Kolom
valueMetadata

object (ValueMetadata)

Metadata tentang nilai potensial variabel.

Jenis data. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons:
basicType

enum (BasicType)

Jenis data dasar.

resourceType

object (ResourceType)

Jenis ID resource aplikasi.

Akhir kolom yang saling eksklusif.

BasicType

Jenis data generik dasar.

Enum
BASIC_TYPE_UNSPECIFIED Nilai default. JANGAN GUNAKAN.
STRING String karakter.
INTEGER Bilangan bulat.
FLOAT Ditulis dalam bilangan floating point.
TIMESTAMP Stempel waktu dalam format ISO 8601.
BOOLEAN Nilai yang dapat berupa benar atau salah.
EMAIL_ADDRESS Alamat email, yang merupakan string dalam format alamat email.
GOOGLE_USER Pengguna layanan Google, dalam format users/{user}.
FILE Referensi file.
FORMATTED_TEXT Teks dengan format beragam.

ValueMetadata

Informasi tentang nilai potensial variabel.

Representasi JSON
{
  "enumValues": [
    string
  ],
  "dynamicTypes": [
    enum (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
Kolom
enumValues[]

string

Opsional. Menentukan nilai yang diizinkan untuk string. Kolom ini hanya dapat ditetapkan jika DataType adalah STRING.

dynamicTypes[]

enum (BasicType)

Opsional. Menentukan jenis yang diizinkan yang dapat ditransmisikan secara dinamis untuk variabel. Ini hanya dapat ditetapkan jika DataType adalah String dan variabelnya adalah output.

semanticDescriptors[]

object (SemanticDescriptor)

Opsional. Membantu mendeskripsikan makna semantik variabel.

dynamicSchema

object (DynamicSchema)

Opsional. Konfigurasi untuk me-resolve skema variabel ini secara dinamis.

defaultValue

string

Opsional. String yang menentukan nilai default untuk variabel ini. Misalnya, untuk boolean, defaultValue dapat ditetapkan ke true atau false.

SemanticDescriptor

Metadata tentang makna semantik variabel.

Representasi JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
Kolom
resourceAttribute

string

Menunjukkan bahwa variabel sesuai dengan atribut tertentu dari resource. Hal ini sangat berguna untuk variabel yang mewakili ID untuk resource (id, url, kunci, dll.).

Format yang direkomendasikan adalah: - "{brand}/{appName}/{resource}:{attribute}" {brand} bersifat opsional dan harus dihilangkan jika sama dengan {appName}.

Contoh: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" dll.

Klien akan menggunakan informasi ini untuk memberi petunjuk kepada pengguna tentang variabel output yang kompatibel dengan input tertentu.

disallowedResourceAttributes[]

string

Opsional. Hanya berlaku untuk input, dan diabaikan untuk output. Atribut yang tidak diizinkan yang sesuai dengan deskriptor semantik ini. Klien akan secara eksplisit mencegah pemilihan variabel untuk output yang sesuai dengan salah satu atribut resource yang tidak diizinkan ini.

DynamicSchema

Konfigurasi untuk me-resolve skema variabel ini secara dinamis saat runtime.

Representasi JSON
{
  "requiredInputIds": [
    string
  ],
  "strictEnum": boolean
}
Kolom
requiredInputIds[]

string

ID variabel input seinduk yang harus diberikan sebelum skema variabel ini dapat di-resolve secara dinamis.

strictEnum

boolean

Jika benar, nilai variabel harus cocok dengan salah satu nilai enum yang di-resolve secara dinamis. Jika salah (false), nilai yang diselesaikan secara dinamis akan diperlakukan sebagai saran yang tidak ketat.

ResourceFieldsDefinitionRetrieval

Mengambil definisi kolom yang didukung oleh resource.

Representasi JSON
{
  "elementId": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  }
}
Kolom
elementId

string

Menentukan ID elemen yang skema resource dinamisnya akan diambil.

inputs

map (key: string, value: object (VariableData))

Ini terdiri dari input kolom node yang menyediakan variabel. Peta variabel input yang di-key berdasarkan nama variabel input.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

Saran pelengkapan otomatis untuk kartu yang saat ini dirender.

Representasi JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
Kolom
query

string

Kueri yang akan dilengkapi otomatis.

inputs

map (key: string, value: object (VariableData))

Peta variabel input yang di-key berdasarkan nama variabel input.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

Fungsi yang dipanggil yang terkait dengan widget.

resourceId

string

ID resource yang harus dilengkapi otomatis. Kolom ini bersifat opsional dan mungkin tidak ditetapkan.

operationId

string

ID operasi yang menyediakan resource yang akan dilengkapi otomatis. Kolom ini bersifat opsional dan mungkin tidak ditetapkan.

ExecutionMetadata

Metadata tentang eksekusi alur kerja.

Representasi JSON
{
  "versionId": integer,
  "timeZone": string,
  "stepNumber": integer
}
Kolom
versionId

integer

Versi elemen alur kerja yang dipanggil.

timeZone

string

Zona waktu alur kerja yang disimpan. misalnya, "America/Los_Angeles".

stepNumber

integer

Mewakili nomor langkah primitif yang dipanggil.

TriggerEventSource

Sumber peristiwa pemicu yang memicu eksekusi ini.

Enum
TRIGGER_EVENT_SOURCE_UNSPECIFIED Nilai default. JANGAN GUNAKAN.
TRIGGER_EVENT_SOURCE_AUTOMATED Eksekusi dipicu secara otomatis oleh peristiwa.
TRIGGER_EVENT_SOURCE_TEST_RUN Eksekusi dipicu melalui uji coba.