GoogleAdsFieldService
का इस्तेमाल करके, संसाधनों, संसाधन के फ़ील्ड, सेगमेंटेशन कुंजियों, और GoogleAdsService
Search और SearchStream तरीकों में उपलब्ध मेट्रिक के कैटलॉग के लिए डाइनैमिक तौर पर अनुरोध किया जा सकता है. कैटलॉग, मेटाडेटा उपलब्ध कराता है. इसका इस्तेमाल Google Ads API क्लाइंट, Google Ads क्वेरी लैंग्वेज स्टेटमेंट की पुष्टि करने और उन्हें बनाने के लिए कर सकते हैं.
एचटीटीपी अनुरोध और जवाब का उदाहरण
अनुरोध में, Google Ads API सर्वर को भेजा गया HTTP GET
शामिल है. यह सर्वर इस यूआरएल पर मौजूद है:
https://googleads.googleapis.com/v22/googleAdsFields/{resource_or_field}
यहां दिए गए उदाहरण में, ad_group संसाधन के लिए GoogleAdsFieldService
से मिले जवाब के साथ-साथ अनुरोध भी दिखाया गया है:
अनुरोध
https://googleads.googleapis.com/v22/googleAdsFields/ad_group
जवाब
{
"resourceName": "googleAdsFields/ad_group",
"name": "ad_group",
"category": "RESOURCE",
"selectable": false,
"filterable": false,
"sortable": false,
"selectableWith": [
"campaign",
"customer",
"metrics.average_cpc",
"segments.device",
...
],
"attributeResources": [
"customer",
"campaign"
],
"metrics": [
"metrics.conversions",
"metrics.search_budget_lost_impression_share",
"metrics.average_cost",
"metrics.clicks",
...
],
"segments": [
"segments.date",
"segments.ad_network_type",
"segments.device",
...
]
}
इस उदाहरण के लिए, ये अहम कलेक्शन हैं:
attributeResources
- ऐसे संसाधन जिन्हें
FROM
क्लॉज़ में मौजूद संसाधन से इंप्लिसिट तौर पर जोड़ा जा सकता है. metrics
- ऐसी मेट्रिक जिन्हें
FROM
क्लॉज़ में मौजूद संसाधन के साथ चुना जा सकता है. यह सिर्फ़ उन फ़ील्ड के लिए अपने-आप भरता है जहांcategory
,RESOURCE
है. segments
- ऐसे सेगमेंट की कुंजियां जिन्हें
FROM
क्लॉज़ में मौजूद संसाधन के साथ चुना जा सकता है. ये क्वेरी में बताई गई मेट्रिक को सेगमेंट करते हैं. यह सिर्फ़ उन फ़ील्ड के लिए अपने-आप भरता है जिनमेंcategory
की वैल्यूRESOURCE
होती है. selectableWith
-
- ऐसे फ़ील्ड जिन्हें
FROM
क्लॉज़ में न होने पर, किसी फ़ील्ड के साथ चुना जा सकता है. यह एट्रिब्यूट सिर्फ़ उन संसाधनों या सेगमेंट की पहचान करने के लिए काम का है जिन्हें ऐसी क्वेरी में चुना जा सकता है जहां उन्हेंFROM
क्लॉज़ में शामिल नहीं किया गया है. उदाहरण के लिए, अगर हमेंad_group
सेad_group.id
औरsegments.date
चुनने हैं और हमेंcampaign
से एट्रिब्यूट शामिल करने हैं, तो हमें यह देखना होगा कि कैंपेन के लिएsegments.date
,selectableWith
एट्रिब्यूट में है या नहीं. ऐसा इसलिए, क्योंकि इसे मौजूदाsegments.date
फ़ील्ड के साथ चुना जा रहा है.
मेटाडेटा की जानकारी
GoogleAdsFieldService
का इस्तेमाल करके, इन लेवल पर कैटलॉग का अनुरोध किया जा सकता है:
- संसाधन
- उदाहरण के लिए,
googleAdsFields/campaign
. - संसाधन का फ़ील्ड
- उदाहरण के लिए,
googleAdsFields/campaign.name
. - सेगमेंटेशन फ़ील्ड
- उदाहरण के लिए,
googleAdsFields/segments.ad_network_type
. - मेट्रिक
- उदाहरण के लिए,
googleAdsFields/metrics.clicks
.