EventObject

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 (CommonEventObject)
  },
  "authorizationEventObject": {
    object (AuthorizationEventObject)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "calendar": {
    object (CalendarEventObject)
  },
  "drive": {
    object (DriveEventObject)
  },
  "gmail": {
    object (GmailEventObject)
  },
  "sheets": {
    object (SheetsEventObject)
  },
  "slides": {
    object (SlidesEventObject)
  },
  "docs": {
    object (DocsEventObject)
  },
  "chat": {
    object (ChatEventObject)
  },
  "workflow": {
    object (WorkflowEventObject)
  }
  // End of mutually exclusive fields.
}
Campos
commonEventObject

object (CommonEventObject)

Um objeto que contém informações comuns a todos os objetos de evento, independentemente do aplicativo hospedado.

authorizationEventObject

object (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

object (CalendarEventObject)

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

object (DriveEventObject)

Presente apenas se o host de chamada for o Google Drive. Um objeto que contém informações do Drive.

gmail

object (GmailEventObject)

Presente apenas se o host de chamada for o Gmail. Um objeto que contém informações do Gmail.

sheets

object (SheetsEventObject)

Presente apenas se o host de chamada for o Google Planilhas. Um objeto que contém informações do app Planilhas.

slides

object (SlidesEventObject)

Presente apenas se o host de chamada for o Google Slides. Um objeto que contém informações do Apresentações.

docs

object (DocsEventObject)

Presente apenas se o host de chamada for o Google Docs. Um objeto que contém informações do Documentos.

chat

object (ChatEventObject)

Presente apenas se o host de chamada for o Google Chat. Um objeto que contém informações do Chat.

workflow

object (WorkflowEventObject)

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 (HostApp),
  "platform": enum (Platform),
  "timeZone": {
    object (TimeZone)
  },
  "formInputs": {
    string: {
      object (Inputs)
    },
    ...
  },
  "parameters": {
    string: string,
    ...
  },
  "invokedFunction": string
}
Campos
userLocale

string

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, en-US.

Para ativar esse campo, defina addOns.common.useLocaleFromApp como true no manifesto do complemento. A lista de escopos do complemento também precisa incluir https://www.googleapis.com/auth/script.locale. Consulte Como acessar a localidade e o fuso horário do usuário para mais detalhes.

hostApp

enum (HostApp)

Indica o app host em que o complemento está ativo quando o objeto de evento é gerado. Os valores possíveis incluem o seguinte:

  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
  • CHAT
platform

enum (Platform)

O tipo enumerado da plataforma que indica a plataforma de origem do evento (WEB, IOS ou ANDROID). Não é compatível com apps do Chat.

timeZone

