Objetos de evento

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

Objetos de evento são estruturas JSON construídas e transmitidas automaticamente como parâmetros para acionar ou fazer callback de funções 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 locais:

  • 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 gatilho da página inicial para identificar o app host ativo, a plataforma do cliente, a localidade 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 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 disparados quando o usuário insere um contexto específico. Exemplo:

    Quando um acionador contextual é disparado, o aplicativo host chama o runFunction correspondente listado no manifesto do complemento, transmitindo um objeto de evento como um parâmetro. Os objetos de evento criados quando 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 que contêm informações contextuais.

  • Ações de widget. Os objetos de evento também são usados para proporcionar interatividade com o widget, usando o mesmo modelo de ação usado pelos 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 evento de ação incluem ainda mais informações que podem ser usadas por uma função de callback.

    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 que contêm informações de widget.

  • Visualizar acionadores de links. 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 cartão que mostrem informações sobre o link no aplicativo host. Você também pode criar ações de widget para permitir que os usuários interajam com o card de visualização e o conteúdo dele.

Estrutura do objeto de eventos

A tabela a seguir descreve a estrutura de nível superior dos objetos de evento de complementos do Google Workspace. A estrutura do objeto de evento inclui um campo de nível superior commonEventObject para informações independentes de 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 de complementos do Google Workspace também incluem todos os campos originais usados nos objetos de eventos de ações dos complementos do Gmail. Esses campos estão listados na tabela abaixo, em "Campos originais de complementos do Gmail". As informações nesses campos são reproduzidas na nova estrutura do objeto.

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 organizador da chamada for o Google Agenda. Um objeto que contém informações de eventos e da agenda.
eventObject.drive Drive event object
Presente apenas se o host da chamada for o Google Drive. Um objeto que contém informações do Drive.
eventObject.gmail Gmail event object
Presente apenas se o host da chamada for o Gmail. Um objeto que contém informações do Gmail.
eventObject.docs Docs event object
Presente apenas se o host da chamada for Documentos Google. Um objeto que contém informações de documentos.
eventObject.sheets Sheets event object
Presente apenas se o host da chamada for o Planilhas Google. Um objeto contendo informações das Planilhas.
eventObject.slides Slides event object
Presente apenas se o organizador da chamada for o app Apresentações Google. Um objeto contendo informações das Apresentações.
Campos originais dos complementos do Gmail
eventObject.messageMetadata.accessToken string
Descontinuado. Um token de acesso. Use esse recurso para ativar o acesso aos dados do usuário com escopos temporários dos complementos do Gmail.

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

eventObject.messageMetadata.messageId string
Descontinuado. O código da mensagem da conversa que é aberta na interface do Gmail.

Para complementos do Google Workspace, você encontra 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, você encontra 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 oferece formInput como uma 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 essa informação 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 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, você encontra essas informações no campo eventObject.commonEventObject.formInputs.

eventObject.parameters object
Descontinuado. Um mapa dos outros parâmetros que você fornecer ao Action usando Action.setParameters(). As chaves e os valores do mapa são strings.

Para complementos do Google Workspace, você encontra 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. Ele também pode ser um código numérico do país UN M49.

Para complementos do Google Workspace, você encontra 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. Para mais detalhes, consulte Como acessar a localidade e o fuso horário do usuário.

Para complementos do Google Workspace, você encontra 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 fuso horário do usuário. Os exemplos incluem: America/New_York, Europe/Vienna e Asia/Seoul. Consulte Acessar a localidade e o fuso horário do usuário para saber mais.

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

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

Para complementos do Google Workspace, você encontra 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 envia informações gerais independentes de 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 da página inicial e dos acionadores contextuais, os complementos constroem 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, seu complemento pode localizar o texto que um usuário digitou em um widget TextInput no objeto eventObject.commentEventObject.formInputs.

Campos de objeto de evento comuns
commonEventObject.platform string
Indica a origem do evento ("WEB", "IOS" ou "ANDROID").
commonEventObject.formInputs object
Um mapa contendo 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 desse objeto 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 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 o ID myDTPicker, acesse o objeto DateTimeInput usando e.commonEventObject.formInputs.myDTPicker.dateTimeInput.

  • A date-only picker: um DateInput object.

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

  • A time-only picker: um TimeInput object.

    Exemplo: para um seletor com o ID 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ê fornecer ao Action usando Action.setParameters().
commonEventObject.userLocale string
Desativado por padrão. O idioma e o identificador de país/região do usuário no formato 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 Acessar a localidade e o fuso horário do usuário para saber mais.

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 escopo do complemento também precisa incluir https://www.googleapis.com/auth/script.locale. Consulte Acessar a localidade e o fuso horário do usuário para saber mais.
commonEventObject.timeZone.id string
O identificador do fuso horário do usuário. Os exemplos incluem: 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 escopo do complemento também precisa incluir https://www.googleapis.com/auth/script.locale. Consulte Acessar a localidade e o fuso horário do usuário para saber mais.
commonEventObject.timeZone.offset string
O ajuste de horário do Tempo Universal Coordenado (UTC) do fuso horário do usuário, medido em milissegundos. Consulte Acessar a localidade e o fuso horário do usuário para saber mais.

