JSON मैपिंग

Search Ads 360 Reporting API के REST इंटरफ़ेस का इस्तेमाल करते समय, आपको JSON में सिर्फ़ उन संसाधनों और टाइप के बारे में जानकारी मिलती है जो Search Ads 360 Reporting API की .proto डिस्क्रिप्टर फ़ाइलों में बताई गई हैं. JSON एन्कोडिंग स्कीम, प्रोटोकॉल बफ़र भाषा गाइड के JSON मैपिंग सेक्शन में बताई गई कैननिकल एन्कोडिंग स्कीम के मुताबिक होती है.

आम तौर पर, सेवाओं को भेजे जाने वाले और उनसे मिलने वाले सभी टॉप लेवल मैसेज, एक ही JSON ऑब्जेक्ट होते हैं. search रिस्पॉन्स, JSON ऑब्जेक्ट होते हैं. इनमें आपकी क्वेरी के नतीजों के सेट के साथ results कलेक्शन होता है.

JSON में आइडेंटिफ़ायर को snake_case (प्रोटोकॉल बफ़र में) से snake_case में बदला जाता है. इस नियम की एक खास बात यह है कि Search Ads 360 की क्वेरी भाषा की क्वेरी भेजने के लिए search या searchStream का इस्तेमाल करना. आप चाहे किसी भी इंटरफ़ेस का इस्तेमाल कर रहे हों, क्वेरी की भाषा में स्नेक केस का इस्तेमाल किया जाता है. हालांकि, REST में किसी क्वेरी के नतीजे, JSON ऑब्जेक्ट के तौर पर दिखाए जाते हैं और उनके आइडेंटिफ़ायर LowCamelCase में दिए जाते हैं.

उदाहरण के लिए, किसी खाते में सक्रिय कीवर्ड की सूची प्राप्त करने के लिए की जाने वाली क्वेरी, क्वेरी के अंदर ही स्नेक केस का उपयोग करती है (ad_group_criterion, adGroupCriterion नहीं):

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 फ़ॉर्मैट में दिखाया जाता है (यह अनुरोध, JSON कैटगरी में रैप किया जाता है, क्योंकि यह अनुरोध searchStream का इस्तेमाल करता है) और इसके बजाय, CamlCase आइडेंटिफ़ायर adGroupCriterion का इस्तेमाल करता है:

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