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 Saiba mais sobre autenticação e autorização.
Configurar o OAuth 2.0 para autorização
Configure a tela de permissão OAuth e escolha escopos para definir quais informações são mostradas aos usuários e revisores de apps e registre seu app para poder publicá-lo depois.
Escopos da API Events do Google Workspace
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, os tipos de dados que ele acessa e o nível de acesso. Os escopos são as solicitações do app para trabalhar com os dados do Google Workspace, incluindo os dados da Conta do Google dos usuários.
Quando o app é instalado, o usuário precisa validar os escopos usados pelo app. Em geral, escolha o escopo mais restrito possível e evite solicitar escopos que não são necessários para o app. Os usuários concedem acesso mais rápido a escopos limitados e claramente descritos.
Quando possível, recomendamos o uso de escopos não confidenciais, já que eles concedem escopo de acesso por arquivo e restringem o acesso a uma funcionalidade específica necessária para um app.
A API Eventos do Google Workspace usa escopos dos aplicativos do Google Workspace compatíveis com assinaturas. Se o app já usa os escopos necessários para sua assinatura, não é necessário adicionar outros escopos para usar a API Google Workspace Events.
A tabela a seguir mostra os escopos compatíveis com a API Events do Google Workspace:
| Código do escopo | Descrição | Uso | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Permite que os apps do Google Chat acessem chats e enviem mensagens. Concede acesso a todos os recursos disponíveis para apps de chat. | Não confidencial | ||
https://www.googleapis.com/auth/chat.memberships |
Acessar, adicionar e remover participantes de conversas no Google Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Ver os participantes nas conversas do Google Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.spaces |
Crie conversas e espaços e confira ou atualize metadados (incluindo as configurações do histórico) no Google Chat. | Sensível | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Conferir o chat e os espaços no Google Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.messages |
Mostrar, escrever, enviar, atualizar e excluir mensagens e adicionar, mostrar e excluir reações a mensagens. | Restrito | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Confira mensagens e reações no Google Chat. | Restrito |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Confira, adicione e exclua as reações às mensagens no Chat. | Restrito |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Confira as reações a uma mensagem no Chat. | Restrito |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Permita que os apps criem, modifiquem e leiam metadados sobre espaços de reunião criados pelo app. | Sensível |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Permitir que os apps leiam metadados sobre qualquer espaço para reuniões a que o usuário tenha acesso. | Sensível |
||
A coluna "Uso" na tabela anterior indica a sensibilidade de cada escopo, de acordo com as seguintes definições:
Não confidencial: esses escopos fornecem o menor escopo de acesso de autorização e exigem apenas uma verificação básica de apps. Para mais informações sobre esse requisito, consulte Etapas de preparação para 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. Isso exige que você passe por uma verificação adicional de apps. Para informações sobre esse requisito, consulte Etapas para apps que solicitam escopos sensíveis.
Restrito: esses escopos fornecem amplo acesso aos dados do usuário do Google e exigem que você passe por um processo de verificação de escopo restrito. Para informações sobre esse requisito, consulte Serviços da API do Google: política de dados do usuário e Outros requisitos para escopos específicos da API. Se você armazenar dados de escopo restrito em servidores (ou transmitir), será necessário passar por uma avaliação de segurança.
Se o app exigir acesso a outras APIs do Google, você também pode 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 o app prossiga com o processo de verificação do OAuth do Google. Leia as Perguntas frequentes sobre a verificação da API OAuth para determinar quando seu app precisa passar pela verificação e que tipo de verificação é necessária. Consulte também os Termos de Serviço adicionais do Google Drive.
Tipos de autenticação necessária
Nesta seção, explicamos quais tipos de autenticação são necessários ou compatíveis, além de apresentar os escopos compatíveis com cada método da API Events do Google Workspace.
Para assinaturas de eventos do Google Chat, a API Events do Google Workspace
oferece suporte à autenticação de usuários e 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 afetará o resultado retornado. Por exemplo, se você chamar o método
subscriptions.list()
com autenticação de usuário, a API retornará uma lista de assinaturas que
o usuário autenticado pode acessar. Se você usar a autenticação do app, a API 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 Google Chat.
A tabela a seguir mostra quais escopos e tipos de autenticação são necessários ou compatíveis com cada método da API Google Workspace Events:
| Método | Autenticação do usuário necessária ou compatível | Compatível com autenticação de apps (somente apps do Google Chat) | Escopos de autorização compatíveis | |
|---|---|---|---|---|
| Criar uma assinatura | — |
Requer um escopo compatível com cada tipo de evento:
|
||
| Assinar |
Com a autenticação de usuário, esse método exige um escopo com suporte a pelo menos um tipo de evento para a assinatura.
Com a autenticação de apps (somente apps do Google Chat):
|
|||
| Listar assinaturas |
Com a autenticação de usuário, esse método exige um escopo com suporte a pelo menos um tipo de evento para a assinatura.
Com a autenticação de apps (somente apps do Google Chat):
|
|||
| Atualizar uma assinatura | — |
Requer um escopo compatível com cada tipo de evento:
|
||
| Reativar uma assinatura | — |
Requer um escopo compatível com cada tipo de evento:
|
||
| Excluir uma assinatura |
Com a autenticação de usuário, esse método exige um escopo com suporte a pelo menos um tipo de evento para a assinatura.
Com a autenticação de apps (somente apps do Google Chat):
|
|||
Escopos por tipo de evento
Ao chamar a API Google Workspace Events usando a autenticação do usuário, especifique um ou mais escopos que correspondam aos tipos de evento da assinatura.
A tabela a seguir mostra os escopos de autorização compatíveis com cada tipo de evento:
| Eventos | Tipos de evento | Escopos de autorização compatíveis | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| Uma mensagem for postada ou atualizada. |
|
|
||||||
| Uma reação é adicionada ou excluída, ou várias reações são alteradas. |
|
|
||||||
| Uma assinatura é criada, atualizada ou removida ou várias associações são alteradas. |
|
|
||||||
| Um espaço é atualizado ou excluído. |
|
|
||||||
| Google Meet | ||||||||
| Uma conferência começa ou termina. |
|
|
||||||
| Um participante entra ou sai de uma videoconferência. |
|
|
||||||
| Uma gravação foi gerada. |
|
|
||||||
| Uma transcrição foi gerada. |
|
|
||||||