AddOns Response Service

Servizio di risposta dei componenti aggiuntivi

Questo servizio consente agli script di configurare e creare componenti aggiuntivi di Google Workspace che estendono Google Workspace Studio.

Corsi

NomeBreve descrizione
ActionUn'azione che i componenti aggiuntivi di Google Workspace che estendono Google Workspace Studio possono utilizzare per eseguire il rendering di una nuova scheda.
AddOnsResponseServiceAddOnsResponseService offre la possibilità di creare risposte per i componenti aggiuntivi di Google Workspace che estendono Google Workspace Studio.
BasicDataTypeUn'enumerazione che rappresenta i tipi di dati generici di base.
ColorUn oggetto Color che rappresenta un colore nello spazio colore RGBA.
DataTypeUn DataType viene utilizzato per impostare il tipo di una variabile.
DynamicResourceDefinitionUna DynamicResourceDefinition è un blocco predefinito per un ResourceFieldsDefinitionRetrievedAction, può contenere uno o più numeri di ResourceField per definire dinamicamente il numero di variabili di output fornite da un passaggio in Google Workspace Studio.
ErrorActionabilityUn'enumerazione che rappresenta l'azione correttiva dell'errore.
ErrorRetryabilityUn'enumerazione che rappresenta la possibilità di ripetere la chiamata di un'azione in caso di errore.
FontWeightUn'enumerazione che rappresenta lo spessore del carattere del testo con stile.
HostAppActionUn'azione HostAppAction è un tipo di azione gestita da singole app host.
HyperlinkUn elemento Link ipertestuale utilizzato in TextFormatElement.
InsertSectionUn builder per gli oggetti InsertSection.
InsertWidgetUn builder per gli oggetti InsertWidget.
LinkL'oggetto link di una risorsa di terze parti che viene convertito in uno smart chip nell'applicazione host.
ListContainerContenitore per gli elementi dell'elenco, in cui ogni elemento può contenere più TextFormatElement.
ListItemUna voce di elenco, dove ogni voce di elenco può contenere più TextFormatElement.
ListTypeUn'enumerazione che rappresenta il tipo di elenco.
ModifyCardUn builder per gli oggetti ModifyCard che modifica e aggiorna l'interfaccia di una scheda esistente passando l'oggetto ModifyCard a un Action.
NavigationUn oggetto helper che controlla la navigazione tra le schede.
RemoveSectionUn builder per gli oggetti RemoveSection.
RemoveWidgetUn generatore per gli oggetti RemoveWidget.
RenderActionEsegue il rendering o aggiorna una scheda eseguendo un Action in risposta a un'interazione dell'utente.
RenderActionBuilderUn builder per gli oggetti RenderAction.
ResourceDataRappresenta i dati di una risorsa specifica dell'applicazione. I dati di una risorsa contengono una raccolta di coppie chiave-valore di nomi di variabili e VariableData.
ResourceFieldUn ResourceField è un blocco di base di un DynamicResourceDefinition, ogni campo della risorsa corrisponde a una variabile di output del passaggio corrente.
ResourceFieldsDefinitionRetrievedActionUn ResourceFieldsDefinitionRetrievedAction è un tipo di ResourceFieldsDefinitionRetrievedAction che viene utilizzato per recuperare la definizione di un elenco di campi delle risorse tramite la funzione dynamicResourceDefinitionProvider specificata nel manifest.
ResourceRetrievedActionResourceRetrievedAction viene utilizzato per recuperare i contenuti delle risorse personalizzate quando necessario, dove il campo della risorsa personalizzata è definito in ResourceData.
ResourceTypeUn tipo di risorsa specifico dell'applicazione. L'identificatore univoco del tipo di risorsa deve avere una WorkflowResourceDefinition corrispondente.
ReturnElementErrorActionUn'azione ReturnElementErrorAction indica che si è verificato un errore durante l'invocazione dell'elemento.
ReturnOutputVariablesActionContiene le variabili di output generate dall'azione eseguita in Google Workspace Studio.
SaveWorkflowActionQuesta azione indica che l'app host (Google Workspace Studio) deve salvare l'agente.
StyledTextElemento di testo con stili come grassetto, corsivo e colore.
TextFormatChipUn chip cliccabile nel formato di testo.
TextFormatElementUn elemento di formato di testo, che può essere TextFormatChip, StyledText, Hyperlink o ListContainer.
TextFormatIconUn'icona visualizzata in un TextFormatChip.
TextStyleUn'enumerazione che rappresenta lo stile del testo formattato.
TimeStampRappresenta un oggetto timestamp che può essere aggiunto a un VariableData.
UpdateWidgetUn builder per gli oggetti UpdateWidget.
ValidationErrorSeverityUn enum che rappresenta la gravità dell'errore di convalida.
ValueMetadataUn oggetto valueMetadata contiene informazioni sui valori potenziali di una variabile.
VariableDataRappresenta una variabile di dati che può contenere una raccolta di valori di vari tipi.
WorkflowActionUn WorkflowAction è un tipo di HostAppAction utilizzato per eseguire un'azione specifica in Google Workspace Studio.
WorkflowTextFormatUn blocco di testo con opzioni di formattazione avanzate, tra cui stili, link ipertestuali ed elementi interattivi definiti in TextFormatElement.
WorkflowValidationErrorActionQuesta azione indica che l'app host (Google Workspace Studio) deve mostrare un errore di convalida.

