AddOns Response Service

Servicio de respuestas de complementos

Este servicio permite que las secuencias de comandos configuren y compilen complementos de Google Workspace que extiendan Google Workspace Studio.

Clases

Nombre	Descripción breve
Action	Es una acción que los complementos de Google Workspace que extienden Google Workspace Studio pueden usar para renderizar una tarjeta nueva.
AddOnsResponseService	AddOnsResponseService proporciona la capacidad de crear respuestas para complementos de Google Workspace que extienden Google Workspace Studio.
BasicDataType	Es una enumeración que representa los tipos de datos genéricos básicos.
Color	Objeto Color que representa un color en el espacio de color RGBA.
DataType	Se usa un DataType para establecer el tipo de una variable.
DynamicResourceDefinition	Un DynamicResourceDefinition es un componente básico para un ResourceFieldsDefinitionRetrievedAction. Puede contener uno o más números de ResourceField para definir de forma dinámica la cantidad de variables de salida que proporciona un paso en Google Workspace Studio.
ErrorActionability	Es una enumeración que representa la capacidad de acción del error.
ErrorRetryability	Es un enum que representa la capacidad de reintento de la invocación de la acción cuando se produce un error.
FontWeight	Es una enumeración que representa el grosor de la fuente del texto con estilo.
HostAppAction	Un HostAppAction es un tipo de Acción que controlan las apps host individuales.
Hyperlink	Es un elemento Hyperlink que se usa en TextFormatElement.
InsertSection	Es un compilador para objetos InsertSection.
InsertWidget	Es un compilador para objetos InsertWidget.
Link	Es el objeto de vínculo de un recurso de terceros que se convierte en un chip inteligente en la aplicación host.
ListContainer	Es un contenedor para elementos de lista, en el que cada elemento de lista puede contener varios TextFormatElement.
ListItem	Es un elemento de lista, donde cada elemento puede contener varios TextFormatElement.
ListType	Es una enum que representa el tipo de lista.
ModifyCard	Es un compilador para objetos ModifyCard que cambia y actualiza la interfaz de una tarjeta existente pasando el objeto ModifyCard a un Action.
Navigation	Es un objeto auxiliar que controla la navegación de tarjetas.
RemoveSection	Es un compilador para objetos RemoveSection.
RemoveWidget	Es un compilador para objetos RemoveWidget.
RenderAction	Renderiza o actualiza una tarjeta realizando un Action en respuesta a una interacción del usuario.
RenderActionBuilder	Es un compilador para objetos RenderAction.
ResourceData	Representa datos de recursos específicos de la aplicación. Los datos de recursos contienen una colección de pares clave-valor de nombres de variables y VariableData.
ResourceField	Un ResourceField es un componente básico de un DynamicResourceDefinition. Cada campo de recurso corresponde a una variable de salida del paso actual.
ResourceFieldsDefinitionRetrievedAction	Un ResourceFieldsDefinitionRetrievedAction es un tipo de ResourceFieldsDefinitionRetrievedAction que se usa para recuperar la definición de una lista de campos de recursos a través de la función dynamicResourceDefinitionProvider especificada en el manifiesto.
ResourceRetrievedAction	Se usa un ResourceRetrievedAction para recuperar contenido de recursos personalizados cuando es necesario, en el que el campo de recursos personalizados se define en ResourceData.
ResourceType	Es un tipo de recurso específico de la aplicación. El identificador único del tipo de recurso debe tener un WorkflowResourceDefinition correspondiente.
ReturnElementErrorAction	Un ReturnElementErrorAction indica que se produjo un error durante la invocación del elemento.
ReturnOutputVariablesAction	Contiene variables de salida generadas por la acción ejecutada en Google Workspace Studio.
SaveWorkflowAction	Esta acción indica que la app host (Workspace Studio de Google) debe guardar el agente.
StyledText	Elemento de texto con estilos como negrita, cursiva y color.
TextFormatChip	Es un chip en el que se puede hacer clic en formato de texto.
TextFormatElement	Es un elemento de formato de texto, que puede ser TextFormatChip, StyledText, Hyperlink o ListContainer.
TextFormatIcon	Ícono que se muestra en un TextFormatChip.
TextStyle	Es una enumeración que representa el estilo del texto con formato.
TimeStamp	Representa un objeto de marca de tiempo que se puede agregar a un VariableData.
UpdateWidget	Es un compilador para objetos UpdateWidget.
ValidationErrorSeverity	Es una enumeración que representa la gravedad del error de validación.
ValueMetadata	Un objeto valueMetadata contiene información sobre los valores posibles de una variable.
VariableData	Representa datos variables que pueden contener una colección de valores en varios tipos.
WorkflowAction	Un WorkflowAction es un tipo de HostAppAction que se usa para realizar una acción específica en Google Workspace Studio.
WorkflowTextFormat	Es un bloque de texto con opciones de formato enriquecido, incluidos estilos, hipervínculos y elementos interactivos definidos en TextFormatElement.
WorkflowValidationErrorAction	Esta acción indica que la app host (Workspace Studio de Google) debe mostrar un error de validación.

