Este guia descreve a estrutura comum de todas as chamadas de API.
Se você usa uma biblioteca de cliente para interagir com a API, não precisa se preocupar com os detalhes da solicitação subjacente. No entanto, saber um pouco sobre eles pode ser útil ao testar e depurar.
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 a um buffer de protocolo e interprete os resultados. A maior parte da nossa documentação descreve o uso do gRPC.
[Opcional] Crie o corpo da solicitação como um objeto JSON, envie-o ao servidor usando HTTP 1.1, desserialize a resposta como um objeto JSON e interprete os resultados. Consulte o guia da interface REST para saber mais sobre como usar a 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 conhecer a estrutura.
IDs compostos
Se o ID de um objeto não for globalmente exclusivo, um ID composto para esse objeto será construído incluindo o ID pai dele e um til (~).
Por exemplo, como o ID de um 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 composto do grupo de anúncios de123~45678
.
Cabeçalhos de solicitação
Estes são os cabeçalhos HTTP (ou metadados do grpc) que acompanham o corpo na solicitação:
Autorização
É necessário incluir um token de acesso do OAuth2 no formato Authorization: Bearer YOUR_ACCESS_TOKEN
, que identifica uma conta de administrador atuando em nome de um cliente ou um anunciante gerenciando 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 token de acesso para receber 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
Este é o ID de cliente autorizado a usar na solicitação, sem hifens (-
). Se você acessa a conta de cliente por meio de uma conta de administrador, esse cabeçalho é obrigatório e precisa ser definido como o ID de cliente da conta de administrador.
https://googleads.googleapis.com/v17/customers/1234567890/campaignBudgets:mutate
Definir o login-customer-id
equivale a escolher uma conta na IU 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-de-cliente-vinculados
Esse cabeçalho é usado apenas por provedores de análise de aplicativos de terceiros no 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 entidades para a conta B
usando um
ThirdPartyAppAnalyticsLink
.
Após a vinculação, um usuário da conta B
poderá fazer chamadas de API com base na conta A
, de acordo com as permissões fornecidas pela vinculação. Nesse caso, as permissões de chamada de API para a conta A
são determinadas pela vinculação de terceiros com a conta B
, e não pela relação de conta de administrador 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çalhos
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 grpc backend-metadata) 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 essa solicitação de maneira exclusiva.