Action

Metodi

MetodoTipo restituitoBreve descrizione
addModifyCard(modifyCard)ActionAggiunge un'operazione ModifyCard all'azione.
addNavigation(navigation)ActionAggiunge una navigazione a schede all'azione.

AddOnsResponseService

Metodi

MetodoTipo restituitoBreve descrizione
newAction()ActionCrea un nuovo Action.
newNavigation()NavigationCrea un nuovo Navigation.
newRenderActionBuilder()RenderActionBuilderCrea un nuovo RenderActionBuilder.

BasicDataType

Proprietà

ProprietàTipoDescrizione
BASIC_TYPE_UNSPECIFIEDEnumValore predefinito.
STRINGEnumUna stringa di caratteri.
INTEGEREnumUn valore intero.
FLOATEnumUn numero con rappresentazione in virgola mobile.
TIMESTAMPEnumUn timestamp nel formato ISO 8601.
BOOLEANEnumUn valore booleano.
EMAIL_ADDRESSEnumUna stringa nel formato di un indirizzo email.
GOOGLE_USEREnumUn utente dei servizi Google, nel formato "users/encoded_GAIA_ID"
FILEEnumUn tipo di file.
FORMATTED_TEXTEnumUn testo con formattazione avanzata.

Color

Metodi

MetodoTipo restituitoBreve descrizione
setAlpha(alpha)ColorImposta il componente alfa del colore.
setBlue(blue)ColorImposta il componente blu del colore.
setGreen(green)ColorImposta il componente verde del colore.
setRed(red)ColorImposta la componente rossa del colore.

DataType

Metodi

MetodoTipo restituitoBreve descrizione
setBasicDataType(basicDataType)DataTypeImposta il tipo di dati su uno dei BasicDataType supportati.
setResourceType(resourceType)DataTypeImposta il tipo di dati su un ResourceType definito personalizzato.
setValueMetadata(valueMetadata)DataTypeImposta ValueMetadata, che contiene informazioni relative al tipo della variabile.

DynamicResourceDefinition

Metodi

MetodoTipo restituitoBreve descrizione
addResourceField(resourceField)DynamicResourceDefinitionAggiunge un campo risorsa alla definizione della risorsa dinamica.
setResourceId(resourceId)DynamicResourceDefinitionImposta l'ID per la definizione della risorsa dinamica. Questo ID corrisponde a workflowResourceDefinitionId nel manifest.

ErrorActionability

Proprietà

ProprietàTipoDescrizione
ERROR_ACTIONABILITY_UNSPECIFIEDEnumNon specificato.
NOT_ACTIONABLEEnumL'errore non può essere corretto dall'utente tramite la scheda di configurazione.
ACTIONABLEEnumL'errore può essere corretto dall'utente tramite la scheda di configurazione.

ErrorRetryability

Proprietà

ProprietàTipoDescrizione
RETRYABILITY_UNSPECIFIEDEnumNon specificato.
NOT_RETRYABLEEnumL'errore non è riproducibile, il flusso termina dopo il primo tentativo.
RETRYABLEEnumL'errore è riprovabile. Workflow tenterà di eseguire il passaggio fino a 5 volte.

FontWeight

Proprietà

