Ánh xạ JSON

Khi sử dụng giao diện REST của API Google Ads, bạn sẽ làm việc với các biểu thị JSON của cùng một tài nguyên và loại được xác định trong các tệp trình mô tả.proto của API Google Ads. Sơ đồ mã hoá JSON tuân theo sơ đồ mã hoá chuẩn được mô tả trong phần JSON Mapping (Ánh xạ JSON) của Hướng dẫn về ngôn ngữ cho bộ đệm giao thức.

Nhìn chung, tất cả các thông báo cấp cao nhất đến và đi từ các dịch vụ đều là các đối tượng JSON riêng lẻ. Hầu hết các yêu cầu biến đổi đều chứa một mảng operations, bản thân mảng này chứa nhiều thao tác create, update hoặc delete. Tương tự, các phản hồi search là các đối tượng JSON chứa một mảng results với tập kết quả của truy vấn.

Mã nhận dạng được chuyển đổi từ snake_case (trong vùng đệm giao thức) thành lowerCamelCase trong JSON. Một điểm hạn chế đáng chú ý đối với quy tắc này là khi sử dụng search hoặc searchStream để gửi các truy vấn Ngôn ngữ truy vấn Google Ads. Bản thân ngôn ngữ truy vấn sử dụng kiểu chữ snake case, bất kể bạn đang sử dụng giao diện nào. Tuy nhiên, kết quả của một truy vấn trong REST được trả về dưới dạng các đối tượng JSON thông thường và có mã nhận dạng ở dạng lowerCamelCase.

Ví dụ: một truy vấn để tìm nạp danh sách từ khoá đang hoạt động trong một tài khoản sẽ sử dụng snake case bên trong chính truy vấn đó (ad_group_criterion, không phải adGroupCriterion):

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'"
}

Tuy nhiên, phản hồi là một biểu thị JSON của các đối tượng (được bao bọc trong một mảng JSON vì yêu cầu này dùng searchStream) và dùng giá trị nhận dạng camelCase adGroupCriterion thay thế:

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