AddOns Response Service

EklentiYanıt Hizmeti

Bu hizmet, komut dosyalarının Google Workspace Studio'yu genişleten Google Workspace eklentilerini yapılandırmasına ve oluşturmasına olanak tanır.

Sınıflar

AdKısa açıklama
ActionGoogle Workspace Studio'yu genişleten Google Workspace eklentilerinin yeni bir kart oluşturmak için kullanabileceği işlem.
AddOnsResponseServiceAddOnsResponseService, Google Workspace Studio'yu genişleten Google Workspace eklentileri için yanıt oluşturma olanağı sunar.
BasicDataTypeTemel genel veri türlerini temsil eden bir enum.
ColorRGBA renk alanındaki bir rengi temsil eden Color nesnesi.
DataTypeDataType, bir değişkenin türünü ayarlamak için kullanılır.
DynamicResourceDefinitionDynamicResourceDefinition, ResourceFieldsDefinitionRetrievedAction için bir yapı taşıdır. Google Workspace Studio'daki bir adım tarafından sağlanan çıkış değişkenlerinin sayısını dinamik olarak tanımlamak için bir veya daha fazla ResourceField sayısı içerebilir.
ErrorActionabilityHatayla ilgili işlem yapılabilirliği temsil eden bir Enum.
ErrorRetryabilityHata olduğunda işlem çağırma işleminin yeniden denenebilirliğini temsil eden bir Enum.
FontWeightStil verilmiş metnin yazı tipi ağırlığını temsil eden bir enum.
HostAppActionHostAppAction, tek tek ana makine uygulamaları tarafından işlenen bir İşlem türüdür.
HyperlinkTextFormatElement içinde kullanılan bir köprü öğesi.
InsertSectionInsertSection nesneleri için oluşturucu.
InsertWidgetInsertWidget nesneleri için oluşturucu.
LinkÜçüncü taraf kaynağındaki bağlantı nesnesi, ana uygulamada akıllı çipe dönüştürülür.
ListContainerListe öğeleri için kapsayıcı. Her liste öğesi birden fazla TextFormatElement içerebilir.
ListItemListe öğesi. Her liste öğesi birden fazla TextFormatElement içerebilir.
ListTypeListenin türünü temsil eden bir enum.
ModifyCardModifyCard nesneleri için oluşturucu. ModifyCard nesnesini Action öğesine ileterek mevcut bir kartın arayüzünü değiştirir ve günceller.
NavigationKart navigasyonunu kontrol eden bir yardımcı nesne.
RemoveSectionRemoveSection nesneleri için bir oluşturucu.
RemoveWidgetRemoveWidget nesneleri için bir oluşturucu.
RenderActionKullanıcı etkileşimine yanıt olarak Action işlemi gerçekleştirerek kart oluşturur veya günceller.
RenderActionBuilderRenderAction nesneleri için bir oluşturucu.
ResourceDataUygulamaya özgü kaynak verilerini temsil eder. Kaynak verileri, değişken adlarının ve VariableData anahtar/değer çiftlerinin bir koleksiyonunu içerir.
ResourceFieldResourceField, bir DynamicResourceDefinition öğesinin temel yapı taşıdır. Her kaynak alanı, mevcut adımın bir çıkış değişkenine karşılık gelir.
ResourceFieldsDefinitionRetrievedActionResourceFieldsDefinitionRetrievedAction, manifest'te belirtilen dynamicResourceDefinitionProvider işlevi aracılığıyla bir kaynak alanı listesinin tanımını almak için kullanılan bir ResourceFieldsDefinitionRetrievedAction türüdür.
ResourceRetrievedActionResourceRetrievedAction, gerektiğinde özel kaynak içeriğini almak için kullanılır. Özel kaynak alanı ResourceData'da tanımlanır.
ResourceTypeUygulamaya özgü bir kaynak türü. Kaynak türünün benzersiz tanımlayıcısı, karşılık gelen bir WorkflowResourceDefinition'a sahip olmalıdır.
ReturnElementErrorActionReturnElementErrorAction, öğe çağırma sırasında bir hata oluştuğunu gösterir.
ReturnOutputVariablesActionGoogle Workspace Studio'da yürütülen işlem tarafından oluşturulan çıkış değişkenlerini içerir.
SaveWorkflowActionBu işlem, ana makine uygulamasının (Google Workspace Studio) aracıyı kaydetmesi gerektiğini gösterir.
StyledTextKalın, italik ve renk gibi stillere sahip metin öğesi.
TextFormatChipMetin biçiminde tıklanabilir bir çip.
TextFormatElementMetin biçimi öğesi (TextFormatChip, StyledText, Hyperlink veya ListContainer olabilir).
TextFormatIconTextFormatChip içinde gösterilen bir simge.
TextStyleBiçimlendirilmiş metnin stilini temsil eden bir enum.
TimeStampVariableData öğesine eklenebilen bir zaman damgası nesnesini temsil eder.
UpdateWidgetUpdateWidget nesneleri için bir oluşturucu.
ValidationErrorSeverityDoğrulama hatasının önem derecesini gösteren bir enum.
ValueMetadataValueMetadata, bir değişkenin olası değerleri hakkında bilgi içerir.
VariableDataÇeşitli türlerde değer koleksiyonu içerebilen değişken verileri temsil eder.
WorkflowActionWorkflowAction, Google Workspace Studio'da belirli bir işlemi gerçekleştirmek için kullanılan bir HostAppAction türüdür.
WorkflowTextFormatTextFormatElement içinde tanımlanan stiller, köprüler ve etkileşimli öğeler de dahil olmak üzere zengin biçimlendirme seçeneklerine sahip bir metin bloğu.
WorkflowValidationErrorActionBu işlem, ana makine uygulamasının (Google Workspace Studio) bir doğrulama hatası göstermesi gerektiğini belirtir.

