资源元数据

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

示例 HTTP 请求和响应

注意 ：该示例展示了底层 HTTP/JSON 请求以供参考，但我们强烈建议您使用基于 gRPC 的某个客户端库提交请求。

该请求包含一个指向以下网址的 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 子句中的资源进行选择的指标。仅对于 category 为 RESOURCE 的字段，此指标才会显示内容。

segments

可使用 FROM 子句中的资源进行选择的细分键。 这些键用于细分相关查询中指定的指标。仅对于 category 为 RESOURCE 的字段，此指标才会显示内容。

selectableWith

不在 FROM 子句中时，可与指定字段一起选择的字段。此属性仅适用于下面的情况：正在识别可在查询中选择的资源或细分，但在该查询中，这些资源或细分又没有包含在 FROM 子句中的资源中。例如，如果您要从 ad_group 中选择 ad_group.id 和 segments.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"
  )