ProprietàTipoDescrizione
FONT_WEIGHT_UNSPECIFIEDEnumPeso standard con spessore normale.
LIGHTEnumPeso ridotto e spessore ridotto.
MEDIUMEnumPeso intermedio tra leggero e grassetto.
BOLDEnumPeso maggiore con spessore aumentato.

HostAppAction

Metodi

MetodoTipo restituitoBreve descrizione
setWorkflowAction(workflowAction)HostAppActionImposta l'azione dell'app host su Azione del flusso di lavoro.

Metodi

MetodoTipo restituitoBreve descrizione
setLink(link)HyperlinkImposta l'URL di destinazione del link ipertestuale.
setText(text)HyperlinkImposta il testo del link ipertestuale.

InsertSection

Metodi

MetodoTipo restituitoBreve descrizione
insertAtTop(onCardTop)InsertSectionImposta il flag onCardTop, che indica se la nuova sezione deve essere inserita nella parte superiore della scheda.
insertBelowSection(sectionId)InsertSectionImposta l'ID della sezione e la nuova sezione viene inserita sotto.
setSection(section)InsertSectionImposta la sezione della scheda da inserire.

InsertWidget

Metodi

MetodoTipo restituitoBreve descrizione
insertAboveWidget(widgetId)InsertWidgetImposta l'ID widget e il nuovo widget viene inserito sopra il widget con l'ID specificato.
insertBelowWidget(widgetId)InsertWidgetImposta l'ID widget e il nuovo widget viene inserito sotto il widget con l'ID specificato.
setWidget(widget)InsertWidgetImposta Widget da inserire.

Metodi

MetodoTipo restituitoBreve descrizione
setTitle(title)LinkImposta il titolo del link.
setUrl(url)LinkImposta l'URL del link.

ListContainer

Metodi

MetodoTipo restituitoBreve descrizione
addListItem(listItem)ListContainerAggiunge un elemento all'elenco al contenitore dell'elenco.
setListNestLevel(listLevel)ListContainerImposta il livello dell'elenco, a partire da 0 per il livello superiore e aumenta di 1 per ogni elenco nidificato.
setListType(listType)ListContainerImposta il tipo di elenco come ordinato o non ordinato.

ListItem

Metodi

MetodoTipo restituitoBreve descrizione
addTextFormatElement(textFormatElement)ListItemAggiunge un TextFormatElement alla voce di elenco.

ListType

Proprietà

ProprietàTipoDescrizione
LIST_TYPE_UNSPECIFIEDEnumValore predefinito.
ORDEREDEnumElenco ordinato.
UNORDEREDEnumElenco non ordinato.

ModifyCard

Metodi

MetodoTipo restituitoBreve descrizione
setInsertSection(insertSection)ModifyCardImposta InsertSection per questo oggetto della scheda di modifica.
setInsertWidget(insertWidget)ModifyCardImposta InsertWidget per questo oggetto della scheda di modifica.
setRemoveSection(removeSection)ModifyCardImposta RemoveSection per questo oggetto della scheda di modifica.
setRemoveWidget(removeWidget)ModifyCardImposta RemoveWidget per questo oggetto della scheda di modifica.
setReplaceSection(replacementSection)ModifyCardImposta la sostituzione CardSection per questo oggetto di modifica della scheda. La sezione di sostituzione deve avere lo stesso ID di una sezione della scheda esistente.
setReplaceWidget(replacementWidget)ModifyCardImposta il widget di sostituzione per questo oggetto di modifica della scheda. Il widget di sostituzione deve avere lo stesso ID di un widget esistente.
setUpdateWidget(updateWidget)ModifyCardImposta UpdateWidget per questo oggetto della scheda di modifica.

Metodi

MetodoTipo restituitoBreve descrizione
printJson()StringStampa la rappresentazione JSON di questo oggetto.
pushCard(card)NavigationInserisce la carta specificata nel mazzo.

RemoveSection

Metodi

MetodoTipo restituitoBreve descrizione
setSectionId(sectionId)RemoveSectionImposta l'ID della sezione da rimuovere.

RemoveWidget

Metodi

MetodoTipo restituitoBreve descrizione
setWidgetId(widgetId)RemoveWidgetImposta l'ID widget del widget da rimuovere.

RenderAction

Metodi

MetodoTipo restituitoBreve descrizione
printJson()StringStampa la rappresentazione JSON di questo oggetto.

RenderActionBuilder

Metodi

