На этой странице предполагается знакомство с руководствами разработчиков «Ресурсно-ориентированное проектирование» и «Имена ресурсов» и приводится дополнительная информация о конкретных аспектах реализации API Google Ads.
Ресурсно-ориентированный дизайн
В целом, API Google Ads построен на ресурсно-ориентированной архитектуре, моделируясь как наборы индивидуально адресуемых ресурсов ( существительных в API). Ссылки на ресурсы осуществляются по их именам, а управление ими осуществляется с помощью небольшого набора методов (также известных как глаголы или операции ).
Эти имена ресурсов и методов , в сочетании с префиксом версии API , составляют URL-адреса интерфейса REST. Например, URL-адрес ниже можно разбить на отдельные компоненты в соответствии со следующей таблицей:
https://googleads.googleapis.com/v21/customers/1234567890:mutate
| Префикс версии API | Имя ресурса (относительное) | Метод |
|---|---|---|
https://googleads.googleapis.com/v21 | customers/1234567890 | mutate |
Все URL-адреса REST для определённой версии API (например, v21 ) имеют общий префикс версии API. Имя ресурса и метод вместе определяют, какая служба API вызывается.
API Google Ads активно использует пользовательские методы , в отличие от большинства традиционных API REST, которые используют стандартные методы REST, такие как list , get , create , update и delete . Примеры пользовательских методов в API Google Ads включают search , searchStream и mutate .
На следующих страницах более подробно рассматриваются имена ресурсов API Google Ads, методы обслуживания и соглашения об именовании JSON , чтобы проиллюстрировать, как они используются вместе для определения конечных точек интерфейса REST.