- EventObject
- CommonEventObject
- HostApp
- Platform
- TimeZone
- Input
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Penyelenggara
- Peserta
- ConferenceData
- ConferenceSolution
- Kunci
- EntryPoint
- Parameter
- AddOnParameters
- Kemampuan
- DriveEventObject
- DriveItemMetadata
- GmailEventObject
- SheetsEventObject
- MatchedUrl
- SlidesEventObject
- DocsEventObject
- ChatEventObject
- EventType
- MessagePayload
- AddedToSpacePayload
- RemovedFromSpacePayload
- ButtonClickedPayload
- DialogEventType
- WidgetUpdatedPayload
- AppCommandPayload
- AppCommandMetadata
- AppCommandType
- SystemCommandPayload
- SystemCommandMetadata
- CancelStream
- WorkflowEventObject
- ActionInvocation
- VariableData
- ResourceReference
- ResourceType
- WorkflowTextFormat
- TextFormatElement
- Chip
- Ikon
- StyledText
- Gaya
- FontWeight
- WrapStyle
- Hyperlink
- ListContainer
- ListType
- ListItem
- FlowLevelContext
- StepContext
- TriggerCreation
- TriggerType
- TriggerDeletion
- ResourceRetrieval
- ElementConfiguration
- DisplayDestination
- VariableReference
- DataType
- BasicType
- ValueMetadata
- SemanticDescriptor
- DynamicSchema
- ResourceFieldsDefinitionRetrieval
- ElementUiAutocomplete
- ExecutionMetadata
- TriggerEventSource
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 ( |
| Kolom | |
|---|---|
commonEventObject |
Objek yang berisi informasi umum untuk semua objek peristiwa, terlepas dari aplikasi host. |
authorizationEventObject |
Hanya ditetapkan untuk permintaan ke endpoint HTTP |
| Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
calendar |
Hanya ada jika host panggilan adalah Google Kalender. Objek yang berisi informasi kalender dan acara. |
drive |
Hanya ada jika host panggilan adalah Google Drive. Objek yang berisi informasi Drive. |
gmail |
Hanya ada jika host panggilan adalah Gmail. Objek yang berisi informasi Gmail. |
sheets |
Hanya ada jika host panggilan adalah Google Spreadsheet. Objek yang berisi informasi Spreadsheet. |
slides |
Hanya ada jika host panggilan adalah Google Slide. Objek yang berisi informasi Slide. |
docs |
Hanya ada jika host panggilan adalah Google Dokumen. Objek yang berisi informasi Dokumen. |
chat |
Hanya ada jika host panggilan adalah Google Chat. Objek yang berisi informasi Chat. |
workflow |
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 ( |
| Kolom | |
|---|---|
userLocale |
Dinonaktifkan secara default. ID bahasa dan negara/wilayah pengguna dalam format kode bahasa ISO 639-kode negara/wilayah ISO 3166. Contoh, Untuk mengaktifkan kolom ini, Anda harus menetapkan |
hostApp |
Menunjukkan aplikasi host tempat add-on aktif saat objek peristiwa dibuat. Nilai yang memungkinkan mencakup:
|
platform |
Enum platform yang menunjukkan platform tempat peristiwa berasal ( |
timeZone |
Dinonaktifkan secara default. ID zona waktu dan selisih dari Waktu Universal Terkoordinasi (UTC). Untuk mengaktifkan kolom ini, Anda harus menetapkan Hanya didukung untuk jenis peristiwa |
formInputs |
Peta yang berisi nilai saat ini dari widget di kartu yang ditampilkan. Kunci peta adalah nilai 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
Contoh: untuk widget input teks dengan
Contoh: untuk widget multi-nilai dengan
Contoh: Untuk pemilih dengan
Contoh: Untuk pemilih dengan
Contoh: Untuk pemilih dengan Objek yang berisi daftar pasangan |
parameters |
Parameter tambahan apa pun yang Anda berikan ke tindakan menggunakan Pratinjau Developer: Untuk add-on yang memperluas Google Chat, guna menyarankan item berdasarkan apa yang diketik pengguna di menu multi-pilihan, gunakan nilai kunci Objek yang berisi daftar pasangan |
invokedFunction |
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 |
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 |
Kode database zona waktu IANA TZ, seperti "America/Toronto". |
offset |
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 ( |
| Kolom | |
|---|---|
| Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
stringInputs |
Daftar string yang mewakili nilai yang dimasukkan pengguna dalam widget. Jika widget hanya menerima satu nilai, seperti widget |
dateTimeInput |
Nilai input tanggal dan waktu dari widget |
dateInput |
Nilai input tanggal dari widget |
timeInput |
Nilai input waktu dari widget |
| 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[] |
Daftar string yang dimasukkan oleh pengguna. |
DateTimeInput
Nilai input tanggal dan waktu.
| Representasi JSON |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| Kolom | |
|---|---|
msSinceEpoch |
Waktu sejak waktu epoch, dalam milidetik. |
hasDate |
Apakah input |
hasTime |
Apakah input |
DateInput
Nilai input tanggal.
| Representasi JSON |
|---|
{ "msSinceEpoch": string } |
| Kolom | |
|---|---|
msSinceEpoch |
Waktu sejak waktu epoch, dalam milidetik. |
TimeInput
Nilai input waktu.
| Representasi JSON |
|---|
{ "hours": integer, "minutes": integer } |
| Kolom | |
|---|---|
hours |
Jam dalam format 24 jam. |
minutes |
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 |
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 |
Token ID pengguna akhir, jika cakupan ID yang sesuai diminta |
systemIdToken |
Token ID untuk akun layanan Add-on G Suite untuk deployment ini |
authorizedScopes[] |
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 ( |
| Kolom | |
|---|---|
id |
ID peristiwa. |
recurringEventId |
ID acara rutin. |
calendarId |
ID kalender. |
organizer |
Objek yang mewakili penyelenggara acara. |
attendees[] |
Data buatan pengguna. Daftar peserta acara kalender. |
conferenceData |
Data buatan pengguna. Objek yang mewakili data konferensi apa pun yang terkait dengan acara ini, seperti detail konferensi Google Meet. |
capabilities |
Data buatan pengguna. Objek yang menjelaskan kemampuan add-on untuk melihat atau memperbarui informasi acara. |
Penyelenggara
| Representasi JSON |
|---|
{ "email": string } |
| Kolom | |
|---|---|
email |
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 |
Alamat email peserta. |
displayName |
Nama tampilan peserta. |
organizer |
true jika tamu adalah penyelenggara untuk acara ini. |
self |
true jika tamu ini mewakili kalender tempat acara ini muncul; false jika tidak. |
resource |
true jika peserta mewakili fasilitas, seperti ruang atau peralatan; false jika tidak. |
optional |
true jika kehadiran untuk peserta ini ditandai sebagai opsional; false jika tidak. |
responseStatus |
Status respons peserta. Nilai yang memungkinkan mencakup:
|
comment |
Komentar respons peserta, jika ada. |
additionalGuests |
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 ( |
| Kolom | |
|---|---|
conferenceId |
ID konferensi. ID ini dimaksudkan untuk memungkinkan aplikasi melacak konferensi; Anda tidak boleh menampilkan ID ini kepada pengguna. |
conferenceSolution |
Objek yang mewakili solusi konferensi, seperti Hangouts atau Google Meet. |
entryPoints[] |
Daftar titik entri konferensi, seperti URL atau nomor telepon. |
notes |
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 |
Objek yang berisi peta data parameter yang ditentukan untuk digunakan oleh add-on. |
ConferenceSolution
| Representasi JSON |
|---|
{
"iconUri": string,
"key": {
object ( |
| Kolom | |
|---|---|
iconUri |
URI untuk ikon yang dapat dilihat pengguna yang mewakili solusi konferensi ini. |
key |
Kunci yang secara unik mengidentifikasi solusi konferensi untuk acara ini. |
name |
Nama solusi konferensi ini yang terlihat oleh pengguna (tidak dilokalkan). |
Kunci
| Representasi JSON |
|---|
{ "type": string } |
| Kolom | |
|---|---|
type |
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 |
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 |
Jenis titik entri. Nilai yang memungkinkan adalah sebagai berikut:
|
label |
Label yang terlihat oleh pengguna untuk URI titik entri (tidak dilokalkan). |
meetingCode |
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 |
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 |
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 |
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 |
URI titik entri. Panjang maksimumnya adalah 1.300 karakter. Pemformatan bergantung pada jenis titik entri:
|
regionCode |
Kode wilayah nomor telepon. Diperlukan oleh pengguna jika URI tidak menyertakan kode negara. Nilai didasarkan pada daftar kode wilayah CLDR publik. |
entryPointFeatures[] |
Fitur titik entri. Saat ini, fitur ini hanya berlaku untuk titik entri telepon:
|
Parameter
| Representasi JSON |
|---|
{
"addOnParameters": {
object ( |
| Kolom | |
|---|---|
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 |
Objek yang berisi daftar pasangan |
Kemampuan
| Representasi JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Kolom | |
|---|---|
canSeeAttendees |
Data buatan pengguna. true jika add-on dapat membaca daftar tamu acara; false jika tidak. |
canAddAttendees |
Data buatan pengguna. true jika add-on dapat menambahkan tamu baru ke daftar tamu acara; false jika tidak. |
canSeeConferenceData |
Data buatan pengguna. true jika add-on dapat membaca data konferensi acara; false jika tidak. |
canSetConferenceData |
Data buatan pengguna. true jika add-on dapat memperbarui data konferensi acara; false jika tidak. |
canAddAttachments |
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 ( |
| Kolom | |
|---|---|
selectedItems[] |
Daftar item (file atau folder) yang dipilih di Drive. |
activeCursorItem |
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 |
ID item yang dipilih. |
iconUrl |
URL ikon yang mewakili item yang dipilih. |
mimeType |
Jenis MIME item yang dipilih. |
title |
Judul item yang dipilih. |
addonHasFileScopePermission |
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 |
ID pesan Gmail yang saat ini terbuka. |
threadId |
ID rangkaian pesan Gmail yang saat ini terbuka. |
accessToken |
Token akses khusus Gmail. Anda dapat menggunakan token ini dengan metode |
toRecipients[] |
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 |
ccRecipients[] |
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 |
bccRecipients[] |
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 |
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 ( |
| Kolom | |
|---|---|
id |
Hanya ada jika cakupan |
title |
Hanya ada jika cakupan |
addonHasFileScopePermission |
Jika |
matchedUrl |
Hanya ada jika kondisi berikut terpenuhi:
URL link yang menghasilkan pratinjau di Google Spreadsheet. Untuk menggunakan kolom ini, Anda harus mengonfigurasi Contoh payload saat pengguna melihat pratinjau link |
MatchedUrl
Objek peristiwa yang ditampilkan dengan permintaan pratinjau link.
| Representasi JSON |
|---|
{ "url": string } |
| Kolom | |
|---|---|
url |
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 ( |
| Kolom | |
|---|---|
id |
Hanya ada jika cakupan |
title |
Hanya ada jika cakupan |
addonHasFileScopePermission |
Jika |
matchedUrl |
Hanya ada jika kondisi berikut terpenuhi:
URL link yang menghasilkan pratinjau di Google Slide. Untuk menggunakan kolom ini, Anda harus mengonfigurasi Contoh payload saat pengguna melihat pratinjau link |
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 ( |
| Kolom | |
|---|---|
id |
Hanya ada jika cakupan |
title |
Hanya ada jika cakupan |
addonHasFileScopePermission |
Jika |
matchedUrl |
Hanya ada jika kondisi berikut terpenuhi:
URL link yang menghasilkan pratinjau di Google Dokumen. Untuk menggunakan kolom ini, Anda harus mengonfigurasi Contoh payload saat pengguna melihat pratinjau link |
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 ( |
| Kolom | |
|---|---|
type |
Jenis peristiwa, hanya diisi untuk peristiwa Beranda Aplikasi di aplikasi Chat yang bukan add-on. |
user |
Pengguna yang berinteraksi dengan aplikasi Chat. |
space |
Ruang tempat peristiwa terjadi, hanya diisi untuk peristiwa Beranda Aplikasi di aplikasi Chat yang bukan add-on. |
eventTime |
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: |
| Payload objek peristiwa. Payload bergantung pada jenis objek peristiwa. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
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 |
addedToSpacePayload |
Pengguna menambahkan aplikasi Chat ke ruang Chat, atau administrator Google Workspace menginstal aplikasi Chat di ruang pesan langsung untuk pengguna di organisasinya. |
removedFromSpacePayload |
Pengguna menghapus aplikasi Chat dari ruang. |
buttonClickedPayload |
Merepresentasikan data payload saat pengguna berinteraksi dengan elemen interaktif kartu atau dialog yang memicu callback Jika pengguna berinteraksi dengan dialog, kolom Payload lengkap juga mencakup |
widgetUpdatedPayload |
Pengguna memperbarui widget di kartu dalam streaming atau dalam dialog. Payload lengkap juga menyertakan |
appCommandPayload |
Pengguna memanggil perintah aplikasi. |
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 ( |
| Kolom | |
|---|---|
space |
Wajib. Ruang Chat tempat objek peristiwa terjadi. |
message |
Pesan yang memicu objek peristiwa. |
configCompleteRedirectUri |
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 ( |
| Kolom | |
|---|---|
space |
Wajib. Ruang Chat tempat objek peristiwa terjadi. |
interactionAdd |
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 |
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 ( |
| Kolom | |
|---|---|
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 ( |
| Kolom | |
|---|---|
space |
Wajib. Ruang Chat tempat objek peristiwa terjadi. |
message |
Pesan yang memicu objek peristiwa. |
isDialogEvent |
Untuk objek peristiwa |
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 ( |
| Kolom | |
|---|---|
space |
Wajib. Ruang Chat tempat objek peristiwa terjadi. |
AppCommandPayload
Pengguna memanggil perintah aplikasi.
| Representasi JSON |
|---|
{ "appCommandMetadata": { object ( |
| Kolom | |
|---|---|
appCommandMetadata |
Diisi untuk perintah aplikasi, termasuk perintah garis miring dan perintah cepat. |
space |
Opsional. Ruang Chat tempat objek peristiwa terjadi. |
thread |
Opsional. Thread tempat objek peristiwa terjadi, jika ada. Kolom ini diisi jika objek peristiwa dikaitkan dengan pesan atau rangkaian pesan tertentu. |
message |
Opsional. Pesan yang memicu objek peristiwa, jika ada. Kolom ini hanya diisi untuk perintah garis miring. |
configCompleteRedirectUri |
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 |
Opsional. Apakah pengguna sedang berinteraksi atau akan berinteraksi dengan dialog. |
dialogEventType |
Opsional. Jenis objek peristiwa dialog yang diterima. Kolom ini hanya berlaku jika |
AppCommandMetadata
Metadata tentang perintah aplikasi Chat.
| Representasi JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Kolom | |
|---|---|
appCommandId |
ID untuk perintah yang ditentukan dalam konfigurasi Chat API. |
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 ( |
| Kolom | |
|---|---|
systemCommandMetadata |
Metadata tentang perintah sistem yang dipanggil. |
space |
Opsional. Ruang Chat tempat objek peristiwa terjadi. |
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 ( |
| Kolom | |
|---|---|
| Perintah sistem dipanggil. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
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 |
Wajib. Nama resource pesan streaming tempat perintah pembatalan dijalankan. Format: |
WorkflowEventObject
LINT.IfChange Objek peristiwa yang diteruskan ke add-on Workflow.
| Representasi JSON |
|---|
{ "executionMetadata": { object ( |
| Kolom | |
|---|---|
executionMetadata |
Metadata tentang eksekusi alur kerja. |
triggerEventSource |
Sumber peristiwa pemicu. |
| Jenis payload peristiwa alur kerja. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
actionInvocation |
Pemanggilan tindakan alur kerja. |
triggerCreation |
Pembuatan pemicu alur kerja. |
triggerDeletion |
Penghapusan pemicu alur kerja. |
resourceRetrieval |
Pengambilan resource (digunakan untuk inflasi variabel). |
elementConfiguration |
Konfigurasi elemen alur kerja. |
resourceFieldsDefinitionRetrieval |
Pengambilan definisi kolom yang didukung oleh resource. |
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 ( |
| Kolom | |
|---|---|
inputs |
Peta variabel input yang di-key berdasarkan nama variabel input. Objek yang berisi daftar pasangan |
triggerId |
ID pemicu yang akan digunakan untuk respons tindakan asinkron. |
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 ( |
| Kolom | |
|---|---|
booleanValues[] |
Nilai boolean. |
integerValues[] |
Nilai bilangan bulat. |
floatValues[] |
Nilai float. |
stringValues[] |
Nilai string. |
timestampValues[] |
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: |
resourceReferences[] |
Referensi resource (ID). |
emailAddressValues[] |
Nilai alamat email. |
googleUserValues[] |
Nilai pengguna Google dalam format |
textFormatValues[] |
Nilai Format Teks Alur Kerja. |
ResourceReference
Nilai ID resource khusus aplikasi.
| Representasi JSON |
|---|
{
"resourceType": {
object ( |
| Kolom | |
|---|---|
resourceType |
Jenis resource yang ditunjuk oleh ID ini. |
resourceId |
ID resource. |
ResourceType
Nama jenis resource kustom.
| Representasi JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Kolom | |
|---|---|
workflowBundleId |
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 |
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 ( |
| Kolom | |
|---|---|
textFormatElements[] |
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 ( |
| 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 |
Teks dalam format teks. |
chip |
Chip yang dapat diklik dalam format teks. |
styledText |
Teks bergaya dalam format teks. |
hyperlink |
Hyperlink dalam format teks. |
listContainer |
Mencantumkan container dalam format teks. |
| Akhir kolom yang saling eksklusif. | |
Chip
Chip yang dapat diklik dalam format teks.
| Representasi JSON |
|---|
{
"icon": {
object ( |
| Kolom | |
|---|---|
icon |
Ikon yang ditampilkan di chip. |
label |
Teks yang ditampilkan di chip. |
url |
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 |
Menampilkan ikon kustom yang dihosting di URL HTTPS. Contoh: Jenis file yang didukung mencakup |
materialIconName |
Nama ikon yang ditentukan di Ikon Material Google, misalnya, |
| Akhir kolom yang saling eksklusif. | |
StyledText
Elemen teks dengan gaya seperti tebal, miring, dan warna.
| Representasi JSON |
|---|
{ "text": string, "styles": [ enum ( |
| Kolom | |
|---|---|
text |
Konten utama teks. |
styles[] |
Kumpulan gaya yang diterapkan ke teks. |
fontWeight |
Ketebalan font teks. |
color |
Warna teks. |
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. |
Hyperlink
Elemen hyperlink dengan teks dan link.
| Representasi JSON |
|---|
{ "link": string, "text": string } |
| Kolom | |
|---|---|
link |
URL tujuan hyperlink. |
text |
Teks hyperlink. |
ListContainer
Penampung untuk item daftar, dengan setiap item daftar dapat berisi beberapa TextFormatElement.
| Representasi JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Kolom | |
|---|---|
listNestLevel |
Tingkat bertingkat daftar. Dimulai dari 0 untuk tingkat teratas, dan bertambah 1 untuk setiap daftar bertingkat. |
listType |
Jenis daftar. |
listItems[] |
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 ( |
| Kolom | |
|---|---|
textFormatElements[] |
Kumpulan elemen format teks. |
FlowLevelContext
Konteks tingkat alur yang berisi output dari langkah-langkah sebelumnya.
| Representasi JSON |
|---|
{
"stepContexts": [
{
object ( |
| Kolom | |
|---|---|
stepContexts[] |
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 ( |
| Kolom | |
|---|---|
stepId |
Opsional. ID unik langkah dalam grafik alur kerja. |
outputs |
Opsional. Peta variabel output yang dihasilkan oleh langkah ini, yang di-key berdasarkan nama variabel. Objek yang berisi daftar pasangan |
TriggerCreation
Pembuatan pemicu alur kerja.
| Representasi JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Kolom | |
|---|---|
triggerId |
ID unik pemicu yang diberikan selama pembuatan. |
triggerType |
Jenis pemicu. |
inputs |
Peta variabel input yang di-key berdasarkan nama variabel input. Objek yang berisi daftar pasangan |
notifyUri |
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 |
ID unik pemicu yang diberikan selama pembuatan. |
ResourceRetrieval
Pengambilan resource.
| Representasi JSON |
|---|
{
"resourceReference": {
object ( |
| Kolom | |
|---|---|
resourceReference |
Jenis dan ID resource yang akan diambil. |
ElementConfiguration
Pemanggilan saat mengonfigurasi elemen alur kerja.
| Representasi JSON |
|---|
{ "inputs": { string: { object ( |
| Kolom | |
|---|---|
inputs |
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 |
displayDestination |
Tujuan kartu konfigurasi elemen. Elemen dapat menggunakan kolom ini untuk menampilkan tata letak kartu konfigurasi yang berbeda berdasarkan tujuan. |
nodeId |
ID node konfigurasi primitif yang sedang dirender. |
workflowId |
ID alur kerja konfigurasi primitif yang sedang dirender. |
availableVariables[] |
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 ( |
| Kolom | |
|---|---|
parentElementId |
ID primitif elemen yang menghasilkan variabel. Kita dapat memperluasnya ke WorkflowElement atau proto metadata yang lebih mendetail jika diperlukan. |
nodeId |
ID referensi node |
path |
Tanda tangan jalur pemilih variabel |
dataType |
Jenis data variabel |
iconUrl |
URL ikon primitif yang menghasilkan variabel ini. |
stepNumber |
Nomor langkah primitif yang menghasilkan variabel ini. |
descriptionText |
Deskripsi variabel. |
displayText |
Teks tampilan chip variabel. |
DataType
Jenis variabel.
| Representasi JSON |
|---|
{ "valueMetadata": { object ( |
| Kolom | |
|---|---|
valueMetadata |
Metadata tentang nilai potensial variabel. |
| Jenis data. Berikut adalah daftar kolom yang saling eksklusif. Maksimal satu kolom akan ditetapkan dalam respons: | |
basicType |
Jenis data dasar. |
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 ( |
| Kolom | |
|---|---|
enumValues[] |
Opsional. Menentukan nilai yang diizinkan untuk string. Kolom ini hanya dapat ditetapkan jika |
dynamicTypes[] |
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[] |
Opsional. Membantu mendeskripsikan makna semantik variabel. |
dynamicSchema |
Opsional. Konfigurasi untuk me-resolve skema variabel ini secara dinamis. |
defaultValue |
Opsional. String yang menentukan nilai default untuk variabel ini. Misalnya, untuk boolean, |
SemanticDescriptor
Metadata tentang makna semantik variabel.
| Representasi JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Kolom | |
|---|---|
resourceAttribute |
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: - Contoh: - Klien akan menggunakan informasi ini untuk memberi petunjuk kepada pengguna tentang variabel output yang kompatibel dengan input tertentu. |
disallowedResourceAttributes[] |
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[] |
ID variabel input seinduk yang harus diberikan sebelum skema variabel ini dapat di-resolve secara dinamis. |
strictEnum |
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 ( |
| Kolom | |
|---|---|
elementId |
Menentukan ID elemen yang skema resource dinamisnya akan diambil. |
inputs |
Ini terdiri dari input kolom node yang menyediakan variabel. Peta variabel input yang di-key berdasarkan nama variabel input. Objek yang berisi daftar pasangan |
ElementUiAutocomplete
Saran pelengkapan otomatis untuk kartu yang saat ini dirender.
| Representasi JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Kolom | |
|---|---|
query |
Kueri yang akan dilengkapi otomatis. |
inputs |
Peta variabel input yang di-key berdasarkan nama variabel input. Objek yang berisi daftar pasangan |
invokedFunction |
Fungsi yang dipanggil yang terkait dengan widget. |
resourceId |
ID resource yang harus dilengkapi otomatis. Kolom ini bersifat opsional dan mungkin tidak ditetapkan. |
operationId |
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 |
Versi elemen alur kerja yang dipanggil. |
timeZone |
Zona waktu alur kerja yang disimpan. misalnya, "America/Los_Angeles". |
stepNumber |
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. |