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