Метаданные ресурса

Вы можете использовать SearchAds360FieldService для динамического запроса каталога ресурсов, полей ресурса, ключей сегментации и показателей, доступных в методах SearchAds360Service Search и SearchStream . Каталог предоставляет метаданные, которые могут использоваться клиентами Search Ads 360 Reporting API для проверки и построения операторов языка запросов Search Ads 360.

Пример HTTP-запроса и ответа

Примечание. В качестве примера показан базовый запрос HTTP/JSON, но для отправки запросов настоятельно рекомендуется использовать одну из клиентских библиотек на основе gRPC .

Запрос состоит из HTTP GET к серверу API отчетов Search Ads 360 по следующему URL-адресу:

https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}

Ниже приведен пример запроса, за которым следует ответ, полученный от SearchAds360FieldService для ресурса ad_group :

Запрос

https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group

Ответ

{
  "resourceName": "searchAds360Fields/ad_group",
  "name": "ad_group",
  "category": "RESOURCE",
  "selectable": false,
  "filterable": false,
  "sortable": false,
  "selectableWith": [
    "campaign",
    "customer",
    "metrics.average_cpc",
    "segments.device",
    ...
  ],
  "attributeResources": [
    "customer",
    "campaign"
  ],

  "metrics": [
    "metrics.conversions",
    "metrics.search_budget_lost_impression_share",
    "metrics.average_cost",
    "metrics.clicks",
    ...
  ],
  "segments": [
    "segments.date",
    "segments.ad_network_type",
    "segments.device",
    ...
  ]
}

В этом примере важными массивами являются:

attributeResources

Ресурсы, которые можно неявно присоединить к ресурсу в предложении FROM .

metrics

Метрики, которые можно выбрать с помощью ресурса в предложении FROM . Заполняется только для полей с category RESOURCE .

segments

Ключи сегмента, которые можно выбрать с помощью ресурса в предложении FROM . Они сегментируют метрики, указанные в запросе. Заполняется только для полей с category RESOURCE .

selectableWith

Поля, которые можно выбрать рядом с данным полем, если они не указаны в предложении FROM . Этот атрибут важен только при идентификации ресурсов или сегментов, которые можно выбрать в запросе, если они не включены в ресурс в предложении FROM . Например, если вы выбираете ad_group.id и segments.date из ad_group и хотите включить атрибуты из campaign , вам необходимо убедиться, что segments.date находится в атрибуте selectableWith для кампании, поскольку он выбирается вместе с атрибутом существующее поле segments.date .

Подробности метаданных

Вы можете запросить каталог с помощью SearchAds360FieldService на следующих уровнях:

Ресурс

Например, searchAds360Fields/campaign .

Поле ресурса

Например, searchAds360Fields/campaign.name .

Поле сегментации

Например, searchAds360Fields/segments.ad_network_type .

Метрика

Например, searchAds360Fields/metrics.clicks .

Используйте запрос, чтобы получить подробную информацию о поле

Подробную информацию о полях можно получить, отправив запрос на адрес

https://searchads360.googleapis.com/v0/searchAds360Fields:search

Пример 1: Использование регулярного выражения.

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE name LIKE 'ad_group.%'"

Пример 2. Запрос определенных полей, показателей или сегментов.

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE
  name IN (
    "ad_group.id",
    "ad_group.name",
    "segments.date",
    "customer.id",
    "customer.manager",
    "metrics.clicks"
  )