AddOns Response Service

AddOns Response Service

Layanan ini memungkinkan skrip mengonfigurasi dan membuat add-on Google Workspace yang memperluas Google Workspace Studio.

Class

NamaDeskripsi singkat
ActionTindakan yang dapat digunakan add-on Google Workspace yang memperluas Google Workspace Studio untuk merender kartu baru.
AddOnsResponseServiceAddOnsResponseService memberikan kemampuan untuk membuat respons bagi add-on Google Workspace yang memperluas Google Workspace Studio.
BasicDataTypeEnum yang merepresentasikan jenis data generik dasar.
ColorObjek Warna yang merepresentasikan warna dalam ruang warna RGBA.
DataTypeDataType digunakan untuk menetapkan jenis variabel.
DynamicResourceDefinitionDynamicResourceDefinition adalah blok penyusun untuk ResourceFieldsDefinitionRetrievedAction, yang dapat berisi satu atau beberapa angka ResourceField untuk menentukan secara dinamis jumlah variabel output yang disediakan oleh langkah di Google Workspace Studio.
ErrorActionabilityEnum yang merepresentasikan kemampuan tindakan error.
ErrorRetryabilityEnum yang merepresentasikan kemampuan coba ulang pemanggilan tindakan saat terjadi error.
FontWeightEnum yang merepresentasikan ketebalan font teks yang diberi gaya.
HostAppActionHostAppAction adalah jenis Tindakan yang ditangani oleh setiap aplikasi host.
HyperlinkElemen Hyperlink yang digunakan di TextFormatElement.
InsertSectionBuilder untuk objek InsertSection.
InsertWidgetBuilder untuk objek InsertWidget.
LinkObjek link dari resource pihak ketiga yang dikonversi menjadi chip smart di aplikasi host.
ListContainerPenampung untuk item daftar, dengan setiap item daftar dapat berisi beberapa TextFormatElement.
ListItemItem daftar, dengan setiap item daftar dapat berisi beberapa TextFormatElement.
ListTypeEnum yang merepresentasikan jenis daftar.
ModifyCardBuilder untuk objek ModifyCard yang mengubah dan memperbarui antarmuka kartu yang ada dengan meneruskan objek ModifyCard ke Action.
NavigationObjek helper yang mengontrol navigasi kartu.
RemoveSectionBuilder untuk objek RemoveSection.
RemoveWidgetBuilder untuk objek RemoveWidget.
RenderActionMerender atau memperbarui kartu dengan melakukan Action sebagai respons terhadap interaksi pengguna.
RenderActionBuilderBuilder untuk objek RenderAction.
ResourceDataMewakili data resource khusus aplikasi, data resource berisi kumpulan pasangan nilai kunci dari nama variabel dan VariableData.
ResourceFieldResourceField adalah elemen penyusun dasar DynamicResourceDefinition, setiap kolom resource sesuai dengan variabel output langkah saat ini.
ResourceFieldsDefinitionRetrievedActionResourceFieldsDefinitionRetrievedAction adalah jenis ResourceFieldsDefinitionRetrievedAction yang digunakan untuk mengambil definisi daftar kolom resource melalui fungsi dynamicResourceDefinitionProvider yang ditentukan dalam manifes.
ResourceRetrievedActionResourceRetrievedAction digunakan untuk mengambil konten resource kustom jika diperlukan, dengan kolom resource kustom ditentukan dalam ResourceData.
ResourceTypeJenis resource khusus aplikasi, ID unik jenis resource harus memiliki WorkflowResourceDefinition yang sesuai.
ReturnElementErrorActionReturnElementErrorAction menunjukkan bahwa terjadi error selama pemanggilan elemen.
ReturnOutputVariablesActionBerisi variabel output yang dihasilkan oleh tindakan yang dijalankan di Google Workspace Studio.
SaveWorkflowActionTindakan ini menunjukkan bahwa aplikasi host (Google Workspace Studio) harus menyimpan agen.
StyledTextElemen teks dengan gaya seperti tebal, miring, dan warna.
TextFormatChipChip yang dapat diklik dalam format teks.
TextFormatElementElemen format teks, yang dapat berupa TextFormatChip, StyledText, Hyperlink, atau ListContainer.
TextFormatIconIkon yang ditampilkan dalam TextFormatChip.
TextStyleEnum yang merepresentasikan gaya teks yang diberi gaya.
TimeStampMenampilkan objek stempel waktu yang dapat ditambahkan ke VariableData.
UpdateWidgetBuilder untuk objek UpdateWidget.
ValidationErrorSeverityEnum yang merepresentasikan tingkat keparahan error validasi.
ValueMetadatavalueMetadata berisi informasi tentang kemungkinan nilai variabel.
VariableDataMewakili data variabel yang dapat berisi kumpulan nilai dalam berbagai jenis.
WorkflowActionWorkflowAction adalah jenis HostAppAction yang digunakan untuk melakukan tindakan tertentu di Google Workspace Studio.
WorkflowTextFormatBlok teks dengan opsi pemformatan lengkap, termasuk gaya, hyperlink, dan elemen interaktif yang ditentukan dalam TextFormatElement.
WorkflowValidationErrorActionTindakan ini menunjukkan bahwa aplikasi host (Google Workspace Studio) harus menampilkan error validasi.

