Todas as chamadas da API Google Ad Manager precisam ser autorizadas por meio do OAuth2, um padrão aberto que permite aos usuários conceder permissões a aplicativos de terceiros para que o aplicativo possa interagir com os serviços da Web em nome do usuário. O OAuth2 permite que o aplicativo cliente da API Ad Manager acesse a conta do Ad Manager de um usuário, sem precisar processar ou armazenar o nome de usuário ou a senha do usuário.
Gerar as credenciais do OAuth2
Siga as etapas abaixo para gerar as credenciais do OAuth2.
1. Determinar seu tipo de autenticação
Consulte a tabela abaixo para ver qual tipo de autenticação é mais apropriado para seu aplicativo da API Ad Manager:
Escolher seu tipo de autenticação OAuth2 | |
---|---|
Conta de serviço |
Escolha essa opção se você precisar de acesso somente aos 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 aplicativo para acessar os dados do Ad Manager dele. 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:
- Abra a página de credenciais do Console de APIs do Google.
- Na lista suspensa do projeto, escolha Criar um novo projeto, insira um nome para ele e edite o ID fornecido. Clique em Criar.
- Na página "Credenciais", selecione Criar credenciais e Chave da conta de serviço.
- Selecione Nova conta de serviço e selecione JSON.
- Clique em Criar para fazer o download de um arquivo que contenha uma chave privada.
- Abra a página de credenciais do Console de APIs do Google.
- Na lista suspensa do projeto, escolha Criar um novo projeto, insira um nome para o projeto e, se preferir, edite o ID do projeto fornecido e clique em Criar.
- Na página "Credenciais", selecione Criar credenciais e ID do cliente OAuth.
- Talvez seja necessário definir um nome de produto na página da tela de consentimento. Se for o caso, clique em Configurar tela de consentimento, insira as informações solicitadas e clique em Salvar para retornar à página "Credenciais".
- Selecione Aplicativo da Web para o Tipo de aplicativo. Siga as instruções para inserir origens do JavaScript, URIs de redirecionamento ou ambos.
- Clique em Criar.
- Na página exibida, copie o ID do cliente e a chave secreta do cliente para a área de transferência, porque você precisará deles quando configurar sua biblioteca de cliente.

3. Configurar sua rede do Ad Manager
Se você é um desenvolvedor terceirizado, peça ao seu cliente para fazer essa etapa.
- Acesse sua rede do Ad Manager.
- Clique na guia Administrador.
- Verifique se o acesso à API está ativado.
- Clique no botão Adicionar um usuário da conta de serviço.
- 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 tivesse acesso às entidades na IU.
- Clique no botão Save. Uma mensagem será exibida para confirmar a adição da conta de serviço.
- Para visualizar os usuários atuais da conta de serviço, acesse a guia "Usuários" e clique no filtro Conta de serviço.
- Acesse sua rede do Ad Manager.
- Clique na guia Administrador.
- Verifique se o acesso à API está ativado.
4. Configurar e usar uma biblioteca de cliente
Siga o guia apropriado abaixo para usar as credenciais na sua biblioteca de cliente:
Java
.NET
Python
PHP
Ruby
Se você decidir não usar uma das nossas bibliotecas de cliente, precisará implementar o fluxo da conta de serviço ou do app da Web do OAuth2 por conta própria.
Bastidores
Nossas bibliotecas de cliente cuidam automaticamente dos detalhes abordados abaixo. Portanto, leia apenas se você tiver interesse no que acontece nos bastidores. Esta seção é destinada a usuários avançados que já estão familiarizados com 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 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 diferentes graus de acesso a várias APIs. Um
parâmetro de variável chamado scope
controla o conjunto de recursos e
operações que um token de acesso permite. Durante a solicitação do 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 realizada no nível do usuário no produto.
Escopo | Permissões |
---|---|
https://www.googleapis.com/auth/dfp |
Ver e gerenciar suas campanhas no Ad Manager. |