Estrutura de chamada de API

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 será necessário 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.

1. [Preferencial] Crie o corpo da solicitação como um buffer de protocolo, envie-o para o servidor usando HTTP/2, desserialize a resposta para um buffer de protocolo e interprete os resultados. A maioria dos nossos documentos descreve o uso do gRPC.

2. [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 como usar o REST.

Observação:este guia descreve a estrutura e os cabeçalhos de transporte comuns aos protocolos gRPC e 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 a estrutura de nomes de recursos da interface REST para ver a estrutura deles.

Importante: confira a documentação de recursos para ver todos os recursos compatíveis e as representações de caminho (resource_name). O mesmo formato é usado para outros serviços.

IDs compostos

Se o ID de um objeto não for exclusivo globalmente, um ID composto para esse objeto será construído ao incluir o ID pai e um til (~).

Por exemplo, como um ID do anúncio do grupo de anúncios não é exclusivo globalmente, nós anexamos o ID do objeto pai (grupo de anúncios) a ele para criar um ID composto exclusivo:

• AdGroupId de 123 + ~ + AdGroupAdId de 45678 = ID de anúncio do grupo de anúncios composto de 123~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 Authorization: Bearer YOUR_ACCESS_TOKEN que identifique uma conta de administrador atuando em nome de um cliente ou um anunciante gerenciando a própria conta. Veja instruções para recuperar um token de acesso no guia do OAuth2. O token de acesso é válido por uma hora após sua aquisição. Quando ele expirar, atualize o token de acesso para recuperar um novo. Observe que 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 do cliente autorizado a ser usado na solicitação, sem hifens (-). Se o acesso à conta do cliente for por meio de uma conta de administrador, esse cabeçalho será obrigatório e precisará ser definido como o ID do cliente da conta de administrador.

Termo-chave: o cliente operacional é o ID do cliente no payload da solicitação. Por exemplo, o cliente operacional na seguinte solicitação do CampaignBudgetService é 1234567890:

https://googleads.googleapis.com/v11/customers/1234567890/campaignBudgets:mutate

Definir o login-customer-id é equivalente 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.

Observação: é possível recuperar a lista de contas que podem ser acessadas diretamente com suas credenciais do OAuth emitindo uma solicitação CustomerService.ListAccessibleCustomers. O login-customer-id não é obrigatório para esse tipo de solicitação e não afeta a lista de clientes retornados.

ID do cliente vinculado

Esse cabeçalho é usado somente por provedores de análise de aplicativos terceirizados 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 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 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, em vez da 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 forma:

• linked-customer-id: a conta de análise de aplicativos de terceiros que faz upload dos dados (conta B).
• customer-id: a conta do Google Ads em que os dados são enviados (conta A).
• Cabeçalho login-customer-id e Authorization: uma combinação de valores para identificar um usuário que tem acesso à conta B.

Cabeçalhos de resposta

Os cabeçalhos a seguir (ou grpc finais-metadata) são retornados com o corpo da resposta. Recomendamos que você registre esses valores para fins de depuração.

ID da solicitação

O request-id é uma string que identifica exclusivamente essa solicitação.