Action

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addModifyCard(modifyCard)ActionMenambahkan operasi ModifyCard ke tindakan.
addNavigation(navigation)ActionMenambahkan navigasi kartu ke tindakan.

AddOnsResponseService

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
newAction()ActionMembuat Action baru.
newNavigation()NavigationMembuat Navigation baru.
newRenderActionBuilder()RenderActionBuilderMembuat RenderActionBuilder baru.

BasicDataType

Properti

PropertiJenisDeskripsi
BASIC_TYPE_UNSPECIFIEDEnumNilai default.
STRINGEnumString karakter.
INTEGEREnumNilai bilangan bulat.
FLOATEnumDitulis dalam bilangan floating point.
TIMESTAMPEnumStempel waktu dalam format ISO 8601.
BOOLEANEnumNilai boolean.
EMAIL_ADDRESSEnumString dalam format alamat email.
GOOGLE_USEREnumPengguna layanan Google, dalam format “users/encoded_GAIA_ID”
FILEEnumJenis file.
FORMATTED_TEXTEnumTeks dengan pemformatan lengkap.

Color

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setAlpha(alpha)ColorMenetapkan komponen alfa warna.
setBlue(blue)ColorMenetapkan komponen biru warna.
setGreen(green)ColorMenetapkan komponen hijau warna.
setRed(red)ColorMenetapkan komponen merah warna.

DataType

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setBasicDataType(basicDataType)DataTypeMenetapkan jenis data ke salah satu BasicDataType yang didukung.
setResourceType(resourceType)DataTypeMenetapkan jenis data ke ResourceType yang ditentukan kustom.
setValueMetadata(valueMetadata)DataTypeMenetapkan ValueMetadata, yang berisi informasi terkait jenis yang terkait dengan variabel.

DynamicResourceDefinition

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addResourceField(resourceField)DynamicResourceDefinitionMenambahkan kolom resource ke definisi resource dinamis.
setResourceId(resourceId)DynamicResourceDefinitionMenetapkan ID untuk definisi resource dinamis, ID ini sesuai dengan workflowResourceDefinitionId dalam manifes.

ErrorActionability

Properti

PropertiJenisDeskripsi
ERROR_ACTIONABILITY_UNSPECIFIEDEnumTidak ditentukan.
NOT_ACTIONABLEEnumError tidak dapat diperbaiki oleh pengguna melalui kartu konfigurasi.
ACTIONABLEEnumError dapat diperbaiki oleh pengguna melalui kartu konfigurasi.

ErrorRetryability

Properti