Action

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addModifyCard(modifyCard)	Action	Agrega una operación ModifyCard a la acción.
addNavigation(navigation)	Action	Agrega una navegación de tarjetas a la acción.

AddOnsResponseService

Métodos

Método	Tipo de datos que se muestra	Descripción breve
newAction()	Action	Crea una Action nueva.
newNavigation()	Navigation	Crea una Navigation nueva.
newRenderActionBuilder()	RenderActionBuilder	Crea una RenderActionBuilder nueva.

BasicDataType

Propiedades

Propiedad	Tipo	Descripción
BASIC_TYPE_UNSPECIFIED	Enum	Valor predeterminado
STRING	Enum	Es una cadena de caracteres.
INTEGER	Enum	Es un valor entero.
FLOAT	Enum	Es un número de punto flotante.
TIMESTAMP	Enum	Es una marca de tiempo en formato ISO 8601.
BOOLEAN	Enum	Un valor booleano
EMAIL_ADDRESS	Enum	Es una cadena con el formato de una dirección de correo electrónico.
GOOGLE_USER	Enum	Es un usuario de los servicios de Google, con el formato “users/encoded_GAIA_ID”.
FILE	Enum	Es un tipo de archivo.
FORMATTED_TEXT	Enum	Es un texto con formato enriquecido.

Color

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setAlpha(alpha)	Color	Establece el componente alfa del color.
setBlue(blue)	Color	Establece el componente azul del color.
setGreen(green)	Color	Establece el componente verde del color.
setRed(red)	Color	Establece el componente rojo del color.

DataType

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setBasicDataType(basicDataType)	DataType	Establece el tipo de datos en uno de los BasicDataType compatibles.
setResourceType(resourceType)	DataType	Establece el tipo de datos en un ResourceType definido de forma personalizada.
setValueMetadata(valueMetadata)	DataType	Establece el ValueMetadata, que contiene información relacionada con el tipo de la variable.

DynamicResourceDefinition

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addResourceField(resourceField)	DynamicResourceDefinition	Agrega un campo de recurso a la definición de recurso dinámico.
setResourceId(resourceId)	DynamicResourceDefinition	Establece el ID para la definición del recurso dinámico. Este ID corresponde a workflowResourceDefinitionId en el manifiesto.

ErrorActionability

Propiedades

Propiedad	Tipo	Descripción
ERROR_ACTIONABILITY_UNSPECIFIED	Enum	Sin especificar.
NOT_ACTIONABLE	Enum	El usuario no puede corregir el error a través de la tarjeta de configuración.
ACTIONABLE	Enum	El usuario puede corregir el error a través de la tarjeta de configuración.

ErrorRetryability

Propiedades

Propiedad	Tipo	Descripción
RETRYABILITY_UNSPECIFIED	Enum	Sin especificar.
NOT_RETRYABLE	Enum	El error no se puede reintentar, por lo que el flujo finaliza después del primer intento.
RETRYABLE	Enum	El error se puede reintentar. El flujo de trabajo intentará ejecutar el paso hasta 5 veces.

