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