JSON マッピング

Search Ads 360 Reporting API の REST インターフェースを使用する場合、Search Ads 360 Reporting API の .proto 記述子ファイルで定義されている同じリソースとタイプを JSON 形式で操作します。JSON エンコード スキームは、プロトコル バッファの 言語ガイドの JSON マッピング セクションで説明されている 正規エンコード スキームに準拠しています。

一般に、 サービスとの間で送受信されるすべての最上位メッセージは単一の JSON オブジェクトです。search レスポンスは、クエリの結果セットを含む results 配列を含む JSON オブジェクトです。

識別子は、プロトコル バッファの snake_case から JSON の lowerCamelCase に変換されます。このルールの例外として、 search または searchStream を使用して 検索広告 360 クエリ言語 クエリを送信する場合が挙げられます。使用しているインターフェースに関係なく、クエリ言語自体はスネークケースを使用します。ただし、REST でのクエリの結果は通常の JSON オブジェクトとして返され、識別子は lowerCamelCase になります。

たとえば、アカウント内の有効なキーワードのリストを取得するクエリでは、クエリ自体の中でスネークケースを使用します(adGroupCriterion ではなく ad_group_criterion)。

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 配列でラップされます)であり、camelCase 識別子 adGroupCriterion を使用します。

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