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