- EventObject
- CommonEventObject
- HostApp
- Plataforma
- TimeZone
- Entradas
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Organizador
- Asistente
- ConferenceData
- ConferenceSolution
- Clave
- EntryPoint
- Parámetros
- AddOnParameters
- Funciones
- 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
- Ícono
- StyledText
- Estilo
- 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
Es un evento de interacción de un complemento de Google que contiene datos sobre la interacción de un usuario con un complemento dentro de una app host.
El objeto de evento se pasa como JSON a la función de devolución de llamada o al activador de un complemento (para Apps Script), o al extremo de https (para HTTP), cuando un usuario interactúa con un complemento dentro de una app host. El objeto de evento almacena un objeto de evento de la app host definido por cada app host, así como un objeto de evento común que contiene algunos campos comunes relacionados con el evento.
Para obtener más información, consulta Objetos de evento.
| Representación JSON |
|---|
{ "commonEventObject": { object ( |
| Campos | |
|---|---|
commonEventObject |
Es un objeto que contiene información común a todos los objetos de evento, independientemente de la aplicación host. |
authorizationEventObject |
Solo se establece para las solicitudes a extremos HTTP |
| La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
calendar |
Solo está presente si el host que realiza la llamada es el Calendario de Google. Es un objeto que contiene información sobre el calendario y los eventos. |
drive |
Solo está presente si el host que realiza la llamada es Google Drive. Es un objeto que contiene información de Drive. |
gmail |
Solo está presente si el host que realiza la llamada es Gmail. Es un objeto que contiene información de Gmail. |
sheets |
Solo está presente si el host de llamada es Hojas de cálculo de Google. Es un objeto que contiene información de Hojas de cálculo. |
slides |
Solo se presenta si el host de llamada es Presentaciones de Google. Es un objeto que contiene información de Presentaciones. |
docs |
Solo está presente si el host que realiza la llamada es Documentos de Google. Es un objeto que contiene información de Documentos. |
chat |
Solo está presente si el host de llamada es Google Chat. Es un objeto que contiene información de Chat. |
workflow |
Solo se presenta si el host de llamada es Google Workspace Studio. Es un objeto que contiene información del flujo de trabajo. |
| Fin de los campos mutuamente excluyentes. | |
CommonEventObject
El objeto de evento común es la parte del objeto de evento general que lleva información general, independiente del host, al complemento desde el cliente del usuario. Esta información incluye detalles como la configuración regional del usuario, la app host y la plataforma.
Además de los activadores contextuales y de la página principal, los complementos crean y pasan objetos de evento a las funciones de devolución de llamada de acción cuando el usuario interactúa con los widgets. La función de devolución de llamada de tu complemento puede consultar el objeto de evento común para determinar el contenido de los widgets abiertos en el cliente del usuario. Por ejemplo, tu complemento puede ubicar el texto que un usuario ingresó en un widget TextInput en el objeto eventObject.commentEventObject.formInputs.
En el caso de las apps de Chat, es el nombre de la función que invocó el usuario cuando interactuó con un widget.
| Representación JSON |
|---|
{ "userLocale": string, "hostApp": enum ( |
| Campos | |
|---|---|
userLocale |
Está inhabilitado de forma predeterminada. Es el identificador de idioma y país o región del usuario en el formato de código de idioma ISO 639-código de país o región ISO 3166. Por ejemplo, Para activar este campo, debes establecer |
hostApp |
Indica la app host en la que está activo el complemento cuando se genera el objeto de evento. Entre los valores posibles, se incluyen los siguientes:
|
platform |
Es la enumeración de la plataforma que indica la plataforma en la que se origina el evento ( |
timeZone |
Está inhabilitado de forma predeterminada. El ID de la zona horaria y el desplazamiento respecto de la hora universal coordinada (UTC). Para activar este campo, debes establecer Solo se admite para los tipos de eventos |
formInputs |
Es un mapa que contiene los valores actuales de los widgets de la tarjeta que se muestra. Las claves del mapa son los valores de cadena La estructura del objeto de valor del mapa depende del tipo de widget: Nota: Los siguientes ejemplos tienen el formato del entorno de ejecución de V8 de Apps Script. Si usas el entorno de ejecución de Rhino, debes agregar
Ejemplo: Para un widget de entrada de texto con
Ejemplo: Para un widget de varios valores con
Ejemplo: Para un selector con un
Ejemplo: Para un selector con un
Ejemplo: Para un selector con un Un objeto que contiene una lista de pares |
parameters |
Cualquier parámetro adicional que proporciones a una acción con Versión preliminar para desarrolladores: Para complementos que extienden Google Chat, para sugerir elementos según lo que los usuarios escriban en menús de selección múltiple, utilice el valor de la clave Un objeto que contiene una lista de pares |
invokedFunction |
Es el nombre de la función que se invocará. Este campo no se propaga para los complementos de Google Workspace que extienden Google Chat. En su lugar, para recibir datos de funciones, como identificadores, los complementos que extienden Chat deben usar el campo |
HostApp
Es la aplicación de Google Workspace para un complemento de Google Workspace o una app de Google Chat.
En el caso de los complementos, es la aplicación de Workspace desde la que se inicia un complemento de Google Workspace. En el caso de las apps de Chat, la app host siempre es CHAT.
| Enums | |
|---|---|
UNSPECIFIED_HOST_APP |
Google no puede identificar una app host. |
GMAIL |
El complemento se inicia desde Gmail. |
CALENDAR |
El complemento se inicia desde el Calendario de Google. |
DRIVE |
El complemento se inicia desde Google Drive. |
DEMO |
No se usa. |
DOCS |
El complemento se inicia desde Documentos de Google. |
MEET |
El complemento se inicia desde Google Meet. |
SHEETS |
El complemento se inicia desde Hojas de cálculo de Google. |
SLIDES |
El complemento se inicia desde Presentaciones de Google. |
DRAWINGS |
El complemento se inicia desde Dibujos de Google. |
CHAT |
Una app de Google Chat |
Plataforma
Identifica la plataforma desde la que se originó esta llamada.
| Enums | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
El ID de la zona horaria y el desplazamiento respecto de la hora universal coordinada (UTC). Solo se admite para los tipos de eventos CARD_CLICKED y SUBMIT_DIALOG.
| Representación JSON |
|---|
{ "id": string, "offset": integer } |
| Campos | |
|---|---|
id |
Es el código de la base de datos de zonas horarias de IANA TZ, como "America/Toronto". |
offset |
Es el desplazamiento de la zona horaria del usuario, en milisegundos, desde el Horario Universal Coordinado (UTC). |
Entradas
Tipos de datos que los usuarios pueden ingresar en tarjetas o diálogos. El tipo de entrada depende del tipo de valores que acepta el widget.
| Representación JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringInputs": { object ( |
| Campos | |
|---|---|
| La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
stringInputs |
Es una lista de cadenas que representan los valores que el usuario ingresa en un widget. Si el widget solo acepta un valor, como un widget |
dateTimeInput |
Son valores de entrada de fecha y hora de un widget |
dateInput |
Son los valores de entrada de fecha de un widget |
timeInput |
Son los valores de entrada de hora de un widget |
| Fin de los campos mutuamente excluyentes. | |
StringInputs
Es el parámetro de entrada para los widgets normales. En el caso de los widgets de un solo valor, es una lista de un solo valor. En el caso de los widgets con varios valores, como las casillas de verificación, se presentan todos los valores.
| Representación JSON |
|---|
{ "value": [ string ] } |
| Campos | |
|---|---|
value[] |
Es una lista de cadenas que ingresa el usuario. |
DateTimeInput
Son los valores de entrada de fecha y hora.
| Representación JSON |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| Campos | |
|---|---|
msSinceEpoch |
Es el tiempo transcurrido desde la época, en milisegundos. |
hasDate |
Indica si la entrada |
hasTime |
Indica si la entrada |
DateInput
Son los valores de entrada de fecha.
| Representación JSON |
|---|
{ "msSinceEpoch": string } |
| Campos | |
|---|---|
msSinceEpoch |
Es el tiempo transcurrido desde la época, en milisegundos. |
TimeInput
Son los valores de entrada de tiempo.
| Representación JSON |
|---|
{ "hours": integer, "minutes": integer } |
| Campos | |
|---|---|
hours |
La hora en un reloj de 24 horas. |
minutes |
Es la cantidad de minutos después de la hora. Los valores válidos van del 0 al 59. |
AuthorizationEventObject
Encapsula la información de autorización para la solicitud del complemento.
| Representación JSON |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| Campos | |
|---|---|
userOAuthToken |
Es el token de acceso de OAuth del usuario final, autorizado con los permisos solicitados. (Después de la desvinculación del consentimiento de OAuth, se autorizará con los permisos autorizados por el usuario final) |
userIdToken |
Un token de ID de usuario final, si se solicitan los permisos de ID adecuados |
systemIdToken |
Un token de ID para la cuenta de servicio de complementos de G Suite de esta implementación |
authorizedScopes[] |
Es la lista de permisos de OAuth autorizados por el usuario. |
CalendarEventObject
El objeto de evento de Calendario es la parte del objeto de evento general que contiene información sobre el calendario y los eventos de calendario de un usuario. Solo está presente en un objeto de evento si la aplicación alojada es el Calendario de Google.
En la siguiente tabla, se enumeran los campos presentes en el campo calendar de un objeto de evento. Los campos marcados como Datos generados por el usuario están presentes en el objeto de evento solo si los datos están presentes en el evento de calendario y el complemento establece su campo de manifiesto addOns.calendar.currentEventAccess en READ o READ_WRITE.
| Representación JSON |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| Campos | |
|---|---|
id |
Es el ID del evento. |
recurringEventId |
Es el ID de un evento recurrente. |
calendarId |
Es el ID del calendario. |
organizer |
Es un objeto que representa al organizador del evento. |
attendees[] |
Datos generados por el usuario. Es una lista de los asistentes al evento de calendario. |
conferenceData |
Datos generados por el usuario. Es un objeto que representa los datos de la conferencia asociados con este evento, como los detalles de la conferencia de Google Meet. |
capabilities |
Datos generados por el usuario. Es un objeto que describe las capacidades del complemento para ver o actualizar la información del evento. |
Organizador
| Representación JSON |
|---|
{ "email": string } |
| Campos | |
|---|---|
email |
Es la dirección de correo electrónico del organizador del evento. |
Asistente
Los objetos de asistentes contienen información sobre los asistentes individuales a los eventos de Calendario de Google. Esta información está presente en el objeto de evento solo si los datos están presentes en el evento de calendario y el complemento establece su campo de manifiesto addOns.calendar.currentEventAccess en READ o READ_WRITE.
| Representación JSON |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| Campos | |
|---|---|
email |
Es la dirección de correo electrónico del asistente. |
displayName |
Es el nombre visible del asistente. |
organizer |
true si el asistente es un organizador de este evento. |
self |
true si este asistente representa el calendario en el que aparece este evento; de lo contrario, false. |
resource |
true si el asistente representa un recurso, como una sala o un equipo; de lo contrario, false. |
optional |
true si la asistencia de este asistente se marca como opcional; false de lo contrario. |
responseStatus |
Es el estado de la respuesta del asistente. Entre los valores posibles, se incluyen los siguientes:
|
comment |
Es el comentario de respuesta del asistente, si lo hay. |
additionalGuests |
Es la cantidad de invitados adicionales que el asistente indicó que llevará. El valor predeterminado es cero. |
ConferenceData
Los objetos de datos de conferencia contienen información sobre las conferencias que se adjuntan a los eventos del Calendario de Google. Estas pueden ser soluciones para conferencias de Google, como Google Meet, o de terceros. Esta información está presente en el objeto de evento solo si los datos están presentes en el evento de calendario y el complemento establece su campo de manifiesto addOns.calendar.currentEventAccess en READ o READ_WRITE.
| Representación JSON |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| Campos | |
|---|---|
conferenceId |
Es el ID de la conferencia. Este ID está diseñado para permitir que las aplicaciones realicen un seguimiento de las conferencias. No debes mostrar este ID a los usuarios. |
conferenceSolution |
Es un objeto que representa la solución para reuniones, como Hangouts o Google Meet. |
entryPoints[] |
Es la lista de puntos de entrada a la conferencia, como URLs o números de teléfono. |
notes |
Son notas adicionales (como instrucciones del administrador de dominio o avisos legales) sobre la conferencia que se mostrarán al usuario. Puede contener HTML. La longitud máxima es de 2,048 caracteres. |
parameters |
Es un objeto que contiene un mapa de datos de parámetros definidos para que los use el complemento. |
ConferenceSolution
| Representación JSON |
|---|
{
"iconUri": string,
"key": {
object ( |
| Campos | |
|---|---|
iconUri |
Es el URI del ícono visible para el usuario que representa esta solución para conferencias. |
key |
Es la clave que identifica de forma única la solución para conferencias de este evento. |
name |
Es el nombre visible para el usuario de esta solución para conferencias (no localizado). |
Clave
| Representación JSON |
|---|
{ "type": string } |
| Campos | |
|---|---|
type |
Es el tipo de solución para conferencias. Entre los valores posibles, se incluyen los siguientes:
|
EntryPoint
Los objetos de punto de entrada contienen información sobre los medios establecidos para acceder a una conferencia determinada, como por teléfono o video. Esta información está presente en el objeto de evento solo si los datos están presentes en el evento de calendario y el complemento establece su campo de manifiesto addOns.calendar.currentEventAccess en READ o READ_WRITE.
| Representación JSON |
|---|
{ "accessCode": string, "entryPointType": string, "label": string, "meetingCode": string, "passcode": string, "password": string, "pin": string, "uri": string, "regionCode": string, "entryPointFeatures": [ string ] } |
| Campos | |
|---|---|
accessCode |
Es el código de acceso que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias. |
entryPointType |
Es el tipo de punto de entrada. Los valores posibles son los siguientes:
|
label |
Es la etiqueta visible para el usuario del URI del punto de entrada (no localizado). |
meetingCode |
Es el código de reunión que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias. |
passcode |
Es la contraseña que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias. |
password |
Es la contraseña que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias. |
pin |
Es el PIN que se usa para acceder a la conferencia. La longitud máxima es de 128 caracteres. Por lo general, los proveedores de conferencias solo usan un subconjunto de {accessCode, meetingCode, passcode, password, pin} para proporcionar acceso a las conferencias. Haz coincidir y muestra solo los campos que usa el proveedor de conferencias. |
uri |
Es el URI del punto de entrada. La longitud máxima es de 1,300 caracteres. El formato depende del tipo de punto de entrada:
|
regionCode |
Es el código de región del número de teléfono. Los usuarios lo necesitan si el URI no incluye un código de país. Los valores se basan en la lista pública de códigos de región de CLDR. |
entryPointFeatures[] |
Son las funciones del punto de entrada. Actualmente, estas funciones solo se aplican a los puntos de entrada de teléfono:
|
Parámetros
| Representación JSON |
|---|
{
"addOnParameters": {
object ( |
| Campos | |
|---|---|
addOnParameters |
Es un mapa de claves y valores de cadenas de parámetros. El desarrollador del complemento define estas claves y valores para adjuntar información a una conferencia específica para el uso del complemento. |
AddOnParameters
| Representación JSON |
|---|
{ "parameters": { string: string, ... } } |
| Campos | |
|---|---|
parameters |
Un objeto que contiene una lista de pares |
Funciones
| Representación JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Campos | |
|---|---|
canSeeAttendees |
Datos generados por el usuario. true si el complemento puede leer la lista de asistentes al evento; false de lo contrario. |
canAddAttendees |
Datos generados por el usuario. true si el complemento puede agregar asistentes nuevos a la lista de asistentes del evento; false de lo contrario. |
canSeeConferenceData |
Datos generados por el usuario. true si el complemento puede leer los datos de la conferencia del evento; false de lo contrario. |
canSetConferenceData |
Datos generados por el usuario. true si el complemento puede actualizar los datos de la conferencia del evento; false de lo contrario. |
canAddAttachments |
Datos generados por el usuario. true si el complemento puede agregar archivos adjuntos nuevos al evento; false de lo contrario. |
DriveEventObject
El objeto de evento de Drive es la parte del objeto de evento general que contiene información sobre la unidad de Google Drive de un usuario y su contenido. Solo está presente en un objeto de evento si la aplicación alojada es Google Drive.
| Representación JSON |
|---|
{ "selectedItems": [ { object ( |
| Campos | |
|---|---|
selectedItems[] |
Es una lista de elementos (archivos o carpetas) seleccionados en Drive. |
activeCursorItem |
Es el elemento de Drive que está activo actualmente. |
DriveItemMetadata
Los objetos de elementos de Drive contienen información sobre elementos específicos de Drive, como archivos o carpetas.
| Representación JSON |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| Campos | |
|---|---|
id |
Es el ID del elemento seleccionado. |
iconUrl |
Es la URL del ícono que representa el elemento seleccionado. |
mimeType |
Es el tipo de MIME del elemento seleccionado. |
title |
Es el título del elemento seleccionado. |
addonHasFileScopePermission |
Si es verdadero, el complemento solicitó y recibió la autorización del permiso https://www.googleapis.com/auth/drive.file para este elemento. De lo contrario, este campo es false. Si el complemento usa un permiso más amplio, como https://www.googleapis.com/auth/drive o https://www.googleapis.com/auth/drive.readonly, este campo no es relevante. Usa siempre los permisos menos permisivos posibles cuando diseñes complementos para proteger la información del usuario. |
GmailEventObject
El objeto de evento de Gmail es la parte del objeto de evento general que contiene información sobre los mensajes de Gmail de un usuario. Solo está presente en un objeto de evento si la aplicación alojada es Gmail.
| Representación JSON |
|---|
{ "messageId": string, "threadId": string, "accessToken": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ] } |
| Campos | |
|---|---|
messageId |
Es el ID del mensaje de Gmail que está abierto actualmente. |
threadId |
Es el ID del hilo de Gmail que está abierto actualmente. |
accessToken |
Es el token de acceso específico de Gmail. Puedes usar este token con el método |
toRecipients[] |
Está inhabilitado de forma predeterminada. Es la lista de direcciones de correo electrónico de los destinatarios "Para:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, debes establecer el campo |
ccRecipients[] |
Está inhabilitado de forma predeterminada. Es la lista de direcciones de correo electrónico de los destinatarios "CC:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, debes establecer el campo |
bccRecipients[] |
Está inhabilitado de forma predeterminada. Es la lista de direcciones de correo electrónico de los destinatarios "Cco:" que se incluyen actualmente en un borrador que está redactando el complemento. Para activar este campo, debes establecer el campo |
SheetsEventObject
El objeto de evento de Hojas de cálculo es la parte del objeto de evento general que contiene información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si el complemento extiende Hojas de cálculo de Google.
| Representación JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Campos | |
|---|---|
id |
Solo se encuentra presente si el usuario autorizó el permiso |
title |
Solo se encuentra presente si el usuario autorizó el permiso |
addonHasFileScopePermission |
Si es |
matchedUrl |
Solo se presenta si se cumplen las siguientes condiciones:
Es la URL del vínculo que genera una vista previa en Hojas de cálculo de Google. Para usar este campo, debes configurar el Ejemplo de carga útil para cuando un usuario obtiene una vista previa del vínculo |
MatchedUrl
Es el objeto de evento que se devuelve con las solicitudes de vista previa de vínculos.
| Representación JSON |
|---|
{ "url": string } |
| Campos | |
|---|---|
url |
La URL que coincidió. |
SlidesEventObject
El objeto de evento de Presentaciones es la parte del objeto de evento general que contiene información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si el complemento extiende Presentaciones de Google.
| Representación JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Campos | |
|---|---|
id |
Solo se incluye si el usuario autorizó el permiso |
title |
Solo se encuentra presente si el usuario autorizó el permiso |
addonHasFileScopePermission |
Si es |
matchedUrl |
Solo se presenta si se cumplen las siguientes condiciones:
Es la URL del vínculo que genera una vista previa en Presentaciones de Google. Para usar este campo, debes configurar el Ejemplo de carga útil para cuando un usuario obtiene una vista previa del vínculo |
DocsEventObject
El objeto de evento de Documentos es la parte del objeto de evento general que contiene información sobre el documento de un usuario y su contenido. Solo está presente en un objeto de evento si el complemento extiende Documentos de Google.
| Representación JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Campos | |
|---|---|
id |
Solo se encuentra presente si el usuario autorizó el permiso |
title |
Solo se encuentra presente si el usuario autorizó el permiso |
addonHasFileScopePermission |
Si es |
matchedUrl |
Solo se presenta si se cumplen las siguientes condiciones:
Es la URL del vínculo que genera una vista previa en Documentos de Google. Para usar este campo, debes configurar el Ejemplo de carga útil para cuando un usuario obtiene una vista previa del vínculo |
ChatEventObject
Es una carga útil de objeto de evento de la app de Google Chat que se envía desde el servidor de Google a los complementos. Las cargas útiles se pueden usar para identificar el tipo de evento.
| Representación JSON |
|---|
{ "type": enum ( |
| Campos | |
|---|---|
type |
Es el tipo de evento, que solo se completa para los eventos de la página principal de la app en las apps de Chat que no son complementos. |
user |
El usuario que interactúa con la app de Chat. |
space |
Es el espacio en el que se produjo el evento, que solo se completa para los eventos de la página principal de la app en las apps de Chat que no son complementos. |
eventTime |
Es la marca de tiempo que indica cuándo se produce el objeto de evento. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
| Es la carga útil del objeto de evento. Las cargas útiles dependen del tipo de objeto de evento. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
messagePayload |
Un usuario envía un mensaje a la app de Chat o menciona con @a la app de Chat en un espacio. En cambio, las invocaciones de comandos de la app (como los comandos de barra y los comandos rápidos) se entregan en |
addedToSpacePayload |
Un usuario agrega la app de Chat a un espacio de Chat, o un administrador de Google Workspace instala la app de Chat en espacios de mensajes directos para los usuarios de su organización. |
removedFromSpacePayload |
Un usuario quita la app de Chat de un espacio. |
buttonClickedPayload |
Representa los datos de carga útil cuando un usuario interactúa con un elemento interactivo de una tarjeta o un diálogo que activa una devolución de llamada Si un usuario interactúa con un diálogo, el campo La carga útil completa también incluye |
widgetUpdatedPayload |
Un usuario actualiza un widget en una tarjeta in-stream o en un diálogo. La carga útil completa también incluye |
appCommandPayload |
Un usuario invoca un comando de la app. |
systemCommandPayload |
Un usuario invoca un comando del sistema. |
| Fin de los campos mutuamente excluyentes. | |
EventType
Es el tipo de evento, que solo se completa para los eventos de la página principal de la app en las apps de Chat que no son complementos.
| Enums | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
Es el valor predeterminado de la enumeración. NO USAR. |
APP_HOME |
Un usuario abre un mensaje directo desde una app de Chat que usa la página principal de la app. Solo se incluyen los campos type, user y space para los eventos de este tipo. Para obtener más información, consulta Cómo compilar una página principal para una app de Google Chat. |
SUBMIT_FORM |
Un usuario envía información en una tarjeta de la página principal de la app. Solo se incluyen los campos type, user y space para los eventos de este tipo. Para obtener más información, consulta [Cómo compilar una página principal para una app de Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message). |
MessagePayload
Un usuario envía un mensaje a la app de Chat o la @menciona en un espacio. En su lugar, las invocaciones de comandos de la app (como los comandos de barra y los comandos rápidos) usan AppCommandPayload.
| Representación JSON |
|---|
{ "space": { object ( |
| Campos | |
|---|---|
space |
Obligatorio. El espacio de Chat en el que se produce el objeto de evento. |
message |
Es el mensaje que activa el objeto de evento. |
configCompleteRedirectUri |
Opcional. Es la URL a la que la app de Chat debe redireccionar al usuario después de que complete un flujo de autorización o configuración fuera de Google Chat. Para obtener más información, consulta Conecta una app de Chat con otros servicios y herramientas. |
AddedToSpacePayload
Un usuario agrega la app de Chat a un espacio o se crea un MD entre la app y un usuario.
| Representación JSON |
|---|
{
"space": {
object ( |
| Campos | |
|---|---|
space |
Obligatorio. El espacio de Chat en el que se produce el objeto de evento. |
interactionAdd |
Indica si la app se agregó al espacio con una interacción del usuario (p.ej., mencionando la app de Chat con @ o invocándola con un comando de barra). Si se establece como verdadero, habrá un objeto de evento independiente asociado con la interacción en sí que se enviará a la app de Chat. |
configCompleteRedirectUri |
Opcional. Es la URL a la que la app de Chat debe redireccionar al usuario después de que complete un flujo de autorización o configuración fuera de Google Chat. Para obtener más información, consulta Conecta una app de Chat con otros servicios y herramientas. |
RemovedFromSpacePayload
Un usuario quita la app de Chat de un espacio.
| Representación JSON |
|---|
{
"space": {
object ( |
| Campos | |
|---|---|
space |
Obligatorio. El espacio de Chat en el que se produce el objeto de evento. |
ButtonClickedPayload
Un usuario interactúa con un elemento interactivo de una tarjeta o un diálogo de un complemento de Chat que activa una devolución de llamada Action. A pesar del nombre, esta carga útil se propaga para todas las devoluciones de llamada Action de tarjetas y diálogos, incluidos los clics en botones, los activadores onChangeAction, las acciones onClick, los clics en CardAction y el envío o la cancelación de diálogos (SUBMIT_DIALOG y CANCEL_DIALOG).
Si un usuario interactúa con un diálogo, el campo isDialogEvent de ButtonClickedPayload se establece en true y se incluye un DialogEventType. Esta carga útil se asigna a los tipos de eventos SUBMIT_FORM y CARD_CLICKED para las apps de Chat que no son complementos.
La carga útil completa también incluye CommonEventObject.form_inputs y CommonEventObject.parameters.
| Representación JSON |
|---|
{ "space": { object ( |
| Campos | |
|---|---|
space |
Obligatorio. El espacio de Chat en el que se produce el objeto de evento. |
message |
Es el mensaje que activa el objeto de evento. |
isDialogEvent |
En el caso de los objetos de evento |
dialogEventType |
Es el tipo de objeto de evento de diálogo que se recibe. |
DialogEventType
Para los objetos de evento que contienen cargas útiles de eventos ButtonClicked o AppCommand, los tipos de interacciones con diálogos.
Para obtener más información sobre los objetos de eventos de la app de Google Chat, consulta Recibe interacciones con tu app de Google Chat y respóndelas.
| Enums | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
Valor predeterminado Sin especificar. |
REQUEST_DIALOG |
Un usuario abre un diálogo. |
SUBMIT_DIALOG |
Un usuario hace clic en un elemento interactivo de un diálogo. Por ejemplo, un usuario completa información en un diálogo y hace clic en un botón para enviarla. |
CANCEL_DIALOG |
Un usuario cierra un diálogo sin enviar información o se cancela el diálogo. |
WidgetUpdatedPayload
Un usuario actualiza un widget en una tarjeta o un diálogo in-stream.
La carga útil completa también incluye CommonEventObject.parameters['autocomplete_widget_query'].
| Representación JSON |
|---|
{
"space": {
object ( |
| Campos | |
|---|---|
space |
Obligatorio. El espacio de Chat en el que se produce el objeto de evento. |
AppCommandPayload
Un usuario invoca un comando de la app.
| Representación JSON |
|---|
{ "appCommandMetadata": { object ( |
| Campos | |
|---|---|
appCommandMetadata |
Se propaga para los comandos de la app, incluidos los comandos de barra y los comandos rápidos. |
space |
Opcional. El espacio de Chat en el que se produce el objeto de evento. |
thread |
Opcional. Es el hilo en el que se produce el objeto de evento, si corresponde. Este campo se completa si el objeto de evento está asociado con un mensaje o una conversación específicos. |
message |
Opcional. Es el mensaje que activa el objeto de evento, si corresponde. Este campo solo se completa para los comandos de barra. |
configCompleteRedirectUri |
Opcional. Es la URL a la que se debe redireccionar al usuario después de que complete un flujo de autorización o configuración fuera de Google Chat. Para obtener más información, consulta Conecta una app de Chat con otros servicios y herramientas. |
isDialogEvent |
Opcional. Indica si el usuario está interactuando con un diálogo o está a punto de hacerlo. |
dialogEventType |
Opcional. Es el tipo de objeto de evento de diálogo que se recibe. Este campo solo se aplica si |
AppCommandMetadata
Metadatos sobre un comando de la app de Chat.
| Representación JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Campos | |
|---|---|
appCommandId |
Es el ID del comando especificado en la configuración de la API de Chat. |
appCommandType |
Es el tipo de comando de la app de Chat. |
AppCommandType
Es el tipo de comando de la app de Chat. Para obtener más información, consulta Tipos de comandos de apps de Chat.
| Enums | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
Valor predeterminado Sin especificar. |
SLASH_COMMAND |
Un comando de barra. El usuario envía el comando en un mensaje de Chat. |
QUICK_COMMAND |
Un comando rápido El usuario selecciona el comando en el menú de Chat, en el área de respuesta del mensaje. |
MESSAGE_ACTION |
Una acción de mensaje. El usuario selecciona el comando en el menú contextual del mensaje en Chat. |
SystemCommandPayload
Un usuario invoca un comando del sistema.
| Representación JSON |
|---|
{ "systemCommandMetadata": { object ( |
| Campos | |
|---|---|
systemCommandMetadata |
Son los metadatos sobre el comando del sistema que se invocó. |
space |
Opcional. El espacio de Chat en el que se produce el objeto de evento. |
thread |
Opcional. Es el hilo en el que se produce el objeto de evento, si corresponde. Este campo se completa si el objeto de evento está asociado con un mensaje o una conversación específicos. |
SystemCommandMetadata
Son los metadatos sobre un comando del sistema que activa el usuario.
| Representación JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"cancelStream": {
object ( |
| Campos | |
|---|---|
| Es el comando del sistema que se invocó. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
cancelStream |
Comando para cancelar un mensaje de transmisión activo. |
| Fin de los campos mutuamente excluyentes. | |
CancelStream
Comando para cancelar un mensaje de transmisión activo.
| Representación JSON |
|---|
{ "streamMessage": string } |
| Campos | |
|---|---|
streamMessage |
Obligatorio. Es el nombre del recurso del mensaje de transmisión en el que se ejecutó el comando de cancelación. Formato: |
WorkflowEventObject
LINT.IfChange Es el objeto de evento que se pasa a los complementos de Workflow.
| Representación JSON |
|---|
{ "executionMetadata": { object ( |
| Campos | |
|---|---|
executionMetadata |
Son los metadatos sobre la ejecución del flujo de trabajo. |
triggerEventSource |
Es la fuente de los eventos activadores. |
| Es el tipo de carga útil del evento de flujo de trabajo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
actionInvocation |
Invocación de una acción de flujo de trabajo. |
triggerCreation |
Creación de un activador de flujo de trabajo. |
triggerDeletion |
Borrado de un activador de flujo de trabajo. |
resourceRetrieval |
Recuperación de un recurso (se usa para la inflación de variables) |
elementConfiguration |
Es la configuración de un elemento de flujo de trabajo. |
resourceFieldsDefinitionRetrieval |
La recuperación de las definiciones de campos que admite un recurso. |
elementUiAutocomplete |
Son las sugerencias de autocompletar para la tarjeta que se renderiza actualmente. |
| Fin de los campos mutuamente excluyentes. | |
ActionInvocation
Invocación de una acción de flujo de trabajo.
| Representación JSON |
|---|
{ "inputs": { string: { object ( |
| Campos | |
|---|---|
inputs |
Es un mapa de las variables de entrada con clave por nombre de variable de entrada. Un objeto que contiene una lista de pares |
triggerId |
Es el ID del activador que se usará para las respuestas de acciones asíncronas. |
flowLevelContext |
Opcional. Contexto a nivel del flujo de los pasos anteriores. |
VariableData
Representa datos de variables, que pueden contener varios valores de diferentes tipos.
| Representación JSON |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| Campos | |
|---|---|
booleanValues[] |
Valores booleanos. |
integerValues[] |
Valores de números enteros. |
floatValues[] |
Valores de punto flotante. |
stringValues[] |
Valores de la cadena. |
timestampValues[] |
Valores de marca de tiempo. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
resourceReferences[] |
Referencias de recursos (IDs) |
emailAddressValues[] |
Valores de direcciones de correo electrónico. |
googleUserValues[] |
Son los valores de usuario de Google en el formato |
textFormatValues[] |
Son los valores de WorkflowTextFormat. |
ResourceReference
Es el valor del ID del recurso específico de la aplicación.
| Representación JSON |
|---|
{
"resourceType": {
object ( |
| Campos | |
|---|---|
resourceType |
Es el tipo de recurso al que apunta este ID. |
resourceId |
Es el ID del recurso. |
ResourceType
Nombre del tipo de recurso personalizado.
| Representación JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Campos | |
|---|---|
workflowBundleId |
Es el ID del paquete de flujo de trabajo al que pertenece este tipo de recurso. Este es opcional y, si está vacío, se considera que es el mismo paquete en el que se usa. |
workflowResourceDefinitionId |
Es el identificador único del recurso. Solo es necesario que sea único dentro del mismo paquete. |
WorkflowTextFormat
Es un bloque de texto con opciones de formato enriquecido, incluidos estilos, hipervínculos y elementos interactivos.
| Representación JSON |
|---|
{
"textFormatElements": [
{
object ( |
| Campos | |
|---|---|
textFormatElements[] |
Es una colección de elementos de formato de texto. |
TextFormatElement
Un solo elemento dentro de un mensaje de WorkflowTextFormat, que puede ser un chip, texto con diseño, un hipervínculo o un contenedor de lista.
| Representación 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 ( |
| Campos | |
|---|---|
| Es un elemento que representa uno de varios elementos de formato de texto posibles. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
text |
Texto en formato de texto. |
chip |
Chip en el que se puede hacer clic en el formato de texto. |
styledText |
Texto con estilo en el formato de texto. |
hyperlink |
Hipervínculo en el formato de texto. |
listContainer |
Es el contenedor de la lista en formato de texto. |
| Fin de los campos mutuamente excluyentes. | |
Chip
Un chip en el que se puede hacer clic en el formato de texto.
| Representación JSON |
|---|
{
"icon": {
object ( |
| Campos | |
|---|---|
icon |
Es el ícono que se muestra en el chip. |
label |
Es el texto que se muestra en el chip. |
url |
Es la URL a la que se navegará cuando se haga clic en el chip. |
Ícono
Es un ícono en el chip.
| Representación 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. } |
| Campos | |
|---|---|
| Es el ícono que se muestra en el chip. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
iconUrl |
Muestra un ícono personalizado alojado en una URL HTTPS. Por ejemplo: Los tipos de archivo admitidos incluyen |
materialIconName |
Es el nombre del ícono definido en el ícono de material de Google, por ejemplo, |
| Fin de los campos mutuamente excluyentes. | |
StyledText
Elemento de texto con estilos como negrita, cursiva y color.
| Representación JSON |
|---|
{ "text": string, "styles": [ enum ( |
| Campos | |
|---|---|
text |
El contenido principal del texto. |
styles[] |
Es una colección de estilos que se aplican al texto. |
fontWeight |
Es el grosor de la fuente del texto. |
color |
Es el color del texto. |
wrapStyle |
Es el estilo de ajuste del texto. |
Estilo
Es una enumeración para diferentes estilos de texto, como cursiva, subrayado, etcétera.
| Enums | |
|---|---|
STYLE_UNSPECIFIED |
No se aplicó ningún estilo. NO USAR. |
ITALIC |
Estilo en cursiva. |
UNDERLINE |
Estilo de subrayado. |
STRIKETHROUGH |
Estilo tachado. |
LINE_BREAK |
Salto de línea. |
UPPERCASE |
Estilo en mayúsculas. |
CODE |
Programa. |
CODE_BLOCK |
Bloque de código. |
FontWeight
Es una enumeración para diferentes grosores de fuente.
| Enums | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
Peso estándar con grosor normal. NO USAR. |
LIGHT |
Más liviano y con un grosor reducido |
MEDIUM |
Peso intermedio entre ligero y negrita. |
BOLD |
Mayor peso y grosor. |
WrapStyle
Enum para diferentes estilos de ajuste.
| Enums | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
No se especificó ningún estilo de ajuste. |
NO_WRAP |
No se ajusta el estilo. |
Hipervínculo
Elemento de hipervínculo con texto y vínculo.
| Representación JSON |
|---|
{ "link": string, "text": string } |
| Campos | |
|---|---|
link |
Es la URL de destino del hipervínculo. |
text |
Es el texto del hipervínculo. |
ListContainer
Es el contenedor de elementos de lista, en el que cada elemento de lista puede contener varios TextFormatElement.
| Representación JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Campos | |
|---|---|
listNestLevel |
Es el nivel de anidamiento de la lista. Comienza en 0 para el nivel superior y aumenta en 1 para cada lista anidada. |
listType |
Es el tipo de lista. |
listItems[] |
Es una colección de elementos de lista. |
ListType
Es una enumeración para diferentes tipos de listas.
| Enums | |
|---|---|
LIST_TYPE_UNSPECIFIED |
No se especificó ningún tipo de lista. NO USAR. |
ORDERED |
Lista ordenada. |
UNORDERED |
Lista sin ordenar. |
BLOCKQUOTE |
Representa una lista de citas en bloque. |
ListItem
Es un elemento de la lista.
| Representación JSON |
|---|
{
"textFormatElements": [
{
object ( |
| Campos | |
|---|---|
textFormatElements[] |
Es una colección de elementos de formato de texto. |
FlowLevelContext
Es el contexto a nivel del flujo que contiene los resultados de los pasos anteriores.
| Representación JSON |
|---|
{
"stepContexts": [
{
object ( |
| Campos | |
|---|---|
stepContexts[] |
Opcional. Es la lista de pasos anteriores. El orden es importante, así que asegúrate de que se mantenga el orden de ejecución en esta lista. |
StepContext
Metadatos de contexto de paso y resultados para el contexto a nivel de flujo.
| Representación JSON |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| Campos | |
|---|---|
stepId |
Opcional. Es el ID único del paso en el gráfico del flujo de trabajo. |
outputs |
Opcional. Es el mapa de variables de salida que produce este paso, con clave por nombre de variable. Un objeto que contiene una lista de pares |
TriggerCreation
Creación de un activador de flujo de trabajo.
| Representación JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Campos | |
|---|---|
triggerId |
Es el identificador único del activador proporcionado durante la creación. |
triggerType |
Es el tipo de activador. |
inputs |
Es un mapa de las variables de entrada con clave por nombre de variable de entrada. Un objeto que contiene una lista de pares |
notifyUri |
Es el extremo al que se llamará cuando se active el activador. |
TriggerType
Es el tipo de activador.
| Enums | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
Valor predeterminado NO USAR. |
REPEATING |
El activador se activará cada vez que se cumplan las condiciones de entrada. |
TriggerDeletion
Borrado de un activador de flujo de trabajo.
| Representación JSON |
|---|
{ "triggerId": string } |
| Campos | |
|---|---|
triggerId |
Es el identificador único del activador proporcionado durante la creación. |
ResourceRetrieval
Recuperación de un recurso.
| Representación JSON |
|---|
{
"resourceReference": {
object ( |
| Campos | |
|---|---|
resourceReference |
Es el tipo y el ID del recurso que se recuperará. |
ElementConfiguration
Invocación cuando se configura un elemento de flujo de trabajo.
| Representación JSON |
|---|
{ "inputs": { string: { object ( |
| Campos | |
|---|---|
inputs |
Es un mapa de las variables de entrada con clave por nombre de variable de entrada. Este mapa podría estar vacío. Se usa cuando se configura un solo elemento de flujo de trabajo (activador o acción) en la página principal del flujo de trabajo. Un objeto que contiene una lista de pares |
displayDestination |
Es el destino de la tarjeta de configuración del elemento. Los elementos pueden usar este campo para devolver diferentes diseños de tarjetas de configuración según el destino. |
nodeId |
Es el ID del nodo de la configuración primitiva que se renderiza. |
workflowId |
Es el ID del flujo de trabajo de la configuración primitiva que se renderiza. |
availableVariables[] |
Son las variables disponibles ordenadas por posición de nodo. |
DisplayDestination
Indica dónde se mostrará la tarjeta de configuración del elemento que se muestra.
| Enums | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
Valor predeterminado NO USAR. |
DISPLAY_DESTINATION_SIDE_PANEL |
La tarjeta de configuración se mostrará en el panel lateral. |
DISPLAY_DESTINATION_FULL_SCREEN |
La tarjeta de configuración se mostrará en la app de pantalla completa. |
VariableReference
Una referencia de variable a una variable en el flujo de trabajo.
| Representación JSON |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| Campos | |
|---|---|
parentElementId |
Es el ID primitivo del elemento que produce la variable. Podemos expandirlo a WorkflowElement o a un proto de metadatos más detallado si es necesario. |
nodeId |
ID de referencia del nodo |
path |
La firma de la ruta de acceso del selector de variables |
dataType |
El tipo de datos de la variable |
iconUrl |
Es la URL del ícono de la primitiva que produce esta variable. |
stepNumber |
Es el número de paso de la primitiva que produce esta variable. |
descriptionText |
Es la descripción de la variable. |
displayText |
Es el texto visible del chip de variable. |
DataType
Es el tipo de variable.
| Representación JSON |
|---|
{ "valueMetadata": { object ( |
| Campos | |
|---|---|
valueMetadata |
Son metadatos sobre los valores potenciales de una variable. |
| El tipo de datos. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
basicType |
Es el tipo de datos básico. |
resourceType |
Es el tipo de ID del recurso de la aplicación. |
| Fin de los campos mutuamente excluyentes. | |
BasicType
Tipos de datos genéricos básicos
| Enums | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
Valor predeterminado NO USAR. |
STRING |
Es una cadena de caracteres. |
INTEGER |
Es un número entero. |
FLOAT |
Un número de punto flotante. |
TIMESTAMP |
Es la marca de tiempo en formato ISO 8601. |
BOOLEAN |
Un valor que puede ser verdadero o falso. |
EMAIL_ADDRESS |
Una dirección de correo electrónico, que es una cadena con el formato de una dirección de correo electrónico. |
GOOGLE_USER |
Usuario de los servicios de Google, en el formato users/{user}. |
FILE |
Referencia del archivo. |
FORMATTED_TEXT |
Texto con formato enriquecido. |
ValueMetadata
Es la información sobre los valores potenciales de una variable.
| Representación JSON |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| Campos | |
|---|---|
enumValues[] |
Opcional. Especifica los valores permitidos para una cadena. Solo se puede establecer si |
dynamicTypes[] |
Opcional. Especifica los tipos permitidos que se pueden convertir de forma dinámica para una variable. Esto solo se puede configurar si el DataType es una cadena y la variable es un resultado. |
semanticDescriptors[] |
Opcional. Ayuda a describir el significado semántico de una variable. |
dynamicSchema |
Opcional. Configuración para resolver de forma dinámica el esquema de esta variable. |
defaultValue |
Opcional. Es la cadena que especifica el valor predeterminado de esta variable. Por ejemplo, para los valores booleanos, |
SemanticDescriptor
Son metadatos sobre el significado semántico de una variable.
| Representación JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Campos | |
|---|---|
resourceAttribute |
Indica que la variable corresponde a un atributo específico de un recurso. Esto es particularmente útil para las variables que representan un identificador de un recurso (id, url, key, etc.). El formato recomendado es el siguiente: - Ejemplos: - El cliente usará esta información para sugerirle al usuario qué variables de salida son compatibles con una entrada determinada. |
disallowedResourceAttributes[] |
Opcional. Solo se aplica a las entradas y se ignora para las salidas. Son los atributos no permitidos que corresponden a este descriptor semántico. El cliente impedirá de forma explícita la selección de variables para los resultados que correspondan a cualquiera de estos atributos de recursos no permitidos. |
DynamicSchema
Es la configuración para resolver de forma dinámica el esquema de esta variable en el entorno de ejecución.
| Representación JSON |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| Campos | |
|---|---|
requiredInputIds[] |
Son los IDs de las variables de entrada de hermanos que se deben proporcionar antes de que se pueda resolver de forma dinámica el esquema de esta variable. |
strictEnum |
Cuando es verdadero, el valor de la variable debe coincidir con uno de los valores de enumeración resueltos de forma dinámica. Cuando es falso, los valores resueltos de forma dinámica se tratan como sugerencias no estrictas. |
ResourceFieldsDefinitionRetrieval
Recupera la definición de los campos que admite un recurso.
| Representación JSON |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| Campos | |
|---|---|
elementId |
Especifica el ID del elemento cuyo esquema de recurso dinámico se recuperará. |
inputs |
Esto incluye las entradas de campo del nodo que proporciona la variable. Es un mapa de las variables de entrada con clave por nombre de variable de entrada. Un objeto que contiene una lista de pares |
ElementUiAutocomplete
Son las sugerencias de autocompletar para la tarjeta que se renderiza actualmente.
| Representación JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Campos | |
|---|---|
query |
Es la consulta que se autocompletará. |
inputs |
Es un mapa de las variables de entrada con clave por nombre de variable de entrada. Un objeto que contiene una lista de pares |
invokedFunction |
Es la función invocada asociada con el widget. |
resourceId |
Es el ID del recurso para el que se debe completar automáticamente. Este campo es opcional y es posible que no esté configurado. |
operationId |
Es el ID de la operación que proporcionó el recurso que se completará automáticamente. Este campo es opcional y es posible que no esté configurado. |
ExecutionMetadata
Son los metadatos sobre la ejecución del flujo de trabajo.
| Representación JSON |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| Campos | |
|---|---|
versionId |
Es la versión del elemento del flujo de trabajo que se invoca. |
timeZone |
Es la zona horaria del flujo de trabajo que se guarda, p. ej., "America/Los_Angeles". |
stepNumber |
Representa el número de paso de la primitiva que se invoca. |
TriggerEventSource
Es la fuente del evento que activó esta ejecución.
| Enums | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
Valor predeterminado NO USAR. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
La ejecución se activa automáticamente por eventos. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
La ejecución se activa a través de la ejecución de prueba. |