FontWeight

Propiedades

Propiedad	Tipo	Descripción
FONT_WEIGHT_UNSPECIFIED	Enum	Peso estándar con grosor normal.
LIGHT	Enum	Menos peso y grosor reducido
MEDIUM	Enum	Peso intermedio entre claro y negrita.
BOLD	Enum	Mayor peso con mayor grosor.

HostAppAction

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setWorkflowAction(workflowAction)	HostAppAction	Establece la acción de la app host en Acción de flujo de trabajo.

Hyperlink

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setLink(link)	Hyperlink	Establece la URL de destino del hipervínculo.
setText(text)	Hyperlink	Establece el texto del hipervínculo.

InsertSection

Métodos

Método	Tipo de datos que se muestra	Descripción breve
insertAtTop(onCardTop)	InsertSection	Establece la marca onCardTop, que indica si la nueva sección se debe insertar en la parte superior de la tarjeta.
insertBelowSection(sectionId)	InsertSection	Establece el ID de la sección y la nueva sección se inserta debajo de ella.
setSection(section)	InsertSection	Establece la sección de la tarjeta que se insertará.

InsertWidget

Métodos

Método	Tipo de datos que se muestra	Descripción breve
insertAboveWidget(widgetId)	InsertWidget	Establece el ID del widget y el nuevo widget se inserta sobre el widget con el ID determinado.
insertBelowWidget(widgetId)	InsertWidget	Establece el ID del widget y el nuevo widget se inserta debajo del widget con el ID determinado.
setWidget(widget)	InsertWidget	Establece el objeto Widget que se insertará.

Link

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setTitle(title)	Link	Establece el título del vínculo.
setUrl(url)	Link	Establece la URL del vínculo.

ListContainer

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addListItem(listItem)	ListContainer	Agrega un elemento de lista al contenedor de lista.
setListNestLevel(listLevel)	ListContainer	Establece el nivel de la lista. Comienza en 0 para el nivel superior y aumenta en 1 para cada lista anidada.
setListType(listType)	ListContainer	Establece el tipo de lista como ordenada o desordenada.

ListItem

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addTextFormatElement(textFormatElement)	ListItem	Agrega un TextFormatElement al elemento de la lista.

ListType

Propiedades

Propiedad	Tipo	Descripción
LIST_TYPE_UNSPECIFIED	Enum	Valor predeterminado
ORDERED	Enum	Lista ordenada.
UNORDERED	Enum	Lista sin ordenar.

ModifyCard

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setInsertSection(insertSection)	ModifyCard	Establece el InsertSection para este objeto de tarjeta de modificación.
setInsertWidget(insertWidget)	ModifyCard	Establece el InsertWidget para este objeto de tarjeta de modificación.
setRemoveSection(removeSection)	ModifyCard	Establece el RemoveSection para este objeto de tarjeta de modificación.
setRemoveWidget(removeWidget)	ModifyCard	Establece el RemoveWidget para este objeto de tarjeta de modificación.
setReplaceSection(replacementSection)	ModifyCard	Establece el CardSection de reemplazo para este objeto de tarjeta de modificación. La sección de reemplazo debe tener el mismo ID que una sección de tarjeta existente.
setReplaceWidget(replacementWidget)	ModifyCard	Establece el widget de reemplazo para este objeto de tarjeta de modificación. El widget de reemplazo debe tener el mismo ID que un widget existente.
setUpdateWidget(updateWidget)	ModifyCard	Establece el UpdateWidget para este objeto de tarjeta de modificación.

Navigation

Métodos

Método	Tipo de datos que se muestra	Descripción breve
printJson()	String	Imprime la representación JSON de este objeto.
pushCard(card)	Navigation	Coloca la carta indicada en la pila.

RemoveSection

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setSectionId(sectionId)	RemoveSection	Establece el ID de la sección que se quitará.

RemoveWidget

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setWidgetId(widgetId)	RemoveWidget	Establece el ID del widget que se quitará.

RenderAction

Métodos

