Objetos de evento

Nesta página, descrevemos a estrutura dos objetos de evento dos complementos do Google Workspace.

Os objetos de evento são estruturas JSON criadas e transmitidas automaticamente como parâmetros para acionar ou chamar funções de callback quando um usuário interage com um complemento. Os objetos de evento transmitem informações do lado do cliente sobre o app host e o contexto atual para a função de callback do lado do servidor do complemento.

Os complementos do Google Workspace usam objetos de evento nos seguintes lugares:

  • Acionadores da página inicial. Cada função homepageTrigger definida recebe automaticamente um objeto de evento quando a função de acionador da página inicial é disparada. É possível usar esse objeto na função de acionamento da página inicial para identificar o app host ativo, a plataforma do cliente, o local do usuário e outras informações.

    Os objetos de evento criados quando os acionadores da página inicial são disparados não contêm todos os campos incluídos nos outros casos. Os campos relacionados a widgets e informações contextuais são omitidos.

  • Acionadores contextuais. Cada aplicativo hospedado fornece um conjunto diferente de acionadores contextuais que são disparados quando o usuário entra em um contexto específico:

    Quando um acionador contextual é disparado, o aplicativo host chama o runFunction correspondente listado no manifesto do complemento, transmitindo um objeto de evento como parâmetro. Os objetos de evento criados quando os acionadores contextuais são disparados contêm todos os campos incluídos nos objetos de evento de acionador da página inicial, além de campos com informações contextuais.

  • Ações do widget. Os objetos de evento fornecem interatividade de widget usando o mesmo modelo de ação que os complementos do Gmail usam. Os complementos do Google Workspace usam as mesmas funções de gerenciador de widgets, objetos Action e respostas de ação. Nos complementos do Google Workspace, os objetos de evento de ação incluem mais informações que uma função de callback pode usar.

    Os objetos de evento criados com base em ações de widget contêm todos os campos incluídos em objetos de evento de acionador contextual, além de campos com informações do widget.

  • Visualizar acionadores de link. Nos apps Google Docs, Planilhas e Apresentações Google, é possível configurar prévias de links para serviços de terceiros com base em padrões de URL específicos. Quando os usuários interagem com um link que corresponde ao padrão, o linkPreviewTriggers é acionado, e um objeto de evento que contém o link é transmitido para a função de callback do acionador. O complemento pode usar esse objeto de evento para criar um ícone inteligente e um card que mostram informações sobre o link no aplicativo host. Também é possível criar ações de widget para que os usuários possam interagir com o card de visualização e o conteúdo dele.

  • Gatilhos do app Google Chat. No Google Chat, seu complemento aparece para os usuários como um app do Chat, e eles podem interagir com ele adicionando-o a espaços, enviando mensagens, usando comandos de barra e muito mais. Para criar recursos interativos, configure e use vários gatilhos de apps do Chat. Cada gatilho envia um payload de objeto de evento diferente que ajuda você a processar ou responder a cada tipo de interação.

Estrutura do objeto de evento

A tabela a seguir descreve a estrutura de nível superior dos objetos de evento dos complementos do Google Workspace. A estrutura inclui um campo de nível superior commonEventObject para informações independentes do host. Cada objeto de evento também pode ter um dos seguintes campos de nível superior específicos do host, determinados pelo app host ativo: gmailEventObject, calendarEventObject ou driveEventObject.

Para compatibilidade com versões anteriores, os objetos de evento dos complementos do Google Workspace incluem os campos originais usados em objetos de evento de ação de complemento do Gmail. Esses campos estão em "Campos originais do complemento do Gmail" e não fazem parte de commonEventObject.

Os campos originais do complemento do Gmail foram descontinuados. Ao desenvolver ou migrar um complemento do Google Workspace, use a estrutura de objeto de evento mais recente. Esses campos podem ser removidos em uma atualização futura.

