Esta página pressupõe familiaridade com os guias para desenvolvedores Projeto orientado a recursos e Nomes de recursos, além de complementar esses guias com detalhes específicos da implementação da API Google Ads.
Design voltado a recursos
Em geral, a API Google Ads segue um design orientado a recursos, modelado como conjuntos de recursos endereçáveis individualmente (os substantivos da API). Os recursos são referenciados pelos respectivos nomes 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 da 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/v21/customers/1234567890:mutate
| Prefixo da versão da API | Nome do recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v21
|
customers/1234567890
|
mutate
|
Todos os URLs REST de uma versão específica da API (por exemplo, v21)
compartilham um prefixo comum de versão da API. O nome do recurso e o método juntos
identificam qual serviço de API está sendo chamado.
A API Google Ads usa muito métodos personalizados, ao contrário da maioria das APIs REST tradicionais, que usam métodos REST padrão, como list, get, create, update e delete. Exemplos de métodos personalizados na API Google Ads
incluem search, searchStream e mutate.
As páginas a seguir detalham 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 endpoints de interface REST.