- EventObject
- CommonEventObject
- HostApp
- Plataforma
- TimeZone
- Entradas
- StringInputs
- DateTimeInput
- DateInput
- TimeInput
- AuthorizationEventObject
- CalendarEventObject
- Organizador
- Convidado
- ConferenceData
- ConferenceSolution
- Chave
- EntryPoint
- Parâmetros
- AddOnParameters
- Recursos
- 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
- Ícone
- Ícone
- 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
Um evento de interação de complemento do Google que contém dados sobre a interação de um usuário com um complemento em um app host.
O objeto de evento é transmitido como JSON para uma função de callback ou um acionador (para o Apps Script) de um complemento ou para um endpoint https (para HTTP) quando um usuário interage com um complemento em um app host. O objeto de evento armazena um objeto de evento do app host definido por cada app host, bem como um objeto de evento comum que contém alguns campos comuns relacionados ao evento.
Para mais informações, consulte Objetos de evento.
| Representação JSON |
|---|
{ "commonEventObject": { object ( |
| Campos | |
|---|---|
commonEventObject |
Um objeto que contém informações comuns a todos os objetos de evento, independentemente do aplicativo hospedado. |
authorizationEventObject |
Definido apenas para solicitações para endpoints HTTP |
| Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
calendar |
Presente somente se o host de chamada for o Google Agenda. Um objeto que contém informações sobre a agenda e o evento. |
drive |
Presente apenas se o host de chamada for o Google Drive. Um objeto que contém informações do Drive. |
gmail |
Presente apenas se o host de chamada for o Gmail. Um objeto que contém informações do Gmail. |
sheets |
Presente apenas se o host de chamada for o Google Planilhas. Um objeto que contém informações do app Planilhas. |
slides |
Presente apenas se o host de chamada for o Google Slides. Um objeto que contém informações do Apresentações. |
docs |
Presente apenas se o host de chamada for o Google Docs. Um objeto que contém informações do Documentos. |
chat |
Presente apenas se o host de chamada for o Google Chat. Um objeto que contém informações do Chat. |
workflow |
Só aparece se o host de chamada for o Google Workspace Studio. Um objeto que contém informações do fluxo de trabalho. |
| Fim dos campos mutuamente exclusivos. | |
CommonEventObject
O objeto de evento comum é a parte do objeto de evento geral que transporta informações gerais e independentes do host para o complemento do cliente do usuário. Essas informações incluem detalhes como localidade, app host e plataforma do usuário.
Além da página inicial e dos acionadores contextuais, os complementos criam e transmitem objetos de evento para funções de callback de ação quando o usuário interage com widgets. A função de callback do complemento pode consultar o objeto de evento comum para determinar o conteúdo dos widgets abertos no cliente do usuário. Por exemplo, o complemento pode localizar o texto que um usuário inseriu em um widget TextInput no objeto eventObject.commentEventObject.formInputs.
Para apps do Chat, o nome da função que o usuário invocou ao interagir com um widget.
| Representação JSON |
|---|
{ "userLocale": string, "hostApp": enum ( |
| Campos | |
|---|---|
userLocale |
Desativado por padrão. O identificador de idioma e país/região do usuário no formato de código de idioma ISO 639 e código de país/região ISO 3166. Por exemplo, Para ativar esse campo, defina |
hostApp |
Indica o app host em que o complemento está ativo quando o objeto de evento é gerado. Os valores possíveis incluem o seguinte:
|
platform |
O tipo enumerado da plataforma que indica a plataforma de origem do evento ( |
timeZone |
Desativado por padrão. O ID do fuso horário e a diferença em relação ao Tempo Universal Coordenado (UTC). Para ativar esse campo, defina Compatível apenas com os tipos de evento |
formInputs |
Um mapa que contém os valores atuais dos widgets no card exibido. As chaves do mapa são os valores de string A estrutura do objeto de valor do mapa depende do tipo de widget: Observação: os exemplos a seguir estão formatados para o ambiente de execução V8 do Apps Script. Se você estiver usando o ambiente de execução Rhino, adicione
Exemplo: para um widget de entrada de texto com
Exemplo: para um widget de vários valores com
Exemplo: para um seletor com um
Exemplo: para um seletor com um
Exemplo: para um seletor com um Um objeto com uma lista de pares |
parameters |
Todos os parâmetros adicionais que você fornecer a uma ação usando Prévia para desenvolvedores: para complementos que estendem o Google Chat, para sugerir itens com base no que os usuários digitam em menus de seleção múltipla, use o valor da chave Um objeto com uma lista de pares |
invokedFunction |
Nome da função a ser invocada. Esse campo não é preenchido para complementos do Google Workspace que estendem o Google Chat. Em vez disso, para receber dados de função, como identificadores, os complementos que estendem o Chat precisam usar o campo |
HostApp
O aplicativo do Google Workspace para um complemento do Google Workspace ou um app do Google Chat.
Para complementos, o aplicativo do Workspace em que um complemento do Google Workspace é iniciado. Para apps do Chat, o app host é sempre CHAT.
| Tipos enumerados | |
|---|---|
UNSPECIFIED_HOST_APP |
O Google não consegue identificar um app host. |
GMAIL |
O complemento é iniciado no Gmail. |
CALENDAR |
O complemento é iniciado no Google Agenda. |
DRIVE |
O complemento é iniciado no Google Drive. |
DEMO |
Não utilizado. |
DOCS |
O complemento é iniciado no Google Docs. |
MEET |
O complemento é iniciado no Google Meet. |
SHEETS |
O complemento é iniciado no Google Planilhas. |
SLIDES |
O complemento é iniciado no Google Slides. |
DRAWINGS |
O complemento é iniciado no Google Desenhos. |
CHAT |
Um app do Google Chat. |
Plataforma
Identifica de qual plataforma a chamada se originou.
| Tipos enumerados | |
|---|---|
UNKNOWN_PLATFORM |
|
WEB |
|
IOS |
|
ANDROID |
|
TimeZone
O ID do fuso horário e a diferença em relação ao Tempo Universal Coordenado (UTC). Compatível apenas com os tipos de evento CARD_CLICKED e SUBMIT_DIALOG.
| Representação JSON |
|---|
{ "id": string, "offset": integer } |
| Campos | |
|---|---|
id |
O código do banco de dados de fuso horário IANA TZ, como "America/Toronto". |
offset |
A diferença de fuso horário do usuário, em milissegundos, em relação ao Tempo Universal Coordenado (UTC). |
Entradas
Tipos de dados que os usuários podem inserir em cards ou caixas de diálogo. O tipo de entrada depende do tipo de valores que o widget aceita.
| Representação 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 | |
|---|---|
| Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
stringInputs |
Uma lista de strings que representam os valores que o usuário insere em um widget. Se o widget aceitar apenas um valor, como um widget |
dateTimeInput |
Valores de entrada de data e hora de um widget |
dateInput |
Valores de entrada de data de um widget |
timeInput |
Valores de entrada de horário de um widget |
| Fim dos campos mutuamente exclusivos. | |
StringInputs
Parâmetro de entrada para widgets comuns. Para widgets de valor único, é uma lista de valor único. Para widgets com vários valores, como caixas de seleção, todos os valores são apresentados.
| Representação JSON |
|---|
{ "value": [ string ] } |
| Campos | |
|---|---|
value[] |
Uma lista de strings inseridas pelo usuário. |
DateTimeInput
Valores de entrada de data e hora.
| Representação JSON |
|---|
{ "msSinceEpoch": string, "hasDate": boolean, "hasTime": boolean } |
| Campos | |
|---|---|
msSinceEpoch |
Tempo desde o período, em milissegundos. |
hasDate |
Se a entrada |
hasTime |
Se a entrada |
DateInput
Valores de entrada de data.
| Representação JSON |
|---|
{ "msSinceEpoch": string } |
| Campos | |
|---|---|
msSinceEpoch |
Tempo desde a época, em milissegundos. |
TimeInput
Valores de entrada de tempo.
| Representação JSON |
|---|
{ "hours": integer, "minutes": integer } |
| Campos | |
|---|---|
hours |
A hora em um relógio de 24 horas. |
minutes |
O número de minutos após a hora. Os valores válidos são de 0 a 59. |
AuthorizationEventObject
Encapsula as informações de autorização para a solicitação do complemento.
| Representação JSON |
|---|
{ "userOAuthToken": string, "userIdToken": string, "systemIdToken": string, "authorizedScopes": [ string ] } |
| Campos | |
|---|---|
userOAuthToken |
O token de acesso OAuth do usuário final, autorizado com os escopos solicitados. (Após o desmembramento do consentimento do OAuth, isso será autorizado com os escopos autorizados pelo usuário final) |
userIdToken |
Um token de ID do usuário final, se os escopos de ID apropriados forem solicitados |
systemIdToken |
Um token de ID para a conta de serviço dos complementos do G Suite para essa implantação. |
authorizedScopes[] |
Lista de escopos do OAuth autorizados pelo usuário. |
CalendarEventObject
O objeto de evento da Agenda é a parte do objeto de evento geral que contém informações sobre a agenda e os eventos da agenda de um usuário. Ele só estará presente em um objeto de evento se o aplicativo host for o Google Agenda.
A tabela a seguir lista os campos presentes no campo calendar de um objeto de evento. Os campos marcados como Dados gerados pelo usuário estarão presentes no objeto de evento se, e somente se, os dados estiverem presentes no evento da Agenda e o complemento definir o campo addOns.calendar.currentEventAccess do manifesto como READ ou READ_WRITE.
| Representação JSON |
|---|
{ "id": string, "recurringEventId": string, "calendarId": string, "organizer": { object ( |
| Campos | |
|---|---|
id |
O ID do evento. |
recurringEventId |
O ID de um evento recorrente. |
calendarId |
O ID da agenda. |
organizer |
Um objeto que representa o organizador do evento. |
attendees[] |
Dados gerados pelo usuário. Uma lista dos convidados do evento da agenda. |
conferenceData |
Dados gerados pelo usuário. Um objeto que representa os dados de conferência associados a esse evento, como os detalhes da conferência do Google Meet. |
capabilities |
Dados gerados pelo usuário. Um objeto que descreve os recursos do complemento para visualizar ou atualizar informações de eventos. |
Organizador
| Representação JSON |
|---|
{ "email": string } |
| Campos | |
|---|---|
email |
O endereço de e-mail do organizador do evento. |
Participante
Os objetos de convidado contêm informações sobre convidados individuais de eventos do Google Agenda. Essas informações estarão presentes no objeto de evento se, e somente se, os dados estiverem presentes no evento da Agenda e o complemento definir o campo addOns.calendar.currentEventAccess do manifesto como READ ou READ_WRITE.
| Representação JSON |
|---|
{ "email": string, "displayName": string, "organizer": boolean, "self": boolean, "resource": boolean, "optional": boolean, "responseStatus": string, "comment": string, "additionalGuests": integer } |
| Campos | |
|---|---|
email |
O endereço de e-mail do convidado. |
displayName |
O nome de exibição do convidado. |
organizer |
true se o convidado for um organizador do evento. |
self |
true se o convidado representar a agenda em que o evento aparece; false caso contrário. |
resource |
true se o convidado representar um recurso, como uma sala ou um equipamento; caso contrário, false. |
optional |
true se a presença do convidado estiver marcada como opcional; false caso contrário. |
responseStatus |
O status da resposta do convidado. Os valores possíveis incluem o seguinte:
|
comment |
O comentário de resposta do convidado, se houver. |
additionalGuests |
O número de convidados adicionais que o participante indicou que vai levar. Assume zero como padrão. |
ConferenceData
Os objetos de dados de conferência contêm informações sobre as conferências anexadas aos eventos do Google Agenda. Podem ser soluções de videoconferência do Google, como o Google Meet, ou de terceiros. Essas informações estarão presentes no objeto de evento se, e somente se, os dados estiverem presentes no evento da Agenda e o complemento definir o campo addOns.calendar.currentEventAccess do manifesto como READ ou READ_WRITE.
| Representação JSON |
|---|
{ "conferenceId": string, "conferenceSolution": { object ( |
| Campos | |
|---|---|
conferenceId |
O ID da videoconferência. Esse ID serve para que os aplicativos acompanhem as conferências. Não mostre esse ID aos usuários. |
conferenceSolution |
Um objeto que representa a solução de videoconferência, como o Hangouts ou o Google Meet. |
entryPoints[] |
A lista de pontos de entrada da conferência, como URLs ou números de telefone. |
notes |
Observações adicionais (como instruções do administrador do domínio ou avisos legais) sobre a videoconferência que serão mostradas ao usuário. Pode conter HTML. O tamanho máximo é de 2.048 caracteres. |
parameters |
Um objeto que contém um mapa de dados de parâmetros definidos para uso pelo complemento. |
ConferenceSolution
| Representação JSON |
|---|
{
"iconUri": string,
"key": {
object ( |
| Campos | |
|---|---|
iconUri |
O URI do ícone visível ao usuário que representa essa solução de videoconferência. |
key |
A chave que identifica exclusivamente a solução de videoconferência para este evento. |
name |
O nome visível para o usuário dessa solução de videoconferência (não localizado). |
Chave
| Representação JSON |
|---|
{ "type": string } |
| Campos | |
|---|---|
type |
O tipo de solução de videoconferência. Os valores possíveis incluem o seguinte:
|
EntryPoint
Os objetos de ponto de entrada contêm informações sobre os meios estabelecidos de acesso a uma determinada conferência, como por telefone ou vídeo. Essas informações estarão presentes no objeto de evento se, e somente se, os dados estiverem presentes no evento da Agenda e o complemento definir o campo addOns.calendar.currentEventAccess do manifesto como READ ou READ_WRITE.
| Representação JSON |
|---|
{ "accessCode": string, "entryPointType": string, "label": string, "meetingCode": string, "passcode": string, "password": string, "pin": string, "uri": string, "regionCode": string, "entryPointFeatures": [ string ] } |
| Campos | |
|---|---|
accessCode |
O código de acesso usado para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponder e exibir apenas os campos usados pelo provedor de conferência. |
entryPointType |
O tipo de ponto de entrada. Os valores possíveis são:
|
label |
O rótulo visível para o usuário do URI do ponto de entrada (não localizado). |
meetingCode |
O código da reunião usado para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponder e exibir apenas os campos usados pelo provedor de conferência. |
passcode |
A senha usada para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponder e exibir apenas os campos usados pelo provedor de conferência. |
password |
A senha usada para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponder e exibir apenas os campos usados pelo provedor de conferência. |
pin |
O PIN usado para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponder e exibir apenas os campos usados pelo provedor de conferência. |
uri |
O URI do ponto de entrada. O tamanho máximo é de 1.300 caracteres. A formatação depende do tipo de ponto de entrada:
|
regionCode |
Código de região do número de telefone. Necessário para os usuários se o URI não incluir um código de país. Os valores são baseados na lista pública de códigos de região do CLDR. |
entryPointFeatures[] |
Recursos do ponto de entrada. No momento, esses recursos se aplicam apenas aos pontos de entrada de telefone:
|
Parâmetros
| Representação JSON |
|---|
{
"addOnParameters": {
object ( |
| Campos | |
|---|---|
addOnParameters |
Um mapa de chaves e valores de string de parâmetro. Essas chaves e valores são definidos pelo desenvolvedor do complemento para anexar informações a uma conferência específica para uso do complemento. |
AddOnParameters
| Representação JSON |
|---|
{ "parameters": { string: string, ... } } |
| Campos | |
|---|---|
parameters |
Um objeto com uma lista de pares |
Recursos
| Representação JSON |
|---|
{ "canSeeAttendees": boolean, "canAddAttendees": boolean, "canSeeConferenceData": boolean, "canSetConferenceData": boolean, "canAddAttachments": boolean } |
| Campos | |
|---|---|
canSeeAttendees |
Dados gerados pelo usuário. true se o complemento puder ler a lista de convidados do evento. Caso contrário, false. |
canAddAttendees |
Dados gerados pelo usuário. true se o complemento puder adicionar novos convidados à lista de convidados do evento; false caso contrário. |
canSeeConferenceData |
Dados gerados pelo usuário. true se o complemento puder ler os dados da conferência do evento; false caso contrário. |
canSetConferenceData |
Dados gerados pelo usuário: true se o complemento puder atualizar os dados da videoconferência do evento; false caso contrário. |
canAddAttachments |
Dados gerados pelo usuário: true se o complemento puder adicionar novos anexos ao evento; false caso contrário. |
DriveEventObject
O objeto de evento do Drive é a parte do objeto de evento geral que contém informações sobre o Google Drive de um usuário e o conteúdo dele. Ele só estará presente em um objeto de evento se o aplicativo host for o Google Drive.
| Representação JSON |
|---|
{ "selectedItems": [ { object ( |
| Campos | |
|---|---|
selectedItems[] |
Uma lista de itens (arquivos ou pastas) selecionados no Drive. |
activeCursorItem |
O item do Drive que está ativo no momento. |
DriveItemMetadata
Os objetos de item do Drive contêm informações sobre itens específicos do Drive, como arquivos ou pastas.
| Representação JSON |
|---|
{ "id": string, "iconUrl": string, "mimeType": string, "title": string, "addonHasFileScopePermission": boolean } |
| Campos | |
|---|---|
id |
O ID do item selecionado. |
iconUrl |
O URL do ícone que representa o item selecionado. |
mimeType |
O tipo MIME do item selecionado. |
title |
O título do item selecionado. |
addonHasFileScopePermission |
Se for true, o complemento solicitou e recebeu a autorização do escopo https://www.googleapis.com/auth/drive.file para este item. Caso contrário, esse campo será false. Se o complemento usar um escopo mais permissivo, como https://www.googleapis.com/auth/drive ou https://www.googleapis.com/auth/drive.readonly, esse campo não será relevante. Sempre use os escopos menos permissivos possíveis ao criar complementos para proteger as informações do usuário. |
GmailEventObject
O objeto de evento do Gmail é a parte do objeto de evento geral que contém informações sobre as mensagens do Gmail de um usuário. Ele só estará presente em um objeto de evento se o aplicativo hospedado for o Gmail.
| Representação JSON |
|---|
{ "messageId": string, "threadId": string, "accessToken": string, "toRecipients": [ string ], "ccRecipients": [ string ], "bccRecipients": [ string ] } |
| Campos | |
|---|---|
messageId |
O ID da mensagem do Gmail aberta no momento. |
threadId |
O ID da conversa do Gmail aberta no momento. |
accessToken |
O token de acesso específico do Gmail. Você pode usar esse token com o método |
toRecipients[] |
Desativado por padrão. A lista de endereços de e-mail dos destinatários "Para:" incluídos em um rascunho que o complemento está escrevendo. Para ativar esse campo, defina o campo |
ccRecipients[] |
Desativado por padrão. A lista de endereços de e-mail dos destinatários em "CC:" incluídos em um rascunho que o complemento está escrevendo. Para ativar esse campo, defina o campo |
bccRecipients[] |
Desativado por padrão. A lista de endereços de e-mail dos destinatários em "Cco:" incluídos em um rascunho que o complemento está escrevendo. Para ativar esse campo, defina o campo |
SheetsEventObject
O objeto de evento do Planilhas é a parte do objeto de evento geral que contém informações sobre o documento de um usuário e o conteúdo dele. Ele só estará presente em um objeto de evento se o complemento estender o Google Planilhas.
| Representação JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Campos | |
|---|---|
id |
Só estará presente se o escopo |
title |
Só estará presente se o escopo |
addonHasFileScopePermission |
Se for |
matchedUrl |
Presente apenas se as seguintes condições forem atendidas:
O URL do link que gera uma visualização no Google Planilhas. Para usar esse campo, configure o Exemplo de payload para quando um usuário visualiza o link |
MatchedUrl
Objeto de evento retornado com solicitações de visualização de link.
| Representação JSON |
|---|
{ "url": string } |
| Campos | |
|---|---|
url |
O URL correspondente. |
SlidesEventObject
O objeto de evento do Apresentações é a parte do objeto de evento geral que contém informações sobre o documento de um usuário e o conteúdo dele. Ele só estará presente em um objeto de evento se o complemento estender as Apresentações Google.
| Representação JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Campos | |
|---|---|
id |
Só estará presente se o escopo |
title |
Só estará presente se o escopo |
addonHasFileScopePermission |
Se for |
matchedUrl |
Presente apenas se as seguintes condições forem atendidas:
O URL do link que gera uma prévia no Google Slides. Para usar esse campo, configure o Exemplo de payload para quando um usuário visualiza o link |
DocsEventObject
O objeto de evento do Documentos é a parte do objeto de evento geral que contém informações sobre o documento de um usuário e o conteúdo dele. Ele só estará presente em um objeto de evento se o complemento estender o Google Docs.
| Representação JSON |
|---|
{
"id": string,
"title": string,
"addonHasFileScopePermission": boolean,
"matchedUrl": {
object ( |
| Campos | |
|---|---|
id |
Só estará presente se o escopo |
title |
Só estará presente se o escopo |
addonHasFileScopePermission |
Se for |
matchedUrl |
Presente apenas se as seguintes condições forem atendidas:
O URL do link que gera uma prévia no Google Docs. Para usar esse campo, configure o Exemplo de payload para quando um usuário visualiza o link |
ChatEventObject
Um payload de objeto de evento do app Google Chat enviado do servidor do Google para complementos. Os payloads podem ser usados para identificar o tipo de evento.
| Representação JSON |
|---|
{ "type": enum ( |
| Campos | |
|---|---|
type |
O tipo do evento, preenchido apenas para eventos da página inicial do app em apps do Chat que não são complementos. |
user |
O usuário que interage com o app do Chat. |
space |
O espaço em que o evento ocorreu, preenchido apenas para eventos da página inicial do app em apps do Chat que não são complementos. |
eventTime |
O carimbo de data/hora que indica quando o objeto de evento ocorre. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: |
| O payload do objeto de evento. Os payloads dependem do tipo de objeto de evento. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
messagePayload |
Um usuário envia uma mensagem para o app do Chat ou @menciona o app em um espaço. As invocações de comandos de apps (como comandos de barra e comandos rápidos) são entregues em |
addedToSpacePayload |
Um usuário adiciona o app do Chat a um espaço do Chat, ou um admin do Google Workspace instala o app do Chat em espaços de mensagens diretas para os usuários da organização. |
removedFromSpacePayload |
Um usuário remove o app Chat de um espaço. |
buttonClickedPayload |
Representa os dados do payload quando um usuário interage com um elemento interativo de um card ou caixa de diálogo que aciona um callback Se um usuário interagir com uma caixa de diálogo, o campo O payload completo também inclui |
widgetUpdatedPayload |
Um usuário atualiza um widget em um card in-stream ou em uma caixa de diálogo. O payload completo também inclui |
appCommandPayload |
Um usuário invoca um comando de app. |
systemCommandPayload |
Um usuário invoca um comando do sistema. |
| Fim dos campos mutuamente exclusivos. | |
EventType
O tipo do evento, preenchido apenas para eventos da página inicial do app em apps do Chat que não são complementos.
| Tipos enumerados | |
|---|---|
EVENT_TYPE_UNSPECIFIED |
Valor padrão do tipo enumerado. NÃO USE. |
APP_HOME |
Um usuário abre uma mensagem direta de um app do Chat que usa a página inicial do app. Somente os campos type, user e space são incluídos para eventos desse tipo. Para mais informações, consulte Criar uma página inicial para um app do Google Chat. |
SUBMIT_FORM |
Um usuário envia informações em um card de página inicial do app. Somente os campos type, user e space são incluídos para eventos desse tipo. Para mais informações, consulte [Criar uma página inicial para um app do Google Chat]((https://developers.google.com/workspace/chat/send-app-home-card-message). |
MessagePayload
Um usuário envia uma mensagem para o app do Chat ou @menciona o app em um espaço. As invocações de comandos de apps (como comandos de barra e comandos rápidos) usam AppCommandPayload.
| Representação JSON |
|---|
{ "space": { object ( |
| Campos | |
|---|---|
space |
Obrigatório. O espaço do Chat em que o objeto de evento ocorre. |
message |
A mensagem que aciona o objeto de evento. |
configCompleteRedirectUri |
Opcional. O URL para o qual o app do Chat deve redirecionar o usuário depois que ele concluir um fluxo de autorização ou configuração fora do Google Chat. Para mais informações, consulte Conectar um app do Chat a outros serviços e ferramentas. |
AddedToSpacePayload
Um usuário adiciona o app do Chat a um espaço ou uma mensagem direta entre o app e um usuário é criada.
| Representação JSON |
|---|
{
"space": {
object ( |
| Campos | |
|---|---|
space |
Obrigatório. O espaço do Chat em que o objeto de evento ocorre. |
interactionAdd |
Se o app foi adicionado ao espaço com uma interação do usuário (por exemplo, mencionando o app do Chat com @ ou invocando com um comando de barra). Se definido como verdadeiro, um objeto de evento separado associado à interação será enviado ao app do Chat. |
configCompleteRedirectUri |
Opcional. O URL para o qual o app do Chat deve redirecionar o usuário depois que ele concluir um fluxo de autorização ou configuração fora do Google Chat. Para mais informações, consulte Conectar um app do Chat a outros serviços e ferramentas. |
RemovedFromSpacePayload
Um usuário remove o app Chat de um espaço.
| Representação JSON |
|---|
{
"space": {
object ( |
| Campos | |
|---|---|
space |
Obrigatório. O espaço do Chat em que o objeto de evento ocorre. |
ButtonClickedPayload
Um usuário interage com um elemento interativo de um card ou caixa de diálogo de um complemento do Chat que aciona um callback Action. Apesar do nome, esse payload é preenchido para todos os callbacks Action de cards e caixas de diálogo, incluindo cliques em botões, acionadores onChangeAction, ações onClick, cliques em CardAction e envio ou cancelamento de caixas de diálogo (SUBMIT_DIALOG e CANCEL_DIALOG).
Se um usuário interagir com uma caixa de diálogo, o campo isDialogEvent do ButtonClickedPayload será definido como true e incluirá um DialogEventType. Esse payload é mapeado para os tipos de evento SUBMIT_FORM e CARD_CLICKED para apps do Chat que não são complementos.
O payload completo também inclui CommonEventObject.form_inputs e CommonEventObject.parameters.
| Representação JSON |
|---|
{ "space": { object ( |
| Campos | |
|---|---|
space |
Obrigatório. O espaço do Chat em que o objeto de evento ocorre. |
message |
A mensagem que aciona o objeto de evento. |
isDialogEvent |
Para objetos de evento |
dialogEventType |
O tipo de objeto de evento dialog recebido. |
DialogEventType
Para objetos de evento que contêm payloads de evento ButtonClicked ou AppCommand, os tipos de interações com caixas de diálogo.
Para saber mais sobre os objetos de evento do app do Google Chat, consulte Receber e responder a interações com seu app do Google Chat.
| Tipos enumerados | |
|---|---|
DIALOG_EVENT_TYPE_UNSPECIFIED |
Valor padrão. Não especificado. |
REQUEST_DIALOG |
Um usuário abre uma caixa de diálogo. |
SUBMIT_DIALOG |
Um usuário clica em um elemento interativo de uma caixa de diálogo. Por exemplo, um usuário preenche informações em uma caixa de diálogo e clica em um botão para enviá-las. |
CANCEL_DIALOG |
Um usuário fecha uma caixa de diálogo sem enviar informações ou a caixa de diálogo é cancelada. |
WidgetUpdatedPayload
Um usuário atualiza um widget em um card ou caixa de diálogo in-stream.
O payload completo também inclui CommonEventObject.parameters['autocomplete_widget_query'].
| Representação JSON |
|---|
{
"space": {
object ( |
| Campos | |
|---|---|
space |
Obrigatório. O espaço do Chat em que o objeto de evento ocorre. |
AppCommandPayload
Um usuário invoca um comando de app.
| Representação JSON |
|---|
{ "appCommandMetadata": { object ( |
| Campos | |
|---|---|
appCommandMetadata |
Preenchido para comandos de app, incluindo comandos de barra e comandos rápidos. |
space |
Opcional. O espaço do Chat em que o objeto de evento ocorre. |
thread |
Opcional. A linha de execução em que o objeto de evento ocorre, se aplicável. Esse campo é preenchido se o objeto de evento estiver associado a uma mensagem ou conversa específica. |
message |
Opcional. A mensagem que aciona o objeto de evento, se aplicável. Este campo é preenchido apenas para comandos de barra. |
configCompleteRedirectUri |
Opcional. O URL para o qual o usuário deve ser redirecionado depois de concluir um fluxo de autorização ou configuração fora do Google Chat. Para mais informações, consulte Conectar um app do Chat a outros serviços e ferramentas. |
isDialogEvent |
Opcional. Se o usuário está interagindo ou prestes a interagir com uma caixa de diálogo. |
dialogEventType |
Opcional. O tipo de objeto de evento dialog recebido. Esse campo só se aplica se |
AppCommandMetadata
Metadados sobre um comando do app do Chat.
| Representação JSON |
|---|
{
"appCommandId": integer,
"appCommandType": enum ( |
| Campos | |
|---|---|
appCommandId |
O ID do comando especificado na configuração da API Chat. |
appCommandType |
O tipo de comando do app do Chat. |
AppCommandType
O tipo de comando do app do Chat. Veja mais detalhes em Tipos de comandos de apps do Chat.
| Tipos enumerados | |
|---|---|
APP_COMMAND_TYPE_UNSPECIFIED |
Valor padrão. Não especificado. |
SLASH_COMMAND |
Um comando de barra. O usuário envia o comando em uma mensagem de chat. |
QUICK_COMMAND |
Um comando rápido. O usuário seleciona o comando no menu do Chat na área de resposta da mensagem. |
MESSAGE_ACTION |
Uma ação de mensagem. O usuário seleciona o comando no menu de contexto da mensagem no Chat. |
SystemCommandPayload
Um usuário invoca um comando do sistema.
| Representação JSON |
|---|
{ "systemCommandMetadata": { object ( |
| Campos | |
|---|---|
systemCommandMetadata |
Metadados sobre o comando do sistema que foi invocado. |
space |
Opcional. O espaço do Chat em que o objeto de evento ocorre. |
thread |
Opcional. A linha de execução em que o objeto de evento ocorre, se aplicável. Esse campo é preenchido se o objeto de evento estiver associado a uma mensagem ou conversa específica. |
SystemCommandMetadata
Metadados sobre um comando do sistema acionado pelo usuário.
| Representação 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 | |
|---|---|
| O comando do sistema invocado. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
cancelStream |
Comando para cancelar uma mensagem de stream ativa. |
| Fim dos campos mutuamente exclusivos. | |
CancelStream
Comando para cancelar uma mensagem de stream ativa.
| Representação JSON |
|---|
{ "streamMessage": string } |
| Campos | |
|---|---|
streamMessage |
Obrigatório. O nome do recurso da mensagem de stream em que o comando de cancelamento foi executado. Formato: |
WorkflowEventObject
LINT.IfChange O objeto de evento transmitido para complementos do Workflow.
| Representação JSON |
|---|
{ "executionMetadata": { object ( |
| Campos | |
|---|---|
executionMetadata |
Metadados sobre a execução do fluxo de trabalho. |
triggerEventSource |
Origem dos eventos de acionamento. |
| O tipo de payload do evento de fluxo de trabalho. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
actionInvocation |
Invocação de uma ação de fluxo de trabalho. |
triggerCreation |
Criação de um gatilho de fluxo de trabalho. |
triggerDeletion |
Exclusão de um gatilho de fluxo de trabalho. |
resourceRetrieval |
Recuperação de um recurso (usado para inflação de variáveis). |
elementConfiguration |
Configuração de um elemento de fluxo de trabalho. |
resourceFieldsDefinitionRetrieval |
A recuperação de definições de campo compatíveis com um recurso. |
elementUiAutocomplete |
Sugestões de preenchimento automático para o card renderizado no momento. |
| Fim dos campos mutuamente exclusivos. | |
ActionInvocation
Invocação de uma ação de fluxo de trabalho.
| Representação JSON |
|---|
{ "inputs": { string: { object ( |
| Campos | |
|---|---|
inputs |
Mapa das variáveis de entrada com chave pelo nome da variável de entrada. Um objeto com uma lista de pares |
triggerId |
ID do gatilho a ser usado para respostas de ações assíncronas. |
flowLevelContext |
Opcional. Contexto do fluxo das etapas anteriores. |
VariableData
Representa dados variáveis, que podem conter vários valores de tipos diferentes.
| Representação JSON |
|---|
{ "booleanValues": [ boolean ], "integerValues": [ string ], "floatValues": [ number ], "stringValues": [ string ], "timestampValues": [ string ], "resourceReferences": [ { object ( |
| Campos | |
|---|---|
booleanValues[] |
Valores booleanos. |
integerValues[] |
Valores inteiros. |
floatValues[] |
Valores flutuantes. |
stringValues[] |
Valores de string. |
timestampValues[] |
Valores de carimbo de data/hora. Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: |
resourceReferences[] |
Referências de recursos (IDs). |
emailAddressValues[] |
Valores de endereço de e-mail. |
googleUserValues[] |
Valores de usuário do Google no formato |
textFormatValues[] |
Valores de formato de texto do fluxo de trabalho. |
ResourceReference
Valor do ID do recurso específico do aplicativo.
| Representação JSON |
|---|
{
"resourceType": {
object ( |
| Campos | |
|---|---|
resourceType |
O tipo de recurso para o qual esse ID aponta. |
resourceId |
ID do recurso. |
ResourceType
Nome do tipo de recurso personalizado.
| Representação JSON |
|---|
{ "workflowBundleId": string, "workflowResourceDefinitionId": string } |
| Campos | |
|---|---|
workflowBundleId |
ID do pacote de fluxo de trabalho que possui esse tipo de recurso. Isso é opcional e, se estiver vazio, será considerado o mesmo pacote em que está sendo usado. |
workflowResourceDefinitionId |
Identificador exclusivo do recurso. Ele só precisa ser exclusivo no mesmo pacote. |
WorkflowTextFormat
Um bloco de texto com opções de formatação avançadas, incluindo estilos, hiperlinks e elementos interativos.
| Representação JSON |
|---|
{
"textFormatElements": [
{
object ( |
| Campos | |
|---|---|
textFormatElements[] |
Uma coleção de elementos de formato de texto. |
TextFormatElement
Um único elemento em uma mensagem WorkflowTextFormat, que pode ser um ícone, um texto estilizado, um hiperlink ou um contêiner de lista.
| Representação 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 | |
|---|---|
| Elemento que representa um dos vários elementos de formato de texto possíveis. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
text |
Texto no formato de texto. |
chip |
Ícone clicável no formato de texto. |
styledText |
Texto estilizado no formato de texto. |
hyperlink |
Hiperlink no formato de texto. |
listContainer |
Contêiner de lista no formato de texto. |
| Fim dos campos mutuamente exclusivos. | |
Ícone
Um ícone clicável no formato de texto.
| Representação JSON |
|---|
{
"icon": {
object ( |
| Campos | |
|---|---|
icon |
O ícone mostrado no ícone. |
label |
O texto que aparece no ícone. |
url |
O URL para o qual navegar quando o ícone é clicado. |
Ícone
Um ícone no ícone.
| Representação 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 | |
|---|---|
| O ícone mostrado no ícone. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
iconUrl |
Mostre um ícone personalizado hospedado em um URL HTTPS. Exemplo: Os tipos de arquivo aceitos incluem |
materialIconName |
O nome do ícone definido no ícone do Material Design do Google, por exemplo, |
| Fim dos campos mutuamente exclusivos. | |
StyledText
Elemento do texto com estilos como negrito, itálico e cor.
| Representação JSON |
|---|
{ "text": string, "styles": [ enum ( |
| Campos | |
|---|---|
text |
O conteúdo principal do texto. |
styles[] |
Uma coleção de estilos aplicados ao texto. |
fontWeight |
A espessura da fonte do texto. |
color |
A cor do texto. |
wrapStyle |
O estilo de ajuste do texto. |
Estilo
Tipo enumerado para diferentes estilos de texto, como itálico, sublinhado etc.
| Tipos enumerados | |
|---|---|
STYLE_UNSPECIFIED |
Nenhum estilo aplicado. NÃO USE. |
ITALIC |
Estilo em itálico. |
UNDERLINE |
Estilo sublinhado. |
STRIKETHROUGH |
Estilo tachado. |
LINE_BREAK |
Quebra de linha. |
UPPERCASE |
Estilo em letras maiúsculas. |
CODE |
Code. |
CODE_BLOCK |
Bloco de código. |
FontWeight
Tipo enumerado para diferentes pesos de fonte.
| Tipos enumerados | |
|---|---|
FONT_WEIGHT_UNSPECIFIED |
Peso padrão com espessura normal. NÃO USE. |
LIGHT |
Mais leve e com espessura reduzida. |
MEDIUM |
Peso intermediário entre leve e negrito. |
BOLD |
Mais pesado e com maior espessura. |
WrapStyle
Tipo enumerado para diferentes estilos de quebra de linha.
| Tipos enumerados | |
|---|---|
WRAP_STYLE_UNSPECIFIED |
Nenhum estilo de quebra de linha especificado. |
NO_WRAP |
Sem estilo de quebra de linha. |
Hiperlink
Elemento de hiperlink com texto e link.
| Representação JSON |
|---|
{ "link": string, "text": string } |
| Campos | |
|---|---|
link |
O URL de destino do hiperlink. |
text |
O texto do hiperlink. |
ListContainer
Contêiner para itens de lista, em que cada item pode conter vários TextFormatElements.
| Representação JSON |
|---|
{ "listNestLevel": string, "listType": enum ( |
| Campos | |
|---|---|
listNestLevel |
O nível de aninhamento da lista. Começa em 0 para o nível superior e aumenta em 1 para cada lista aninhada. |
listType |
O tipo da lista. |
listItems[] |
Uma coleção de itens de lista. |
ListType
Tipo enumerado para diferentes tipos de lista.
| Tipos enumerados | |
|---|---|
LIST_TYPE_UNSPECIFIED |
Nenhum tipo de lista foi especificado. NÃO USE. |
ORDERED |
Lista ordenada. |
UNORDERED |
Lista não ordenada. |
BLOCKQUOTE |
Representa uma lista de citações. |
ListItem
Um item de lista.
| Representação JSON |
|---|
{
"textFormatElements": [
{
object ( |
| Campos | |
|---|---|
textFormatElements[] |
Uma coleção de elementos de formato de texto. |
FlowLevelContext
Contexto no nível do fluxo que contém saídas das etapas anteriores.
| Representação JSON |
|---|
{
"stepContexts": [
{
object ( |
| Campos | |
|---|---|
stepContexts[] |
Opcional. Lista de etapas anteriores. A ordem é importante, então verifique se a ordem de execução é mantida nessa lista. |
StepContext
Metadados de contexto de etapa e saídas para contexto no nível do fluxo.
| Representação JSON |
|---|
{
"stepId": string,
"outputs": {
string: {
object ( |
| Campos | |
|---|---|
stepId |
Opcional. ID exclusivo da etapa no gráfico do fluxo de trabalho. |
outputs |
Opcional. Mapa de variáveis de saída produzidas por esta etapa, com chave pelo nome da variável. Um objeto com uma lista de pares |
TriggerCreation
Criação de um gatilho de fluxo de trabalho.
| Representação JSON |
|---|
{ "triggerId": string, "triggerType": enum ( |
| Campos | |
|---|---|
triggerId |
Identificador exclusivo do gatilho fornecido durante a criação. |
triggerType |
Tipo do gatilho. |
inputs |
Mapa das variáveis de entrada com chave pelo nome da variável de entrada. Um objeto com uma lista de pares |
notifyUri |
O endpoint que será chamado quando o gatilho for acionado. |
TriggerType
Tipo do gatilho.
| Tipos enumerados | |
|---|---|
TRIGGER_TYPE_UNDEFINED |
Valor padrão. NÃO USE. |
REPEATING |
O acionador será disparado sempre que as condições de entrada forem atendidas. |
TriggerDeletion
Exclusão de um gatilho de fluxo de trabalho.
| Representação JSON |
|---|
{ "triggerId": string } |
| Campos | |
|---|---|
triggerId |
Identificador exclusivo do gatilho fornecido durante a criação. |
ResourceRetrieval
Recuperação de um recurso.
| Representação JSON |
|---|
{
"resourceReference": {
object ( |
| Campos | |
|---|---|
resourceReference |
Tipo e ID do recurso a ser recuperado. |
ElementConfiguration
Invocação ao configurar um elemento de fluxo de trabalho.
| Representação JSON |
|---|
{ "inputs": { string: { object ( |
| Campos | |
|---|---|
inputs |
Mapa das variáveis de entrada com chave pelo nome da variável de entrada. Este mapa pode estar vazio. Usado ao configurar um único elemento de fluxo de trabalho (gatilho ou ação) na página inicial do fluxo de trabalho. Um objeto com uma lista de pares |
displayDestination |
O destino do card de configuração do elemento. Os elementos podem usar esse campo para retornar diferentes layouts de card de configuração com base no destino. |
nodeId |
O ID do nó da configuração primitiva que está sendo renderizada. |
workflowId |
O ID do fluxo de trabalho da configuração primitiva que está sendo renderizada. |
availableVariables[] |
Variáveis disponíveis ordenadas por posição do nó. |
DisplayDestination
Indica onde o card de configuração do elemento de retorno será exibido.
| Tipos enumerados | |
|---|---|
DISPLAY_DESTINATION_UNSPECIFIED |
Valor padrão. NÃO USE. |
DISPLAY_DESTINATION_SIDE_PANEL |
O card de configuração será exibido no painel lateral. |
DISPLAY_DESTINATION_FULL_SCREEN |
O card de configuração será exibido no app em tela cheia. |
VariableReference
Uma referência a uma variável no fluxo de trabalho.
| Representação JSON |
|---|
{
"parentElementId": string,
"nodeId": string,
"path": string,
"dataType": {
object ( |
| Campos | |
|---|---|
parentElementId |
O ID primitivo do elemento que produz a variável. Podemos expandir isso para WorkflowElement ou um proto de metadados mais detalhado, se necessário. |
nodeId |
ID de referência do nó |
path |
A assinatura do caminho do seletor de variáveis |
dataType |
O tipo de dado da variável |
iconUrl |
O URL do ícone da primitiva que produz essa variável. |
stepNumber |
O número da etapa da primitiva que produz essa variável. |
descriptionText |
A descrição da variável. |
displayText |
O texto de exibição do ícone de variável. |
DataType
Tipo da variável.
| Representação JSON |
|---|
{ "valueMetadata": { object ( |
| Campos | |
|---|---|
valueMetadata |
Metadados sobre os valores possíveis de uma variável. |
| O tipo de dados. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta: | |
basicType |
Tipo de dados básico. |
resourceType |
Tipo de ID do recurso do aplicativo. |
| Fim dos campos mutuamente exclusivos. | |
BasicType
Tipos de dados genéricos básicos.
| Tipos enumerados | |
|---|---|
BASIC_TYPE_UNSPECIFIED |
Valor padrão. NÃO USE. |
STRING |
Uma string de caracteres. |
INTEGER |
Um número inteiro. |
FLOAT |
Um número de ponto flutuante. |
TIMESTAMP |
Carimbo de data/hora no formato ISO 8601. |
BOOLEAN |
Um valor que pode ser verdadeiro ou falso. |
EMAIL_ADDRESS |
Um endereço de e-mail, que é uma string no formato de um endereço de e-mail. |
GOOGLE_USER |
Usuário dos Serviços do Google, no formato users/{user}. |
FILE |
Referência do arquivo. |
FORMATTED_TEXT |
Texto com formatação avançada. |
ValueMetadata
Informações sobre os valores possíveis de uma variável.
| Representação JSON |
|---|
{ "enumValues": [ string ], "dynamicTypes": [ enum ( |
| Campos | |
|---|---|
enumValues[] |
Opcional. Especifica os valores permitidos para uma string. Isso só poderá ser definido se |
dynamicTypes[] |
Opcional. Especifica os tipos permitidos que podem ser transmitidos dinamicamente para uma variável. Isso só pode ser definido se o DataType for uma string e a variável for uma saída. |
semanticDescriptors[] |
Opcional. Ajuda a descrever o significado semântico de uma variável. |
dynamicSchema |
Opcional. Configuração para resolver dinamicamente o esquema dessa variável. |
defaultValue |
Opcional. String que especifica o valor padrão para essa variável. Por exemplo, para booleanos, |
SemanticDescriptor
Metadados sobre o significado semântico de uma variável.
| Representação JSON |
|---|
{ "resourceAttribute": string, "disallowedResourceAttributes": [ string ] } |
| Campos | |
|---|---|
resourceAttribute |
Indica que a variável corresponde a um atributo específico de um recurso. Isso é especialmente útil para variáveis que representam um identificador de um recurso (id, url, key etc.). O formato recomendado é: - Exemplos: - O cliente vai usar essas informações para sugerir ao usuário quais variáveis de saída são compatíveis com uma determinada entrada. |
disallowedResourceAttributes[] |
Opcional. Aplicável apenas a entradas e ignorado para saídas. Atributos não permitidos que correspondem a esse descritor semântico. O cliente vai impedir explicitamente a seleção de variáveis para saídas que correspondam a qualquer um desses atributos de recurso não permitidos. |
DynamicSchema
Configuração para resolver dinamicamente o esquema dessa variável no momento da execução.
| Representação JSON |
|---|
{ "requiredInputIds": [ string ], "strictEnum": boolean } |
| Campos | |
|---|---|
requiredInputIds[] |
IDs de variáveis de entrada semelhantes que precisam ser fornecidos antes que o esquema dessa variável possa ser resolvido dinamicamente. |
strictEnum |
Quando verdadeiro, o valor da variável precisa corresponder a um dos valores de tipo enumerado resolvidos dinamicamente. Quando é falso, os valores resolvidos dinamicamente são tratados como sugestões não estritas. |
ResourceFieldsDefinitionRetrieval
Recupera a definição de campos compatíveis com um recurso.
| Representação JSON |
|---|
{
"elementId": string,
"inputs": {
string: {
object ( |
| Campos | |
|---|---|
elementId |
Especifica o ID do elemento que tem o esquema de recurso dinâmico a ser buscado. |
inputs |
Isso inclui as entradas de campo do nó que fornece a variável. Mapa das variáveis de entrada com chave pelo nome da variável de entrada. Um objeto com uma lista de pares |
ElementUiAutocomplete
Sugestões de preenchimento automático para o card renderizado no momento.
| Representação JSON |
|---|
{
"query": string,
"inputs": {
string: {
object ( |
| Campos | |
|---|---|
query |
A consulta a ser preenchida automaticamente. |
inputs |
Mapa das variáveis de entrada com chave pelo nome da variável de entrada. Um objeto com uma lista de pares |
invokedFunction |
A função invocada associada ao widget. |
resourceId |
O ID do recurso que deve ser preenchido automaticamente. Esse campo é opcional e pode não ser definido. |
operationId |
O ID da operação que forneceu o recurso a ser preenchido automaticamente. Esse campo é opcional e pode não ser definido. |
ExecutionMetadata
Metadados sobre a execução do fluxo de trabalho.
| Representação JSON |
|---|
{ "versionId": integer, "timeZone": string, "stepNumber": integer } |
| Campos | |
|---|---|
versionId |
A versão do elemento do fluxo de trabalho que está sendo invocado. |
timeZone |
O fuso horário do fluxo de trabalho que está sendo salvo, por exemplo, "America/Los_Angeles". |
stepNumber |
Representa o número da etapa da primitiva que está sendo invocada. |
TriggerEventSource
Origem do evento que acionou essa execução.
| Tipos enumerados | |
|---|---|
TRIGGER_EVENT_SOURCE_UNSPECIFIED |
Valor padrão. NÃO USE. |
TRIGGER_EVENT_SOURCE_AUTOMATED |
A execução é acionada automaticamente por eventos. |
TRIGGER_EVENT_SOURCE_TEST_RUN |
A execução é acionada por uma execução de teste. |