Cette page suppose que vous connaissez les guides du développeur Conception orientée ressources et Noms de ressources, et les complète avec des détails d'implémentation spécifiques de l'API Google Ads.
Conception orientée ressources
En règle générale, l'API Google Ads suit une conception orientée ressources, modélisée sous forme de collections de ressources adressables individuellement (les noms de l'API). Les ressources sont référencées par leur nom et manipulées à l'aide d'un petit ensemble de méthodes (également appelées verbes ou opérations). Ces noms de ressources et méthodes, combinés à un préfixe de version d'API spécifique, constituent les URL de l'interface REST. Par exemple, l'URL suivante peut être décomposée en composants individuels, comme indiqué dans le tableau ci-dessous :
https://googleads.googleapis.com/v26/customers/1234567890:mutate
| Préfixe de version de l'API | Nom de la ressource (relatif) | Méthode |
|---|---|---|
https://googleads.googleapis.com/v26
|
customers/1234567890
|
mutate
|
Toutes les URL REST d'une version particulière de l'API (par exemple, v26) partagent un préfixe de version d'API commun. Le nom de la ressource et la méthode identifient ensemble le service d'API appelé.
L'API Google Ads utilise beaucoup de méthodes personnalisées, contrairement à la plupart des API REST qui utilisent des méthodes REST standards telles que list, get, create, update et delete. search, searchStream et mutate sont des exemples de méthodes personnalisées dans l'API Google Ads.
Les pages suivantes décrivent plus en détail les noms de ressources, les méthodes de service et les conventions d'attribution de noms JSON de l'API Google Ads pour illustrer comment ils sont utilisés ensemble pour définir les points de terminaison de l'interface REST.
Gestion des erreurs
Consultez Comprendre les erreurs d'API pour savoir comment analyser et déboguer les erreurs qui se produisent.
Document de découverte
Pour faciliter et automatiser la découverte des méthodes disponibles dans l'API Google Ads, vous pouvez utiliser le document de découverte publié pour chaque version.
Il est disponible à l'adresse https://googleads.googleapis.com/$discovery/rest?version=<API_VERSION>.
Par exemple, voici le document de découverte de la dernière version de l'API Google Ads.
Le document de découverte contient des informations sur tous les services, méthodes, ressources et entités utilisés dans l'API Google Ads, comme la documentation de référence, mais dans un format JSON lisible par machine.