Autenticação

Todas as chamadas da Google Ad Manager API precisam ser autorizadas por meio do OAuth2, um padrão aberto que permite que os usuários concedam permissões a aplicativos de terceiros para que o aplicativo possa interagir com os serviços da Web em nome do usuário. Com o OAuth2, seu aplicativo cliente da API Ad Manager pode acessar a conta do Ad Manager de um usuário sem precisar manipular ou armazenar o nome ou a senha desse usuário.

Gerar as credenciais do OAuth2

Siga estas etapas para gerar as credenciais do OAuth2.

1. Determinar o tipo de autenticação

Consulte a tabela abaixo para ver qual tipo de autenticação é mais apropriado para sua aplicação da API Ad Manager:

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

Escolha essa opção se precisar de acesso somente aos seus próprios dados do Ad Manager.

Saiba mais.
Aplicativo da Web

Escolha essa opção se você quiser autenticar como qualquer usuário que concede 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. Na lista suspensa do projeto, escolha Criar um novo projeto, insira um nome para ele e, se quiser, edite o ID fornecido. Clique em Criar.
  3. Na página "Credenciais", selecione Criar credenciais e selecione 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 que contém uma chave privada.
Aplicativo da Web
  1. Abra a página de credenciais do Console de APIs do Google.
  2. Na lista suspensa do projeto, escolha Criar um novo projeto, insira um nome para ele (e, se quiser, edite o ID fornecido) e clique em Criar.
  3. Na página "Credenciais", selecione Criar credenciais e selecione ID do cliente OAuth.
  4. Talvez você precise definir um nome de produto na página "Tela de consentimento". Se esse for o caso, clique em Configurar tela de consentimento, forneça as informações solicitadas e clique em Salvar para retornar à página "Credenciais".
  5. Selecione Aplicativo da Web para o Tipo de aplicativo. Siga as instruções para inserir origens do JavaScript, redirecionar URIs ou ambos.
  6. Clique em Criar.
  7. Na página exibida, copie o ID e a chave secreta do cliente para a área de transferência, porque eles serão necessários durante a configuração da biblioteca de cliente.
Captura de tela do ID e da chave secreta do cliente

3. Configurar a rede do Ad Manager

Se você for um desenvolvedor terceirizado, talvez seja necessário que seu cliente realize essa etapa por você.

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 ele acessasse as entidades na interface.
  6. Clique no botão Salvar. Uma mensagem será exibida, confirmando a adição da conta de serviço.
  7. Para ver os usuários da conta de serviço atual, 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 a conta de serviço ou o fluxo do app da Web do OAuth2 por conta própria.

Cenas dos bastidores

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

Cabeçalho de solicitação HTTP

O cabeçalho HTTP de cada solicitação à API Ad Manager precisa incluir um token de acesso da seguinte forma:

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 graus variados de acesso a várias APIs. Um parâmetro de variável chamado scope controla o conjunto de recursos e operações permitidos por um token de acesso. Durante a solicitação do token de acesso, o aplicativo envia um ou mais valores no parâmetro scope.

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

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