Este documento contém informações de autorização e autenticação específicas da API Google Workspace Events. Antes de ler este documento, confira 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 do OAuth e escolha escopos para definir quais informações são mostradas aos usuários e revisores de apps e registre o app para poder publicá-lo mais tarde.
Escopos da API Google Workspace Events
Para definir o nível de acesso concedido ao seu app, é necessário identificar e declarar escopos de autorização. Um escopo de autorização é uma string URI do OAuth 2.0 que contém o nome do app do Google Workspace, o tipo de dados acessados e o nível de acesso. Os escopos são 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. Em geral, escolha o escopo mais restrito possível e evite solicitar escopos que o app não precisa. Os usuários concedem acesso mais facilmente a escopos limitados e claramente descritos.
Quando possível, recomendamos usar escopos não sensíveis, já que eles concedem escopo de acesso por arquivo e restringem o acesso à funcionalidade específica necessária para um app.
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 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 vejam 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 |
Ver, 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 |
Criar conversas e espaços e ver ou atualizar os metadados (incluindo as configurações do histórico) no Google Chat. | Sensível | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Ver 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 |
Acessar 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 |
Ver mensagens e reações no Google Chat. | Restrito |
||
| Google Drive | ||||
https://www.googleapis.com/auth/drive.file |
Criar ou modificar arquivos do Drive abertos com um app ou compartilhados com um app pelo usuário ao usar a API Google Picker ou o seletor de arquivos do app. | Não sensível | ||
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 Drive. | Restrito | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Permitir que os apps criem, modifiquem e leiam metadados sobre espaços de reunião criados pelo seu app. | Sensível |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Permite que os apps leiam metadados sobre qualquer espaço de reunião 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 sensíveis: esses escopos fornecem o menor escopo de acesso de autorização e exigem apenas a verificação básica do app. Para mais informações sobre esse requisito, consulte Requisitos de verificação.
Sensíveis: esses escopos fornecem acesso a dados específicos do usuário do Google autorizados pelo usuário para seu app. Eles exigem que você passe por uma verificação adicional do app. Para informações sobre esse requisito, consulte Requisitos de escopo sensível e restrito.
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 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ê armazenar (ou transmitir) dados de escopo restrito em servidores, será necessário passar por uma avaliação de segurança.
Se o app precisar de acesso a outras APIs do Google, adicione esses escopos também. 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 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 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 compatíveis para cada método da API Google Workspace Events.
Para assinaturas de eventos do Google Chat, a API Google Workspace Events
aceita a autenticação de usuários e apps para chamar alguns dos métodos dela. Se um método de API aceitar os dois tipos de credenciais, o tipo usado na chamada vai afetar o resultado retornado. Por exemplo, se você chamar o método
subscriptions.list
com autenticação de usuário, a API vai retornar uma lista de assinaturas a que o usuário autenticado tem acesso. Se você usa a autenticação de app, a API
retorna uma lista de assinaturas a 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 obrigatória ou compatível | Autenticação de app compatível (somente apps do Google Chat) | Escopos de autorização compatíveis | |
|---|---|---|---|---|
| Criar uma assinatura | — |
Exige um escopo compatível para cada tipo de evento:
|
||
| Assinar |
Com a autenticação do usuário, esse método exige um escopo que aceite pelo menos um tipo de evento para a assinatura.
Com a autenticação de app (somente apps do Google Chat):
|
|||
| Listar assinaturas |
Com a autenticação do usuário, esse método exige um escopo que aceite pelo menos um tipo de evento para a assinatura.
Com a autenticação de app (somente apps do Google Chat):
|
|||
| Atualizar uma assinatura | — |
Exige um escopo compatível para cada tipo de evento:
|
||
| Reativar uma assinatura | — |
Exige 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 aceite pelo menos um tipo de evento para a assinatura.
Com a autenticação de app (somente apps do Google Chat):
|
|||
Escopos por tipo de evento
Ao chamar a API Google Workspace Events usando a autenticação do usuário, você precisa 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 aceitos | ||||||
|---|---|---|---|---|---|---|---|---|
| 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 Drive | ||||||||
| Um arquivo é criado, alterado, movido, excluído, enviado para a lixeira ou removido dela. |
|
|
||||||
| Uma proposta de acesso é criada ou resolvida em um arquivo. |
|
|
||||||
| 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. |
|
|
||||||