Action

Yöntemler

YöntemDönüş türüKısa açıklama
addModifyCard(modifyCard)Actionİşleme bir ModifyCard işlemi ekler.
addNavigation(navigation)Actionİşleme kart gezinme özelliği ekler.

AddOnsResponseService

Yöntemler

YöntemDönüş türüKısa açıklama
newAction()ActionYeni bir Action oluşturur.
newNavigation()NavigationYeni bir Navigation oluşturur.
newRenderActionBuilder()RenderActionBuilderYeni bir RenderActionBuilder oluşturur.

BasicDataType

Özellikler

MülkTürAçıklama
BASIC_TYPE_UNSPECIFIEDEnumVarsayılan değer.
STRINGEnumKarakter dizisi.
INTEGEREnumTam sayı değeri.
FLOATEnumKayan nokta biçiminde sayı.
TIMESTAMPEnumISO 8601 biçiminde bir zaman damgası.
BOOLEANEnumBoole değeri.
EMAIL_ADDRESSEnumE-posta adresi biçiminde bir dize.
GOOGLE_USEREnumGoogle hizmetlerinin kullanıcısı, "users/encoded_GAIA_ID" biçiminde
FILEEnumDosya türü.
FORMATTED_TEXTEnumZengin biçimlendirmeye sahip bir metin.

Color

Yöntemler

YöntemDönüş türüKısa açıklama
setAlpha(alpha)ColorRengin alfa bileşenini ayarlar.
setBlue(blue)ColorRengin mavi bileşenini ayarlar.
setGreen(green)ColorRengin yeşil bileşenini ayarlar.
setRed(red)ColorRengin kırmızı bileşenini ayarlar.

DataType

Yöntemler

