Design da interface REST

Você precisa estar familiarizado com as diretrizes do Guia de design e recursos de nomes (em inglês) dos guias do desenvolvedor e e os complementa 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 pelos respectivos nomes e manipulados com uma pequena 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/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 o mesmo prefixo de versão da API. O nome do recurso e o método juntos identifica qual serviço de API está sendo chamado.

A API Google Ads usa muitos métodos personalizados, em oposição à maioria 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 contêm mais detalhes sobre o recurso da API do Google Ads de serviço, métodos de serviço e Convenções de nomenclatura JSON para ilustrar como elas são usadas para definir endpoints da interface REST.