การแมป JSON

เมื่อใช้ REST Interface ของ Google Ads API คุณจะทำงานกับตัวแทน JSON ของทรัพยากรและประเภทเดียวกันที่กำหนดไว้ในไฟล์ตัวอธิบาย .proto ของ Google Ads API รูปแบบการเข้ารหัส JSON เป็นไปตามรูปแบบการเข้ารหัสที่ชัดเจนซึ่งอธิบายไว้ในส่วนการแมป JSON ของคำแนะนำเกี่ยวกับภาษาของ Protocol Buffer

โดยทั่วไป ข้อความระดับบนสุดทั้งหมดที่ส่งไปยังและจากบริการจะเป็นออบเจ็กต์ JSON เดียว คำขอเปลี่ยนแปลงส่วนใหญ่มีอาร์เรย์ operations ซึ่งมี การดำเนินการ create, update หรือ delete จำนวนมาก ในทำนองเดียวกัน คำตอบของ search คือออบเจ็กต์ JSON ที่มีอาร์เรย์ results พร้อมชุดผลลัพธ์ของการค้นหา

ตัวระบุจะเปลี่ยนจาก snake_case (ในบัฟเฟอร์โปรโตคอล) เป็น lowerCamelCase ใน JSON ข้อควรระวังที่สำคัญอย่างหนึ่งของกฎนี้คือเมื่อใช้ searchหรือ searchStream เพื่อส่งคำค้นหาภาษาของคำค้นหาของ Google Ads ภาษาของคําค้นหาเองจะใช้รูปแบบ Snake Case ไม่ว่าคุณจะใช้อินเทอร์เฟซใดก็ตาม อย่างไรก็ตาม ผลลัพธ์ของการค้นหาใน REST จะแสดงเป็น ออบเจ็กต์ JSON ปกติและมีตัวระบุในรูปแบบ lowerCamelCase

เช่น คำค้นหาเพื่อดึงรายการคีย์เวิร์ดที่ใช้งานอยู่ในบัญชีจะใช้ รูปแบบตัวพิมพ์เล็กคั่นด้วยขีดล่างภายในคำค้นหาเอง (ad_group_criterion ไม่ใช่ 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'"
}

อย่างไรก็ตาม การตอบกลับคือการแสดงออบเจ็กต์ในรูปแบบ JSON (อยู่ในอาร์เรย์ JSON เนื่องจากคำขอนี้ใช้ searchStream) และใช้ตัวระบุ camelCase adGroupCriterion แทน

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