Entradas do formulário do seletor de data e hora

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

Objeto DateTimeInput
dateTimeInput.hasDate boolean
true se a hora da data de entrada incluir uma data; se false for incluído apenas uma hora.
dateTimeInput.hasTime boolean
true se a hora da data de entrada incluir uma hora; se false for incluído apenas uma data.
dateTimeInput.msSinceEpoch string
O horário selecionado pelo usuário, em milissegundos, desde a época (00:00:00 UTC em 1o 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 1o 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 do Google Agenda é a parte do objeto de evento geral que contém informações sobre 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 estarão presentes no objeto do evento apenas se os dados estiverem no evento do Agenda e o complemento definir o campo addOns.calendar.currentEventAccess do manifesto como READ ou READ_WRITE.

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 participantes à lista de participantes do evento. Caso contrário, false.
calendar.capabilities.canSeeAttendees boolean
Dados gerados pelo usuário. true se o complemento puder ler a lista de participantes do evento. Caso contrário, false.
calendar.capabilities.canSeeConferenceData boolean
Dados gerados pelo usuário. true se o complemento puder ler os dados da conferência do evento. Caso contrário, false.
calendar.capabilities.canSetConferenceData boolean
Dados gerados pelo usuário. true se o complemento puder atualizar os dados da conferência do evento. Caso contrário, false.
calendar.capabilities.canAddAttachments boolean
Dados gerados pelo usuário. true se o complemento puder adicionar novos anexos ao evento. Caso contrário, false.
calendar.conferenceData Conference data object
Dados gerados pelo usuário. Um objeto que representa todos os dados de videoconferência associados a este evento, como detalhes da videoconferência do Google Meet.
calendar.id string
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 transmitem informações sobre pessoas específicas para os eventos do Google Agenda. Essas informações estarão presentes no objeto de evento apenas se os dados estiverem presentes no evento do Agenda e o complemento definir o campo de manifesto addOns.calendar.currentEventAccess como READ ou READ_WRITE.

Objeto do participante
attendee.additionalGuests number
O número de convidados adicionais que o convidado indicou que levaria. Assume zero como padrão.
attendee.comment string
O comentário de resposta do convidado, se houver.
attendee.displayName string
O nome exibido do convidado.
attendee.email string
O endereço de e-mail do convidado.
attendee.optional boolean
true se a participação deste participante for marcada como opcional. Caso contrário, false.
attendee.organizer boolean
true se o participante for um organizador deste evento.
attendee.resource boolean
true se o convidado representar um recurso, como sala ou equipamento. false caso contrário.
attendee.responseStatus string
O status de resposta do convidado. Os valores possíveis incluem o seguinte:
  • accepted: o convidado aceitou o convite do evento.
  • declined: o convidado recusou o convite do evento.
  • needsAction: o convidado não respondeu ao convite do evento.
  • tentative: o convidado aceitou provisoriamente o convite do evento.
attendee.self boolean
true se o convidado representa a agenda em que o evento aparece. Caso contrário, false.

Dados da conferência

Os objetos de dados de videoconferências transmitem informações sobre conferências anexadas aos eventos do Google Agenda. Podem ser soluções de videoconferência do Google, como o Google Meet, ou conferências de terceiros. Essas informações estarão presentes no objeto de evento apenas se os dados estiverem presentes no evento da Agenda e o complemento definir o campo de manifesto addOns.calendar.currentEventAccess como READ ou READ_WRITE.

Objeto de dados da videoconferência
conferenceData.conferenceId string
O ID da videoconferência. O objetivo desse ID é permitir que os aplicativos monitorem as conferências. Não o exiba 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 conferência.
conferenceData.conferenceSolution.key object
A chave que identifica de forma exclusiva a solução de conferência para esse evento.
conferenceData.conferenceSolution.key.type string
O tipo de solução de conferência. Os valores possíveis incluem o seguinte:
  • eventHangout para 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 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 a serem exibidas para o 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âmetros. 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 do ponto de entrada transportam 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 apenas se os dados estiverem presentes no evento do Agenda e o complemento definir o campo de manifesto addOns.calendar.currentEventAccess como READ ou READ_WRITE.

Objeto de ponto de entrada
entryPoint.accessCode string
O código de acesso usado para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de videoconferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para dar acesso a conferências. Faça a correspondência e mostre apenas os campos que o provedor de videoconferência usa.
entryPoint.entryPointFeatures list
Recursos do ponto de entrada. Atualmente, esses recursos se aplicam apenas aos pontos de entrada phone:
  • toll: o ponto de entrada é uma chamada telefônica sem custo financeiro.
  • toll_free: o ponto de entrada é uma chamada telefônica sem custo financeiro.
entryPoint.entryPointType string
O tipo de ponto de entrada. Os valores possíveis são os seguintes:
  • more: instruções adicionais para participar de videoconferências, como números de telefone alternativos. Uma conferência pode ter apenas um ponto de entrada more. Se houver pelo menos um outro tipo de ponto de entrada, também é necessário.
  • phone: use um número de telefone para participar da conferência. Uma videoconferência pode ter zero ou mais pontos de entrada do phone. O Google Agenda mostra apenas os dois primeiros pontos de entrada do smartphone, depois de formatar e classificar em ordem alfabética.
  • sip: participe da videoconferência por SIP. Uma conferência pode ter no máximo um ponto de entrada sip.
  • video: participe da videoconferência por HTTP. Uma videoconferência pode ter no máximo um ponto de entrada video.
entryPoint.label string
O rótulo visível ao usuário referente ao URI do ponto de entrada (não localizado).
entryPoint.meetingCode string
O código da reunião usado para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de videoconferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para dar acesso a conferências. Faça a correspondência e mostre apenas os campos que o provedor de videoconferência usa.
entryPoint.passcode string
A senha usada para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de videoconferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para dar acesso a conferências. Faça a correspondência e mostre apenas os campos que o provedor de videoconferência usa.
entryPoint.password string
A senha usada para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de videoconferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para dar acesso a conferências. Faça a correspondência e mostre apenas os campos que o provedor de videoconferência usa.
entryPoint.pin string
O PIN usado para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de videoconferência geralmente usam apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} para dar acesso a conferências. Faça a correspondência e mostre apenas os campos que o provedor de videoconferência usa.
entryPoint.regionCode string
Código de região do número de telefone. É necessário para os usuários quando o URI não inclui um código do país. Os valores são baseados na lista pública CLDR de códigos de região.
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: é 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: é necessário um esquema sip: ou sips:. Por exemplo, "sip:12345678@myprovider.com".
  • video: é necessário um esquema http: ou https:.

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 seu conteúdo. Ele só estará 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 Google Drive

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