object (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 addOns.common.useLocaleFromApp como true no manifesto do complemento. A lista de escopos do complemento também precisa incluir https://www.googleapis.com/auth/script.locale. Consulte Como acessar a localidade e o fuso horário do usuário para mais detalhes.

Compatível apenas com os tipos de evento CARD_CLICKED e SUBMIT_DIALOG.

formInputs

map (key: string, value: object (Inputs))

Um mapa que contém os valores atuais dos widgets no card exibido. As chaves do mapa são os valores de string name atribuídos a cada widget de entrada (como TextInput.name, SelectionInput.name, DateTimePicker.name ou DecoratedText.SwitchControl.name).

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 [""] após o valor. Por exemplo, em vez de e.commonEventObject.formInputs.employeeName.stringInputs.value[0], formate o objeto de evento como e.commonEventObject.formInputs.employeeName[""].stringInputs.value[0]. Para saber mais sobre os ambientes de execução no Apps Script, consulte a Visão geral do ambiente de execução do V8.

  • Widgets de valor único (por exemplo, um widget TextInput ou um widget SelectionInput do tipo DROPDOWN ou RADIO_BUTTON): um objeto StringInputs que contém uma lista de elemento único (ou uma lista vazia se nenhuma seleção for feita).

Exemplo: para um widget de entrada de texto com employeeName como name, acesse o valor da entrada de texto com: e.commonEventObject.formInputs.employeeName.stringInputs.value[0].

  • Widgets de vários valores (por exemplo, um widget SelectionInput do tipo CHECK_BOX, SWITCH ou MULTI_SELECT): um objeto StringInputs que contém a lista de strings value do item selecionado.

Exemplo: para um widget de vários valores com participants como name, acesse a matriz de valores com: e.commonEventObject.formInputs.participants.stringInputs.value.

  • Um widget DecoratedText.SwitchControl: um objeto StringInputs. Quando selected é true, stringInputs.value contém o campo value da chave (ou "" se value não foi especificado; se várias chaves compartilharem o mesmo name, o value de cada chave selecionada será incluído na lista). Quando selected for false, o value da chave será omitido de stringInputs.value.

  • Um seletor de data e hora (DateTimePickerType.DATE_AND_TIME): um DateTimeInput object.

Exemplo: para um seletor com um name de myDTPicker, acesse o objeto DateTimeInput usando e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • Um seletor somente de data (DateTimePickerType.DATE_ONLY): um DateInput object.

Exemplo: para um seletor com um name de myDatePicker, acesse o objeto DateInput usando e.commonEventObject.formInputs.myDatePicker.dateInput.

  • Um seletor somente de horário (DateTimePickerType.TIME_ONLY): um TimeInput object.

Exemplo: para um seletor com um name de myTimePicker, acesse o objeto TimeInput usando e.commonEventObject.formInputs.myTimePicker.timeInput.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

parameters

map (key: string, value: string)

Todos os parâmetros adicionais que você fornecer a uma ação usando actionParameters ou Action.setParameters().

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 "autocomplete_widget_query" (event.commonEventObject.parameters["autocomplete_widget_query"]). Você pode usar esse valor para consultar um banco de dados e sugerir itens selecionáveis aos usuários enquanto eles digitam. Veja mais detalhes em Coletar e processar informações de usuários do Google Chat.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

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 parameters. Consulte Criar interfaces interativas para apps do Chat.

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

string

O código do banco de dados de fuso horário IANA TZ, como "America/Toronto".

offset

integer

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 (StringInputs)
  },
  "dateTimeInput": {
    object (DateTimeInput)
  },
  "dateInput": {
    object (DateInput)
  },
  "timeInput": {
    object (TimeInput)
  }
  // End of mutually exclusive fields.
}
Campos
Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
stringInputs

object (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 TextInput, a lista vai conter um objeto de string. Se o widget aceitar vários valores, como um widget SelectionInput de caixas de seleção, a lista vai conter um objeto de string para cada valor que o usuário inserir ou selecionar.

dateTimeInput

object (DateTimeInput)

Valores de entrada de data e hora de um widget DateTimePicker que aceita data e hora.

dateInput

object (DateInput)

Valores de entrada de data de um widget DateTimePicker que aceita apenas valores de data.

timeInput

object (TimeInput)

Valores de entrada de horário de um widget DateTimePicker que aceita apenas valores de horário.

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[]

string

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

string (int64 format)

Tempo desde o período, em milissegundos.

hasDate

boolean

Se a entrada datetime inclui uma data do calendário.

hasTime

boolean

Se a entrada datetime inclui um carimbo de data/hora.

DateInput

Valores de entrada de data.

Representação JSON
{
  "msSinceEpoch": string
}
Campos
msSinceEpoch

string (int64 format)

Tempo desde a época, em milissegundos.

TimeInput

Valores de entrada de tempo.

Representação JSON
{
  "hours": integer,
  "minutes": integer
}
Campos
hours

integer

A hora em um relógio de 24 horas.

minutes

integer

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

string

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

string

Um token de ID do usuário final, se os escopos de ID apropriados forem solicitados

systemIdToken

string

Um token de ID para a conta de serviço dos complementos do G Suite para essa implantação.

authorizedScopes[]

string

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 (Organizer)
  },
  "attendees": [
    {
      object (Attendee)
    }
  ],
  "conferenceData": {
    object (ConferenceData)
  },
  "capabilities": {
    object (Capabilities)
  }
}
Campos
id

