Autorização e cabeçalhos HTTP

Você precisa de credenciais do aplicativo OAuth 2.0 ao chamar a API Search Ads 360 Reporting. Se você estiver fazendo chamadas de API como uma conta de administrador do Search Ads 360, também precisará especificar um cabeçalho login-customer-id em cada solicitação. Esta página descreve como definir esses valores e documenta 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 Search Ads 360 Reporting usa credenciais de aplicativo para identificar e autorizar solicitações de API. Os clientes OAuth 2.0 podem ser configurados. Todas as chamadas da API Search Ads 360 Reporting precisam ser autorizadas pelo OAuth2. O OAuth2 permite que o app cliente da API Search Ads 360 Reporting acesse a conta do usuário no Search Ads 360 sem precisar processar ou armazenar as informações de login do usuário.

Se você é novo nas APIs do Google, use o oauth2l ou o OAuth 2.0 Playground para testar as credenciais do aplicativo e a API Search Ads 360 antes de escrever o código do seu app. Também é possível gerar um token de atualização do OAuth executando o script de geração de credenciais do usuário fornecido.

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:

Observação: a versão v3 no URL do endpoint OAuth não tem relação com a versão da API Search Ads 360 Reporting e não deve mudar ao migrar para versões mais recentes da API Search Ads 360 Reporting.

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 Search Ads 360 Reporting:

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

Cabeçalhos de solicitação

ID de cliente de login

Para chamadas da API Search Ads 360 Reporting 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 do cliente do Search Ads 360 do administrador que faz a chamada de API.

Incluir esse cabeçalho é equivalente a escolher uma conta na interface do Search Ads 360 depois de fazer login ou clicar na imagem do seu 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 /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_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