YöntemDönüş türüKısa açıklama
setBasicDataType(basicDataType)DataTypeVeri türünü desteklenen BasicDataType'lardan birine ayarlar.
setResourceType(resourceType)DataTypeVeri türünü özel olarak tanımlanmış bir ResourceType olarak ayarlar.
setValueMetadata(valueMetadata)DataTypeDeğişkenle ilgili tür bilgilerini içeren ValueMetadata ayarlar.

DynamicResourceDefinition

Yöntemler

YöntemDönüş türüKısa açıklama
addResourceField(resourceField)DynamicResourceDefinitionDinamik kaynak tanımına bir kaynak alanı ekler.
setResourceId(resourceId)DynamicResourceDefinitionDinamik kaynak tanımının kimliğini ayarlar. Bu kimlik, manifestteki workflowResourceDefinitionId öğesine karşılık gelir.

ErrorActionability

Özellikler

MülkTürAçıklama
ERROR_ACTIONABILITY_UNSPECIFIEDEnumBelirtilmedi.
NOT_ACTIONABLEEnumHata, kullanıcı tarafından yapılandırma kartı aracılığıyla düzeltilemez.
ACTIONABLEEnumKullanıcı, yapılandırma kartını kullanarak hatayı düzeltebilir.

ErrorRetryability

Özellikler

MülkTürAçıklama
RETRYABILITY_UNSPECIFIEDEnumBelirtilmedi.
NOT_RETRYABLEEnumHata yeniden denenemez. Akış, ilk denemeden sonra sonlandırılır.
RETRYABLEEnumHata yeniden denenebilir. İş akışı, adımı en fazla 5 kez yürütmeye çalışır.

FontWeight

Özellikler

MülkTürAçıklama
FONT_WEIGHT_UNSPECIFIEDEnumNormal kalınlıkta standart ağırlık.
LIGHTEnumDaha az kalınlık ve daha hafif ağırlık.
MEDIUMEnumAçık ve kalın arasında bir ağırlık.
BOLDEnumDaha fazla kalınlık ile daha ağır.

HostAppAction

Yöntemler

YöntemDönüş türüKısa açıklama
setWorkflowAction(workflowAction)HostAppActionBarındırıcı uygulama işlemini İş Akışı işlemi olarak ayarlar.

Yöntemler

YöntemDönüş türüKısa açıklama
setLink(link)HyperlinkKöprünün hedef URL'sini ayarlar.
setText(text)HyperlinkKöprünün metnini ayarlar.

InsertSection

Yöntemler

YöntemDönüş türüKısa açıklama
insertAtTop(onCardTop)InsertSectionYeni bölümün kartın en üstüne eklenip eklenmeyeceğini belirten onCardTop işaretini ayarlar.
insertBelowSection(sectionId)InsertSectionBölüm kimliğini ayarlar ve yeni bölüm bunun altına eklenir.
setSection(section)InsertSectionEklenecek kart bölümünü ayarlar.

InsertWidget

Yöntemler

YöntemDönüş türüKısa açıklama
insertAboveWidget(widgetId)InsertWidgetWidget kimliğini ayarlar ve yeni widget, belirtilen kimliğe sahip widget'ın üstüne eklenir.
insertBelowWidget(widgetId)InsertWidgetWidget kimliğini ayarlar ve yeni widget, belirtilen kimliğe sahip widget'ın altına eklenir.
setWidget(widget)InsertWidgetEklenecek Widget öğesini ayarlar.

Yöntemler

YöntemDönüş türüKısa açıklama
setTitle(title)LinkBağlantının başlığını ayarlar.
setUrl(url)LinkBağlantının URL'sini ayarlar.

ListContainer

Yöntemler

YöntemDönüş türüKısa açıklama
addListItem(listItem)ListContainerListe kapsayıcısına bir liste öğesi ekler.
setListNestLevel(listLevel)ListContainerListenin düzeyini ayarlar. Üst düzey için 0'dan başlar ve her iç içe liste için 1 artar.
setListType(listType)ListContainerListenin türünü sıralı veya sırasız olarak ayarlar.

