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