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

Основными компонентами Search Ads 360 Reporting API являются ресурсы и сервисы . Ресурс представляет собой объект 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 уникальна в глобальном масштабе.
Идентификатор фида Глобальный
Идентификатор элемента фида Глобальный
Идентификатор атрибута фида Кормить
Идентификатор сопоставления фида Глобальный
Идентификатор этикетки Глобальный
Идентификатор списка пользователей Глобальный

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

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

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

Имена ресурсов

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

Например, имена ресурсов кампании имеют вид:

customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID

Кампания с идентификатором 987654 в аккаунте Search Ads 360 с идентификатором клиента 1234567 имеет resource_name :

customers/1234567/campaigns/987654

Услуги

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

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

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

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

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