Autorização e cabeçalhos HTTP

Você precisa de credenciais de 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 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 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 Reporting do Search Ads 360 acesse a conta de um usuário sem precisar processar ou armazenar as informações de login dele.

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 Reporting do Search Ads 360 antes de escrever o código do 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 do cliente, um secret do cliente e um token de atualização, 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/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 de relatórios do Search Ads 360:

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 em uma conta de cliente (ou seja, ao fazer login como administrador para fazer chamadas de API em uma das contas de cliente), você também precisa fornecer o cabeçalho HTTP login-customer-id. Esse valor representa o ID de cliente do Search Ads 360 do gerente que está fazendo 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 sua imagem de 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.

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 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 para desenvolvedores do Google.

request-id: 2a5Cj89VV7CNhya1DZjjrC