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