JSON 映射

使用 Google Ads API 的 REST 接口时,您使用的 JSON 表示法与 Google Ads API 的 .proto Descriptor 文件中定义的资源和类型相同。JSON 编码方案遵循协议缓冲区语言指南JSON 映射部分中所述的规范编码方案。

一般来说,进出服务的所有顶级消息都是单个 JSON 对象。大多数转变请求都包含一个 operations 数组,该数组本身包含许多 createupdatedelete 操作。同样,search 响应是 JSON 对象,其中包含一个 results 数组,其中包含查询结果。

在 JSON 中,标识符从 snake_case(在协议缓冲区中)转换为 lowerCamelCase。此规则的一个重要注意事项是,使用 searchsearchStream 发送 Google Ads 查询语言查询时。无论您使用哪个接口,查询语言本身都会使用蛇形结构。但是,REST 中的查询结果会以普通 JSON 对象的形式返回,并且其标识符采用驼峰式大小写形式。

例如,如果查询要获取帐号中有效关键字列表的列表,则会在查询本身内使用蛇形大小写(ad_group_criterion,而不是 adGroupCriterion):

POST /v16/customers/CUSTOMER_ID/googleAds:searchStream HTTP/1.1
Host: googleads.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

{
  "query": "SELECT ad_group_criterion.keyword.text
            FROM ad_group_criterion
            WHERE ad_group_criterion.type = 'KEYWORD'
            AND ad_group_criterion.status = 'ENABLED'"
}

不过,响应是对象的 JSON 表示法(封装在 JSON 数组中,因为此请求使用 searchStream),而改为使用驼峰式大小写标识符 adGroupCriterion

[
  {
    "results": [
      {
        "adGroupCriterion": {
          "resourceName": "customers/1842689525/adGroupCriteria/55771861891~10003060",
          "keyword": {
            "text": "pay per click"
          }
        }
      },
      ...
    ]
  }
]