MetodoTipo restituitoBreve descrizione
build()RenderActionCrea l'azione di rendering corrente e la convalida.
setAction(action)RenderActionBuilderImposta l'azione che i componenti aggiuntivi possono utilizzare per aggiornare l'interfaccia utente all'azione di rendering.
setHostAppAction(hostAppAction)RenderActionBuilderImposta l'intent HostAppAction gestito dalle singole app host sull'azione di rendering.

ResourceData

Metodi

MetodoTipo restituitoBreve descrizione
addVariableData(key, value)ResourceDataAggiunge un VariableData con chiave in base al nome della variabile. Se la chiave esiste già, il valore viene sovrascritto.
setVariableDataMap(fields)ResourceDataImposta la mappa dei dati delle variabili in base ai nomi delle variabili.

ResourceField

Metodi

MetodoTipo restituitoBreve descrizione
setDataType(dataType)ResourceFieldImposta il tipo di dati del campo e consente ad altri passaggi di filtrare le variabili per tipo al momento della selezione.
setDisplayText(displayText)ResourceFieldImposta la descrizione del campo visualizzata dall'utente finale durante la selezione delle variabili nei passaggi successivi.
setSelector(selector)ResourceFieldImposta una chiave per la funzione del provider a cui fornire il valore durante l'esecuzione del passaggio.

ResourceFieldsDefinitionRetrievedAction

Metodi

MetodoTipo restituitoBreve descrizione
addDynamicResourceDefinition(dynamicResourceDefinition)ResourceFieldsDefinitionRetrievedActionAggiunge un DynamicResourceDefinition alla definizione dei campi della risorsa dell'azione recuperata.

ResourceRetrievedAction

Metodi

MetodoTipo restituitoBreve descrizione
setResourceData(resourceData)ResourceRetrievedActionImposta ResourceData sull'azione di recupero delle risorse per fornire valori ai campi delle risorse dinamiche o ai campi delle risorse personalizzate.

ResourceType

Metodi

MetodoTipo restituitoBreve descrizione
setWorkflowResourceDefinitionId(resourceType)ResourceTypeImposta l'ID definizione della risorsa del flusso di lavoro.

ReturnElementErrorAction

Metodi

MetodoTipo restituitoBreve descrizione
setErrorActionability(errorActionability)ReturnElementErrorActionImposta l'azione correttiva per l'errore, che deve essere correggibile se può essere risolto riconfigurando il passaggio.
setErrorLog(log)ReturnElementErrorActionImposta il log degli errori da visualizzare all'utente finale nel feed Attività del flusso di lavoro.
setErrorRetryability(errorRetryability)ReturnElementErrorActionImposta la possibilità di riprovare in caso di errore. Il flusso termina dopo il primo tentativo se un errore non è riprovabile.

ReturnOutputVariablesAction

Metodi

MetodoTipo restituitoBreve descrizione
addVariableData(key, value)ReturnOutputVariablesActionAggiunge una variabile di dati identificata dal nome della variabile. Un valore viene sovrascritto se la chiave esiste già.
setLog(log)ReturnOutputVariablesActionImposta il log dell'azione del flusso di lavoro eseguita per l'utente finale nel feed delle attività del flusso di lavoro.
setVariableDataMap(variables)ReturnOutputVariablesActionImposta la mappa dei dati delle variabili in base al nome della variabile. Un valore viene sovrascritto se la chiave esiste già.

SaveWorkflowAction

StyledText

Metodi

MetodoTipo restituitoBreve descrizione
addStyle(style)StyledTextImposta lo stile del testo formattato. È possibile applicare più stili a un singolo testo formattato.
setColor(color)StyledTextImposta il colore del testo formattato.
setFontWeight(fontWeight)StyledTextImposta lo spessore del carattere del testo con stile.
setText(text)StyledTextImposta i contenuti principali del testo formattato.

TextFormatChip

Metodi

MetodoTipo restituitoBreve descrizione
setLabel(label)TextFormatChipImposta il testo visualizzato nel chip.
setTextFormatIcon(icon)TextFormatChipImposta l'icona visualizzata nel chip.
setUrl(url)TextFormatChipImposta l'URL a cui passare quando si fa clic sul chip.

TextFormatElement

Metodi