Método	Tipo de datos que se muestra	Descripción breve
printJson()	String	Imprime la representación JSON de este objeto.

RenderActionBuilder

Métodos

Método	Tipo de datos que se muestra	Descripción breve
build()	RenderAction	Compila la acción de renderización actual y la valida.
setAction(action)	RenderActionBuilder	Establece la acción que los complementos pueden usar para actualizar la IU a la acción de renderización.
setHostAppAction(hostAppAction)	RenderActionBuilder	Establece el HostAppAction controlado por las apps de host individuales en la acción de renderización.

ResourceData

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addVariableData(key, value)	ResourceData	Agrega un VariableData con la clave de su nombre de variable. Si la clave ya existe, se sobrescribe el valor.
setVariableDataMap(fields)	ResourceData	Establece el mapa de los datos de las variables con los nombres de las variables como claves.

ResourceField

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setDataType(dataType)	ResourceField	Establece el tipo de datos del campo y permite que otros pasos filtren las variables por tipo en la selección.
setDisplayText(displayText)	ResourceField	Establece la descripción del campo que se muestra al usuario final durante la selección de variables en los pasos posteriores.
setSelector(selector)	ResourceField	Establece una clave para que la función del proveedor proporcione el valor durante la ejecución del paso.

ResourceFieldsDefinitionRetrievedAction

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addDynamicResourceDefinition(dynamicResourceDefinition)	ResourceFieldsDefinitionRetrievedAction	Agrega un DynamicResourceDefinition a la acción recuperada de la definición de campos de recursos.

ResourceRetrievedAction

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setResourceData(resourceData)	ResourceRetrievedAction	Establece el ResourceData en la acción de recuperación del recurso para proporcionar valores a los campos de recursos dinámicos o personalizados.

ResourceType

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setWorkflowResourceDefinitionId(resourceType)	ResourceType	Establece el ID de definición del recurso del flujo de trabajo.

ReturnElementErrorAction

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setErrorActionability(errorActionability)	ReturnElementErrorAction	Establece la capacidad de acción del error. Un error debe ser de acción si se puede resolver reconfigurando el paso.
setErrorLog(log)	ReturnElementErrorAction	Establece el registro de errores que se mostrará al usuario final en el feed de actividad del flujo de trabajo.
setErrorRetryability(errorRetryability)	ReturnElementErrorAction	Establece la capacidad de reintento del error. El flujo finaliza después del primer intento si no se puede reintentar el error.

ReturnOutputVariablesAction

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addVariableData(key, value)	ReturnOutputVariablesAction	Agrega datos de variables con clave según el nombre de la variable. Si la clave ya existe, se reemplaza el valor.
setLog(log)	ReturnOutputVariablesAction	Establece el registro de la acción del flujo de trabajo ejecutado para el usuario final en el feed de actividad del flujo de trabajo.
setVariableDataMap(variables)	ReturnOutputVariablesAction	Establece el mapa de los datos de la variable con la clave del nombre de la variable. Si la clave ya existe, se reemplaza el valor.

SaveWorkflowAction

StyledText

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addStyle(style)	StyledText	Establece el estilo del texto con formato. Se pueden aplicar varios estilos a un solo texto con formato.
setColor(color)	StyledText	Establece el color del texto con estilo.
setFontWeight(fontWeight)	StyledText	Establece el grosor de la fuente del texto con estilo.
setText(text)	StyledText	Establece el contenido principal del texto con estilo.

TextFormatChip

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setLabel(label)	TextFormatChip	Establece el texto que se muestra en el chip.
setTextFormatIcon(icon)	TextFormatChip	Establece el ícono que se muestra en el chip.
setUrl(url)	TextFormatChip	Establece la URL a la que se navegará cuando se haga clic en el chip.

TextFormatElement

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setHyperlink(hyperlink)	TextFormatElement	Establece el elemento de formato de texto como un Hyperlink.
setListContainer(listContainer)	TextFormatElement	Establece el elemento de formato de texto como un ListContainer.
setStyledText(styledText)	TextFormatElement	Establece el elemento de formato de texto como un StyledText.
setText(text)	TextFormatElement	Establece el elemento de formato de texto como una cadena de texto.
setTextFormatChip(chip)	TextFormatElement	Establece el elemento de formato de texto como un TextFormatChip.

