Esta página pressupõe que você já conhece os guias do desenvolvedor Design orientado a recursos e Nomes de recursos, e os complementa com detalhes específicos de implementação da API Google Ads.
Design orientado a recursos
Em geral, a API Google Ads segue um design orientado a recursos, modelado como conjuntos de recursos endereçáveis individualmente (os substantivos da API). Os recursos são referenciados pelos 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 de API específico, compõem os URLs da interface REST. Por exemplo, este URL de exemplo pode ser dividido nesses componentes individuais de acordo com a tabela a seguir:
https://googleads.googleapis.com/v24/customers/1234567890:mutate
| Prefixo da versão da API | Nome do recurso (relativo) | Método |
|---|---|---|
https://googleads.googleapis.com/v24
|
customers/1234567890
|
mutate
|
Todos os URLs REST de uma versão específica da API (por exemplo, v24) compartilham um prefixo de versão de API comum. O nome e o método do recurso juntos 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 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 fornecem 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 juntos para definir endpoints de interface REST.
Gerenciamento de erros
Consulte Entender erros da API para orientações sobre como analisar e depurar erros.
Documento de descoberta
Para facilitar e automatizar a descoberta de métodos disponíveis na API Google Ads, use o documento de descoberta publicado para cada versão.
Ele está disponível em
https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Por exemplo, este é o
documento de descoberta
da versão mais recente da API Google Ads.
O documento de descoberta contém informações sobre todos os serviços, métodos, recursos e entidades usados na API Google Ads, como a documentação de referência, mas em um formato JSON legível por máquina.