string

O ID do evento.

recurringEventId

string

O ID de um evento recorrente.

calendarId

string

O ID da agenda.

organizer

object (Organizer)

Um objeto que representa o organizador do evento.

attendees[]

object (Attendee)

Dados gerados pelo usuário. Uma lista dos convidados do evento da agenda.

conferenceData

object (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

object (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

string

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

string

O endereço de e-mail do convidado.

displayName

string

O nome de exibição do convidado.

organizer

boolean

true se o convidado for um organizador do evento.

self

boolean

true se o convidado representar a agenda em que o evento aparece; false caso contrário.

resource

boolean

true se o convidado representar um recurso, como uma sala ou um equipamento; caso contrário, false.

optional

boolean

true se a presença do convidado estiver marcada como opcional; false caso contrário.

responseStatus

string

O status da resposta do convidado. Os valores possíveis incluem o seguinte:

  • accepted: o convidado aceitou o convite para o evento.
  • declined: o convidado recusou o convite para o evento.
  • needsAction: o convidado não respondeu ao convite do evento.
  • tentative: o convidado aceitou provisoriamente o convite para o evento.
comment

string

O comentário de resposta do convidado, se houver.

additionalGuests

integer

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 (ConferenceSolution)
  },
  "entryPoints": [
    {
      object (EntryPoint)
    }
  ],
  "notes": string,
  "parameters": {
    object (Parameters)
  }
}
Campos
conferenceId

string

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

object (ConferenceSolution)

Um objeto que representa a solução de videoconferência, como o Hangouts ou o Google Meet.

entryPoints[]

object (EntryPoint)

A lista de pontos de entrada da conferência, como URLs ou números de telefone.

notes

string

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

object (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 (Key)
  },
  "name": string
}
Campos
iconUri

string

O URI do ícone visível ao usuário que representa essa solução de videoconferência.

key

object (Key)

A chave que identifica exclusivamente a solução de videoconferência para este evento.

name

string

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

string

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

string

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

string

O tipo de ponto de entrada. Os valores possíveis são:

  • more: outras instruções para participar da conferência, como números de telefone alternativos. Uma videoconferência só pode ter um ponto de entrada mais. Se houver, pelo menos um outro tipo de ponto de entrada também será necessário.
  • phone: participe da conferência por um número de telefone. Uma conferência pode ter zero ou mais pontos de entrada de telefone. O Google Agenda mostra apenas os dois primeiros pontos de entrada de telefone, após a formatação e a classificação em ordem alfabética.
  • sip: participe da conferência por SIP. Uma conferência pode ter no máximo um ponto de entrada sip.
  • video: participe da conferência por HTTP. Uma conferência pode ter no máximo um ponto de entrada de vídeo.
label

string

O rótulo visível para o usuário do URI do ponto de entrada (não localizado).

meetingCode

string

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

string

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

string

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

string

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

string

O URI do ponto de entrada. O tamanho máximo é de 1.300 caracteres. A formatação depende do tipo de ponto de entrada:

  • mais: é necessário um esquema http: ou https:.
  • phone: um esquema tel: é obrigatório. O URI precisa incluir toda a sequência de discagem (por exemplo, "tel:+12345678900,,,12345678;1234").
  • sip: um esquema sip: ou sips: é obrigatório. Por exemplo, "sip:12345678@myprovider.com".
  • video: é necessário um esquema http: ou https:.
regionCode

string

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[]

string

Recursos do ponto de entrada. No momento, esses recursos se aplicam apenas aos pontos de entrada de telefone:

  • toll: o ponto de entrada é uma ligação telefônica paga.
  • toll_free: o ponto de entrada é uma ligação sem custo financeiro.

Parâmetros

Representação JSON
{
  "addOnParameters": {
    object (AddOnParameters)
  }
}
Campos
addOnParameters

