Cuidado: você está vendo a documentação da interface REST da API. A maioria das nossas bibliotecas de cliente oficiais usa o gRPC. Consulte Introdução ao REST para ver mais detalhes.

Design da interface REST

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Nesta página, pressupomos que você esteja familiarizado com os guias do desenvolvedor Design orientado por recursos e Nomes de recursos (links em inglês) e os complemente com detalhes específicos de implementação da API Google Ads.

Design voltado a recursos

Geralmente, a API Google Ads segue um design orientado a recursos, modelado como coleções de recursos endereçáveis individualmente (os substantivos da API). Os recursos são referenciados com os respectivos nomes de recursos e manipulados usando um pequeno conjunto de métodos, também conhecidos como verbos ou operações.

Esses nomes de recursos e métodos, combinados com um prefixo de versão de API específico, compõem os URLs da interface REST. Por exemplo, o URL abaixo pode ser dividido nesses componentes individuais de acordo com a tabela a seguir:

https://googleads.googleapis.com/v12/customers/1234567890:mutate
Prefixo da versão da API Nome do recurso (relativo) Método
https://googleads.googleapis.com/v12 customers/1234567890 mutate

Todos os URLs REST de uma versão específica da API (por exemplo, v12) compartilhe um prefixo de versão de API comum. O nome e o método do recurso juntos identificam qual serviço de API está sendo chamado.

A API Google Ads usa bastante os métodos personalizados, em vez da maioria das APIs REST tradicionais que usam métodos REST padrão, como list, get, create, update e delete. Os exemplos de métodos personalizados na API Google Ads incluem search, searchStream e mutate.

As páginas a seguir oferecem mais detalhes sobre os nomes de recursos, os métodos de serviço e as convenções de nomenclatura JSON da API Google Ads para ilustrar como eles são usados juntos para definir os endpoints da interface REST.