PropertiJenisDeskripsi
RETRYABILITY_UNSPECIFIEDEnumTidak ditentukan.
NOT_RETRYABLEEnumError tidak dapat dicoba lagi, alur akan berakhir setelah percobaan pertama.
RETRYABLEEnumError dapat dicoba lagi, Workflow akan mencoba menjalankan Langkah hingga 5 kali.

FontWeight

Properti

PropertiJenisDeskripsi
FONT_WEIGHT_UNSPECIFIEDEnumKetebalan standar dengan ketebalan normal.
LIGHTEnumLebih ringan dengan ketebalan yang lebih kecil.
MEDIUMEnumKetebalan sedang antara ringan dan tebal.
BOLDEnumBobot yang lebih berat dengan ketebalan yang lebih besar.

HostAppAction

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setWorkflowAction(workflowAction)HostAppActionMenetapkan tindakan aplikasi host ke tindakan Alur kerja.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setLink(link)HyperlinkMenetapkan URL tujuan hyperlink.
setText(text)HyperlinkMenetapkan teks hyperlink.

InsertSection

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
insertAtTop(onCardTop)InsertSectionMenetapkan tanda onCardTop, yang menunjukkan apakah bagian baru harus disisipkan di bagian atas kartu.
insertBelowSection(sectionId)InsertSectionMenetapkan ID bagian, dan bagian baru disisipkan di bawahnya.
setSection(section)InsertSectionMenetapkan bagian kartu yang akan disisipkan.

InsertWidget

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
insertAboveWidget(widgetId)InsertWidgetMenetapkan ID widget, dan widget baru disisipkan di atas widget dengan ID yang diberikan.
insertBelowWidget(widgetId)InsertWidgetMenetapkan ID widget, dan widget baru disisipkan di bawah widget dengan ID yang diberikan.
setWidget(widget)InsertWidgetMenetapkan Widget yang akan disisipkan.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setTitle(title)LinkMenetapkan judul link.
setUrl(url)LinkMenetapkan URL link.

ListContainer

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addListItem(listItem)ListContainerMenambahkan item daftar ke penampung daftar.
setListNestLevel(listLevel)ListContainerMenetapkan level daftar, dimulai dari 0 untuk level teratas, dan bertambah 1 untuk setiap daftar bertingkat.
setListType(listType)ListContainerMenetapkan jenis daftar yang akan diurutkan atau tidak diurutkan.

ListItem

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addTextFormatElement(textFormatElement)ListItemMenambahkan TextFormatElement ke item daftar.

ListType

Properti

PropertiJenisDeskripsi
LIST_TYPE_UNSPECIFIEDEnumNilai default.
ORDEREDEnumDaftar yang diurutkan.
UNORDEREDEnumDaftar yang tidak diurutkan.

ModifyCard

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setInsertSection(insertSection)ModifyCardMenetapkan InsertSection untuk objek kartu modifikasi ini.
setInsertWidget(insertWidget)ModifyCardMenetapkan InsertWidget untuk objek kartu modifikasi ini.
setRemoveSection(removeSection)ModifyCardMenetapkan RemoveSection untuk objek kartu modifikasi ini.
setRemoveWidget(removeWidget)ModifyCardMenetapkan RemoveWidget untuk objek kartu modifikasi ini.
setReplaceSection(replacementSection)ModifyCardMenetapkan CardSection pengganti untuk objek kartu yang diubah ini, bagian pengganti harus memiliki ID yang sama dengan bagian kartu yang ada.
setReplaceWidget(replacementWidget)ModifyCardMenetapkan widget pengganti untuk objek kartu modifikasi ini, widget pengganti harus memiliki ID yang sama dengan widget yang ada.
setUpdateWidget(updateWidget)ModifyCardMenetapkan UpdateWidget untuk objek kartu modifikasi ini.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
printJson()StringMencetak representasi JSON dari objek ini.
pushCard(card)NavigationMendorong kartu yang diberikan ke tumpukan.

RemoveSection

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setSectionId(sectionId)RemoveSectionMenetapkan ID bagian yang akan dihapus.

RemoveWidget

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setWidgetId(widgetId)RemoveWidgetMenetapkan ID widget yang akan dihapus.

