Esta página pressupõe que você conhece os guias para desenvolvedores sobre design orientado para recursos e nomes de recursos e os complementa com detalhes específicos de implementação da API Google Ads.
Design voltado a recursos
Geralmente, a Google Ads API segue um design voltado para recursos, modelado como conjuntos de recursos endereçáveis individualmente (os substantivos da API). Os recursos são referenciados com seus 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, compreendem 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/v16/customers/1234567890:mutate
| Prefixo da versão da API | Nome do recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v16
|
customers/1234567890
|
mutate
|
Todos os URLs REST de uma versão específica da API (por exemplo, v16) compartilham um prefixo comum de versão da API. Juntos, o nome e o método do recurso identificam qual serviço de API está sendo chamado.
A API Google Ads faz uso intenso de 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 trazem 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 em conjunto para definir endpoints da interface REST.