Objetos de evento

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

Objetos de evento são estruturas JSON construídas e transmitidas automaticamente como parâmetros para acionar ou funções de callback quando um usuário interage com um . Os objetos de evento transportam informações do lado do cliente sobre o app host e os contexto atual à 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 que você define recebe automaticamente um evento quando a função de acionamento da página inicial é disparada. É possível usar esse objeto a função de gatilho da página inicial para identificar o app host ativo, o da plataforma, a localidade do usuário e outras informações.

    Os objetos de evento criados quando o acionamento da página inicial é acionado não contêm todos os incluídos nos outros dois casos; de widgets e informações contextuais são omitidas.

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

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

  • Ações de widget. Objetos de evento também são usados para fornecer elementos de widget interatividade, usando a mesma modelo de ação que os complementos do Gmail usar. Os complementos do Google Workspace usam as mesmas funções de gerenciador de widgets, Objetos Action e ação de resposta. No entanto, nos complementos do Google Workspace, objetos de evento de ação incluir ainda mais informações sobre as quais uma função de retorno pode agir.

    Os objetos de evento criados como resultado das ações do widget contêm todas as campos incluídos em objetos de evento de acionamento contextuais, além dos campos que contêm informações do widget.

  • Visualizar acionadores de links. Nos apps Documentos, Planilhas e Apresentações Google, você pode: 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 o padrão, o linkPreviewTriggers é disparado, e um objeto de evento que contém o link é transmitido ao função de callback. Seu complemento pode usar esse objeto de evento para criar um ícone e cartão inteligente que mostra informações sobre o link no host para o aplicativo. Também é possível 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 evento

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

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

Objeto de evento
eventObject.commonEventObject Common fields object
Um objeto que contém informações comuns a todos os objetos de evento, seja qual for o aplicativo host.
eventObject.calendar Calendar event object e
Só estará presente 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 e
Só estará presente se o host da chamada for o Google Drive. Um objeto que contêm informações do Google Drive.
eventObject.gmail Gmail event object e
Só estará presente se o host da chamada for o Gmail. Um objeto que contêm informações do Gmail.
eventObject.docs Docs event object e
Só estará presente se o host da chamada for o app Documentos Google. Um objeto contendo informações do Google Docs.
eventObject.sheets Sheets event object e
Só esteja presente se o host da chamada for as Planilhas Google. Um objeto contendo informações do Planilhas.
eventObject.slides Slides event object e
Só vai estar presente se o organizador da chamada for o app Apresentações Google. Um objeto que contêm informações do Apresentações.
Campos dos complementos originais do Gmail
eventObject.messageMetadata.accessToken string
Descontinuado. Um token de acesso. Você pode usar para ativar o acesso aos dados do usuário usando escopos temporários de complementos do Gmail.

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

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

Para complementos do Google Workspace, você encontra essas informações na eventObject.gmail.messageId .

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

Para complementos do Google Workspace, você encontra essas informações na 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. A chaves são os IDs de string associados aos widgets e os valores são as strings. O objeto de evento fornece formInput como um conveniência para quando você precisa ler dados de vários widgets com valores singulares esperados, como entradas e chaves de texto. Para widgets com vários valores, como caixas de seleção, é possível ler cada valor formInputs.

Para complementos do Google Workspace, você encontra essas informações na eventObject.commonEventObject.formInputs . widgets com valores únicos são representados como matrizes um único elemento.

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

Para complementos do Google Workspace, você encontra essas informações na eventObject.commonEventObject.formInputs .

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

Para complementos do Google Workspace, você encontra essas informações na eventObject.commonEventObject.parameters .

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

Para complementos do Google Workspace, você encontra essas informações na eventObject.commonEventObject.userLocale .

eventObject.userLocale string
Descontinuado e desativado por padrão. A duas letras ISO 639 que indica o idioma do usuário. Consulte Acesso ao usuário localidade e fuso horário para mais detalhes.

Para complementos do Google Workspace, você encontra essas informações na eventObject.commonEventObject.userLocale .

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

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

