Objetos de evento

Esta página descreve a estrutura dos objetos de eventos dos complementos do Google Workspace.

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

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

  • Acionadores da página inicial. Todas as funções homepageTrigger definidas são transmitidas automaticamente a um objeto de evento quando a função de gatilho 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 gatilhos da página inicial são acionados não contêm todos os campos incluídos nos outros dois casos. Os campos relacionados a widgets e informações contextuais são omitidos.

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

    Quando um acionador contextual é acionado, 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 acionados contêm todos os campos incluídos nos objetos de evento de gatilho da página inicial, além de campos com informações contextuais.

  • Ações do widget. Os objetos de evento também são usados para fornecer interatividade ao widget, usando o mesmo modelo de ação que os complementos do Gmail. Os complementos do Google Workspace usam as mesmas funções de gerenciador de widgets, objetos Action e respostas de ação. No entanto, nos complementos do Google Workspace, os objetos de eventos de ação incluem ainda mais informações que uma função de callback pode usar.

    Os objetos de evento criados como resultado das ações do widget contêm todos os campos incluídos nos objetos de evento de gatilho contextual, além de campos com informações do widget.

  • Acessar acionadores de links de visualização. Nos apps Documentos, Planilhas e Apresentações Google, é possível configurar visualizações 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 atende 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. Seu 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 widgets para permitir que os usuários interajam com o card de visualização e o conteúdo dele.

  • Acionadores do app Google Chat (prévia para desenvolvedores). 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 mais. Para criar recursos interativos, você configura e usa vários gatilhos do app Chat. Cada gatilho envia um payload de objeto de evento diferente que ajuda 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 do objeto de evento 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, determinado pelo app host ativo: gmailEventObject, calendarEventObject ou driveEventObject.

Para compatibilidade com versões anteriores, os objetos de eventos de complementos do Google Workspace também incluem todos os campos originais usados em objetos de eventos de ação de complementos do Gmail. Esses campos estão listados na tabela abaixo em "Campos do complemento original do Gmail". As informações nesses campos são reproduzidas na nova estrutura de objetos.