Objeto de evento
eventObject.commonEventObject Common fields object
Um objeto que contém informações comuns a todos os objetos de evento, independentemente do aplicativo host.
eventObject.calendar Calendar event object
Presente apenas se o host de chamada for o Google Agenda. Um objeto que contém informações sobre a agenda e o evento.
eventObject.chat Chat event object
Presente apenas se o host de chamada for o Google Chat. Um objeto que contém informações do Chat.
eventObject.drive Drive event object
Presente apenas se o host de chamada for o Google Drive. Um objeto que contém informações do Drive.
eventObject.gmail Gmail event object
Presente apenas se o host de chamada for o Gmail. Um objeto que contém informações do Gmail.
eventObject.docs Docs event object
Presente apenas se o host de chamada for o Google Docs. Um objeto que contém informações do Documentos.
eventObject.sheets Sheets event object
Presente apenas se o host de chamada for o Google Planilhas. Um objeto que contém informações do Planilhas.
eventObject.slides Slides event object
Presente apenas se o host de chamada for o Google Slides. Um objeto que contém informações do Apresentações.
Campos originais do complemento do Gmail
eventObject.messageMetadata.accessToken string
Descontinuado. Um token de acesso. Você pode usar isso para ativar o acesso aos dados do usuário usando escopos temporários de complementos do Gmail.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.gmail.accessToken.

eventObject.messageMetadata.messageId string
Descontinuado. O ID da mensagem da conversa aberta na interface do Gmail.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.gmail.messageId.

eventObject.clientPlatform string
Descontinuado. Indica onde o evento se origina (Web, iOS ou Android).

Para complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.platform.

eventObject.formInput object
Descontinuado. Um mapa dos valores atuais de todos os widgets de formulário no card, restrito a um valor por widget. As chaves são os IDs de string associados aos widgets, e os valores são strings. O objeto de evento fornece formInput como uma conveniência para quando você precisa ler dados de vários widgets com valores singulares esperados, como entradas de texto e interruptores. Para widgets com vários valores, como caixas de seleção, leia cada valor de formInputs.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.formInputs. Os widgets com valores únicos são representados como matrizes com um único elemento.

eventObject.formInputs object
Descontinuado. Um mapa dos valores atuais dos widgets no card, apresentados como listas de strings. As chaves são os IDs de string associados ao widget. Para widgets de valor único, o valor é apresentado em uma matriz de elemento único. Para widgets com vários valores, como grupos de caixas de seleção, todos os valores são apresentados em uma lista.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.formInputs.

eventObject.parameters object
Descontinuado. Um mapa de todos os parâmetros adicionais que você fornece ao Action usando Action.setParameters. As chaves e os valores do mapa são strings.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.parameters.

eventObject.userCountry string
Descontinuado e desativado por padrão. O código de duas letras que indica o país ou a região do usuário. Também pode ser um código de país numérico UN M49.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Descontinuado e desativado por padrão. O código ISO 639 de duas letras que indica o idioma do usuário. Consulte Como acessar a localidade e o fuso horário do usuário para mais detalhes.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.userLocale.

eventObject.userTimezone.id string
Descontinuado e desativado por padrão. O identificador de fuso horário do usuário. Por exemplo: America/New_York, Europe/Vienna e Asia/Seoul. Consulte Como acessar a localidade e o fuso horário do usuário para mais detalhes.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.timeZone.id.

eventObject.userTimezone.offset string
Descontinuado e desativado por padrão. O ajuste de tempo do Tempo Universal Coordenado (UTC) do fuso horário do usuário, medido em milissegundos. Consulte Como acessar a localidade e o fuso horário do usuário para mais detalhes.

Para complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.timeZone.offset.

Objeto de evento comum

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 dos acionadores contextuais e de página inicial, 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.

Campos de objeto de evento comuns
commonEventObject.platform string
Indica onde o evento se origina (WEB, IOS ou ANDROID).
commonEventObject.formInputs object
Um mapa com os valores atuais dos widgets no card exibido. As chaves do mapa são os IDs de string atribuídos a cada widget.

A estrutura do objeto de valor do mapa depende do tipo de widget:

  • Widgets de valor único (por exemplo, uma caixa de texto): uma lista de strings (apenas um elemento).

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

  • Widgets com vários valores (por exemplo, grupos de caixas de seleção): uma lista de strings.

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

  • A date-time picker: um DateTimeInput object.

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

  • A date-only picker: um DateInput object.

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

  • A time-only picker: um TimeInput object.

    Exemplo: para um seletor com um ID de myTimePicker, acesse o objeto TimeInput usando e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
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
commonEventObject.parameters object
Todos os parâmetros adicionais que você fornece a uma ação usando actionParameters ou Action.setParameters.

Prévia para desenvolvedores : para apps do 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. Para mais detalhes, consulte Coletar e processar informações de usuários do Google Chat.
commonEventObject.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.

