Autorização e cabeçalhos HTTP

Vídeo: Autenticação

Você precisa das credenciais do aplicativo OAuth 2.0 e de uma função de desenvolvedor token ao chamar a API Google Ads. Se você fizer chamadas de API com uma conta de administrador do Google Ads, também vai precisar especificar um login-customer-id cabeçalho a cada solicitação. Esta página descreve como definir esses valores e documenta vários cabeçalhos HTTP adicionais 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 do aplicativo para identificar e autorizar APIs solicitações. Tanto os clientes OAuth 2.0 quanto os serviços contas podem ser configuradas. Para mais detalhes sobre como configurar a autorização do lado do cliente, consulte OAuth2 na API Google Ads.

Se você nunca usou as APIs do Google, pode usar oauth2l ou o OAuth 2.0 Playground para testar credenciais do aplicativo e a API Google Ads antes de escrever o código da sua app.

Como usar fluxos de apps da Web ou para computadores

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

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

Como usar contas de serviço

Siga as instruções comuns na seção Informações Contas guia para configurar o acesso à conta de serviço para a API Google Ads.

Depois de configurar uma conta de serviço para acessar sua conta do Google Ads, siga as Uso do OAuth 2.0 para servidor para servidor Aplicativos certificando-se de selecionar a guia HTTP/REST. O scope que será usado na API Google Ads é https://www.googleapis.com/auth/adwords.

Gerar novos tokens de acesso

Com o ID do cliente, a chave secreta do cliente e o token de atualização, será possível gerar um novo token de acesso para usar 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 na Cabeçalho HTTP Authorization de cada chamada de API à API Google Ads:

GET /v17/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 no Interface do Google Ads. Para obter mais detalhes sobre como configurar com um token de desenvolvedor, consulte Receba seu token de desenvolvedor.

É necessário incluir o valor do token de desenvolvedor no arquivo HTTP developer-token cabeçalho de cada chamada da API Google Ads:

GET /v17/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, quando fizer login como administrador para fazer chamadas de API para uma de suas contas de cliente), você também precisam fornecer o cabeçalho HTTP login-customer-id. Esse valor representa o ID de cliente do Google Ads do gerente que faz a chamada de API.

A inclusão desse cabeçalho equivale a escolher uma conta na interface do Google Ads depois de fazer login ou clicar em sua imagem de perfil no canto superior direito de da página. Ao especificar o ID de cliente, remova os hifens (—), por exemplo: 1234567890, não 123-456-7890.

GET /v17/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 provedores de análise de aplicativos de terceiros quando fazendo o upload de conversões para uma conta do Google Ads vinculada padrão. Consulte a Guia de estrutura de chamada 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 em respostas HTTP da API.

ID da solicitação

O request-id é uma string que identifica de forma exclusiva a solicitação de API. Quando depurar ou solucionar problemas com chamadas de API específicas, o request-id; é um identificador importante ao entrar em contato com o Google Developers suporte.

request-id: 2a5Cj89VV7CNhya1DZjjrC