Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Design da interface REST

Nesta página, consideramos uma familiaridade com os guias de desenvolvedor de Design orientado a recursos e Nomes de recursos e os complementamos com detalhes específicos de implementação da API Google Ads.

Design voltado a recursos

Geralmente, a API do 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 com os nomes dos recursos 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 de 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/v11/customers/1234567890:mutate
Prefixo da versão da API Nome do recurso (relativo) Método
https://googleads.googleapis.com/v11 customers/1234567890 mutate

Todos os URLs REST de uma versão específica da API (por exemplo, v11) compartilham um prefixo de versão da API comum. Juntos, o nome e o método do recurso identificam qual serviço de API está sendo chamado.

A API Google Ads usa muito os métodos personalizados, em vez 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 abordam 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 juntos para definir endpoints da interface REST.