JSON マッピング

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

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

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

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

POST /v19/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"
          }
        }
      },
      ...
    ]
  }
]
前へ
サービス メソッド
次へ
概要