RenderAction

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
printJson()StringMencetak representasi JSON dari objek ini.

RenderActionBuilder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
build()RenderActionMembangun tindakan rendering saat ini dan memvalidasinya.
setAction(action)RenderActionBuilderMenetapkan tindakan yang dapat digunakan add-on untuk mengupdate UI ke tindakan render.
setHostAppAction(hostAppAction)RenderActionBuilderMenetapkan HostAppAction yang ditangani oleh setiap aplikasi host ke tindakan render.

ResourceData

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addVariableData(key, value)ResourceDataMenambahkan VariableData yang dikunci oleh nama variabelnya, nilai akan ditimpa jika kunci sudah ada.
setVariableDataMap(fields)ResourceDataMenetapkan peta data variabel yang dikelompokkan menurut nama variabel.

ResourceField

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setDataType(dataType)ResourceFieldMenetapkan jenis data kolom, memungkinkan langkah-langkah lain memfilter variabel menurut jenis saat pemilihan.
setDisplayText(displayText)ResourceFieldMenetapkan deskripsi kolom yang ditampilkan kepada pengguna akhir selama pemilihan variabel pada langkah-langkah berikutnya.
setSelector(selector)ResourceFieldMenetapkan kunci untuk fungsi penyedia guna memberikan nilai selama eksekusi langkah.

ResourceFieldsDefinitionRetrievedAction

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addDynamicResourceDefinition(dynamicResourceDefinition)ResourceFieldsDefinitionRetrievedActionMenambahkan DynamicResourceDefinition ke tindakan yang diambil definisi kolom resource.

ResourceRetrievedAction

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setResourceData(resourceData)ResourceRetrievedActionMenetapkan ResourceData ke tindakan yang diambil resource untuk memberikan nilai ke kolom resource dinamis atau kolom resource kustom.

ResourceType

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setWorkflowResourceDefinitionId(resourceType)ResourceTypeMenetapkan ID definisi resource alur kerja.

ReturnElementErrorAction

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setErrorActionability(errorActionability)ReturnElementErrorActionMenetapkan kemampuan tindakan error, error harus dapat ditindaklanjuti jika dapat diselesaikan dengan mengonfigurasi ulang langkah.
setErrorLog(log)ReturnElementErrorActionMenetapkan log error yang akan ditampilkan kepada pengguna akhir di feed aktivitas Alur Kerja.
setErrorRetryability(errorRetryability)ReturnElementErrorActionMenetapkan kemampuan coba ulang error, alur akan berakhir setelah percobaan pertama jika error tidak dapat dicoba ulang.

ReturnOutputVariablesAction

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addVariableData(key, value)ReturnOutputVariablesActionMenambahkan data variabel yang dikunci berdasarkan nama variabelnya, nilai akan ditimpa jika kunci sudah ada.
setLog(log)ReturnOutputVariablesActionMenetapkan Log tindakan alur kerja yang dijalankan ke pengguna akhir di feed aktivitas Alur kerja.
setVariableDataMap(variables)ReturnOutputVariablesActionMenetapkan peta data variabel yang dikelompokkan berdasarkan nama variabel, nilai akan ditimpa jika kunci sudah ada.

SaveWorkflowAction

StyledText

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addStyle(style)StyledTextMenetapkan gaya teks yang diberi gaya, dapat menerapkan beberapa gaya ke satu teks yang diberi gaya.
setColor(color)StyledTextMenetapkan warna teks yang diberi gaya.
setFontWeight(fontWeight)StyledTextMenetapkan ketebalan font teks yang diberi gaya.
setText(text)StyledTextMenetapkan konten utama teks yang diberi gaya.

TextFormatChip

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setLabel(label)TextFormatChipMenetapkan teks yang ditampilkan di chip.
setTextFormatIcon(icon)TextFormatChipMenetapkan ikon yang ditampilkan di chip.
setUrl(url)TextFormatChipMenetapkan URL yang akan dibuka saat chip diklik.

