Este documento contém autorizações específicas da API Google Workspace Events e informações de autenticação. Antes de ler este documento, informações gerais de autenticação e autorização do Google Workspace em Saiba mais sobre autenticação e autorização.
Configurar OAuth 2.0 para autorização
Configurar a tela de permissão OAuth e escolher escopos para definir quais informações são exibidas aos usuários e revisores do app 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, você precisa 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: dos usuários Dados da Conta do Google.
Quando o app é instalado, o usuário precisa validar os escopos utilizados pelo app. Geralmente, você deve escolher o escopo mais restrito possível e evite solicitar escopos que não são necessários para seu aplicativo. Mais usuários conceder acesso prontamente a escopos limitados e claramente descritos.
Quando possível, recomendamos o uso de escopos não confidenciais, porque eles concedem por arquivo escopo de acesso e restringe o acesso a uma funcionalidade específica de que um aplicativo precisa.
A API Google Workspace Events usa escopos do Google Workspace aplicativos compatíveis com assinaturas. Caso seu app já use os escopos necessários para sua assinatura, não é preciso adicionar para usar a API Google Workspace Events.
A tabela a seguir exibe os escopos compatíveis 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 as conversas e enviem mensagens. Oferece acesso a todos os recursos disponíveis nos apps do Chat. | Não confidencial | ||
https://www.googleapis.com/auth/chat.memberships |
Ver, adicionar e remover participantes em 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 os metadados (incluindo as configurações do histórico) no Google Chat. | Sensível | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Confira as conversas e os espaços no Google Chat. | Sensível |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Confira, adicione e exclua 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 |
Confira mensagens e reações no Google Chat. | Restrito |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Permitir que 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 |
Permitir que os apps leiam metadados sobre qualquer espaço para 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 confidencial: esses escopos oferecem o menor escopo de e exige apenas uma verificação básica de apps. Para informações sobre esse requisito, consulte Etapas de preparação para de verificação.
Sensíveis: esses escopos dão acesso a dados do usuário do Google específicos autorizado pelo usuário para o app. Ele exige que você passe por verificação adicional de apps. Para informações sobre esse requisito, consulte Etapas para aplicativos que solicitam escopos
Restrito: estes escopos dão acesso amplo 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: dados do usuário Política e Outros requisitos para APIs específicas Escopos. Se você armazenar ou transmitir dados de escopo restrito em servidores, será preciso passar por uma avaliação de segurança.
Caso seu app exija acesso a outras APIs do Google, adicione esses escopos . Para mais informações sobre os escopos da API do Google, consulte 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 prossiga com os requisitos Verificação de OAuth de análise de dados. Leia a verificação da API OAuth. Perguntas frequentes para determinar quando seu app deve passar pela verificação e que tipo de e a verificação é obrigatória. Consulte também os Termos Adicionais do Google Drive para Serviço.
Tipos de autenticação exigida
Esta seção explica quais tipos de autenticação são obrigatórios ou compatíveis, e fornece os escopos suportados para cada método da na API Google Workspace Events.
Para assinaturas de eventos do Google Chat, a API Google Workspace Events
oferece suporte à autenticação de usuário e de app para chamar alguns de seus métodos. Se uma API
oferece suporte para as duas credenciais, o tipo de credencial usado na chamada
afeta o resultado retornado. Por exemplo, se você chamar o método
subscriptions.list()
com autenticação do usuário, a API retorna uma lista de assinaturas que
o usuário autenticado pode acessar. Se você usa a autenticação do app, a API
retorna 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 de chat e API Google Chat
solicitações.
A tabela a seguir exibe os escopos e os tipos a autenticação é necessária ou compatível com cada API Google Workspace Events :
| Método | Autenticação de usuário obrigatória ou compatível | Autenticação de apps com suporte (somente apps do Google Chat) | Escopos de autorização compatíveis | |
|---|---|---|---|---|
| Criar uma assinatura | — |
Requer um escopo compatível com cada tipo de evento:
|
||
| Fazer uma assinatura |
Com a autenticação do usuário, esse método exige um escopo compatível com 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 seja compatível com 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 do usuário, esse método exige um escopo que seja compatível com 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 de usuário, você precisa especificar um ou mais escopos que correspondam aos tipos de evento do assinatura.
A tabela a seguir exibe 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 criar, atualizar ou remover assinaturas, ou são alterados. |
|
|
||||||
| 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. |
|
|
||||||