As chamadas para a API Search Ads 360 Reporting geralmente são feitas pela biblioteca de cliente. Consulte a explicação sobre bibliotecas de cliente para mais informações. No entanto, o conhecimento sobre a estrutura dos detalhes da solicitação pode ser útil durante o teste e a depuração.
A API Search Ads 360 Reporting é uma API gRPC com vinculações REST. Isso significa que é possível fazer chamadas à API de duas maneiras alternativas:
- Método preferido
- Use uma biblioteca de cliente:
- Crie o corpo da solicitação como um buffer de protocolo.
- Envie a solicitação ao servidor usando HTTP/2.
- Desserialize a resposta para um buffer de protocolo.
- Interprete os resultados.
- Método alternativo opcional
- Use REST:
- Crie o corpo da solicitação como um objeto JSON.
- Envie a solicitação ao servidor usando HTTP 1.1.
- Desserialize a resposta como um objeto JSON.
- Interprete os resultados.
Consulte as APIs do Google Cloud para mais informações.
As seções a seguir se aplicam aos protocolos gRPC e REST.
Nomes de recursos
A maioria dos objetos na API é identificada pelas respectivas strings de nome de recurso. Essas strings também servem como URLs ao usar a interface REST.
Consulte Referência > REST para mais informações sobre os recursos compatíveis e a representação de caminho deles. O mesmo formato é usado para outros serviços.
IDs compostos
Se o ID de um objeto não for globalmente exclusivo, um ID composto para esse objeto será criado incluindo o ID pai e um til (~) antes do ID.
Por exemplo, como um ID de anúncio do grupo de anúncios não é globalmente exclusivo, o ID do objeto pai (grupo de anúncios) é anexado a ele, resultando em um ID composto exclusivo.
Exemplo: AdGroupId de 123 + ~ + AdGroupAdId de 45678
= ID do anúncio composto do grupo de anúncios de 123~45678.
Cabeçalhos de solicitação
Os cabeçalhos HTTP (ou metadados gRPC) nas seções a seguir precisam ser incluídos no corpo da solicitação.
Autorização
É necessário incluir um token de acesso OAuth2 no formulário:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
O token deve identificar uma conta de administrador que atua em nome de um cliente ou um anunciante que gerencia diretamente a própria conta de subadministrador ou de cliente. Consulte Sobre as contas de administrador do Search Ads 360 e Autenticação para saber mais.
Cabeçalho do ID do cliente de login
O cabeçalho login-customer-id é necessário ao usar uma conta de administrador para acessar uma conta de subadministrador ou de cliente. Ele não é necessário para acessar diretamente uma conta de subadministrador ou de cliente. Embora não seja estritamente necessário, recomendamos sempre especificar o login-customer-id para usuários autenticados que
têm acesso a mais de uma conta. Isso evita ambiguidade e impede
a definição não intencional do contexto para a conta incorreta.
A solicitação precisa incluir o ID de cliente do usuário autorizado, sem hífens (-), por exemplo:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
Definir o login-customer-id é 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.
Cabeçalhos de resposta
Os cabeçalhos a seguir (ou metadados finais do gRPC) são retornados com o corpo da resposta. Recomendamos que você registre esses valores para fins de depuração.
ID da solicitação
O cabeçalho request-id é uma string que identifica exclusivamente a solicitação.