commonEventObject.timeZone string
Desativado por padrão. O ID e o deslocamento do fuso horário. 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.
commonEventObject.timeZone.id string
O identificador de fuso horário do usuário. Por exemplo: America/New_York, Europe/Vienna e Asia/Seoul. 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.
commonEventObject.timeZone.offset string
O ajuste de tempo do Tempo Universal Coordenado (UTC) do fuso horário do usuário, medido em milissegundos. Consulte Como acessar a localidade e o fuso horário do usuário para mais detalhes.

Entradas de formulário do seletor de data e hora

As funções de callback de ação podem receber valores de widget atuais no campo commonEventObject.formInputs. Isso inclui os valores de data ou hora selecionados pelo usuário nos widgets de seletor de data ou hora. A estrutura de informações varia de acordo com a configuração do widget: seletor de data e hora, seletor de data ou seletor de hora. As diferenças estruturais são descritas na tabela a seguir:

Objeto DateTimeInput
dateTimeInput.hasDate boolean
true se a data e hora de entrada incluir uma data; se false, apenas um horário será incluído.
dateTimeInput.hasTime boolean
true se a data e hora de entrada incluir um horário; se false, apenas uma data será incluída.
dateTimeInput.msSinceEpoch string
O horário selecionado pelo usuário, em milissegundos desde a época (00:00:00 UTC em 1º de janeiro de 1970).
Objeto DateInput
dateInput.msSinceEpoch string
O horário selecionado pelo usuário, em milissegundos desde a época (00:00:00 UTC em 1º de janeiro de 1970).
Objeto TimeInput
timeInput.hours number
O número da hora selecionado pelo usuário.
timeInput.minutes number
O número de minutos selecionado pelo usuário.

Objeto de evento do Chat

O objeto de evento do Chat é a parte do objeto de evento geral que contém informações sobre as interações de um usuário com um app do Chat. Ele só estará presente em um objeto de evento se o complemento estender o Google Chat.

Chat
chat.user object (User)
O usuário do Chat que interagiu com o app do Chat.
chat.space object (Space)
O espaço do Chat em que um usuário interagiu com o app do Chat.
chat.eventTime

string (Timestamp format)

O horário em que a interação ocorreu.

Campo de união payload. Para um acionador de página inicial do app (quando um usuário abre a guia Página inicial), payload não é definido e chat contém chat.user e chat.eventTime.

payload pode ser apenas de um dos tipos a seguir:
chat.messagePayload

object (MessagePayload)

O payload que os apps do Chat recebem de um gatilho de mensagem.
chat.addedToSpacePayload

object (AddedToSpacePayload)

O payload que os apps do Chat recebem de um gatilho Adicionado ao espaço.
chat.removedFromSpacePayload

object (RemovedFromSpacePayload)

O payload que os apps do Chat recebem de um gatilho Removido do espaço.
chat.buttonClickedPayload

object (ButtonClickedPayload)

O payload que os apps do Chat recebem quando os usuários clicam em um botão de uma mensagem ou card. Se um usuário clicar em um botão para enviar informações, o objeto commonEventObject.formInputs vai conter os valores coletados do usuário. Para mais detalhes, consulte Coletar informações de usuários do Google Chat.
chat.widgetUpdatedPayload

object (WidgetUpdatedPayload)

O payload que os apps do Chat recebem quando os usuários digitam texto no menu de seleção múltipla de um widget selectionInput. Os apps do Chat podem usar esse objeto de evento para preencher itens sugeridos de uma fonte de dados dinâmica. Por exemplo, para preencher casos de suporte de uma fonte de dados externa, um app do Chat pode consultar a fonte de dados com base no que o usuário digita no menu e retornar os casos de suporte correspondentes como itens selecionáveis.

O objeto CommonEventObject.parameters['autocomplete_widget_query'] contém o valor de string que o usuário digita no menu.

chat.appCommandPayload

object (AppCommandPayload)

O payload que os apps do Chat recebem quando um usuário usa um comando do app do Chat.

Payload

Dependendo do tipo de interação do app do Chat, o evento contém um payload com um ou mais recursos da API Chat.

Payload da mensagem
MessagePayload
chat.messagePayload.message object (Message)
A mensagem de chat que acionou o evento.
chat.messagePayload.space object (Space)
O espaço do Chat em que um usuário enviou a mensagem que invocou o app do Chat.
chat.messagePayload.configCompleteRedirectUri string
O URL para onde 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 o complemento do Google Workspace a um serviço de terceiros.
Payload adicionado ao espaço
AddedToSpacePayload
chat.addedToSpacePayload.space object (Space)
O espaço do Chat em que o usuário adicionou ou instalou o app do Chat.