object (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

map (key: string, value: string)

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Recursos

Representação JSON
{
  "canSeeAttendees": boolean,
  "canAddAttendees": boolean,
  "canSeeConferenceData": boolean,
  "canSetConferenceData": boolean,
  "canAddAttachments": boolean
}
Campos
canSeeAttendees

boolean

Dados gerados pelo usuário. true se o complemento puder ler a lista de convidados do evento. Caso contrário, false.

canAddAttendees

boolean

Dados gerados pelo usuário. true se o complemento puder adicionar novos convidados à lista de convidados do evento; false caso contrário.

canSeeConferenceData

boolean

Dados gerados pelo usuário. true se o complemento puder ler os dados da conferência do evento; false caso contrário.

canSetConferenceData

boolean

Dados gerados pelo usuário: true se o complemento puder atualizar os dados da videoconferência do evento; false caso contrário.

canAddAttachments

boolean

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 (DriveItemMetadata)
    }
  ],
  "activeCursorItem": {
    object (DriveItemMetadata)
  }
}
Campos
selectedItems[]

object (DriveItemMetadata)

Uma lista de itens (arquivos ou pastas) selecionados no Drive.

activeCursorItem

object (DriveItemMetadata)

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

string

O ID do item selecionado.

iconUrl

string

O URL do ícone que representa o item selecionado.

mimeType

string

O tipo MIME do item selecionado.

title

string

O título do item selecionado.

addonHasFileScopePermission

boolean

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

string

O ID da mensagem do Gmail aberta no momento.

threadId

string

O ID da conversa do Gmail aberta no momento.

accessToken

string

O token de acesso específico do Gmail. Você pode usar esse token com o método GmailApp.setCurrentMessageAccessToken(accessToken) para conceder ao complemento acesso temporário à mensagem do Gmail aberta no momento ou permitir que ele escreva novos rascunhos.

toRecipients[]

string

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 addOns.gmail.composeTrigger.draftAccess no manifesto como METADATA.

ccRecipients[]

string

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 addOns.gmail.composeTrigger.draftAccess no manifesto como METADATA.

bccRecipients[]

string

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 addOns.gmail.composeTrigger.draftAccess no manifesto como METADATA.

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 (MatchedUrl)
  }
}
Campos
id

string

Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O ID da planilha aberta na interface do Planilhas.

title

string

Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O título da planilha aberta na interface do Planilhas.

addonHasFileScopePermission

boolean

Se for true, o complemento solicitou e recebeu a autorização do escopo https://www.googleapis.com/auth/drive.file para a planilha aberta na interface do Planilhas. Caso contrário, esse campo será false.

matchedUrl

object (MatchedUrl)

Presente apenas se as seguintes condições forem atendidas:

  • https://www.googleapis.com/auth/workspace.linkpreview foi autorizado pelo usuário.
  • O URL corresponde ao padrão de host especificado no acionador LinkPreviewTriggers.

O URL do link que gera uma visualização no Google Planilhas. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do complemento. Consulte Conferir prévias de links com os ícones inteligentes para mais detalhes.

Exemplo de payload para quando um usuário visualiza o link https://www.example.com/12345:

"sheets" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

MatchedUrl

Objeto de evento retornado com solicitações de visualização de link.

Representação JSON
{
  "url": string
}
Campos
url

string

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 (MatchedUrl)
  }
}
Campos
id

string

Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O ID da apresentação aberta na interface das Apresentações.

title

string

Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O título da apresentação aberta na interface do Apresentações.

addonHasFileScopePermission

boolean

Se for true, o complemento solicitou e recebeu a autorização de escopo https://www.googleapis.com/auth/drive.file para a apresentação aberta na interface do Apresentações. Caso contrário, esse campo será false.

matchedUrl

object (MatchedUrl)

Presente apenas se as seguintes condições forem atendidas:

  • https://www.googleapis.com/auth/workspace.linkpreview foi autorizado pelo usuário.
  • O URL corresponde ao padrão de host especificado no acionador LinkPreviewTriggers.

O URL do link que gera uma prévia no Google Slides. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do complemento. Consulte Conferir prévias de links com os ícones inteligentes para mais detalhes.

Exemplo de payload para quando um usuário visualiza o link https://www.example.com/12345:

"slides" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

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 (MatchedUrl)
  }
}
Campos
id