Objeto de evento
eventObject.commonEventObject Common fields object
Um objeto que contém informações comuns a todos os objetos de evento, independente do aplicativo host.
eventObject.calendar Calendar event object
Presente somente se o organizador da chamada for o Google Agenda. Um objeto que contém informações de eventos e da agenda.
eventObject.chat Chat event object
Presente somente se o organizador da chamada for o Google Chat. Um objeto que contém informações do Chat.
eventObject.drive Drive event object
Presente somente se o host de chamada for o Google Drive. Um objeto que contém informações do Drive.
eventObject.gmail Gmail event object
Apenas presente se o host de chamada for o Gmail. Um objeto que contém informações do Gmail.
eventObject.docs Docs event object
Presente somente se o host de chamada for o Documentos Google. Um objeto que contém informações do Documentos.
eventObject.sheets Sheets event object
Presente somente se o host de chamada for as Planilhas Google. Um objeto que contém informações do Planilhas.
eventObject.slides Slides event object
Presente somente se o organizador da chamada for o Google Slides. Um objeto que contém informações do Slides.
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 a origem do evento (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 conveniência para quando você precisa ler dados de vários widgets com valores singulares esperados, como entradas de texto e chaves. Para widgets com vários valores, como caixas de seleção, é possível ler 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, apresentado 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 um único elemento. 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 qualquer parâmetro extra que você fornecer 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 UN M49 numérico.

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. A diferença de tempo em relação ao Tempo Universal Coordenado (UTC) do fuso horário do usuário, medida 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 carrega informações gerais e independentes do host para o complemento do cliente do usuário. Essas informações incluem detalhes como a localidade do usuário, o app host e a plataforma.

Além dos acionadores contextuais e da 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 seu complemento pode consultar o objeto de evento comum para determinar o conteúdo dos widgets abertos no cliente do usuário. Por exemplo, seu 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 de onde o evento se origina ("WEB", "IOS" ou "ANDROID").
commonEventObject.formInputs object
Um mapa que contém 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 de vários valores (por exemplo, grupos de caixas de seleção): uma lista de strings.

    Exemplo: para um widget com 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, acesso 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, acesso 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, acesso 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 os seguintes:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Qualquer parâmetro adicional que você fornece 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"]). É possível usar esse valor para consultar um banco de dados e sugerir itens selecionáveis aos usuários conforme eles digitam. Confira mais detalhes em Coletar e processar informações dos 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 - 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 escopo 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 a diferença de fuso horário. Para ativar esse campo, defina addOns.common.useLocaleFromApp como true no manifesto do seu complemento. A lista de escopo do seu 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. Exemplos incluem: America/New_York, Europe/Vienna e Asia/Seoul. Para ativar esse campo, defina addOns.common.useLocaleFromApp como true no manifesto do seu complemento. A lista de escopo do seu 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
A diferença de horário do Tempo Universal Coordenado (UTC) do fuso horário do usuário, medida em milissegundos. Consulte Como acessar a localidade e o fuso horário do usuário para mais detalhes.

Formulários de entrada do seletor de data e hora

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

Objeto DateTimeInput
dateTimeInput.hasDate boolean
true se a data e a hora da entrada incluirem uma data. Se false, apenas uma hora será incluída.
dateTimeInput.hasTime boolean
true se a data e a hora da entrada incluirem uma hora. Se false, apenas uma data será incluída.
dateTimeInput.msSinceEpoch string
O tempo 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 tempo 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 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 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 calendarEventObject de um objeto de evento. Os campos marcados como Dados gerados pelo usuário estã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 manifesto para READ ou READ_WRITE.

Objeto de evento da agenda
calendar.attendees[] list of attendee objects
Dados gerados pelo usuário. Uma lista dos convidados 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 as informações do evento.
calendar.capabilities.canAddAttendees boolean
Dados gerados pelo usuário. true se o complemento pode adicionar novos participantes à lista de participantes do evento; false, caso contrário.
calendar.capabilities.canSeeAttendees boolean
Dados gerados pelo usuário. true se o complemento puder ler a lista de participantes do evento. Caso contrário, será false.
calendar.capabilities.canSeeConferenceData boolean
Dados gerados pelo usuário. true se o complemento puder ler os dados da conferência do evento. false caso contrário.
calendar.capabilities.canSetConferenceData boolean
Dados gerados pelo usuário. true se o complemento pode 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 pode 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 os 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 participante contêm informações sobre participantes individuais de eventos do Google Agenda. Essas informações estão presentes no objeto do evento se e somente se os dados estão presentes no evento da Agenda e o complemento define o campo addOns.calendar.currentEventAccess manifesto 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 participante, se houver.
attendee.displayName string
O nome do participante.
attendee.email string
O endereço de e-mail do participante.
attendee.optional boolean
true se a participação desse participante está marcada como opcional. false, caso contrário.
attendee.organizer boolean
true se o participante for um organizador do evento.
attendee.resource boolean
true se o participante representa um recurso, como uma sala ou um equipamento; false, caso contrário.
attendee.responseStatus string
O status da resposta do participante. Os valores possíveis incluem:
  • accepted: o participante aceitou o convite do evento.
  • declined: o participante recusou o convite para o evento.
  • needsAction: o participante não respondeu ao convite do evento.
  • tentative: o participante aceitou provisoriamente o convite para o evento.
attendee.self boolean
true se o participante representa a agenda em que o evento aparece. Caso contrário, será false.

Dados da conferência

Os objetos de dados de conferências contêm informações sobre conferências anexadas a eventos do Google Agenda. Elas podem ser soluções de conferência do Google, como o Google Meet, ou conferências de terceiros. Essas informações estão presentes no objeto do evento se e somente se os dados estiverem presentes no evento da Agenda e o complemento definir o campo addOns.calendar.currentEventAccess manifesto para READ ou READ_WRITE.

Objeto de dados da conferência
conferenceData.conferenceId string
O ID da videoconferência. Esse ID tem como objetivo permitir 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 conferência, como o Hangouts ou o Google Meet.
conferenceData.conferenceSolution.iconUri string
O URI do ícone visível para o usuário que representa essa solução de conferência.
conferenceData.conferenceSolution.key object
A chave que identifica exclusivamente a solução de conferência para este evento.
conferenceData.conferenceSolution.key.type string
O tipo de solução de conferência. Os valores possíveis incluem:
  • 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 para o usuário desta solução de conferê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 a serem mostradas ao usuário. Pode conter HTML. O comprimento máximo é de 2.048 caracteres.
conferenceData.parameters object
Um objeto que contém um mapa de dados de parâmetro 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 contêm informações sobre os meios estabelecidos de acesso a uma determinada conferência, como por telefone ou vídeo. Essas informações estão presentes no objeto de evento somente se os dados estiverem presentes no evento do Google Agenda e o complemento definir o campo addOns.calendar.currentEventAccess manifesto para READ ou READ_WRITE.

Objeto de ponto de entrada
entryPoint.accessCode string
O código de acesso usado para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferências geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso a conferências. Corresponder e mostrar apenas os campos que o provedor de conferências usa.
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 telefônica sem custo financeiro.
entryPoint.entryPointType string
O tipo de ponto de entrada. Os valores possíveis são estes:
  • more: outras instruções de participação na conferência, como números de telefone alternativos. Uma conferência só pode ter um ponto de entrada more. Se ele estiver presente, pelo menos um outro tipo de ponto de entrada também será necessário.
  • phone: participar da conferência usando 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 do telefone, depois de formatar e classificar alfabeticamente.
  • sip: participar da conferência pelo SIP. Uma conferência pode ter no máximo um ponto de entrada sip.
  • video: participar 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 para o usuário do 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ências geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso a conferências. Corresponder e mostrar apenas os campos que o provedor de conferências usa.
entryPoint.passcode string
A senha usada para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferências geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso a conferências. Corresponder e mostrar apenas os campos que o provedor de conferências usa.
entryPoint.password string
A senha usada para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferências geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso a conferências. Corresponder e mostrar apenas os campos que o provedor de conferências usa.
entryPoint.pin string
O PIN usado para acessar a conferência. O tamanho máximo é de 128 caracteres. Os provedores de conferências geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para fornecer acesso a conferências. Corresponder e mostrar apenas os campos que o provedor de conferências usa.
entryPoint.regionCode string
Código de região do número de telefone. Necessário para 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 comprimento máximo é de 1.300 caracteres. A formatação depende do tipo de ponto de entrada:
  • more: um esquema http: ou https: é necessário.
  • phone: um esquema tel: é necessário. O URI precisa incluir toda a sequência de discagem (por exemplo, "tel:+12345678900,,,12345678;1234").
  • sip: um esquema sip: ou sips: é necessário. Por exemplo, "sip:12345678@myprovider.com".
  • video: um esquema http: ou https: é necessá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ó está presente em um objeto de evento se o aplicativo host for 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 itens 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 true, o complemento solicitou e recebeu a autorização de escopo https://www.googleapis.com/auth/drive.file para esse item. Caso contrário, esse campo é 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ó está presente em um objeto de evento se o aplicativo host for o Gmail.

Objeto de evento do Gmail
gmail.accessToken string
O token de acesso específico do Gmail. É possível usar esse token com o método GmailApp.setCurrentMessageAccessToken(accessToken) para conceder ao complemento acesso temporário à mensagem do Gmail aberta atualmente de um usuário ou permitir que ele crie novos rascunhos.
gmail.bccRecipients[] list of strings
Desativado por padrão. A lista de endereços de e-mail de destinatários "Cco:" atualmente incluídos em um rascunho que está sendo criado pelo complemento. Para ativar esse campo, defina o campo addOns.gmail.composeTrigger.draftAccess no manifesto como METADATA.
gmail.ccRecipients[] list of strings
Desativado por padrão. A lista de endereços de e-mail de destinatários "CC:" atualmente incluídos em um rascunho que está sendo criado pelo complemento. 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 linha de execução 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:" atualmente incluídos em um rascunho que está sendo criado pelo complemento. Para ativar esse campo, defina o campo addOns.gmail.composeTrigger.draftAccess no manifesto como METADATA.

Objeto de evento do Documentos

O objeto de evento do Google Docs é a parte do objeto de evento geral que carrega informações sobre o documento de um usuário e o conteúdo dele. Ele só está presente em um objeto de evento se o aplicativo host for o Documentos Google.

Objeto de evento do Documentos
docs.id string
Presente apenas 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
Presente somente 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 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, este campo é false.
docs.matchedUrl.url string
Somente apresentado 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 nos Documentos Google. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do seu 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 das Planilhas

O objeto de evento do Planilhas é a parte do objeto de evento geral que carrega informações sobre o documento de um usuário e o conteúdo dele. Ele só está presente em um objeto de evento se o aplicativo host for o Planilhas Google.

Objeto de evento das Planilhas
sheets.id string
Presente apenas se o escopo https://www.googleapis.com/auth/drive.file foi autorizado pelo usuário. O ID da planilha aberta na interface das Planilhas.
sheets.title string
Presente apenas se o escopo https://www.googleapis.com/auth/drive.file foi autorizado pelo usuário. O título da planilha aberta na interface das Planilhas.
sheets.addonHasFileScopePermission boolean
Se true, o complemento solicitou e recebeu a autorização de escopo https://www.googleapis.com/auth/drive.file para a planilha aberta na interface das Planilhas. Caso contrário, este campo é false.
sheets.matchedUrl.url string
Somente apresentado 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 seu 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 Slides

O objeto de evento do Slides é a parte do objeto de evento geral que carrega informações sobre o documento de um usuário e o conteúdo dele. Ele só vai estar presente em um objeto de evento se o aplicativo de hospedagem for o Apresentações Google.

Objeto de evento do app Slides
slides.id string
Presente apenas se o escopo https://www.googleapis.com/auth/drive.file foi autorizado pelo usuário. O ID da apresentação aberta na interface das Apresentações Google.
slides.title string
Presente apenas se o escopo https://www.googleapis.com/auth/drive.file foi autorizado pelo usuário. O título da apresentação aberta na interface do Apresentações Google.
slides.addonHasFileScopePermission boolean
Se 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 Google. Caso contrário, este campo é false.
slides.matchedUrl.url string
Somente apresentado 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 Apresentações Google. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do seu 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"
  }
}