检索对象

GoogleAdsService 是 Google Ads API 的统一对象检索和报告服务。该服务具有可执行以下操作的方法:

  • 检索对象的特定属性。
  • 根据日期范围检索对象的效果指标。
  • 根据对象属性对对象进行排序。
  • 使用条件来指明要在响应中返回的对象。
  • 限制返回的对象数量。

GoogleAdsService 可以通过两种方式返回结果:

  • GoogleAdsService.SearchStream 在单个流式传输响应中返回所有行,这对于大型(超过 10000 行)结果集而言更为高效。如果您的批处理应用希望尽快下载尽可能多的数据,这种做法可能更合适。
  • GoogleAdsService.Search 将大型响应分解为易于管理的结果页面。如果您的互动应用一次显示一个结果页,这样做可能更合适。

详细了解分页与流式传输

发出请求

搜索方法需要 SearchGoogleAdsRequest,其中包含以下属性:

  • 一个 customer_id
  • Google Ads 查询语言 query,指示要查询的资源、要检索的属性、细分和指标,以及用于限制返回哪些对象的条件。
  • (仅限 GoogleAdsService.Searchpage_size,用于指示在使用分页时单个响应中返回的对象数量。
  • (仅限 GoogleAdsService.Search)使用 分页时,可选的 page_token 来检索下一批结果。

如需详细了解 Google Ads 查询语言,请参阅 Google Ads 查询语言指南

处理响应

GoogleAdsService 会返回 GoogleAdsRow 对象的列表。

每个 GoogleAdsRow 代表一个查询返回的对象,由一组根据 SELECT 子句中请求的字段填充的属性组成。SELECT 子句中未包含的属性不会填充响应中的 GoogleAdsRow 对象。

例如,虽然 ad_group_criterion 具有 status 属性,但如果查询的 SELECT 子句不包含 ad_group_criterion.status,则不会在该行的响应中填充该行的 ad_group_criterion 属性。同样,如果 SELECT 子句不包含 campaign 资源中的任何字段,则不会填充该行的 campaign 属性。

每个 GoogleAdsRow 都可以与同一结果集中的另一行具有不同的属性和指标;因此这些行应被视为对象,而不是表格的固定行。

UNKNOWN 枚举类型

该 API 版本不完全支持返回 UNKNOWN 类型的资源。这些资源可能是通过其他界面(例如 Google Ads 界面)创建的。当资源的类型为 UNKNOWN 时,您可以选择指标,但不能通过 API 更改资源。例如,在界面中引入了新的广告系列或广告,但您正在查询的 API 版本中对此不受支持。

以下是一些注意事项:

  • 类型为 UNKNOWN 的资源可能在以后受支持或无限期保留 UNKNOWN
  • 随时可能会显示 UNKNOWN 类型的新对象。这些对象可向后兼容,因为枚举值已存在。我们在做出此变化后会引入资源,以便您准确了解自己的帐号。显示 UNKNOWN 资源可能是因为您的帐号通过其他接口有新活动,或者资源不再受到正式支持。
  • UNKNOWN 资源可能附加了详细指标,您可以查询这些指标。
  • UNKNOWN 资源通常在 Google Ads 界面中完全可见。
  • UNKNOWN 资源通常无法更改。

分割

对于以下各项的每个组合,响应将包含一个 GoogleAdsRow

  • FROM 子句中指定的主资源的实例
  • 每个所选 segment 字段的值

例如,对于选择 FROM campaign 并在 SELECT 子句中包含 segments.ad_network_typesegments.date 的查询,其响应将包含以下行的组合:

  • campaign
  • segments.ad_network_type
  • segments.date