string

Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O ID do documento aberto na interface do Documentos.

title

string

Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O título do documento aberto na interface do Documentos.

addonHasFileScopePermission

boolean

Se for true, o complemento solicitou e recebeu a autorização do escopo https://www.googleapis.com/auth/drive.file para o documento aberto na interface do app Documentos. Caso contrário, esse campo será false.

matchedUrl

object (MatchedUrl)

Presente apenas se as seguintes condições forem atendidas:

  • https://www.googleapis.com/auth/workspace.linkpreview foi autorizado pelo usuário.
  • O URL corresponde ao padrão de host especificado no acionador LinkPreviewTriggers.

O URL do link que gera uma prévia no Google Docs. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do complemento. Consulte Conferir prévias de links com os ícones inteligentes para mais detalhes.

Exemplo de payload para quando um usuário visualiza o link https://www.example.com/12345:

"docs" : {
  "matchedUrl" : {
    "url" : "https://www.example.com/12345"
  }
}

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 (EventType),
  "user": {
    object (User)
  },
  "space": {
    object (Space)
  },
  "eventTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "messagePayload": {
    object (MessagePayload)
  },
  "addedToSpacePayload": {
    object (AddedToSpacePayload)
  },
  "removedFromSpacePayload": {
    object (RemovedFromSpacePayload)
  },
  "buttonClickedPayload": {
    object (ButtonClickedPayload)
  },
  "widgetUpdatedPayload": {
    object (WidgetUpdatedPayload)
  },
  "appCommandPayload": {
    object (AppCommandPayload)
  },
  "systemCommandPayload": {
    object (SystemCommandPayload)
  }
  // End of mutually exclusive fields.
}
Campos
type

enum (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.

user

object (User)

O usuário que interage com o app do Chat.

space

object (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

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

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

object (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 appCommandPayload.

addedToSpacePayload

object (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

object (RemovedFromSpacePayload)

Um usuário remove o app Chat de um espaço.

buttonClickedPayload

object (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 Action. Apesar do nome, esse payload é preenchido para todos os callbacks Action de cards e caixas de diálogo, não apenas cliques em botões, mas também acionadores onChangeAction, ações onClick, cliques 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.

O payload completo também inclui commonEventObject.formInputs e commonEventObject.parameters.

widgetUpdatedPayload

object (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 CommonEventObject.parameters['autocomplete_widget_query'].

appCommandPayload

object (AppCommandPayload)

Um usuário invoca um comando de app.

systemCommandPayload

object (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 (Space)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string
}
Campos
space

object (Space)

Obrigatório. O espaço do Chat em que o objeto de evento ocorre.

message

object (Message)

A mensagem que aciona o objeto de evento.

configCompleteRedirectUri

string

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 (Space)
  },
  "interactionAdd": boolean,
  "configCompleteRedirectUri": string
}
Campos
space

object (Space)

Obrigatório. O espaço do Chat em que o objeto de evento ocorre.

interactionAdd

boolean

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

string

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 (Space)
  }
}
Campos
space

object (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 (Space)
  },
  "message": {
    object (Message)
  },
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Campos
space

object (Space)

Obrigatório. O espaço do Chat em que o objeto de evento ocorre.

message

object (Message)

A mensagem que aciona o objeto de evento.

isDialogEvent

boolean

Para objetos de evento ButtonClicked e Message, se o usuário está interagindo ou prestes a interagir com uma caixa de diálogo.

dialogEventType

enum (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 (Space)
  }
}
Campos
space

object (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 (AppCommandMetadata)
  },
  "space": {
    object (Space)
  },
  "thread": {
    object (Thread)
  },
  "message": {
    object (Message)
  },
  "configCompleteRedirectUri": string,
  "isDialogEvent": boolean,
  "dialogEventType": enum (DialogEventType)
}
Campos
appCommandMetadata

object (AppCommandMetadata)

Preenchido para comandos de app, incluindo comandos de barra e comandos rápidos.

space

object (Space)

Opcional. O espaço do Chat em que o objeto de evento ocorre.

thread