Quando os administradores instalam apps do Chat, o campo space.adminInstalled é definido como true.

chat.addedToSpacePayload.interactionAdd boolean
Se um usuário adiciona o app do Chat a um espaço usando uma mensagem. Por exemplo, @menciona o app do Chat ou usa um comando. Se for true, o Chat vai enviar outro objeto de evento com um messagePayload que contém informações sobre a mensagem.
chat.addedToSpacePayload.configCompleteRedirectUri string
O URL para onde 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 o complemento do Google Workspace a um serviço de terceiros.
Payload de remoção do espaço
RemovedFromSpacePayload
chat.removedFromSpacePayload.space object (Space)
O espaço do Chat de onde o usuário removeu ou desinstalou o app do Chat.

Quando os administradores desinstalam apps do Chat, o campo space.adminInstalled é definido como false.

Payload do botão clicado
ButtonClickedPayload
chat.buttonClickedPayload.message object (Message)
A mensagem de chat que contém o botão clicado pelo usuário.
chat.buttonClickedPayload.space object (Space)
O espaço do Chat em que o usuário clicou em um botão de uma mensagem do app Chat.
chat.buttonClickedPayload.isDialogEvent boolean
Indica se o usuário clicou no botão para interagir com uma caixa de diálogo.
chat.buttonClickedPayload.dialogEventType enum (DialogEventType)
Se isDialogEvent for true, o tipo de interação em uma caixa de diálogo.

Tipo enumerado DialogEventType.

O valor de dialogEventType pode ser apenas um dos seguintes:
TYPE_UNSPECIFIED Valor padrão. Não especificado.
REQUEST_DIALOG Um usuário solicita uma caixa de diálogo. Por exemplo, eles usam um comando ou clicam em um botão de uma mensagem.
SUBMIT_DIALOG Um usuário clica em um elemento interativo em 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 enviar as informações.
Payload atualizado do widget
WidgetUpdatedPayload
chat.widgetUpdatedPayload.space object (Space)
O espaço do Chat em que a interação ocorreu.
Payload do comando do app
AppCommandPayload
chat.appCommandPayload.appCommandMetadata object (AppCommandMetadata)
Metadados sobre qual comando o usuário usou e como ele foi acionado.
chat.appCommandPayload.space object (Space)
O espaço do Chat em que um usuário usou o comando.
chat.appCommandPayload.thread object (Thread)
Se a interação ocorreu em uma conversa, a conversa do Chat em que o usuário usou o comando.
chat.appCommandPayload.message object (Message)
Para comandos de barra, a mensagem com o comando de barra.
chat.appCommandPayload.configCompleteRedirectUri string
Se o comando exigir autorização ou configuração, um URL para redirecionar o usuário depois que ele concluir o processo fora do Google Chat.
chat.appCommandPayload.isDialogEvent boolean
Se o comando abre uma caixa de diálogo.
chat.appCommandPayload.dialogEventType enum (DialogEventType)
O tipo de interação com uma caixa de diálogo.

Tipo enumerado DialogEventType.

O valor de dialogEventType pode ser apenas um dos seguintes:
TYPE_UNSPECIFIED Valor padrão. Não especificado.
REQUEST_DIALOG Um usuário solicita uma caixa de diálogo. Por exemplo, eles usam um comando ou clicam em um botão de uma mensagem.
SUBMIT_DIALOG Um usuário clica em um elemento interativo em 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 enviar as informações.
Metadados de comando do app
AppCommandMetadata
chat.appCommandPayload.appCommandMetadata.appCommandId

string (int64 format)

O ID do comando.
chat.appCommandPayload.appCommandMetadata.appCommandType enum (AppCommandType)
O tipo de comando.

Tipo enumerado AppCommandType.

O valor de AppCommandType pode ser apenas um dos seguintes:
APP_COMMAND_TYPE_UNSPECIFIED Valor padrão. Não especificado.
SLASH_COMMAND Para usar o comando, o usuário envia uma mensagem que começa com uma barra /.
QUICK_COMMAND O usuário seleciona o comando no menu do Chat na área de resposta da mensagem.

Objeto de evento da agenda

O objeto de evento da agenda é a parte do objeto de evento geral que contém informações sobre a agenda e os eventos de um usuário. Ele só estará presente em um objeto de evento se o complemento estender o Google Agenda.

