Você precisa de credenciais do OAuth 2.0 ao chamar a API Google Ads. Se você estiver fazendo chamadas de API com uma conta de administrador do Google Ads, também precisará especificar um cabeçalho login-customer-id com cada solicitação. Nesta página, descrevemos como definir esses valores e documentamos vários outros cabeçalhos HTTP específicos da API que são enviados e recebidos ao usar a interface REST.
Credenciais do OAuth 2.0
A API Google Ads usa o OAuth 2.0 para autorizar solicitações de API. O fluxo de autenticação do usuário e o fluxo da conta de serviço do OAuth 2.0 são compatíveis. Para mais detalhes, consulte OAuth 2.0 na API Google Ads.
Se você não conhece as APIs do Google, use a CLI gcloud ou o OAuth 2.0 Playground para testar as credenciais do OAuth 2.0 e a API Google Ads antes de escrever o código do seu app.
Recomendamos que você use uma das bibliotecas do OAuth 2.0 disponíveis em https://oauth.net/code/ para implementar os fluxos de trabalho de autorização do OAuth 2.0. No entanto, listamos as instruções do curl caso você precise implementar por conta própria.
Contas de serviço
Siga as etapas para configurar um projeto na nuvem do Google Cloud para a API Google Ads. Registre o e-mail da conta de serviço e a chave da conta de serviço. Em seguida, siga as instruções comuns no guia Contas de serviço para configurar a conta de serviço e acessar sua conta do Google Ads.
Autenticação do usuário
Siga as etapas para configurar um projeto do console do Google Cloud para a
API Google Ads. Registre o ID do cliente e a chave secreta do cliente. Em seguida, siga as instruções do fluxo do app para computador
ou as instruções do fluxo do app da Web
para gerar um token de atualização e um token de acesso. O scope a ser usado para acesso à API Google Ads é https://www.googleapis.com/auth/adwords.
Gerar novos tokens de acesso
Contas de serviço
Quando você tiver o e-mail da conta de serviço e a chave da conta de serviço,
siga o guia Como usar o OAuth 2.0 para aplicativos de servidor para servidor
para gerar um conjunto de declarações JWT, que pode ser trocado para receber
um token de acesso do OAuth 2.0. Selecione a guia HTTP/REST ao seguir o guia. O scope do OAuth 2.0 a ser usado para acesso à API Google Ads é
https://www.googleapis.com/auth/adwords. Além disso, é possível pular o parâmetro
sub ao construir o conjunto de declarações JWT, porque as etapas de configuração
concedem à conta de serviço acesso direto à conta do Google Ads, evitando
a necessidade de personificar um usuário do Google Ads.
Em seguida, use o token de acesso no cabeçalho HTTP Authorization de
cada chamada de API para a API Google Ads:
GET /v25/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
Autenticação do usuário
Depois de ter um ID do cliente, uma chave secreta do cliente e um token de
atualização do OAuth 2.0, você pode gerar um novo token de acesso para uso em chamadas de API com a
ferramenta de linha de comando curl:
curl \
--data "grant_type=refresh_token" \
--data "client_id=CLIENT_ID" \
--data "client_secret=CLIENT_SECRET" \
--data "refresh_token=REFRESH_TOKEN" \
https://www.googleapis.com/oauth2/v3/tokenEm seguida, use o token de acesso retornado pela solicitação curl no cabeçalho HTTP Authorization de cada chamada de API para a API Google Ads:
GET /v25/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
Cabeçalhos de solicitação
As seções a seguir descrevem os cabeçalhos HTTP necessários ou usados ao fazer solicitações para a API Google Ads.
ID de cliente de login
Para chamadas da API Google Ads feitas por um administrador em uma conta de cliente (ou seja, ao fazer login como administrador para fazer chamadas de API em uma das contas de cliente), também é necessário fornecer o cabeçalho HTTP login-customer-id. Esse valor representa o ID de cliente do Google Ads do gerente que está fazendo a chamada de API.
Incluir esse cabeçalho é equivalente a escolher uma conta na interface do Google Ads depois de fazer login ou clicar na imagem do perfil no canto superior direito da página. Ao especificar o ID do cliente, remova todos os hífens (—). Por exemplo: 1234567890, não 123-456-7890. Consulte o guia do modelo de acesso do Google Ads para saber mais sobre o ID de cliente de login.
GET /v25/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
ID de cliente vinculado
O cabeçalho "ID de cliente vinculado" é usado por parceiros (como provedores de análise de apps de terceiros ou parceiros de dados) ao agir em uma conta vinculada do Google Ads. Consulte o guia de estrutura de chamada de API para mais detalhes.
Authorization: Bearer ACCESS_TOKEN
login-customer-id: PARTNER_CUSTOMER_ID
linked-customer-id: ADVERTISER_CUSTOMER_ID
Cabeçalhos de resposta
Os cabeçalhos a seguir são retornados em respostas HTTP da API.
ID da solicitação
O request-id é uma string que identifica a solicitação de API de forma exclusiva. Ao depurar ou resolver problemas com chamadas de API específicas, o request-id é um identificador importante para ter em mãos ao entrar em contato com o suporte a desenvolvedores do Google.
request-id: 2a5Cj89VV7CNhya1DZjjrC