object (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

object (Message)

Opcional. A mensagem que aciona o objeto de evento, se aplicável. Este campo é preenchido apenas para comandos de barra.

configCompleteRedirectUri

string

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

boolean

Opcional. Se o usuário está interagindo ou prestes a interagir com uma caixa de diálogo.

dialogEventType

enum (DialogEventType)

Opcional. O tipo de objeto de evento dialog recebido. Esse campo só se aplica se isDialogEvent for true.

AppCommandMetadata

Metadados sobre um comando do app do Chat.

Representação JSON
{
  "appCommandId": integer,
  "appCommandType": enum (AppCommandType)
}
Campos
appCommandId

integer

O ID do comando especificado na configuração da API Chat.

appCommandType

enum (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 (SystemCommandMetadata)
  },
  "space": string,
  "thread": {
    object (Thread)
  }
}
Campos
systemCommandMetadata

object (SystemCommandMetadata)

Metadados sobre o comando do sistema que foi invocado.

space

string

Opcional. O espaço do Chat em que o objeto de evento ocorre.

thread

object (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 (CancelStream)
  }
  // End of mutually exclusive fields.
}
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

object (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

string

Obrigatório. O nome do recurso da mensagem de stream em que o comando de cancelamento foi executado.

Formato: spaces/{space}/streamMessages/{streamMessage}

WorkflowEventObject

LINT.IfChange O objeto de evento transmitido para complementos do Workflow.

Representação JSON
{
  "executionMetadata": {
    object (ExecutionMetadata)
  },
  "triggerEventSource": enum (TriggerEventSource),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "actionInvocation": {
    object (ActionInvocation)
  },
  "triggerCreation": {
    object (TriggerCreation)
  },
  "triggerDeletion": {
    object (TriggerDeletion)
  },
  "resourceRetrieval": {
    object (ResourceRetrieval)
  },
  "elementConfiguration": {
    object (ElementConfiguration)
  },
  "resourceFieldsDefinitionRetrieval": {
    object (ResourceFieldsDefinitionRetrieval)
  },
  "elementUiAutocomplete": {
    object (ElementUiAutocomplete)
  }
  // End of mutually exclusive fields.
}
Campos
executionMetadata

object (ExecutionMetadata)

Metadados sobre a execução do fluxo de trabalho.

triggerEventSource

enum (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

object (ActionInvocation)

Invocação de uma ação de fluxo de trabalho.

triggerCreation

object (TriggerCreation)

Criação de um gatilho de fluxo de trabalho.

triggerDeletion

object (TriggerDeletion)

Exclusão de um gatilho de fluxo de trabalho.

resourceRetrieval

object (ResourceRetrieval)

Recuperação de um recurso (usado para inflação de variáveis).

elementConfiguration

object (ElementConfiguration)

Configuração de um elemento de fluxo de trabalho.

resourceFieldsDefinitionRetrieval

object (ResourceFieldsDefinitionRetrieval)

A recuperação de definições de campo compatíveis com um recurso.

elementUiAutocomplete

object (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 (VariableData)
    },
    ...
  },
  "triggerId": string,
  "flowLevelContext": {
    object (FlowLevelContext)
  }
}
Campos
inputs

map (key: string, value: object (VariableData))

Mapa das variáveis de entrada com chave pelo nome da variável de entrada.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

triggerId

string

ID do gatilho a ser usado para respostas de ações assíncronas.

flowLevelContext

object (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 (ResourceReference)
    }
  ],
  "emailAddressValues": [
    string
  ],
  "googleUserValues": [
    string
  ],
  "textFormatValues": [
    {
      object (WorkflowTextFormat)
    }
  ]
}
Campos
booleanValues[]

boolean

Valores booleanos.

integerValues[]

string (int64 format)

Valores inteiros.

floatValues[]

number

Valores flutuantes.

stringValues[]

string

Valores de string.

timestampValues[]

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

resourceReferences[]

object (ResourceReference)

Referências de recursos (IDs).

emailAddressValues[]

string

Valores de endereço de e-mail.

googleUserValues[]

string

Valores de usuário do Google no formato users/{user}.