eventObject.userTimezone.offset string
Descontinuado e desativado por padrão. A diferente do Tempo Universal Coordenado (UTC, na sigla em inglês) do horário em milissegundos. Consulte Acesse a localidade e o fuso horário do usuário para mais detalhes.

Para complementos do Google Workspace, você encontra essas informações na 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 independentes de host para o complemento do cliente do usuário. Isso As informações incluem detalhes como a localidade, o app host e a plataforma do usuário.

Além da página inicial e dos gatilhos 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 de widgets abertos no sistema para o cliente. Por exemplo, seu complemento pode localizar o texto que o usuário digitou em uma Widget TextInput na objeto eventObject.commentEventObject.formInputs.

Campos de objetos de evento comuns
commonEventObject.platform string
Indica a origem do evento ("WEB", "IOS" ou "ANDROID").
commonEventObject.formInputs object
Um mapa contendo os valores atuais do widgets no cartão exibido. As chaves do mapa são os IDs de string é atribuída a cada widget.

A estrutura do objeto de valor do mapa é de acordo com o 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 o ID, acesse o texto valor de entrada com: e.commonEventObject.formInputs.employeeName.stringInputs.value[0]

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

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

  • A date-time picker: um DateTimeInput object.

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

  • A date-only picker: um DateInput object.

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

  • A time-only picker: um TimeInput object.

    Exemplo: para um seletor com um ID myTimePicker, acesse objeto TimeInput usando e.commonEventObject.formInputs.myTimePicker.timeInput.
commonEventObject.hostApp string
Indica o app host em que o complemento está ativo quando o objeto do evento for gerado. Os valores possíveis incluem o valor-chave seguinte:
  • GMAIL
  • CALENDAR
  • DRIVE
  • DOCS
  • SHEETS
  • SLIDES
commonEventObject.parameters object
Qualquer parâmetro adicional que você fornecer para Action usando Action.setParameters().
commonEventObject.userLocale string
Desativado por padrão. Idioma do usuário e o identificador de país/região no formato de ISO 639 Código do idioma – ISO 3166 código do país/região. 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 incluem https://www.googleapis.com/auth/script.locale. Consulte Acesse a localidade e o fuso horário do usuário para mais detalhes.

commonEventObject.timeZone string
Desativado por padrão. O ID do fuso horário e deslocamento. Para ativar esse campo, defina addOns.common.useLocaleFromApp para true no manifesto do complemento. A lista de escopo do seu complemento também precisa incluir https://www.googleapis.com/auth/script.locale: Consulte Acesse a localidade e o fuso horário do usuário para mais detalhes.
commonEventObject.timeZone.id string
O identificador de fuso horário do fuso horário do usuário. Por exemplo: America/New_York, Europe/Vienna e Asia/Seoul Para ativar esse campo, defina addOns.common.useLocaleFromApp para true no manifesto do complemento. A lista de escopo do seu complemento também precisa incluir https://www.googleapis.com/auth/script.locale: Consulte Acesse a localidade e o fuso horário do usuário para mais detalhes.
commonEventObject.timeZone.offset string
O diferença de horário do Tempo Universal Coordenado (UTC, na sigla em inglês) do horário em milissegundos. Consulte Acesse a localidade e o fuso horário do usuário para mais detalhes.

Entradas de formulário do seletor de data e hora

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 no seletor de data ou hora widgets. No entanto, a estrutura das informações difere dependendo se foi configurado como um seletor de data e hora, somente de data ou de hora seletor. As diferenças estruturais são descritas na tabela a seguir:

Objeto DateTimeInput
dateTimeInput.hasDate boolean
true se a data e hora de entrada inclui uma data; se false, apenas uma hora será incluída.
dateTimeInput.hasTime boolean
true se a data e hora de entrada inclui um horário; se false, apenas uma data será incluída.
dateTimeInput.msSinceEpoch string
O horário selecionado pelo usuário, em milissegundos desde é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 época (00:00:00 UTC em 1o de janeiro de 1970).
Objeto TimeInput
timeInput.hours number
O horário selecionado pelo usuário.
timeInput.minutes number
O minuto selecionado pelo usuário.

