Authentication

Todas as chamadas da API Google Ad Manager precisam ser autorizadas pelo OAuth2, um padrão aberto que permite aos usuários conceder permissões a aplicativos de terceiros para que eles interajam com serviços da Web em nome do usuário. O OAuth2 permite que seu aplicativo cliente da API Ad Manager acesse a conta de um usuário sem precisar processar ou armazenar o nome de usuário ou a senha dele.

Gerar as credenciais do OAuth2

Siga estas etapas para gerar as credenciais do OAuth2.

1. Determinar seu tipo de autenticação

Confira na tabela abaixo qual tipo de autenticação é mais adequado para seu aplicativo da API Ad Manager:

Escolher o tipo de autenticação OAuth2
Conta de serviço

Escolha essa opção se você precisar acessar apenas seus próprios dados do Ad Manager.

Saiba mais.
Aplicativo da Web

Escolha essa opção se quiser autenticar como qualquer usuário que conceda permissão ao seu aplicativo para acessar os dados do Ad Manager.

Saiba mais.

2. Criar credenciais do OAuth2

Depois de determinar o tipo de autenticação, clique na guia correspondente abaixo e siga as instruções para gerar as credenciais do OAuth2:

Conta de serviço
  1. Abra a página de credenciais do Console de APIs do Google.
  2. No menu suspenso de projetos, escolha Criar um novo projeto, insira um nome para o projeto e, se quiser, edite o ID do projeto fornecido. Clique em Criar.
  3. Na página "Credenciais", selecione Criar credenciais e depois Chave da conta de serviço.
  4. Selecione Nova conta de serviço e JSON.
  5. Clique em Criar para fazer o download de um arquivo com uma chave privada.
Aplicativo da Web
  1. Abra a página de credenciais do Console de APIs do Google.
  2. No menu suspenso de projetos, escolha Criar um novo projeto, insira um nome para o projeto (e, opcionalmente, edite o ID do projeto fornecido) e clique em Criar.
  3. Na página "Credenciais", selecione Criar credenciais e depois ID do cliente OAuth.
  4. Talvez seja necessário definir um nome de produto na página "Tela de permissão". Se for o caso, clique em Configurar tela de permissão, forneça as informações solicitadas e clique em Salvar para voltar à página "Credenciais".
  5. Selecione Aplicativo da Web para o Tipo de aplicativo. Siga as instruções para inserir origens do JavaScript, URIs de redirecionamento ou ambos.
  6. Clique em Criar.
  7. Na página que aparece, copie o ID do cliente e a chave secreta do cliente para a área de transferência, porque você vai precisar deles ao configurar a biblioteca de cliente.
Captura de tela do ID e da chave secreta do cliente

3. Configurar sua rede do Ad Manager

Se você for um desenvolvedor terceirizado, talvez seja necessário pedir que seu cliente faça essa etapa.

Conta de serviço
  1. Acesse sua rede do Ad Manager.
  2. Clique na guia Administrador.
  3. Verifique se o acesso à API está ativado.
  4. Clique no botão Adicionar um usuário da conta de serviço.
  5. Preencha o formulário usando o e-mail da conta de serviço. O usuário da conta de serviço precisa receber permissões para acessar as entidades como se estivesse acessando-as na interface.
  6. Clique no botão Salvar. Uma mensagem vai aparecer, confirmando a adição da sua conta de serviço.
  7. Para ver os usuários da conta de serviço, acesse a guia "Usuários" e clique no filtro Conta de serviço.
Aplicativo da Web
  1. Acesse sua rede do Ad Manager.
  2. Clique na guia Administrador.
  3. Verifique se o acesso à API está ativado.

4. Configurar e usar uma biblioteca de cliente

Siga o guia adequado abaixo para usar as credenciais na sua biblioteca de cliente:

Se você optar por não usar uma das nossas bibliotecas de cliente, será necessário implementar o fluxo de conta de serviço ou app da Web do OAuth2 por conta própria.

Bastidores

Nossas bibliotecas de cliente cuidam automaticamente dos detalhes abordados abaixo. Portanto, continue lendo apenas se você quiser saber o que está acontecendo nos bastidores. Esta seção é destinada a usuários avançados que já conhecem a especificação do OAuth2 e sabem como usar o OAuth2 com as APIs do Google.

Cabeçalho da solicitação HTTP

O cabeçalho HTTP em todas as solicitações à API Ad Manager precisa incluir um token de acesso neste formato:

Authorization: Bearer ACCESS_TOKEN

Exemplo:

POST … HTTP/1.1
Host: …
Authorization: Bearer 1/fFAGRNJru1FTz70BzhT3Zg
Content-Type: text/xml;charset=UTF-8
Content-Length: …

<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope">
…
</soap:Envelope>

Escopo

Um único token de acesso pode conceder vários graus de acesso a várias APIs. Um parâmetro variável chamado scope controla o conjunto de recursos e operações permitidas por um token de acesso. Durante a solicitação de token de acesso, seu aplicativo envia um ou mais valores no parâmetro scope.

O Ad Manager tem apenas um escopo, mostrado abaixo. A autorização precisa ser feita no nível do usuário dentro do produto.

Escopo Permissões
https://www.googleapis.com/auth/admanager Veja e gerencie suas campanhas no Ad Manager.