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