Objeto de evento da agenda

O objeto de evento do Google Agenda é a parte do objeto de evento geral que carrega informações sobre a agenda e os eventos da agenda de um usuário. É apenas presente em um objeto de evento se o aplicativo host for o Google Agenda.

A tabela a seguir lista os campos presentes no calendarEventObject de um objeto de evento. Os campos marcados como Dados gerados pelo usuário são presente no objeto de evento se e somente se os dados estiverem presentes no evento, e o complemento define seu addOns.calendar.currentEventAccess manifesto para READ ou READ_WRITE.

Objeto de evento da agenda
calendar.attendees[] list of attendee objects e
Dados gerados pelo usuário. Uma lista dos convidados da agenda evento.
calendar.calendarId string
O ID da agenda.
calendar.capabilities object
Dados gerados pelo usuário. Um objeto descrevendo os recursos do complemento para exibir ou atualizar eventos informações imprecisas ou inadequadas.
calendar.capabilities.canAddAttendees boolean
Dados gerados pelo usuário. true se o complemento pode 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 pode ler a lista de participantes do evento; false caso contrário.
calendar.capabilities.canSeeConferenceData boolean
Dados gerados pelo usuário. true se o complemento pode ler os dados de videoconferência do evento; false caso contrário.
calendar.capabilities.canSetConferenceData boolean
Dados gerados pelo usuário. true se o complemento pode atualizar os dados de 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; Caso contrário, false.
calendar.conferenceData Conference data object e
Dados gerados pelo usuário. Um objeto que representa os dados de conferência associadas a este evento, como os detalhes da videoconferência do Google Meet.
calendar.id string
É o ID do evento.
calendar.organizer object
Um objeto que representa o organizador da 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 participantes carregam informações sobre os participantes para o Google Agenda. eventos. Essas informações estarão presentes no objeto de evento somente se os dados está presente no evento do Google Agenda, e o complemento define addOns.calendar.currentEventAccess manifestar para READ ou READ_WRITE.

Objeto do participante
attendee.additionalGuests number
O número de convidados adicionais indicou que estão trazendo. Assume zero como padrão.
attendee.comment string
Comentário da resposta do convidado, se houver.
attendee.displayName string
O nome exibido para o convidado.
attendee.email string
O endereço de e-mail do participante.
attendee.optional boolean
true se a participação neste evento convidado é marcado como opcional. Caso contrário, false.
attendee.organizer boolean
true se o participante for um organizador deste evento.
attendee.resource boolean
true se o participante representar uma recurso, como sala ou equipamento; false caso contrário.
attendee.responseStatus string
O status de resposta do convidado. Possível incluem o seguinte:
  • accepted: o convidado aceitou o evento convite.
  • declined: o convidado recusou o evento convite.
  • needsAction: o convidado não respondeu à convite para o evento.
  • tentative: o participante aceitou provisoriamente o convite para o evento.
attendee.self boolean
true se este participante representar a agenda em que o evento aparece; Caso contrário, false.

Dados da videoconferência

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 conferência do Google, como Google Meet ou em videoconferências de terceiros. Essas informações estão presentes objeto de evento se e somente se os dados estiverem presentes no evento do Google Agenda e o o complemento define o addOns.calendar.currentEventAccess manifestar para READ ou READ_WRITE.

