Este guia descreve a estrutura comum de todas as chamadas de API.
Se você estiver usando uma biblioteca de cliente para interagir com a API, não vai precisar se preocupar com os detalhes da solicitação. No entanto, saber um pouco sobre eles pode ser útil durante os testes e a depuração.
A API Google Ads é uma API gRPC com vinculações REST. Isso significa que há duas maneiras de fazer chamadas à API.
[Preferencial] Crie o corpo da solicitação como um buffer de protocolo, envie-o ao servidor usando HTTP/2, desserialize a resposta para um buffer de protocolo e interprete os resultados. A maior parte da documentação descreve o uso do gRPC.
[Opcional] Crie o corpo da solicitação como um objeto JSON, envie-o para o servidor usando HTTP 1.1, desserialize a resposta como um objeto JSON e interprete os resultados. Consulte o guia da interface REST para mais informações sobre o uso de REST.
Nomes de recursos
A maioria dos objetos na API é identificada pelas strings de nome de recurso. Essas strings também servem como URLs ao usar a interface REST. Consulte os nomes de recursos da interface REST para a estrutura deles.
IDs compostos
Se o ID de um objeto não for globalmente exclusivo, um ID composto para esse objeto será construído anexando o ID pai e um til (~).
Por exemplo, como um ID de anúncio do grupo de anúncios não é globalmente exclusivo, anexamos o ID do objeto pai (grupo de anúncios) a ele para criar um ID composto exclusivo:
AdGroupId
de123
+~
+AdGroupAdId
de45678
= ID do anúncio do grupo de anúncios composto de123~45678
.
Cabeçalhos de solicitação
Estes são os cabeçalhos HTTP (ou metadados grpc) que acompanham o corpo na solicitação:
Autorização
É necessário incluir um token de acesso OAuth2 no formato de
Authorization: Bearer YOUR_ACCESS_TOKEN
que identifique uma
conta de administrador agindo em nome de um cliente ou um anunciante que gerencia
diretamente a própria conta. Instruções para recuperar um token de acesso
estão disponíveis no guia do OAuth2. Um token de acesso é válido por uma hora após sua aquisição. Quando ele expirar, atualize-o para recuperar um novo. Nossas bibliotecas de cliente atualizam automaticamente os tokens expirados.
token de desenvolvedor
Um token de desenvolvedor é uma string de 22 caracteres que identifica exclusivamente um desenvolvedor da API Google Ads. Um exemplo de string de token de desenvolvedor é
ABcdeFGH93KL-NOPQ_STUv
. O token de desenvolvedor precisa ser incluído na
forma de developer-token : ABcdeFGH93KL-NOPQ_STUv
.
login-customer-id
Esse é o ID de cliente do cliente autorizado a ser usado na solicitação, sem hifens (-
). Caso seu acesso à conta de cliente seja feito por uma conta de administrador, esse cabeçalho é obrigatório e precisa ser definido como o ID de cliente dessa conta.
https://googleads.googleapis.com/v16/customers/1234567890/campaignBudgets:mutate
Definir o login-customer-id
é equivalente a escolher uma conta na interface do Google Ads depois de fazer login ou clicar na sua imagem de perfil no canto superior direito. Se você não incluir esse cabeçalho, o padrão será o cliente operacional.
id-cliente-vinculado
Esse cabeçalho só é usado por provedores de análise de aplicativos de terceiros ao fazer o upload de conversões para uma conta vinculada do Google Ads.
Considere o cenário em que os usuários na conta A
fornecem acesso de leitura e edição
às suas entidades para a conta B
usando um
ThirdPartyAppAnalyticsLink
.
Após a vinculação, um usuário na conta B
pode fazer chamadas de API na conta A
, de acordo com as permissões fornecidas pelo link. Nesse caso, as permissões de chamada de API para a conta A
são determinadas pela vinculação de terceiros à conta B
, e não pela relação entre a conta de administrador e a conta usada em outras chamadas de API.
O provedor de análise de aplicativos de terceiros faz uma chamada de API da seguinte maneira:
linked-customer-id
: a conta de análise de aplicativos de terceiros que faz upload dos dados (contaB
).customer-id
: a conta do Google Ads para a qual os dados são enviados (contaA
).- Cabeçalho
login-customer-id
eAuthorization
: uma combinação de valores para identificar um usuário que tem acesso à contaB
.
Cabeçalhos de resposta
Os cabeçalhos a seguir (ou metadados finais de gRPC) são retornados com o corpo da resposta. Recomendamos que você registre esses valores para fins de depuração.
request-id
O request-id
é uma string que identifica exclusivamente essa solicitação.