TextFormatIcon

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setIconUrl(iconUrl)	TextFormatIcon	Establece la URL del ícono.
setMaterialIconName(materialIconName)	TextFormatIcon	Establece el nombre del ícono de material definido en Google Material Icons.

TextStyle

Propiedades

Propiedad	Tipo	Descripción
STYLE_UNSPECIFIED	Enum	No se aplicó ningún estilo.
ITALIC	Enum	Estilo en cursiva.
UNDERLINE	Enum	Estilo de subrayado.
STRIKETHROUGH	Enum	Estilo de tachado.
LINE_BREAK	Enum	Salto de línea.
UPPERCASE	Enum	Estilo en mayúsculas.
CODE	Enum	Estilo de código
CODE_BLOCK	Enum	Es el estilo del bloque de código.

TimeStamp

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setNanos(nanos)	TimeStamp	Establece los nanosegundos de la marca de tiempo, que representan la cantidad de nanosegundos dentro del segundo actual.
setSeconds(seconds)	TimeStamp	Establece los segundos de la marca de tiempo, que representa la cantidad de segundos desde la época de Unix(1 de enero de 1970, 00:00:00 UTC).

UpdateWidget

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addSuggestion(text, value, selected, startIconUri, bottomText)	UpdateWidget	Agrega un elemento nuevo que se puede seleccionar para los menús de selección múltiple.

ValidationErrorSeverity

Propiedades

Propiedad	Tipo	Descripción
SEVERITY_UNSPECIFIED	Enum	Sin especificar.
CRITICAL	Enum	Crítico: El error es crítico y se debe corregir antes de la publicación.
WARNING	Enum	Advertencia: El error no es crítico y no impide la publicación.

ValueMetadata

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addCastableType(dataType)	ValueMetadata	Agrega tipos permitidos opcionales que se pueden convertir de forma dinámica para los datos de una variable en los metadatos de este valor.
addEnumValue(enumValue)	ValueMetadata	Agrega un valor de cadena opcional a los valores de enumeración permitidos de una variable. Este campo solo se puede establecer si DataType se establece en el tipo String.
setDefaultValue(defaultValue)	ValueMetadata	Establece el valor predeterminado opcional de la variable. Por ejemplo, si el tipo de variable es booleano, defaultValue se puede establecer en "true" o "false".

VariableData

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addBooleanValue(value)	VariableData	Agrega un valor booleano a los datos de la variable.
addEmailAddress(emailAddress)	VariableData	Agrega una dirección de correo electrónico a los datos de la variable.
addFloatValue(value)	VariableData	Agrega un valor de número de punto flotante a los datos de la variable.
addGoogleUser(googleUser)	VariableData	Agrega un usuario de Google a los datos de la variable.
addIntegerValue(value)	VariableData	Agrega un valor entero a los datos de la variable.
addResourceData(resourceData)	VariableData	Agrega un valor ResourceData a los datos de la variable.
addResourceReference(resourceReference)	VariableData	Agrega un ID de referencia de recurso a los datos de la variable.
addStringValue(value)	VariableData	Agrega un valor de cadena a los datos de la variable.
addTimestampValue(value)	VariableData	Agrega un valor TimeStamp a los datos de la variable.
addWorkflowTextFormat(workflowTextFormat)	VariableData	Agrega un valor WorkflowTextFormat a los datos de la variable.

WorkflowAction

WorkflowTextFormat

Métodos

Método	Tipo de datos que se muestra	Descripción breve
addTextFormatElement(textFormatElement)	WorkflowTextFormat	Agrega un TextFormatElement al formato de texto del flujo de trabajo.

WorkflowValidationErrorAction

Métodos

Método	Tipo de datos que se muestra	Descripción breve
setSeverity(severity)	WorkflowValidationErrorAction	Establece la gravedad del error de validación.