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 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 lugares:

  • 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 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 gatilhos contextuais que dispara 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 de 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 usam. 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, 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 dos objetos de evento dos 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 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 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
Presente somente 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 somente se o host de chamada for o Google Drive. Um objeto que contêm informações do Google Drive.
eventObject.gmail Gmail event object
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
Presente somente se o host de chamada for o Documentos Google. Um objeto contendo informações do Google Docs.
eventObject.sheets Sheets event object
Presente somente se o host de chamada for as Planilhas Google. Um objeto contendo 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 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 a origem do evento (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. O 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 de formInputs.

Para os 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 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 os complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.formInputs.

eventObject.parameters object
Descontinuado. Um mapa de qualquer local 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. 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 os complementos do Google Workspace, encontre essas informações no campo eventObject.commonEventObject.userLocale.

eventObject.userLocale string
Descontinuado e desativado por padrão. O 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 os 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 fuso horário do usuário. Exemplos incluem: 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, você encontra essas informações na eventObject.commonEventObject.timeZone.id .

eventObject.userTimezone.offset string
Descontinuado e desativado por padrão. O 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 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 o usuário digitou em uma Widget TextInput na 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 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 depende do tipo de widget:

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

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

  • Widgets com vários valores (por exemplo, grupos de caixas de seleção): uma lista de 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 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ê fornecer ao 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 seu complemento. A lista de escopo do 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 string
Desativado por padrão. O ID e a diferença de fuso horário. 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 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 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 Como acessar a localidade e o fuso horário do usuário para mais detalhes.

Entradas de formulário do seletor de data e hora

As funções de callback de ação podem receber os valores atuais do widget 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 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 minuto 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. É apenas 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 participantes do evento da agenda.
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; false, caso contrário.
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 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 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
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 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 participante contêm informações sobre participantes individuais de eventos do Google Agenda. 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 de 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 do participante.
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 representa um recurso, como uma sala ou um equipamento; false, caso contrário.
attendee.responseStatus string
O status de resposta do convidado. Possível incluem o seguinte:
  • accepted: o participante aceitou o convite do evento.
  • declined: o convidado recusou o evento convite.
  • needsAction: o participante não respondeu ao convite do evento.
  • tentative: o participante aceitou provisoriamente o convite do 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 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 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 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 a solução de conferência para este evento.
conferenceData.conferenceSolution.key.type string
O tipo de solução de conferência. Valores possíveis incluem o seguinte:
  • eventHangout para o Hangouts para consumidores (http://hangouts.google.com).
  • eventNamedHangout para o Hangouts clássico para usuários do Google Workspace (http://hangouts.google.com).
  • hangoutsMeet para o Google Meet (http://meet.google.com).
conferenceData.conferenceSolution.name string
O nome 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 comprimento máximo é de 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 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 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 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 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 telefônica paga.
  • toll_free: o ponto de entrada é uma ligação sem custo financeiro.
entryPoint.entryPointType string
O tipo de ponto de entrada. Os valores possíveis são estes:
  • more: outras instruções de participação na conferência, como números de telefone alternativos. Uma conferência pode ter apenas um more ponto de entrada; se houver pelo menos um outro tipo de ponto de entrada também é obrigatório.
  • phone: participar da conferência usando um número de telefone. Um videoconferência pode ter zero ou mais phone pontos de entrada. O Google Agenda mostra apenas os dois primeiros pontos de entrada de 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. 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 conferê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 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 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ê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 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 na lista pública de códigos de região (link em inglês) CLDR.
entryPoint.uri string
O URI do ponto de entrada. O máximo é de 1.300 caracteres. A formatação depende do tipo de ponto de entrada:
  • more: um http: ou https: é obrigató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 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
O item do Google 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 do 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 carrega 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. É 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 "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 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 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
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 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 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
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 UI.
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
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 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 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 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 abre 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
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 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"
  }
}