Objeto de dados de conferência
conferenceData.conferenceId string
O ID da videoconferência. Este ID significa para permitir que os aplicativos acompanhem as conferências; você não deve vai mostrar esse ID aos usuários.
conferenceData.conferenceSolution object
Um objeto que representa a conferência do Google, como o Hangouts ou o Google Meet.
conferenceData.conferenceSolution.iconUri string
O URI do ícone visível ao usuário que representa esta solução de conferência.
conferenceData.conferenceSolution.key object
A chave que identifica exclusivamente o para este evento.
conferenceData.conferenceSolution.key.type string
O tipo de solução de videoconferência. 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 desta videoconferência visível para o usuário solução (não localizada).
conferenceData.entryPoints[] list of entry point objects
A lista de pontos de entrada de videoconferência, como URLs ou números de telefone.
conferenceData.notes string
Observações adicionais (como instruções de o administrador do domínio ou avisos legais) sobre a conferência exibir ao usuário. Pode conter HTML. O tamanho máximo é 2.048 caracteres.
conferenceData.parameters object
Um objeto que contém um mapa de dados de parâmetros para uso pelo complemento.
conferenceData.parameters.addOnParameters object
Um mapa de chaves e valores de strings 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 o uso do complemento.

Ponto de entrada

Os objetos de ponto de entrada transportam informações sobre os meios estabelecidos de acessar de uma determinada conferência, por exemplo, por telefone ou vídeo. Essas informações estão presentes objeto de evento se e somente se os dados estiverem presentes no evento do Google Agenda e o complemento define o addOns.calendar.currentEventAccess manifestar para 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 conferência normalmente usar apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} até fornecer acesso a conferências. Corresponder e só mostrar os campos pelo provedor de conferência.
entryPoint.entryPointFeatures list
Recursos do ponto de entrada. Atualmente, os recursos só se aplicam aos pontos de entrada do phone:
  • toll: o ponto de entrada é uma ligação sem custo financeiro.
  • 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 o seguinte:
  • more: instruções adicionais para participar da conferência. como números de telefone alternativos. Uma videoconferência só pode ter um more ponto de entrada; se houver pelo menos um outro tipo de ponto de entrada também é obrigatório.
  • phone: participe da conferência usando um número de telefone. Um videoconferência pode ter zero ou mais phone pontos de entrada. O Google Agenda só exibe os dois primeiros pontos de entrada do 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: participar da conferência por HTTP. Um videoconferência pode ter no máximo um video ponto de entrada.
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 videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência normalmente usar apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} até fornecer acesso a conferências. Corresponder e só mostrar os campos pelo provedor de conferência.
entryPoint.passcode string
A senha usada para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência normalmente usar apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} até fornecer acesso a conferências. Corresponder e só mostrar os campos pelo provedor de conferência.
entryPoint.password string
A senha usada para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência normalmente usar apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} até fornecer acesso a conferências. Corresponder e só mostrar os campos pelo provedor de conferência.
entryPoint.pin string
O PIN usado para acessar a videoconferência. O tamanho máximo é de 128 caracteres. Os provedores de conferência normalmente usar apenas um subconjunto de {accessCode, meetingCode, passcode, password, pin} até fornecer acesso a conferências. Corresponder e só mostrar os campos pelo provedor de conferência.
entryPoint.regionCode string
Código de região do número de telefone. Necessário por aos usuários se o URI não incluir um código de país. Os valores são baseados em o público Lista CLDR de códigos regionais.
entryPoint.uri string
O URI do ponto de entrada. O máximo é de 1.300 caracteres. A formatação depende do ponto de entrada type
  • more: um http: ou https: é obrigatório.
  • phone: um esquema tel: é necessário. A O URI precisa incluir toda a sequência de discagem (por exemplo, "tel.:+12345678900,,,12345678;1234").
  • sip: um sip: ou sips: é obrigatório. Por exemplo, "sip:12345678@myprovider.com".
  • video: um http: ou https: é obrigatório.

Objeto de evento do Drive

O objeto de evento do Google Drive é a parte do objeto de evento geral que carrega informações sobre o Google Drive de um usuário e seu conteúdo. É apenas presentes em um objeto de evento se o aplicativo host for o Google Drive.

Objeto de evento do Drive
drive.activeCursorItem Drive item object e
O item do Google Drive ativo no momento.
drive.selectedItems[] list of Drive item objects e
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 do Drive, como arquivos ou pastas.

