As credenciais são usadas para receber um token de acesso dos servidores de autorização do Google. Assim, o app pode chamar as APIs do Google Workspace. Este guia descreve como escolher e configurar as credenciais de que o app precisa.
Para definições de termos encontrados nesta página, consulte Visão geral da autenticação e autorização.
Tipos de credenciais
As credenciais necessárias dependem do tipo de dados, da plataforma e da metodologia de acesso do app. Há três tipos de credenciais disponíveis:
Chave de API: use essa credencial para acessar anonimamente os dados disponíveis publicamente no app.
ID do cliente OAuth: use essa credencial para fazer a autenticação como usuário final e acessar os dados. Exige que o app solicite e receba o consentimento do usuário.
Conta de serviço: use essa credencial para autenticar como uma conta de serviço robô ou para acessar recursos em nome dos usuários do Google Workspace ou do Cloud Identity por meio da delegação em todo o domínio.
Dica:use a opção "Ajude-me a escolher" no Console do Google Cloud a ser aberta para escolher a credencial correta com base em uma série de perguntas.
Credenciais da chave de API
Uma chave de API é uma string longa que contém letras maiúsculas e minúsculas, números,
sublinhados e hifens, como AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe.
Esse método de autenticação é usado para acessar anonimamente dados disponíveis
publicamente, como arquivos do Google Workspace compartilhados com a configuração de compartilhamento "Qualquer pessoa na Internet
com este link". Para mais detalhes, consulte Como usar chaves de API.
Para criar uma chave de API, siga estas etapas:
- No console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > Chave de API.
- A nova chave de API será exibida.
- Clique em Copiar para copiar a chave de API a ser usada no código do app. A chave de API também pode ser encontrada na seção "Chaves de API" das credenciais do projeto.
- Clique em Restringir chave para atualizar as configurações avançadas e limitar o uso da chave de API. Para mais detalhes, consulte Como aplicar restrições de chave de API.
Credenciais do ID do cliente OAuth
Para se autenticar como usuário final e acessar os dados do usuário no seu app, crie um ou mais IDs do cliente OAuth 2.0. Um ID do cliente é usado para identificar um único app nos servidores OAuth do Google. Se o aplicativo for executado em várias plataformas, crie um ID do cliente separado para cada uma.Escolha seu tipo de aplicativo para ver instruções específicas sobre como criar um ID do cliente OAuth:
Aplicativo da Web
- No Console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > Aplicativo da Web.
- No campo Nome, digite um nome para a credencial. Esse nome só é mostrado no console do Google Cloud.
- Adicione URIs autorizados relacionados ao seu app:
- Apps do lado do cliente (JavaScript): em Origens JavaScript autorizadas, clique em Adicionar URI. Em seguida, digite um URI para usar nas solicitações do navegador. Identifica os domínios de que seu aplicativo pode enviar solicitações de API para o servidor OAuth 2.0.
- Apps do lado do servidor (Java, Python e outros): em URIs de redirecionamento autorizados, clique em Adicionar URI. Em seguida, insira um URI de endpoint para o qual o servidor OAuth 2.0 possa enviar respostas.
- Clique em Criar. A tela criada pelo cliente OAuth é exibida, mostrando seu novo ID e chave secreta do cliente.
Anote o ID do cliente. Chaves secretas do cliente não são usadas em aplicativos da Web.
- Clique em OK. A credencial recém-criada aparece em IDs do cliente OAuth 2.0.
- Opcional: se você estiver criando credenciais como pré-requisito para um guia de início rápido do JavaScript, também precisará gerar uma chave de API.
Android
- No Console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > Android.
- No campo "Nome", digite um nome para a credencial. Esse nome só é mostrado no console do Google Cloud.
- No campo "Nome do pacote", insira o nome do pacote do seu arquivo
AndroidManifest.xml. - No campo "Impressão digital do certificado SHA-1", insira a impressão digital do certificado SHA-1 gerada.
- Clique em Criar. A tela de criação do cliente OAuth aparece, mostrando seu novo ID do cliente.
- Clique em OK. A credencial recém-criada aparece em "IDs do cliente OAuth 2.0".
iOS
- No Console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > iOS.
- No campo "Nome", digite um nome para a credencial. Esse nome só é mostrado no console do Google Cloud.
- No campo "ID do pacote", insira o identificador do pacote conforme listado no arquivo
Info.plistdo app. - Opcional: se o seu aplicativo aparecer na App Store da Apple, digite o ID da App Store.
- Opcional: no campo "ID da equipe", digite a string de 10 caracteres exclusiva, gerada pela Apple e atribuída à sua equipe.
- Clique em Criar. A tela criada pelo cliente OAuth é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada aparece em "IDs do cliente OAuth 2.0".
App Chrome
- No Console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > App Chrome.
- No campo "Nome", digite um nome para a credencial. Esse nome só é mostrado no console do Google Cloud.
- No campo "ID do aplicativo", insira a string exclusiva de 32 caracteres do app. O valor do ID pode ser encontrado no URL da Chrome Web Store do seu app e no Painel do desenvolvedor da Chrome Web Store.
- Clique em Criar. A tela criada pelo cliente OAuth é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada aparece em "IDs do cliente OAuth 2.0".
App para computador
- No Console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > App para computador.
- No campo Nome, digite um nome para a credencial. Esse nome só é mostrado no console do Google Cloud.
- Clique em Criar. A tela criada pelo cliente OAuth é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada aparece em IDs do cliente OAuth 2.0.
TVs e dispositivos de entrada limitada
- No Console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > TVs e dispositivos de entrada limitada.
- No campo "Nome", digite um nome para a credencial. Esse nome só é mostrado no console do Google Cloud.
- Clique em Criar. A tela criada pelo cliente OAuth é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada aparece em "IDs do cliente OAuth 2.0".
Plataforma Universal do Windows (UWP)
- No Console do Google Cloud, acesse Menu > APIs e serviços > Credenciais.
- Clique em Criar credenciais > ID do cliente OAuth.
- Clique em Tipo de aplicativo > Plataforma Universal do Windows (UWP).
- No campo "Nome", digite um nome para a credencial. Esse nome só é mostrado no console do Google Cloud.
- No campo "ID da loja", insira o valor exclusivo de 12 caracteres do ID da Microsoft. Você pode encontrar esse ID no URL da Microsoft Store do app e na Central de parceiros.
- Clique em Criar. A tela criada pelo cliente OAuth é exibida, mostrando seu novo ID e chave secreta do cliente.
- Clique em OK. A credencial recém-criada aparece em "IDs do cliente OAuth 2.0".
Credenciais da conta de serviço
Uma conta de serviço é um tipo especial de conta usada por um aplicativo, em vez de uma pessoa. É possível usar uma conta de serviço para acessar dados ou executar ações pela conta de robô ou para acessar dados em nome de usuários do Google Workspace ou do Cloud Identity. Para mais informações, consulte as Noções básicas sobre contas de serviço.Crie uma conta de serviço
- No console do Google Cloud, acesse Menu > IAM e administrador > Contas de serviço.
- Clique em Criar conta de serviço.
- Preencha os detalhes da conta de serviço e clique em Criar e continuar.
- Opcional: atribua papéis à conta de serviço para conceder acesso aos recursos do seu projeto do Google Cloud. Para mais detalhes, consulte Como conceder, alterar e revogar o acesso a recursos.
- Clique em Continuar.
- Opcional: insira usuários ou grupos que possam gerenciar e realizar ações com essa conta de serviço. Para mais detalhes, consulte Como gerenciar a representação de uma conta de serviço.
- Clique em Concluído.
Criar credenciais para uma conta de serviço
Você precisa de credenciais na forma de um par de chaves públicas/privadas. Essas credenciais são usadas pelo código para autorizar ações da conta de serviço no app.Para receber credenciais para sua conta de serviço:
- No console do Google Cloud, acesse Menu > IAM e administrador > Contas de serviço.
- Selecione sua conta de serviço.
- Clique em Chaves > Adicionar chave > Criar nova chave.
- Selecione JSON e clique em Criar.
Seu novo par de chave pública/privada é gerado e o download é feito para sua máquina como um novo arquivo. Esse arquivo é a única cópia da chave. Para informações sobre como armazenar sua chave com segurança, consulte Como gerenciar chaves de conta de serviço.
- Clique em Fechar.
Opcional: configurar a delegação em todo o domínio para uma conta de serviço
Para chamar APIs em nome de usuários em uma organização do Google Workspace, sua conta de serviço precisa receber a delegação de autoridade em todo o domínio no Admin Console do Google Workspace por uma conta de superadministrador. Para mais informações, consulte Delegar autoridade em todo o domínio a uma conta de serviço (em inglês).Para configurar a delegação de autoridade em todo o domínio em uma conta de serviço, faça o seguinte:
- No console do Google Cloud, acesse Menu > IAM e administrador > Contas de serviço.
- Selecione sua conta de serviço.
- Clique em Mostrar configurações avançadas.
- Em "Delegação em todo o domínio", encontre o "ID do cliente" da sua conta de serviço. Clique em Copiar para copiar o valor do ID do cliente para a área de transferência.
Se você tiver acesso de superadministrador à conta relevante do Google Workspace, clique em Ver o Admin Console do Google Workspace, faça login usando uma conta de usuário de superadministrador e siga as etapas abaixo.
Se você não tiver acesso de superadministrador à conta relevante do Google Workspace, entre em contato com um superadministrador da conta e envie o ID do cliente da sua conta de serviço e a lista de escopos do OAuth para que ele conclua as etapas a seguir no Admin Console.
- No Google Admin Console, acesse Menu > Segurança > Controle de dados e acesso > Controles de API.
- Clique em Gerenciar a delegação em todo o domínio.
- clique em Add new;
- No campo "ID do cliente", cole o ID que você copiou na etapa 5.
- No campo "Escopos do OAuth", digite uma lista delimitada por vírgulas com os escopos exigidos pelo aplicativo. Esse é o mesmo conjunto de escopos que você definiu ao configurar a tela de permissão OAuth.
- Clique em Autorizar.
Próxima etapa
Você já pode desenvolver seu app no Google Workspace. Veja a lista de produtos para desenvolvedores do Google Workspace e como encontrar ajuda.