Este documento contém informações de autorização e autenticação específicas da API Google Workspace Events. Antes de ler este documento, leia as informações gerais de autenticação e autorização do Google Workspace em Aprenda Mais sobre autenticação e autorização.
Configurar o OAuth 2.0 para autorização
Configure a tela de permissão OAuth e escolha os escopos para definir quais informações serão mostradas aos usuários e revisores de apps e registre seu app para que ele possa ser publicado mais tarde.
Escopos da API Google Workspace Events
Para definir o nível de acesso concedido ao app, é necessário identificar e declarar escopos de autorização. Um escopo de autorização é uma string de URI do OAuth 2.0 que contém o nome do app do Google Workspace, o tipo de dados que ele acessa e o nível de acesso. Os escopos são as solicitações do seu app para trabalhar com dados do Google Workspace, incluindo dados da Conta do Google dos usuários.
Quando o app é instalado, o usuário precisa validar os escopos usados por ele. Geralmente, é recomendável escolher o escopo mais específico possível e evitar solicitar escopos que não são necessários para o app. Os usuários concedem acesso mais facilmente a escopos limitados e claramente descritos.
A API Google Workspace Events usa escopos de aplicativos do Google Workspace que aceitam assinaturas. Se o app já usa os escopos necessários para sua assinatura, não é preciso adicionar escopos para usar a API Google Workspace Events. Se você adicionar escopos, escolha o menos sensível que ainda permita que o app funcione. Para detalhes sobre as categorias de escopo, consulte Categorias de escopo.
A tabela a seguir lista os escopos compatíveis com a API Google Workspace Events:
| Código do escopo | Descrição | Uso | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Permite que os apps do Chat vejam conversas e enviem mensagens. Dá acesso a todos os recursos disponíveis para apps do Chat. | Não confidencial | ||
https://www.googleapis.com/auth/chat.memberships |
Ver, adicionar e remover participantes de conversas no Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Ver os participantes nas conversas do Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.app.memberships |
Mostrar, adicionar, atualizar e remover participantes de conversas e espaços no Chat como um app do Chat. Exige aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com delegação em todo o domínio usando esse escopo. |
Sensível |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Ver os participantes de conversas e espaços no Google Chat como um app do Chat. Exige aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com delegação em todo o domínio usando esse escopo. |
Sensível |
||
https://www.googleapis.com/auth/chat.spaces |
Criar conversas e espaços e ver ou atualizar os metadados (incluindo as configurações do histórico) no Chat. | Sensível | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Ver conversas e espaços no Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.app.spaces |
Criar conversas e espaços e ver ou atualizar os metadados (incluindo as configurações do histórico) no Chat como um app do Chat. Exige aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com delegação em todo o domínio usando esse escopo. |
Sensível |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Ver metadados (incluindo as configurações do histórico) no Google Chat como um app do Chat. Exige aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com delegação em todo o domínio usando esse escopo. |
Sensível |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Ver, adicionar e excluir reações a mensagens no Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Ver as reações a uma mensagem no Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.messages |
Ver, escrever, enviar, atualizar e excluir mensagens e adicionar, ver e excluir reações a elas. | Restrito | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Ver mensagens e reações no Chat. | Restrito |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Ver mensagens e reações no Chat como um app do Chat. Exige a aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com delegação em todo o domínio usando esse escopo. |
Restrito |
||
https://www.googleapis.com/auth/chat.users.readstate |
Ver e atualizar o estado de leitura do usuário no Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Ver o estado de leitura do usuário no Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.users.availability |
Ver e mudar o status de disponibilidade no Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
Ver o status de disponibilidade no Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
Acessar metadados sobre todos os espaços e conversas no Google Chat em toda a organização do Google Workspace, mesmo quando o app do Chat não é um participante. Esse escopo só é compatível com assinaturas de clientes. Exige aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com a delegação em todo o domínio usando esse escopo. |
Restrito | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
Ver todos os participantes nos espaços e nas conversas do Google Chat em toda a organização do Google Workspace, mesmo quando o app do Chat não é participante deles. Esse escopo só é compatível com assinaturas de clientes. Exige a aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com a delegação em todo o domínio usando esse escopo. |
Restrito | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
Acessar todas as mensagens e reações na organização do Google Workspace, mesmo quando o app do Chat não é membro de um espaço ou conversa. Esse escopo só é compatível com assinaturas de clientes. Exige aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com a delegação em todo o domínio usando esse escopo. |
Restrito | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
Acessar o último horário de leitura de todos os usuários em todos os espaços e conversas da sua organização do Google Workspace, mesmo quando o app do Chat não é participante deles. Esse escopo só é compatível com assinaturas de clientes. Exige aprovação do administrador. Esse escopo só aceita a autenticação de apps com contas de serviço. Não é possível autenticar com credenciais de usuário ou com a delegação em todo o domínio usando esse escopo. |
Restrito | ||
| Google Drive | ||||
https://www.googleapis.com/auth/drive.file |
Crie novos arquivos do Drive ou modifique os arquivos que você abre com um app ou que o usuário compartilha com um app ao usar a API Google Picker ou o seletor de arquivos do app. | Não confidencial | ||
https://www.googleapis.com/auth/drive |
Ver e gerenciar todos os seus arquivos do Drive. | Restrito | ||
https://www.googleapis.com/auth/drive.readonly |
Ver e baixar todos os seus arquivos do Drive. | Restrito | ||
https://www.googleapis.com/auth/drive.metadata |
Ver e gerenciar metadados dos arquivos no seu Drive. | Restrito | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Ver metadados de arquivos no seu Drive. | Restrito | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Permitir que os apps criem, modifiquem e leiam metadados sobre espaços para reuniões criados pelo seu app. | Sensível |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Permite que os apps leiam metadados sobre qualquer espaço para reuniões que o usuário tenha acesso. | Sensível |
||
A coluna "Uso" na tabela anterior indica a sensibilidade de cada escopo:
Não sensíveis: esses escopos oferecem o menor escopo de acesso de autorização e exigem apenas a verificação de apps básica. Para mais informações sobre esse requisito, consulte Requisitos de verificação.
Sensíveis: esses escopos dão acesso a dados específicos do usuário do Google autorizados pelo usuário para seu app. É necessário passar por uma verificação de apps adicional. Para mais informações sobre esse requisito, consulte Requisitos de escopo sensível e restrito.
Restritos: esses escopos oferecem amplo acesso aos dados do usuário do Google e exigem que você passe por um processo de verificação de escopo restrito. Para mais informações sobre esse requisito, consulte Serviços de API do Google: política de dados do usuário e Requisitos adicionais para escopos de API específicos. Se você armazena dados de escopo restrito em servidores (ou os transmite), precisa passar por uma avaliação de segurança.
Se o app precisar de acesso a outras APIs do Google, você também poderá adicionar esses escopos. Para mais informações sobre os escopos da API do Google, consulte Como usar o OAuth 2.0 para acessar as APIs do Google.
Para mais informações sobre escopos específicos do OAuth 2.0, consulte Escopos do OAuth 2.0 para APIs do Google.
Verificação do OAuth
O uso de determinados escopos do OAuth pode exigir que seu app passe pela Central de Ajuda de verificação de apps OAuth. Leia as perguntas frequentes sobre apps OAuth para determinar quando o app precisa passar pela verificação e qual tipo de verificação é necessário. Consulte também os Termos de Serviço do Drive.
Tipos de autenticação necessária
Nesta seção, explicamos quais tipos de autenticação são obrigatórios ou aceitos e fornecemos os escopos aceitos para cada método da API Google Workspace Events.
Para assinaturas de eventos do Chat, a
API Google Workspace Events oferece suporte à autenticação de usuários e de apps para chamar
alguns dos métodos. Se um método de API for compatível com as duas credenciais, o tipo de credencial usado na chamada vai afetar o resultado retornado. Por exemplo, se
você chamar o método
subscriptions.list
com autenticação do usuário, a API vai retornar uma lista de inscrições que
o usuário autenticado pode acessar. Se você usar a autenticação de app, a API
vai retornar uma lista de assinaturas que o app pode acessar. Para saber mais sobre
os tipos de autenticação do Chat, consulte Autenticar e autorizar
apps do Chat e solicitações da API
Chat.
A tabela a seguir mostra quais escopos e tipos de autenticação são necessários ou aceitos para cada método da API Google Workspace Events:
| Método | Autenticação de usuário obrigatória ou aceita | Autenticação de app aceita (somente apps do Chat) | Escopos de autorização aceitos | |
|---|---|---|---|---|
| Criar uma assinatura | — |
Com a autenticação do usuário, é necessário um escopo compatível para cada tipo de evento:
Com a autenticação de apps e a aprovação do administrador (somente apps do Google Chat), é necessário um escopo compatível para cada tipo de evento:
|
||
| Quer assinar? |
Com a autenticação do usuário, esse método requer um escopo que aceite pelo menos um tipo de evento para a assinatura.
Com autenticação de app (somente apps do Chat):
|
|||
| Listar assinaturas |
Com a autenticação do usuário, esse método requer um escopo que ofereça suporte a pelo menos um tipo de evento para a assinatura.
Com autenticação de app (somente apps do Chat):
|
|||
| Atualizar uma assinatura | — |
Com a autenticação do usuário, é necessário um escopo compatível para cada tipo de evento:
Com a autenticação de apps e a aprovação do administrador (somente apps do Google Chat), é necessário um escopo compatível para cada tipo de evento:
|
||
| Reativar uma assinatura | — |
Com a autenticação do usuário, é necessário um escopo compatível para cada tipo de evento:
Com a autenticação de apps e a aprovação do administrador (somente apps do Chat), é necessário um escopo compatível para cada tipo de evento:
|
||
| Excluir uma assinatura |
Com a autenticação do usuário, esse método requer um escopo que ofereça suporte a pelo menos um tipo de evento para a assinatura.
Com autenticação de app (somente apps do Chat):
|
|||
Escopos por tipo de evento
Ao chamar a API Google Workspace Events usando a autenticação do usuário, é necessário especificar um ou mais escopos que correspondam aos tipos de evento da assinatura.
A tabela a seguir mostra quais escopos de autorização são compatíveis com cada tipo de evento:
| Eventos | Tipos de evento | Escopos de autorização compatíveis | ||||||
|---|---|---|---|---|---|---|---|---|
| Chat | ||||||||
| Uma mensagem é postada ou atualizada. |
|
Com a Autenticação do usuário:
|
||||||
| Uma reação é adicionada ou excluída, ou várias reações são alteradas. |
|
Com a autenticação do usuário:
|
||||||
| Uma assinatura é criada, atualizada ou removida, ou várias assinaturas são alteradas. |
|
Com a autenticação do usuário:
|
||||||
| Um espaço é atualizado ou excluído. |
|
Com a autenticação do usuário:
|
||||||
| O estado de leitura do espaço ou o estado de leitura da conversa de um usuário é atualizado. |
|
Com a autenticação do usuário:
|
||||||
| Uma disponibilidade é atualizada. |
|
Com a autenticação do usuário:
|
||||||
| Drive | ||||||||
| Um arquivo é criado, alterado, movido, excluído, renomeado, enviado para a lixeira ou removido dela. |
|
|
||||||
| Uma proposta de acesso é criada ou resolvida em um arquivo. |
|
|
||||||
| Uma aprovação é cancelada, concluída, criada, redefinida, os revisores são alterados ou os revisores respondem em um arquivo. |
|
|
||||||
| Um comentário é criado, excluído, editado, reaberto ou resolvido em um arquivo. |
|
|
||||||
| Uma resposta é criada, excluída ou editada em um arquivo. |
|
|
||||||
| Uma permissão é criada, excluída ou editada em um arquivo. |
|
|
||||||
| Meet | ||||||||
| Uma conferência começa ou termina. |
|
|
||||||
| Um participante entra ou sai de uma conferência. |
|
|
||||||
| Uma gravação foi gerada. |
|
|
||||||
| Uma transcrição foi gerada. |
|
|
||||||