ListItem

Yöntemler

YöntemDönüş türüKısa açıklama
addTextFormatElement(textFormatElement)ListItemListe öğesine TextFormatElement ekler.

ListType

Özellikler

MülkTürAçıklama
LIST_TYPE_UNSPECIFIEDEnumVarsayılan değer.
ORDEREDEnumSıralı liste.
UNORDEREDEnumSırasız liste.

ModifyCard

Yöntemler

YöntemDönüş türüKısa açıklama
setInsertSection(insertSection)ModifyCardBu değiştirme kartı nesnesi için InsertSection ayarlar.
setInsertWidget(insertWidget)ModifyCardBu değiştirme kartı nesnesi için InsertWidget ayarlar.
setRemoveSection(removeSection)ModifyCardBu değiştirme kartı nesnesi için RemoveSection ayarlar.
setRemoveWidget(removeWidget)ModifyCardBu değiştirme kartı nesnesi için RemoveWidget ayarlar.
setReplaceSection(replacementSection)ModifyCardBu değiştirme kartı nesnesi için değiştirme CardSection değerini ayarlar. Değiştirme bölümü, mevcut bir kart bölümüyle aynı kimliğe sahip olmalıdır.
setReplaceWidget(replacementWidget)ModifyCardBu değiştirme kartı nesnesi için yedek widget'ı ayarlar. Yedek widget, mevcut bir widget ile aynı kimliğe sahip olmalıdır.
setUpdateWidget(updateWidget)ModifyCardBu değiştirme kartı nesnesi için UpdateWidget ayarlar.

Yöntemler

YöntemDönüş türüKısa açıklama
printJson()StringBu nesnenin JSON gösterimini yazdırır.
pushCard(card)NavigationBelirtilen kartı desteye iter.

RemoveSection

Yöntemler

YöntemDönüş türüKısa açıklama
setSectionId(sectionId)RemoveSectionKaldırılacak bölümün bölüm kimliğini ayarlar.

RemoveWidget

Yöntemler

YöntemDönüş türüKısa açıklama
setWidgetId(widgetId)RemoveWidgetKaldırılacak widget'ın widget kimliğini ayarlar.

RenderAction

Yöntemler

YöntemDönüş türüKısa açıklama
printJson()StringBu nesnenin JSON gösterimini yazdırır.

RenderActionBuilder

Yöntemler

YöntemDönüş türüKısa açıklama
build()RenderActionMevcut oluşturma işlemini oluşturur ve doğrular.
setAction(action)RenderActionBuilderEklentilerin kullanıcı arayüzünü oluşturma işlemiyle güncellemek için kullanabileceği işlemi ayarlar.
setHostAppAction(hostAppAction)RenderActionBuilderHostAppAction, tek tek ana makine uygulamaları tarafından oluşturma işlemi için ayarlanır.

ResourceData

Yöntemler

YöntemDönüş türüKısa açıklama
addVariableData(key, value)ResourceDataDeğişken adına göre anahtarlanmış bir VariableData ekler. Anahtar zaten varsa değerin üzerine yazılır.
setVariableDataMap(fields)ResourceDataDeğişken adlarıyla anahtarlanan değişken verilerinin haritasını ayarlar.

ResourceField

Yöntemler

YöntemDönüş türüKısa açıklama
setDataType(dataType)ResourceFieldAlan için veri türünü ayarlar ve diğer adımların değişkenleri seçim sırasında türe göre filtrelemesine olanak tanır.
setDisplayText(displayText)ResourceFieldSonraki adımlarda değişken seçimi sırasında son kullanıcıya gösterilen alanın açıklamasını ayarlar.
setSelector(selector)ResourceFieldAdımın yürütülmesi sırasında değeri sağlayacak sağlayıcı işlevi için bir anahtar ayarlar.

ResourceFieldsDefinitionRetrievedAction

