您可以使用 GoogleAdsFieldService
动态请求目录,以获取 GoogleAdsService
Search 和 SearchStream 方法中提供的资源、资源的字段、细分键和指标。该目录提供了可供 Google Ads API 客户端验证和构建 Google Ads 查询语言语句的元数据。
示例 HTTP 请求和响应
此请求包含发送到 Google Ads API 服务器的 HTTP GET
,位于以下网址:
https://googleads.googleapis.com/v17/googleAdsFields/{resource_or_field}
以下是一个请求示例,后跟从 GoogleAdsFieldService
针对 ad_group 资源的响应:
请求
https://googleads.googleapis.com/v17/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
。