TextFormatElement

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setHyperlink(hyperlink)TextFormatElementMenetapkan elemen format teks sebagai Hyperlink.
setListContainer(listContainer)TextFormatElementMenetapkan elemen format teks sebagai ListContainer.
setStyledText(styledText)TextFormatElementMenetapkan elemen format teks sebagai StyledText.
setText(text)TextFormatElementMenetapkan elemen format teks sebagai string teks.
setTextFormatChip(chip)TextFormatElementMenetapkan elemen format teks sebagai TextFormatChip.

TextFormatIcon

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setIconUrl(iconUrl)TextFormatIconMenetapkan URL ikon.
setMaterialIconName(materialIconName)TextFormatIconMenetapkan nama ikon material yang ditentukan di Ikon Material Google.

TextStyle

Properti

PropertiJenisDeskripsi
STYLE_UNSPECIFIEDEnumTidak ada gaya yang diterapkan.
ITALICEnumGaya miring.
UNDERLINEEnumGaya garis bawah.
STRIKETHROUGHEnumGaya coret.
LINE_BREAKEnumJeda baris.
UPPERCASEEnumGaya huruf besar.
CODEEnumGaya kode.
CODE_BLOCKEnumGaya blok kode.

TimeStamp

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setNanos(nanos)TimeStampMenetapkan nanos stempel waktu, yang merepresentasikan jumlah nanodetik dalam detik saat ini.
setSeconds(seconds)TimeStampMenetapkan detik stempel waktu, yang mewakili jumlah detik sejak epoch Unix(1 Januari 1970, 00:00:00 UTC).

UpdateWidget

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetMenambahkan item baru yang dapat dipilih, untuk menu pilihan ganda.

ValidationErrorSeverity

Properti

PropertiJenisDeskripsi
SEVERITY_UNSPECIFIEDEnumTidak ditentukan.
CRITICALEnumKritis, error ini bersifat kritis dan harus diperbaiki sebelum dipublikasikan.
WARNINGEnumPeringatan, error tidak penting dan tidak menghalangi publikasi.

ValueMetadata

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addCastableType(dataType)ValueMetadataMenambahkan jenis yang diizinkan opsional yang dapat ditransmisikan secara dinamis untuk data variabel ke metadata nilai ini.
addEnumValue(enumValue)ValueMetadataMenambahkan nilai string opsional ke nilai enum yang diizinkan dari variabel, kolom ini hanya dapat ditetapkan jika DataType ditetapkan ke jenis String.
setDefaultValue(defaultValue)ValueMetadataMenetapkan nilai default opsional variabel, misalnya, jika jenis variabel adalah boolean, defaultValue dapat ditetapkan ke "true" atau "false".

VariableData

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addBooleanValue(value)VariableDataMenambahkan nilai boolean ke data variabel.
addEmailAddress(emailAddress)VariableDataMenambahkan alamat email ke data variabel.
addFloatValue(value)VariableDataMenambahkan nilai float ke data variabel.
addGoogleUser(googleUser)VariableDataMenambahkan pengguna Google ke data variabel.
addIntegerValue(value)VariableDataMenambahkan nilai bilangan bulat ke data variabel.
addResourceData(resourceData)VariableDataMenambahkan nilai ResourceData ke data variabel.
addResourceReference(resourceReference)VariableDataMenambahkan ID referensi resource ke data variabel.
addStringValue(value)VariableDataMenambahkan nilai string ke data variabel.
addTimestampValue(value)VariableDataMenambahkan nilai TimeStamp ke data variabel.
addWorkflowTextFormat(workflowTextFormat)VariableDataMenambahkan nilai WorkflowTextFormat ke data variabel.

WorkflowAction

WorkflowTextFormat

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addTextFormatElement(textFormatElement)WorkflowTextFormatMenambahkan TextFormatElement ke format teks alur kerja.

WorkflowValidationErrorAction

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
setSeverity(severity)WorkflowValidationErrorActionMenetapkan tingkat keparahan error validasi.