Objeto de item do Drive
item.addonHasFileScopePermission boolean
Se true, o complemento solicitou e recebeu autorização de escopo https://www.googleapis.com/auth/drive.file para este item. Caso contrário, o campo será false.
item.id string
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
Título do item selecionado.

Objeto de evento do Gmail

O objeto de evento do Gmail é a parte do objeto de evento geral que carrega informações sobre as mensagens de um usuário do Gmail. Ele só está presente em um objeto de evento quando o aplicativo host é 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 de um usuário que está 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 de destinatários em "Cco:" incluídos atualmente em um rascunho que o complemento está criando. 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 em "Cc:" incluídos em um rascunho que o complemento está criando. Para ativar esse campo, defina o campo addOns.gmail.composeTrigger.draftAccess no manifesto como METADATA.
gmail.messageId string
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 de destinatários em "Para:" incluídos em um rascunho que o complemento está criando. Para ativar esse campo, defina o campo addOns.gmail.composeTrigger.draftAccess no manifesto como METADATA.

Objeto de evento dos Documentos

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

Objeto de evento dos 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 dos Documentos Google.
docs.title string
Presente apenas 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 uma autorização de escopo https://www.googleapis.com/auth/drive.file para o documento aberto na interface do Documentos. Caso contrário, o 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 do host especificado no gatilho LinkPreviewTriggers.

O URL do link que gera uma visualização nos Documentos 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: 

"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 seu conteúdo. Ele só estará 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 tiver sido autorizado pelo usuário. O código da planilha é aberto na interface do Planilhas.
sheets.title string
Presente apenas se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O título da planilha é aberto na interface do Planilhas.
sheets.addonHasFileScopePermission boolean
Se true, o complemento solicitou e recebeu uma autorização de escopo https://www.googleapis.com/auth/drive.file para a planilha aberta na interface do Planilhas. Caso contrário, o 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 do host especificado no gatilho 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 das Apresentações

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

Objeto de evento das Apresentações
slides.id string
Presente apenas se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O ID da apresentação é aberto na interface das Apresentações.
slides.title string
Presente apenas se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário. O título da apresentação é aberto na interface das Apresentações.
slides.addonHasFileScopePermission boolean
Se true, o complemento solicitou e recebeu uma autorização de escopo https://www.googleapis.com/auth/drive.file para que a apresentação seja aberta na interface das Apresentações. Caso contrário, o 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 do host especificado no gatilho LinkPreviewTriggers.

O URL do link que gera uma visualização nas Apresentações 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:

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