Структура API отчетов Search Ads 360

Основными компонентами API для создания отчетов Search Ads 360 являются ресурсы и сервисы . Ресурс представляет собой сущность Search Ads 360, а для получения сущностей Search Ads 360 используется сервис.

Иерархия объектов

Аккаунт Search Ads 360 представляет собой иерархию объектов.

  • Ресурсом верхнего уровня в рамках учетной записи является клиент .

  • В каждом аккаунте содержится одна или несколько активных кампаний .

  • Каждая Campaign содержит одну или несколько групп объявлений , которые объединяют ваши объявления в логические коллекции.

  • Каждая AdGroup содержит одно или несколько объявлений группы .

  • К группе объявлений или кампании можно прикрепить один или несколько критериев AdGroupCriterion или CampaignCriterion . Критерии определяют, как запускаются объявления.

    • Существует множество типов критериев , таких как ключевые слова, возрастные диапазоны и местоположения. Критерии, определенные на уровне кампании, влияют на все остальные ресурсы в рамках кампании. Вы также можете указать бюджеты и даты для всей кампании.

Ресурсы

Ресурсы представляют собой сущности в вашем аккаунте Search Ads 360. Примеры ресурсов: Customer , Campaign и AdGroup .

Идентификаторы объектов

Каждый объект в Search Ads 360 идентифицируется своим собственным идентификатором. Некоторые идентификаторы являются уникальными во всех аккаунтах Search Ads 360, в то время как другие уникальны только в пределах определенной области.

Область действия уникальности идентификатора объекта
Идентификатор бюджета Глобальный
Идентификатор кампании Глобальный
Идентификатор группы объявлений Глобальный
Идентификатор объявления Группа объявлений

Каждая пара AdGroupId / AdId является уникальной в глобальном масштабе.
Идентификатор AdGroupCriterion Группа объявлений

Каждая пара AdGroupId / CriterionId является уникальной в глобальном масштабе.
Идентификатор критерия кампании Кампания

Каждая пара CampaignId / CriterionId является уникальной в глобальном масштабе.
Расширения объявлений Кампания

Каждая пара CampaignId / AdExtensionId является уникальной в глобальном масштабе.
Идентификатор ленты Глобальный
Идентификатор элемента корма Глобальный
Идентификатор атрибута ленты Кормить
Идентификатор сопоставления потока Глобальный
Идентификатор метки Глобальный
Идентификатор списка пользователей Глобальный

Эти правила идентификации могут быть полезны при проектировании локального хранилища для объектов Search Ads 360.

Типы объектов

Некоторые объекты могут использоваться для нескольких типов сущностей. В этом случае объект содержит поле type , описывающее его содержимое. Например, AdGroupAd может относиться к текстовой рекламе, рекламе отеля или местной рекламе. Доступ к значению типа можно получить через поле AdGroupAd.ad.type . Его значение возвращается в перечислении AdType .

Названия ресурсов

Каждый ресурс однозначно идентифицируется строкой resource_name , которая объединяет ресурс и его родительские элементы в путь.

Например, названия ресурсов кампании имеют следующий вид:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

В рекламной кампании с ID 987654 в аккаунте Search Ads 360 с ID клиента 1234567 присутствует resource_name :

customers/1234567/campaigns/987654

Услуги

Сервисы позволяют получать доступ к объектам и метаданным вашей системы Search Ads 360. Существует три типа сервисов:

Поисковая служба
SearchAds360Service — это единый унифицированный сервис для получения всех объектов ресурсов и статистики производительности. Он предоставляет два метода: Search и SearchStream . Оба метода требуют запроса, указывающего ресурс для запроса, атрибуты ресурса и метрики производительности для получения, предикаты для фильтрации запроса и сегменты для дальнейшего анализа статистики производительности. См. разделы «Создание отчетов поиска» и «Язык запросов Search Ads 360» для получения дополнительной информации.
Выездное обслуживание
SearchAds360FieldService извлекает метаданные о ресурсах, такие как доступные атрибуты ресурса и его тип данных. Вы можете запросить каталог ресурсов, полей ресурсов, ключей сегментации и метрик, доступных в методах поиска SearchAds360Service . См. раздел «Извлечение метаданных ресурса» для получения дополнительной информации.
Услуги, специфичные для конкретной организации

Эти сервисы предоставляют метод GET запроса, который извлекает единственный экземпляр ресурса. Это полезно для изучения структуры ресурса.

Примерами услуг, специфичных для конкретной организации, являются:

  • CustomColumnService , возвращающий запрошенный пользовательский столбец с подробным описанием.