JSON マッピング

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

一般に、サービスとの間でやり取りされるすべての最上位メッセージは単一の JSON オブジェクトです。ほとんどの変更リクエストには、多くの createupdatedelete オペレーションを含む operations 配列が含まれています。同様に、search レスポンスは、クエリの結果セットを含む results 配列を含む JSON オブジェクトです。

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

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

POST /v21/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 表現(このリクエストは searchStream を使用するため JSON 配列でラップ)であり、代わりに camelCase 識別子 adGroupCriterion を使用します。

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