您可以使用 GoogleAdsFieldService 动态请求以下内容的目录:资源、资源的字段、细分键和指标,它们均位于 GoogleAdsService Search 和 SearchStream 方法中。该目录提供了各种元数据,可供 Google Ads API 客户端用于验证和构建 Google Ads 查询语言语句。
示例 HTTP 请求和响应
在以下网址中,该请求包含一个指向 Google Ads API 服务器的 HTTP GET:
https://googleads.googleapis.com/v22/googleAdsFields/{resource_or_field}
以下示例展示了请求,再下面就是从 GoogleAdsFieldService 为 ad_group 资源返回的响应:
请求
https://googleads.googleapis.com/v22/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中选择ad_group.id和segments.date,并且想要包含campaign中的属性,则需要检查segments.date是否位于广告系列的selectableWith属性中,因为它是与现有segments.date字段一起选择的。
元数据详情
您可以在以下级别使用 GoogleAdsFieldService 请求目录:
- 资源
- 例如,
googleAdsFields/campaign。 - 资源的字段
- 例如,
googleAdsFields/campaign.name。 - 细分字段
- 例如,
googleAdsFields/segments.ad_network_type。 - 指标
- 例如,
googleAdsFields/metrics.clicks。