Autorização e cabeçalhos HTTP

Vídeo: Autenticação

Você precisa de credenciais de aplicativo OAuth 2.0 e um token de desenvolvedor 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. Esta página descreve como definir esses valores e documenta vários 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 credenciais de aplicativo para identificar e autorizar solicitações de API. É possível configurar clientes OAuth 2.0 e contas de serviço. Para mais detalhes sobre como configurar a autorização do lado do cliente, consulte OAuth2 na API Google Ads.

Se você não conhece as APIs do Google, use o oauth2l ou o OAuth 2.0 Playground para testar as credenciais do aplicativo e a API Google Ads antes de escrever o código do app.

Usar fluxos de apps da Web ou para computador

Siga as etapas para configurar um projeto do Console de APIs do Google para a API Google Ads. Anote o ID do cliente e a chave secreta do cliente e volte a esta página.

Depois de criar um cliente OAuth, siga as instruções do fluxo de apps para computador ou as instruções do fluxo de apps da Web para gerar um token de atualização e um token de acesso.

Como usar contas de serviço

Siga as instruções comuns no guia Contas de serviço para configurar o acesso da conta de serviço à API Google Ads.

Depois de configurar uma conta de serviço para acessar sua conta do Google Ads, siga o guia Como usar o OAuth 2.0 para aplicativos de servidor para servidor e selecione a guia HTTP/REST. O scope a ser usado para o acesso à API Google Ads é https://www.googleapis.com/auth/adwords.

Como gerar novos tokens de acesso

Depois de ter um ID de cliente, um secreto de cliente e um token de atualização, é possível 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/token

Em 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 /v19/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

Cabeçalhos de solicitação

Token de desenvolvedor

A API Google Ads também exige um token de desenvolvedor para fazer chamadas para a API. Você pode solicitar um token para sua conta de administrador diretamente na interface do Google Ads. Para mais detalhes sobre como configurar um token de desenvolvedor, consulte Receber seu token de desenvolvedor.

É necessário incluir o valor do token de desenvolvedor no cabeçalho HTTP developer-token de todas as chamadas de API para a API Google Ads:

GET /v19/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

ID de cliente de login

Para chamadas da API Google Ads feitas por um administrador para uma conta de cliente (ou seja, ao fazer login como administrador para fazer chamadas de API para 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 administrador 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 sua foto do perfil no canto superior direito da página. Ao especificar o ID do cliente, remova todos os hifens (—), por exemplo: 1234567890, não 123-456-7890.

GET /v19/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

ID de cliente vinculado

Esse cabeçalho só é usado por fornecedores de análise de aplicativos de terceiros ao fazer upload de conversões para uma conta vinculada do Google Ads. Consulte o guia da estrutura de chamadas de API para mais detalhes.

...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID

Cabeçalhos de resposta

Os cabeçalhos a seguir são retornados nas respostas HTTP da API.

ID da solicitação

O request-id é uma string que identifica exclusivamente a solicitação da API. 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 ao desenvolvedor do Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC
Anterior
Introdução
Próxima
Visão geral