资源元数据

您可以使用 SearchAds360FieldService 动态请求目录,以获取 SearchAds360Service SearchSearchStream 方法中提供的资源、资源字段、细分键和指标。该目录提供了可供 Search Ads 360 Reporting API 客户端用于验证和构建 Search Ads 360 查询语言语句的元数据。

示例 HTTP 请求和响应

该请求包含发送到以下网址的 Search Ads 360 Reporting API 服务器的 HTTP GET

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

下面是一个请求示例,后跟从 ad_group 资源的 SearchAds360FieldService 返回的响应:

请求

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 子句中的资源选择的可用指标。仅针对 categoryRESOURCE 的字段填充数据。
segments
可使用 FROM 子句中的资源进行选择的细分键。它们会对查询中指定的指标进行细分。仅针对 categoryRESOURCE 的字段填充数据。
selectableWith
与给定字段一起选择的字段(当不在 FROM 子句中时)。此属性仅在识别能够在查询中选择的资源或细分(未包含在 FROM 子句中的资源中)时,才具有相关性。例如,如果您从 ad_group 中选择 ad_group.idsegments.date,并且想要添加 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"
  )