textFormatValues[]

object (WorkflowTextFormat)

Valores de formato de texto do fluxo de trabalho.

ResourceReference

Valor do ID do recurso específico do aplicativo.

Representação JSON
{
  "resourceType": {
    object (ResourceType)
  },
  "resourceId": string
}
Campos
resourceType

object (ResourceType)

O tipo de recurso para o qual esse ID aponta.

resourceId

string

ID do recurso.

ResourceType

Nome do tipo de recurso personalizado.

Representação JSON
{
  "workflowBundleId": string,
  "workflowResourceDefinitionId": string
}
Campos
workflowBundleId

string

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

string

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 (TextFormatElement)
    }
  ]
}
Campos
textFormatElements[]

object (TextFormatElement)

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 (Chip)
  },
  "styledText": {
    object (StyledText)
  },
  "hyperlink": {
    object (Hyperlink)
  },
  "listContainer": {
    object (ListContainer)
  }
  // End of mutually exclusive fields.
}
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

string

Texto no formato de texto.

chip

object (Chip)

Ícone clicável no formato de texto.

styledText

object (StyledText)

Texto estilizado no formato de texto.

listContainer

object (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 (Icon)
  },
  "label": string,
  "url": string
}
Campos
icon

object (Icon)

O ícone mostrado no ícone.

label

string

O texto que aparece no ícone.

url

string

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

string

Mostre um ícone personalizado hospedado em um URL HTTPS.

Exemplo:

"iconUrl":
"https://developers.google.com/workspace/chat/images/quickstart-app-avatar.png"

Os tipos de arquivo aceitos incluem .png e .jpg.

materialIconName

string

O nome do ícone definido no ícone do Material Design do Google, por exemplo, check_box. Os nomes inválidos são abandonados e substituídos por uma string vazia, o que resulta na falha de renderização do ícone.

Fim dos campos mutuamente exclusivos.

StyledText

Elemento do texto com estilos como negrito, itálico e cor.

Representação JSON
{
  "text": string,
  "styles": [
    enum (Style)
  ],
  "fontWeight": enum (FontWeight),
  "color": {
    object (Color)
  },
  "wrapStyle": enum (WrapStyle)
}
Campos
text

string

O conteúdo principal do texto.

styles[]

enum (Style)

Uma coleção de estilos aplicados ao texto.

fontWeight

enum (FontWeight)

A espessura da fonte do texto.

color

object (Color)

A cor do texto.

wrapStyle

enum (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.

ListContainer

Contêiner para itens de lista, em que cada item pode conter vários TextFormatElements.

Representação JSON
{
  "listNestLevel": string,
  "listType": enum (ListType),
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
Campos
listNestLevel

string (int64 format)

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

enum (ListType)

O tipo da lista.

listItems[]

object (ListItem)

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 (TextFormatElement)
    }
  ]
}
Campos
textFormatElements[]

object (TextFormatElement)

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 (StepContext)
    }
  ]
}
Campos
stepContexts[]

object (StepContext)

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 (VariableData)
    },
    ...
  }
}
Campos
stepId

string

Opcional. ID exclusivo da etapa no gráfico do fluxo de trabalho.

outputs

map (key: string, value: object (VariableData))

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 "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TriggerCreation

Criação de um gatilho de fluxo de trabalho.

Representação JSON
{
  "triggerId": string,
  "triggerType": enum (TriggerType),
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "notifyUri": string
}
Campos
triggerId

string

Identificador exclusivo do gatilho fornecido durante a criação.

triggerType

enum (TriggerType)

Tipo do gatilho.

inputs

map (key: string, value: object (VariableData))

Mapa das variáveis de entrada com chave pelo nome da variável de entrada.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

notifyUri

string

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

string

Identificador exclusivo do gatilho fornecido durante a criação.

ResourceRetrieval

Recuperação de um recurso.

Representação JSON
{
  "resourceReference": {
    object (ResourceReference)
  }
}
Campos
resourceReference