MetodoTipo restituitoBreve descrizione
setHyperlink(hyperlink)TextFormatElementImposta l'elemento di formato del testo come Hyperlink.
setListContainer(listContainer)TextFormatElementImposta l'elemento di formato del testo come ListContainer.
setStyledText(styledText)TextFormatElementImposta l'elemento di formato del testo come StyledText.
setText(text)TextFormatElementImposta l'elemento di formato del testo come stringa di testo.
setTextFormatChip(chip)TextFormatElementImposta l'elemento di formato del testo come TextFormatChip.

TextFormatIcon

Metodi

MetodoTipo restituitoBreve descrizione
setIconUrl(iconUrl)TextFormatIconImposta l'URL dell'icona.
setMaterialIconName(materialIconName)TextFormatIconImposta il nome dell'icona del materiale definito in Google Material Icons.

TextStyle

Proprietà

ProprietàTipoDescrizione
STYLE_UNSPECIFIEDEnumNessuno stile applicato.
ITALICEnumStile corsivo.
UNDERLINEEnumStile sottolineatura.
STRIKETHROUGHEnumStile barrato.
LINE_BREAKEnumInterruzione di riga.
UPPERCASEEnumStile maiuscolo.
CODEEnumStile del codice.
CODE_BLOCKEnumStile del blocco di codice.

TimeStamp

Metodi

MetodoTipo restituitoBreve descrizione
setNanos(nanos)TimeStampImposta i nanosecondi del timestamp, che rappresentano il numero di nanosecondi all'interno del secondo corrente.
setSeconds(seconds)TimeStampImposta i secondi del timestamp, che rappresenta il numero di secondi trascorsi dall'epoca di Unix(1° gennaio 1970, 00:00:00 UTC).

UpdateWidget

Metodi

MetodoTipo restituitoBreve descrizione
addSuggestion(text, value, selected, startIconUri, bottomText)UpdateWidgetAggiunge un nuovo elemento che può essere selezionato per i menu a selezione multipla.

ValidationErrorSeverity

Proprietà

ProprietàTipoDescrizione
SEVERITY_UNSPECIFIEDEnumNon specificato.
CRITICALEnumCritico: l'errore è critico e deve essere corretto prima della pubblicazione.
WARNINGEnumAvviso: l'errore non è critico e non blocca la pubblicazione.

ValueMetadata

Metodi

MetodoTipo restituitoBreve descrizione
addCastableType(dataType)ValueMetadataAggiunge tipi consentiti facoltativi che possono essere convertiti dinamicamente per i dati di una variabile in questi metadati del valore.
addEnumValue(enumValue)ValueMetadataAggiunge un valore stringa facoltativo ai valori enum consentiti di una variabile. Questo campo può essere impostato solo se DataType è impostato sul tipo Stringa.
setDefaultValue(defaultValue)ValueMetadataImposta il valore predefinito facoltativo della variabile. Ad esempio, se il tipo di variabile è booleano, defaultValue può essere impostato su "true" o "false".

VariableData

Metodi

MetodoTipo restituitoBreve descrizione
addBooleanValue(value)VariableDataAggiunge un valore booleano ai dati della variabile.
addEmailAddress(emailAddress)VariableDataAggiunge un indirizzo email ai dati variabili.
addFloatValue(value)VariableDataAggiunge un valore float ai dati della variabile.
addGoogleUser(googleUser)VariableDataAggiunge un utente Google ai dati della variabile.
addIntegerValue(value)VariableDataAggiunge un valore intero ai dati della variabile.
addResourceData(resourceData)VariableDataAggiunge un valore ResourceData ai dati della variabile.
addResourceReference(resourceReference)VariableDataAggiunge un ID riferimento risorsa ai dati variabili.
addStringValue(value)VariableDataAggiunge un valore stringa ai dati della variabile.
addTimestampValue(value)VariableDataAggiunge un valore TimeStamp ai dati della variabile.
addWorkflowTextFormat(workflowTextFormat)VariableDataAggiunge un valore WorkflowTextFormat ai dati della variabile.

WorkflowAction

WorkflowTextFormat

Metodi

MetodoTipo restituitoBreve descrizione
addTextFormatElement(textFormatElement)WorkflowTextFormatAggiunge un TextFormatElement al formato di testo del workflow.

WorkflowValidationErrorAction

Metodi

MetodoTipo restituitoBreve descrizione
setSeverity(severity)WorkflowValidationErrorActionImposta la gravità dell'errore di convalida.