Nesta página, você precisa conhecer os guias do desenvolvedor sobre Design orientado por recursos e Nomes de recursos, além de incluir 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 pelos respectivos nomes e manipulados com 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, formam 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/v17/customers/1234567890:mutate
| Prefixo da versão da API | Nome do recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v17
|
customers/1234567890
|
mutate
|
Todos os URLs REST de uma versão específica da API (por exemplo, v17) compartilham um prefixo de versão de API comum. Juntos, o nome do recurso e o método identificam qual serviço de API está sendo chamado.
A Google Ads API faz um uso intenso de 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. Exemplos de métodos personalizados na API Google Ads incluem search, searchStream e mutate.
As páginas a seguir apresentam mais detalhes sobre os nomes de recursos, métodos de serviço e convenções de nomenclatura JSON da API Google Ads para ilustrar como eles são usados em conjunto para definir endpoints da interface REST.