Yöntemler

YöntemDönüş türüKısa açıklama
addDynamicResourceDefinition(dynamicResourceDefinition)ResourceFieldsDefinitionRetrievedActionAlınan işlem kaynak alanları tanımına DynamicResourceDefinition ekler.

ResourceRetrievedAction

Yöntemler

YöntemDönüş türüKısa açıklama
setResourceData(resourceData)ResourceRetrievedActionDinamik kaynak alanlarına veya özel kaynak alanlarına değer sağlamak için ResourceData değerini, alınan kaynak işlemi olarak ayarlar.

ResourceType

Yöntemler

YöntemDönüş türüKısa açıklama
setWorkflowResourceDefinitionId(resourceType)ResourceTypeİş akışı kaynağı tanımı kimliğini ayarlar.

ReturnElementErrorAction

Yöntemler

YöntemDönüş türüKısa açıklama
setErrorActionability(errorActionability)ReturnElementErrorActionHatanın işlenebilirliğini ayarlar. Bir adım yeniden yapılandırılarak çözülebiliyorsa hata işlenebilir olmalıdır.
setErrorLog(log)ReturnElementErrorActionHata günlüğünün, iş akışının etkinlik feed'inde son kullanıcıya gösterilmesini sağlar.
setErrorRetryability(errorRetryability)ReturnElementErrorActionHatanın yeniden denenip denenemeyeceğini ayarlar. Hata yeniden denenemiyorsa akış ilk denemeden sonra sonlandırılır.

ReturnOutputVariablesAction

Yöntemler

YöntemDönüş türüKısa açıklama
addVariableData(key, value)ReturnOutputVariablesActionDeğişken adına göre anahtarlanmış bir değişken verisi ekler. Anahtar zaten varsa değerin üzerine yazılır.
setLog(log)ReturnOutputVariablesActionÇalıştırılan iş akışı işleminin günlüğünü, iş akışının etkinlik feed'inde son kullanıcıya ayarlar.
setVariableDataMap(variables)ReturnOutputVariablesActionDeğişken adına göre anahtarlanmış değişken verilerinin haritasını ayarlar. Anahtar zaten varsa değerin üzerine yazılır.

SaveWorkflowAction

StyledText

Yöntemler

YöntemDönüş türüKısa açıklama
addStyle(style)StyledTextStil verilmiş metnin stilini ayarlar. Tek bir stil verilmiş metne birden fazla stil uygulanabilir.
setColor(color)StyledTextStil verilmiş metnin rengini ayarlar.
setFontWeight(fontWeight)StyledTextStil verilmiş metnin yazı tipi ağırlığını ayarlar.
setText(text)StyledTextStil verilmiş metnin ana içeriğini ayarlar.

TextFormatChip

Yöntemler

YöntemDönüş türüKısa açıklama
setLabel(label)TextFormatChipÇipte gösterilen metni ayarlar.
setTextFormatIcon(icon)TextFormatChipÇipte gösterilen simgeyi ayarlar.
setUrl(url)TextFormatChipÇip tıklandığında gidilecek URL'yi ayarlar.

TextFormatElement

Yöntemler

YöntemDönüş türüKısa açıklama
setHyperlink(hyperlink)TextFormatElementMetin biçimi öğesini Hyperlink olarak ayarlar.
setListContainer(listContainer)TextFormatElementMetin biçimi öğesini ListContainer olarak ayarlar.
setStyledText(styledText)TextFormatElementMetin biçimi öğesini StyledText olarak ayarlar.
setText(text)TextFormatElementMetin biçimi öğesini metin dizesi olarak ayarlar.
setTextFormatChip(chip)TextFormatElementMetin biçimi öğesini TextFormatChip olarak ayarlar.

TextFormatIcon

Yöntemler

