Este documento contém autorização específica da API do Gmail 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 Gmail
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.
A API Gmail é compatível com os seguintes escopos:
| Código do escopo | Descrição | Uso |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Gerencie rascunhos e envie e-mails quando você interagir com o . | Não confidencial |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Visualizar suas mensagens de e-mail quando você interagir com o . | Não confidencial |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Ver os metadados da mensagem de e-mail quando o complemento está em execução. | Sensível |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Ver suas mensagens de e-mail quando o complemento estiver em execução. | Sensível |
https://www.googleapis.com/auth/gmail.labels |
Somente criar, ler, atualizar e excluir marcadores. | Não confidencial |
https://www.googleapis.com/auth/gmail.send |
Envie apenas mensagens. Nenhum privilégio de leitura ou modificação na caixa de e-mails. | Sensível |
https://www.googleapis.com/auth/gmail.readonly |
Ler todos os recursos e os respectivos metadados, sem operações de gravação. | Restrito |
https://www.googleapis.com/auth/gmail.compose |
criar, ler, atualizar e excluir rascunhos; enviar mensagens e rascunhos; | Restrito |
https://www.googleapis.com/auth/gmail.insert |
Inserir e importar apenas mensagens. | Restrito |
https://www.googleapis.com/auth/gmail.modify |
Todas as operações de leitura/gravação, exceto exclusão imediata e permanente de conversas e mensagens, ignorando a Lixeira. | Restrito |
https://www.googleapis.com/auth/gmail.metadata |
Ler metadados de recursos, incluindo rótulos, registros de histórico e e-mails cabeçalhos da mensagem, mas não o corpo ou os anexos dela. | Restrito |
https://www.googleapis.com/auth/gmail.settings.basic |
Gerenciar configurações básicas de e-mail. | Restrito |
https://www.googleapis.com/auth/gmail.settings.sharing |
Gerencie configurações de e-mails confidenciais, incluindo regras de encaminhamento e aliases.
Observação:as operações protegidas por esse escopo são restritas a para uso administrativo. Elas só estão disponíveis para clientes do Google Workspace. usando uma conta de serviço com delegação em todo o domínio. |
Restrito |
https://mail.google.com/ |
Acesso total às caixas de correio da conta, incluindo exclusão permanente de linhas de execução e mensagens. Esse escopo só deverá ser solicitado se seu aplicativo precisa excluir conversas e mensagens de forma imediata e permanente, ignorando Lixo; todas as outras ações podem ser realizadas com escopos menos permissivos. | Restrito |
A coluna Uso na tabela acima indica a sensibilidade de cada escopo, de acordo com as seguintes definições:
Não confidencial: esses escopos fornecem a menor esfera de para autorização e exigem apenas uma verificação básica de apps. Para informações sobre esse requisito, consulte Etapas de preparação para a verificação
Sensíveis: esses escopos permitem acesso aos dados do usuário do Google e exigem um processo de verificação de escopo sensível. Para informações sobre esse requisito, consulte Serviços das APIs do Google: política de dados do usuário. Esses escopos não exigem uma avaliação de segurança.
Restrito: esses escopos dão amplo acesso aos dados do usuário do Google. exigem que você passe por um processo de verificação de escopo restrito. Para informações sobre esse requisito, consulte Serviços das APIs do Google: política de dados do usuário e Outros requisitos para escopos específicos da API. Se você armazenar ou transmitir dados de escopo restrito em servidores, vai precisar passar por uma avaliação de segurança.
Informações adicionais que regem o uso e o acesso às APIs do Gmail quando você solicitação para acessar dados do usuário pode ser encontrada Dados do usuário e política para desenvolvedores dos serviços da API Gmail.
Caso seu app precise de acesso a outras APIs do Google, adicione esses escopos também. Para mais informações sobre escopos das APIs do Google, ver Usar o OAuth 2.0 para acessar as APIs do Google
Verificação do OAuth
O uso de determinados escopos OAuth sensíveis pode exigir que seu app seja aprovado Processo de verificação do OAuth do Google. Leia as Perguntas frequentes sobre a verificação do OAuth para determinar quando seu app deve passar pela verificação e que tipo de e a verificação é obrigatória. Consulte também Serviços das APIs do Google: política de dados do usuário.