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
Configurar a tela de consentimento do OAuth e escolher escopos para definir quais informações são exibidas para usuários e revisores de apps e registrar seu app para poder publicá-lo mais tarde.
Escopos da API Google Workspace Events
Para definir o nível de acesso concedido ao app, é necessário identificar e declarar os escopos de autorização. Um escopo de autorização é uma string de URI OAuth 2.0 que contém o nome do app do Google Workspace, o tipo de dados acessado e o nível de acesso. Os escopos são as solicitações do 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, escolha o escopo mais focado possível e evite solicitar escopos que o app não exige. Os usuários concedem acesso mais fácil a escopos limitados e claramente descritos.
Sempre que possível, recomendamos o uso de escopos não sensíveis, porque eles concedem escopo de acesso por arquivo e restringem o acesso a funcionalidades específicas necessárias por um app.
A API Google Workspace Events usa escopos de aplicativos do Google Workspace que oferecem suporte a assinaturas. Se o app já usa os escopos necessários para a assinatura, não é preciso adicionar outros para usar a API Google Workspace Events.
A tabela a seguir mostra 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 Google Chat acessem conversas e enviem mensagens. Dá acesso a todos os recursos disponíveis para apps de chat. | Não sensível | ||
https://www.googleapis.com/auth/chat.memberships |
Visualizar, 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 |
Acessar conversas e espaços no Google Chat. | 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 |
Confira as reações a uma mensagem no 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 |
Acesse mensagens e reações no Google Chat. | Restrito |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Permitir que os apps criem, modifiquem e leiam metadados sobre os 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 de reunião a que o usuário tenha acesso. | Sensível |
||
A coluna "Usage" na tabela anterior indica a sensibilidade de cada escopo, de acordo com as seguintes definições:
Não sensível: esses escopos oferecem o menor escopo de acesso de autorização e exigem apenas a verificação básica do app. Para informações sobre esse requisito, consulte Etapas para se preparar para a verificação.
Sensível: esses escopos fornecem acesso a dados específicos do usuário do Google autorizados pelo usuário para o app. É necessário passar por outra verificação do app. Para informações sobre esse requisito, consulte Etapas para apps que solicitam escopos sensíveis.
Restrito: esses escopos oferecem amplo acesso aos dados de 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 de API do Google: política de dados do usuário e Requisitos adicionais para escopos específicos da API. Se você armazenar dados de escopo restrito em servidores (ou transmitir), será necessário fazer uma avaliação de segurança.
Se o app exigir acesso a outras APIs do Google, você também poderá adicionar esses escopos. Para mais informações sobre os escopos das APIs 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 passe pelo processo de verificação do OAuth do Google. Leia as Perguntas frequentes sobre a verificação de APIs OAuth para determinar quando o app precisa passar pela verificação e que tipo de verificação é necessário. Consulte também os Termos de Serviço adicionais do Google Drive.
Tipos de autenticação obrigatória
Esta seção explica quais tipos de autenticação são necessários ou aceitos e fornece os escopos aceitos para cada método da API Google Workspace Events.
Para assinaturas de eventos do Google Chat, a API Google Workspace Events
oferece suporte à autenticação de usuários e apps para chamar alguns métodos. Se um método
de API oferecer suporte a ambas as credenciais, o tipo de credencial usado na chamada
vai afetar o resultado retornado. Por exemplo, se você chamar o método
subscriptions.list()
com a autenticação do usuário, a API vai retornar uma lista de assinaturas 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
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 com suporte | Autenticação de apps aceita (somente apps do Google Chat) | Escopos de autorização compatíveis | |
|---|---|---|---|---|
| Criar uma assinatura | — |
É necessário um escopo compatível para cada tipo de evento:
|
||
| Assinar |
Com a autenticação do usuário, esse método exige um escopo que ofereça 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 do usuário, esse método exige um escopo que ofereça 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 | — |
É necessário um escopo compatível para cada tipo de evento:
|
||
| Reativar uma assinatura | — |
É necessário um escopo compatível para cada tipo de evento:
|
||
| Excluir uma assinatura |
Com a autenticação do usuário, esse método exige um escopo que ofereça 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, é necessário especificar um ou mais escopos que correspondem 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 com suporte | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| Uma mensagem é 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 assinaturas 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 conferência. |
|
|
||||||
| Uma gravação foi gerada. |
|
|
||||||
| Uma transcrição foi gerada. |
|
|
||||||