A tabela a seguir lista os campos presentes no campo calendarEventObject 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 manifest como READ ou READ_WRITE.

Para muitos dos campos neste objeto e nas subestruturas dele, há um mapeamento direto para os campos do recurso de evento da API Calendar com o mesmo nome. Se as descrições dos campos forem diferentes, as informações na tabela a seguir estão corretas.

Objeto de evento da agenda
calendar.attendees[] list of attendee objects
Dados gerados pelo usuário. Uma lista dos participantes do evento da agenda.
calendar.calendarId string
O ID da agenda.
calendar.capabilities object
Dados gerados pelo usuário. Um objeto que descreve os recursos do complemento para visualizar ou atualizar informações de eventos.
calendar.capabilities.canAddAttendees boolean
Dados gerados pelo usuário. true se o complemento puder adicionar novos convidados à lista de convidados do evento; false caso contrário.
calendar.capabilities.canSeeAttendees boolean
Dados gerados pelo usuário. true se o complemento puder ler a lista de convidados do evento; caso contrário, false.
calendar.capabilities.canSeeConferenceData boolean
Dados gerados pelo usuário. true se o complemento puder ler os dados da videoconferência do evento; false, caso contrário.
calendar.capabilities.canSetConferenceData boolean
Dados gerados pelo usuário. true se o complemento puder atualizar os dados da videoconferência do evento; false, caso contrário.
calendar.capabilities.canAddAttachments boolean
Dados gerados pelo usuário. true se o complemento puder adicionar novos anexos ao evento; false caso contrário.
calendar.conferenceData Conference data object
Dados gerados pelo usuário. Um objeto que representa todos os dados de conferência associados a esse evento, como detalhes da conferência do Google Meet.
calendar.id string
O ID do evento.
calendar.organizer object
Um objeto que representa o organizador do evento.
calendar.organizer.email string
O endereço de e-mail do organizador do evento.
calendar.recurringEventId string
O ID de um evento recorrente.

Participante

Os objetos de convidado carregam informações sobre convidados individuais para 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 manifest como READ ou READ_WRITE.

Objeto de participante
attendee.additionalGuests number
O número de convidados adicionais que o participante indicou que vai levar. Assume zero como padrão.
attendee.comment string
O comentário de resposta do convidado, se houver.
attendee.displayName string
O nome de exibição do convidado.
attendee.email string
O endereço de e-mail do convidado.
attendee.optional boolean
true se a participação do convidado estiver marcada como opcional; false caso contrário.
attendee.organizer boolean
true se o convidado for um organizador do evento.
attendee.resource boolean
true se o convidado representar um recurso, como uma sala ou um equipamento; false, caso contrário.
attendee.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 temporariamente o convite para o evento.
attendee.self boolean
true se esse convidado representar a agenda em que o evento aparece; false caso contrário.

Dados da reunião

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 manifest como READ ou READ_WRITE.

