JSON 對應

使用 Search Ads 360 Reporting API 的 REST 介面時,您可以在 JSON 表示法中使用 Search Ads 360 Reporting API 的 .proto 描述元檔案所定義的相同資源和類型。JSON 編碼配置遵循通訊協定緩衝區語言指南中「JSON 對應」一節所述的標準編碼配置。

一般而言,服務往來的所有頂層訊息都是單一 JSON 物件。search 回應是 JSON 物件,內含 results 陣列與查詢結果集。

使用 JSON 格式時,ID 會從 snake_case (在通訊協定緩衝區中) 轉換為 lowerCamelCase。此規則需要注意的一點是,使用 searchsearchStream 傳送 Search Ads 360 查詢語言查詢。無論您使用哪個介面,查詢語言本身都會使用蛇形大小寫。然而,REST 中的查詢結果會以一般 JSON 物件的形式傳回,而這些結果的 ID 會是 smallCamelCase。

例如,要擷取帳戶中有效關鍵字清單的查詢,會在查詢本身中使用假大小寫 (ad_group_criterion,而非 adGroupCriterion):

POST /v0/customers/CUSTOMER_ID/searchAds360:searchStream HTTP/1.1
Host: searchads360.googleapis.com
Content-Type: application/json
Authorization: Bearer ACCESS_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 表示法 (因為這項要求使用 searchStream,所以包裝在 JSON 陣列中),並改用駝峰式 ID adGroupCriterion

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