Esta página pressupõe que você conhece os guias para desenvolvedores sobre Design orientado a recursos e Nomes de recursos e os complementa com detalhes específicos de implementação da API Search Ads 360 Reporting.
Design voltado a recursos
Geralmente, a API Search Ads 360 Reporting segue um design orientado a recursos, modelado como conjuntos de recursos endereçáveis individualmente (os substantivos da API). Os recursos são referenciados com os 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, 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://searchads360.googleapis.com/v0/customers/1234567890/searchAds360:search
| Prefixo da versão da API | Nome do recurso (relativo) | Método |
|---|---|---|
https://searchads360.googleapis.com/v0
|
customers/1234567890
|
search
|
Todos os URLs REST de uma determinada versão da API (por exemplo, v0) compartilham um prefixo comum de versão da API. Juntos, o nome e o método do recurso identificam qual serviço da API está sendo chamado.
A API Search Ads 360 Reporting faz um uso intenso de métodos personalizados, em oposição à maioria das APIs REST tradicionais que usam métodos REST padrão, como list e get. A API Search Ads 360 Reporting inclui dois métodos personalizados: search e searchStream.
As páginas a seguir entram em mais detalhes sobre os nomes de recursos, os métodos de serviço e as convenções de nomenclatura JSON da API Search Ads 360 Reporting para ilustrar como eles são usados juntos para definir endpoints da interface REST.