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

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

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

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

https://googleads.googleapis.com/v20/googleAdsFields/{resource_or_field}

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

Запрос 

https://googleads.googleapis.com/v20/googleAdsFields/ad_group

Ответ 

{
  "resourceName": "googleAdsFields/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 для campaign, поскольку он выбирается вместе с существующим полем segments.date .

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

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

Ресурс
Например, googleAdsFields/campaign .
Поле ресурса
Например, googleAdsFields/campaign.name .
Поле сегментации
Например, googleAdsFields/segments.ad_network_type .
Метрическая
Например, googleAdsFields/metrics.clicks .
Назад
Получение объектов
Далее
Структура вызова