object (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 (VariableData)
    },
    ...
  },
  "displayDestination": enum (DisplayDestination),
  "nodeId": string,
  "workflowId": string,
  "availableVariables": [
    {
      object (VariableReference)
    }
  ]
}
Campos
inputs

map (key: string, value: object (VariableData))

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 "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

displayDestination

enum (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

string

O ID do nó da configuração primitiva que está sendo renderizada.

workflowId

string

O ID do fluxo de trabalho da configuração primitiva que está sendo renderizada.

availableVariables[]

object (VariableReference)

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 (DataType)
  },
  "iconUrl": string,
  "stepNumber": integer,
  "descriptionText": string,
  "displayText": string
}
Campos
parentElementId

string

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

string

ID de referência do nó

path

string

A assinatura do caminho do seletor de variáveis

dataType

object (DataType)

O tipo de dado da variável

iconUrl

string

O URL do ícone da primitiva que produz essa variável.

stepNumber

integer

O número da etapa da primitiva que produz essa variável.

descriptionText

string

A descrição da variável.

displayText

string

O texto de exibição do ícone de variável.

DataType

Tipo da variável.

Representação JSON
{
  "valueMetadata": {
    object (ValueMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "basicType": enum (BasicType),
  "resourceType": {
    object (ResourceType)
  }
  // End of mutually exclusive fields.
}
Campos
valueMetadata

object (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

enum (BasicType)

Tipo de dados básico.

resourceType

object (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 (BasicType)
  ],
  "semanticDescriptors": [
    {
      object (SemanticDescriptor)
    }
  ],
  "dynamicSchema": {
    object (DynamicSchema)
  },
  "defaultValue": string
}
Campos
enumValues[]

string

Opcional. Especifica os valores permitidos para uma string. Isso só poderá ser definido se DataType for STRING.

dynamicTypes[]

enum (BasicType)

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[]

object (SemanticDescriptor)

Opcional. Ajuda a descrever o significado semântico de uma variável.

dynamicSchema

object (DynamicSchema)

Opcional. Configuração para resolver dinamicamente o esquema dessa variável.

defaultValue

string

Opcional. String que especifica o valor padrão para essa variável. Por exemplo, para booleanos, defaultValue pode ser definido como true ou false.

SemanticDescriptor

Metadados sobre o significado semântico de uma variável.

Representação JSON
{
  "resourceAttribute": string,
  "disallowedResourceAttributes": [
    string
  ]
}
Campos
resourceAttribute

string

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 é: - "{brand}/{appName}/{resource}:{attribute}" {brand} é opcional e deve ser omitido se for igual ao {appName}.

Exemplos: - "google/drive/file:id" - "google/drive/folder:id" - "google/docs/document:id" - "google/sheets/spreadsheet:id" - "jira/issue:key" - "slack/channel:id" etc.

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[]

string

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[]

string

IDs de variáveis de entrada semelhantes que precisam ser fornecidos antes que o esquema dessa variável possa ser resolvido dinamicamente.

strictEnum

boolean

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 (VariableData)
    },
    ...
  }
}
Campos
elementId

string

Especifica o ID do elemento que tem o esquema de recurso dinâmico a ser buscado.

inputs

map (key: string, value: object (VariableData))

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 "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ElementUiAutocomplete

Sugestões de preenchimento automático para o card renderizado no momento.

Representação JSON
{
  "query": string,
  "inputs": {
    string: {
      object (VariableData)
    },
    ...
  },
  "invokedFunction": string,
  "resourceId": string,
  "operationId": string
}
Campos
query

string

A consulta a ser preenchida automaticamente.

inputs

map (key: string, value: object (VariableData))

Mapa das variáveis de entrada com chave pelo nome da variável de entrada.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

invokedFunction

string

A função invocada associada ao widget.

resourceId

string

O ID do recurso que deve ser preenchido automaticamente. Esse campo é opcional e pode não ser definido.

operationId

string

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

integer

A versão do elemento do fluxo de trabalho que está sendo invocado.

timeZone

string

O fuso horário do fluxo de trabalho que está sendo salvo, por exemplo, "America/Los_Angeles".

stepNumber

integer

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.