Conception de l'interface REST

Cette page part du principe que vous connaissez le modèle Orienté Conception et Ressource Names dans les guides du développeur et les complète avec des informations spécifiques sur l'implémentation de l'API Google Ads.

Conception orientée ressources

En règle générale, l'API Google Ads suit une conception axée sur les ressources, modélisée comme suit : Des collections de ressources adressables individuellement (les noms de l'API) Les ressources sont référencées avec leur nom de ressource et manipulées à l'aide d'un petit ensemble de méthodes (également appelé verbes ou opérations).

Ces noms de ressources et ces méthodes, combinés avec un préfixe de version d'API spécifique, constituent les URL de l'interface REST. Par exemple, l'URL ci-dessous peut être décomposée en ces composants individuels. conformément au tableau suivant:

https://googleads.googleapis.com/v17/customers/1234567890:mutate
Préfixe de version de l'API Nom de ressource (relatif) Méthode
https://googleads.googleapis.com/v17 customers/1234567890 mutate

Toutes les URL REST pour une version particulière de l'API (par exemple, v17). partagent un préfixe de version d'API commun. Ensemble du nom de la ressource et de la méthode identifie le service d'API appelé.

L'API Google Ads fait un usage intensif de méthodes personnalisées, les API REST traditionnelles qui utilisent des méthodes REST standards telles que list, get, create, update et delete. Exemples de méthodes personnalisées dans l'API Google Ads incluent search, searchStream et mutate.

Pour plus d'informations sur la ressource de l'API Google Ads, consultez les pages suivantes : noms, méthodes de service et Conventions d'attribution de noms JSON pour illustrer leur utilisation pour définir les points de terminaison de l'interface REST.