Objeto do item do Drive
item.addonHasFileScopePermission boolean
Se true, o complemento solicitou e recebeu https://www.googleapis.com/auth/drive.file do escopo deste item. caso contrário, este campo será false.
item.id string
O ID do item selecionado.
item.iconUrl string
O URL do ícone que representa 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 transporta informações sobre as mensagens do Gmail de um usuário. 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. Você pode usar esse token com o GmailApp.setCurrentMessageAccessToken(accessToken) para conceder ao seu complemento acesso temporário à funcionalidade atual de um usuário abra a mensagem do Gmail ou deixe o complemento escrever novos rascunhos.
gmail.bccRecipients[] list of strings
Desativado por padrão. A lista de "BCC:" os endereços de e-mail dos destinatários incluídos em um rascunho do está criando. Para ativar esse campo, defina o addOns.gmail.composeTrigger.draftAccess no manifesto para METADATA.
gmail.ccRecipients[] list of strings
Desativado por padrão. A lista de "CC:" os endereços de e-mail dos destinatários incluídos em um rascunho do está criando. Para ativar esse campo, defina o addOns.gmail.composeTrigger.draftAccess no manifesto para METADATA.
gmail.messageId string
O ID da mensagem do Gmail aberta no momento.
gmail.threadId string
O ID da conversa do Gmail aberto no momento.
gmail.toRecipients[] list of strings
Desativado por padrão. A lista de "Para:" os endereços de e-mail dos destinatários incluídos em um rascunho do está criando. Para ativar esse campo, defina o addOns.gmail.composeTrigger.draftAccess no manifesto para METADATA.

Objeto de evento dos Documentos

O objeto de evento dos Documentos é a parte do objeto de evento geral que transporta informações sobre o documento de um usuário e seu conteúdo. Ele está presente apenas objeto de evento se o aplicativo host for Documentos Google.

Objeto de evento dos 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 app Documentos.
docs.title string
Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizado pelo usuário.
O título do documento é aberto na interface do app Documentos.
docs.addonHasFileScopePermission boolean
Se true, o complemento solicitou e recebeu https://www.googleapis.com/auth/drive.file autorização de escopo para o documento aberto na interface do app Documentos caso contrário, é false.
docs.matchedUrl.url string
Só estará presente 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 app Documentos Google. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do seu complemento. Consulte mais detalhes em Visualizar links com ícones inteligentes.

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

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

Objeto de evento das Planilhas

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

Objeto de evento das Planilhas
sheets.id string
Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizadas 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 autorizadas pelo usuário. Título da planilha aberto no app Planilhas de ML pela IU.
sheets.addonHasFileScopePermission boolean
Se true, o complemento solicitou e recebeu https://www.googleapis.com/auth/drive.file autorização de escopo para a planilha aberta na interface do Planilhas caso contrário este campo é false.
sheets.matchedUrl.url string
Só estará presente 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 app Planilhas Google. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do seu complemento. Consulte mais detalhes em Visualizar links com ícones inteligentes.

Exemplo de payload para quando um usuário visualizar 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 das Apresentações é a parte do objeto de evento geral que transporta informações sobre o documento de um usuário e seu conteúdo. Ele só está presente objeto de evento se o aplicativo host for Apresentações Google.

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 autorizadas pelo usuário. O ID da apresentação aberta no app Apresentações de ML pela IU.
slides.title string
Só estará presente se o escopo https://www.googleapis.com/auth/drive.file tiver sido autorizadas pelo usuário. O título da apresentação é aberto no Interface do app Apresentações.
slides.addonHasFileScopePermission boolean
Se true, o complemento solicitou e recebeu https://www.googleapis.com/auth/drive.file autorização de escopo para a apresentação aberta na interface do Apresentações caso contrário este campo é false.
slides.matchedUrl.url string
Só estará presente 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 Apresentações Google. Para usar esse campo, configure o LinkPreviewTriggers no manifesto do seu complemento. Consulte mais detalhes em Visualizar links com ícones inteligentes.

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

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