Objeto de dados da videoconferência
conferenceData.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.
conferenceData.conferenceSolution object
Um objeto que representa a solução de videoconferência, como o Hangouts ou o Google Meet.
conferenceData.conferenceSolution.iconUri string
O URI do ícone visível ao usuário que representa essa solução de videoconferência.
conferenceData.conferenceSolution.key object
A chave que identifica exclusivamente a solução de videoconferência para este evento.
conferenceData.conferenceSolution.key.type string
O tipo de solução de videoconferência. Os valores possíveis incluem o seguinte:
  • eventHangout para o Hangouts para consumidores (http://hangouts.google.com).
  • eventNamedHangout para o Hangouts clássico para usuários do Google Workspace (http://hangouts.google.com).
  • hangoutsMeet para o Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
O nome visível ao usuário dessa solução de videoconferência (não localizado).
conferenceData.entryPoints[] list of entry point objects
A lista de pontos de entrada da conferência, como URLs ou números de telefone.
conferenceData.notes string
Observações adicionais (como instruções do administrador do domínio ou avisos legais) sobre a conferência que serão mostradas ao usuário. Pode conter HTML. O tamanho máximo é de 2.048 caracteres.
conferenceData.parameters object
Um objeto que contém um mapa de dados de parâmetros definidos para uso pelo complemento.
conferenceData.parameters.addOnParameters object
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.

Ponto de entrada

Os objetos de ponto de entrada carregam 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 manifest como READ ou READ_WRITE.

Objeto de ponto de entrada
entryPoint.accessCode string
O código de acesso usado para entrar na conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência normalmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponda e mostre apenas os campos usados pelo provedor de conferência.
entryPoint.entryPointFeatures list
Recursos do ponto de entrada. No momento, esses recursos se aplicam apenas aos pontos de entrada phone:
  • toll: o ponto de entrada é uma ligação telefônica paga.
  • toll_free: o ponto de entrada é uma ligação sem custo financeiro.
entryPoint.entryPointType string
O tipo de ponto de entrada. Os valores possíveis são os seguintes:
  • 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 more. 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 phone. O Google Agenda mostra apenas os dois primeiros pontos de entrada de telefone, depois de formatar e classificar 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 video.
entryPoint.label string
O rótulo visível ao usuário para o URI do ponto de entrada (não localizado).
entryPoint.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 normalmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponda e mostre apenas os campos usados pelo provedor de conferência.
entryPoint.passcode string
A senha usada para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência normalmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponda e mostre apenas os campos usados pelo provedor de conferência.
entryPoint.password string
A senha usada para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência normalmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponda e mostre apenas os campos usados pelo provedor de conferência.
entryPoint.pin string
O PIN usado para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência normalmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso às conferências. Corresponda e mostre apenas os campos usados pelo provedor de conferência.
entryPoint.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.
entryPoint.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:
  • more: um esquema http: ou https: é obrigatório.
  • 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: um esquema http: ou https: é obrigatório.

Objeto de evento do Drive

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 complemento estender o Google Drive.

Objeto de evento do Drive
drive.activeCursorItem Drive item object
O item do Drive ativo no momento.
drive.selectedItems[] list of Drive item objects
Uma lista de itens (arquivos ou pastas) selecionados no Drive.

Item do Drive

Os objetos de item do Drive contêm informações sobre itens específicos do Drive, como arquivos ou pastas.

Objeto de item do Drive
item.addonHasFileScopePermission boolean
Se for true, o complemento solicitou e recebeu a autorização de escopo https://www.googleapis.com/auth/drive.file para este item. Caso contrário, esse campo será false.
item.id string
O ID do item selecionado.
item.iconUrl string
O URL do ícone que representa o item selecionado.
item.mimeType string
O tipo MIME do item selecionado.
item.title string
O título do item selecionado.

Objeto de evento do Gmail

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.

Objeto de evento do Gmail
gmail.accessToken string
O token de acesso específico do Gmail. Use esse token com o método GmailApp.setCurrentMessageAccessToken para conceder ao complemento acesso temporário à mensagem do Gmail aberta no momento ou permitir que o complemento escreva novos rascunhos.
gmail.bccRecipients[] list of strings
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 seu manifesto como METADATA.
gmail.ccRecipients[] list of strings
Desativado por padrão. A lista de endereços de e-mail de destinatários "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.
gmail.messageId string
O ID da mensagem do Gmail aberta no momento.
gmail.threadId string
O ID da conversa do Gmail aberta no momento.
gmail.toRecipients[] list of strings
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 seu manifesto como METADATA.

Objeto de evento do app Documentos

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.

Objeto de evento do app Documentos
docs.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.
docs.title string
Só aparece 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.
docs.addonHasFileScopePermission boolean
Se for true, o complemento solicitou e recebeu a autorização de escopo https://www.googleapis.com/auth/drive.file para o documento aberto na interface do Documentos. Caso contrário, esse campo será false.
docs.matchedUrl.url string
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 Docs. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do complemento. Consulte Visualizar links com í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"
  }
}

Objeto de evento do Planilhas

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 Planilhas Google.

Objeto de evento do Planilhas
sheets.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.
sheets.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.
sheets.addonHasFileScopePermission boolean
Se for true, o complemento solicitou e recebeu a autorização de escopo https://www.googleapis.com/auth/drive.file para a planilha aberta na interface do Planilhas. Caso contrário, esse campo será false.
sheets.matchedUrl.url string
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 nas Planilhas Google. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do complemento. Consulte Visualizar links com í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"
  }
}

Objeto de evento do app Apresentações

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 o Google Slides.

Objeto de evento do app Apresentações
slides.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 do Apresentações.
slides.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.
slides.addonHasFileScopePermission boolean
Se for true, o complemento solicitou e recebeu a autorização do 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.
slides.matchedUrl.url string
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 Slides. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do complemento. Consulte Visualizar links com í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"
  }
}