YöntemDönüş türüKısa açıklama
setIconUrl(iconUrl)TextFormatIconSimge URL'sini ayarlar.
setMaterialIconName(materialIconName)TextFormatIconGoogle Material Icons'da tanımlanan malzeme simgesi adını ayarlar.

TextStyle

Özellikler

MülkTürAçıklama
STYLE_UNSPECIFIEDEnumStil uygulanmadı.
ITALICEnumİtalik stil.
UNDERLINEEnumAltı çizili stil.
STRIKETHROUGHEnumÜstü çizili stil.
LINE_BREAKEnumSatır sonu.
UPPERCASEEnumBüyük harf stili.
CODEEnumKod stili.
CODE_BLOCKEnumKod bloğu stili.

TimeStamp

Yöntemler

YöntemDönüş türüKısa açıklama
setNanos(nanos)TimeStampZaman damgasının nanosunu ayarlar. Bu, geçerli saniye içindeki nanosaniye sayısını gösterir.
setSeconds(seconds)TimeStampZaman damgasının saniyesini ayarlar. Unix sıfır zamanından(1 Ocak 1970, 00:00:00 UTC) bu yana geçen saniye sayısını gösterir.

UpdateWidget

Yöntemler

YöntemDönüş türüKısa açıklama
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetÇoklu seçim menüleri için seçilebilecek yeni bir öğe ekler.

ValidationErrorSeverity

Özellikler

MülkTürAçıklama
SEVERITY_UNSPECIFIEDEnumBelirtilmedi.
CRITICALEnumKritik: Hata kritiktir ve yayınlamadan önce düzeltilmesi gerekir.
WARNINGEnumUyarı: Hata kritik değildir ve yayınlamayı engellemez.

ValueMetadata

Yöntemler

YöntemDönüş türüKısa açıklama
addCastableType(dataType)ValueMetadataBu değere, değişken veriler için dinamik olarak yayınlanabilen isteğe bağlı izin verilen türler ekler. metadata.
addEnumValue(enumValue)ValueMetadataBir değişkenin izin verilen enum değerlerine isteğe bağlı bir dize değeri ekler. Bu alan yalnızca DataType dize türü olarak ayarlanırsa ayarlanabilir.
setDefaultValue(defaultValue)ValueMetadataDeğişkenin isteğe bağlı varsayılan değerini ayarlar. Örneğin, değişken türü boole ise defaultValue "true" veya "false" olarak ayarlanabilir.

VariableData

Yöntemler

YöntemDönüş türüKısa açıklama
addBooleanValue(value)VariableDataDeğişken verilerine bir Boole değeri ekler.
addEmailAddress(emailAddress)VariableDataDeğişken verilerine bir e-posta adresi ekler.
addFloatValue(value)VariableDataDeğişken verilerine kayan nokta değeri ekler.
addGoogleUser(googleUser)VariableDataDeğişken verilerine bir Google kullanıcısı ekler.
addIntegerValue(value)VariableDataDeğişken verilerine bir tam sayı değeri ekler.
addResourceData(resourceData)VariableDataDeğişken verilerine ResourceData değeri ekler.
addResourceReference(resourceReference)VariableDataDeğişken verilerine bir kaynak referans kimliği ekler.
addStringValue(value)VariableDataDeğişken verilerine bir dize değeri ekler.
addTimestampValue(value)VariableDataDeğişken verilerine TimeStamp değeri ekler.
addWorkflowTextFormat(workflowTextFormat)VariableDataDeğişken verilerine WorkflowTextFormat değeri ekler.

WorkflowAction

WorkflowTextFormat

Yöntemler

YöntemDönüş türüKısa açıklama
addTextFormatElement(textFormatElement)WorkflowTextFormatİş akışı metin biçimine TextFormatElement ekler.

WorkflowValidationErrorAction

Yöntemler

YöntemDönüş türüKısa açıklama
setSeverity(severity)WorkflowValidationErrorActionDoğrulama hatasının önem derecesini ayarlar.