资源元数据

您可以使用 GoogleAdsFieldService 动态请求 GoogleAdsService 搜索SearchStream 方法中提供的资源、资源字段、细分键和指标的目录。该目录提供了元数据,可供 Google Ads API 客户端用于验证和构建 Google Ads 查询语言语句。

示例 HTTP 请求和响应

此请求包含对以下网址的 Google Ads API 服务器的 HTTP GET

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

以下示例展示了请求,后跟来自 GoogleAdsFieldService 针对 ad_group 资源的响应:

请求

https://googleads.googleapis.com/v11/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 子句中的资源选择的指标。仅针对 categoryRESOURCE 的字段填充。
segments
可使用 FROM 子句中的资源选择的键。 这些指标对查询中指定的指标进行细分。仅对 categoryRESOURCE 的字段填充。
selectableWith
不在 FROM 子句中时可与给定字段一起选择的字段。此属性仅适用于在查询中能够选择 FROM 子句中未包含相应资源的资源或细分。例如,如果我们从 ad_group 中选择 ad_group.idsegments.date,并且希望包含 campaign 中的属性,则需要检查 segments.date 是否在广告系列的 selectableWith 属性中,因为该值与现有 segments.date 字段一起选择。

元数据详情

您可以在以下级别使用 GoogleAdsFieldService 请求目录:

资源
例如 googleAdsFields/campaign
资源的字段
例如 googleAdsFields/campaign.name
细分字段
例如 googleAdsFields/segments.ad_network_type
指标
例如 googleAdsFields/metrics.clicks