Search Ads 360 Reporting API को कॉल आम तौर पर आपकी क्लाइंट लाइब्रेरी के ज़रिए किया जाता है. ज़्यादा जानकारी के लिए, क्लाइंट लाइब्रेरी के बारे में जानकारी देखें. हालांकि, टेस्टिंग और डीबग करने के दौरान, अनुरोध की जानकारी के स्ट्रक्चर के बारे में जानकारी काम की हो सकती है.
Search Ads 360 Reporting API, REST बिडिंग के साथ gRPC API है. इसका मतलब है कि एपीआई को दो अलग-अलग तरीकों से कॉल किया जा सकता है:
- पसंदीदा तरीका
- क्लाइंट लाइब्रेरी का इस्तेमाल करें:
- अनुरोध के मुख्य हिस्से को प्रोटोकॉल बफ़र के तौर पर बनाएं.
- एचटीटीपी/2 का इस्तेमाल करके, सर्वर को अनुरोध भेजें.
- प्रोटोकॉल बफ़र के जवाब को डिसिएरियलाइज़ करें.
- परिणामों की व्याख्या करें.
- पुष्टि करने का वैकल्पिक तरीका
- REST का इस्तेमाल करना:
- अनुरोध का मुख्य हिस्सा, JSON ऑब्जेक्ट के तौर पर बनाएं.
- एचटीटीपी 1.1 का इस्तेमाल करके, सर्वर को अनुरोध भेजें.
- रिस्पॉन्स को JSON ऑब्जेक्ट के तौर पर डीसीरियलाइज़ करें.
- परिणामों की व्याख्या करें.
ज़्यादा जानकारी के लिए, Google Cloud API देखें.
नीचे दिए गए सेक्शन, gRPC और REST, दोनों प्रोटोकॉल पर लागू होते हैं.
संसाधनों के नाम
एपीआई में मौजूद ज़्यादातर ऑब्जेक्ट की पहचान, उनके संसाधन के नाम की स्ट्रिंग से की जाती है. REST इंटरफ़ेस का इस्तेमाल करते समय, ये स्ट्रिंग यूआरएल के तौर पर भी काम करती हैं.
काम करने वाले रिसॉर्स और उनके पाथ के बारे में ज़्यादा जानकारी के लिए, रेफ़रंस > REST देखें. अन्य सेवाओं के लिए भी यही फ़ॉर्मैट इस्तेमाल किया जाता है.
कंपोजिट आईडी
अगर किसी ऑब्जेक्ट का आईडी दुनिया भर में यूनीक नहीं है, तो उस ऑब्जेक्ट के लिए एक कंपोज़िट आईडी, उसके पैरंट आईडी और टिल्ड (~) के बाद से बनता है.
उदाहरण के लिए, विज्ञापन ग्रुप का विज्ञापन आईडी, दुनिया भर में यूनीक नहीं होता. इसलिए, पैरंट ऑब्जेक्ट (विज्ञापन ग्रुप) आईडी को उसके आगे जोड़ दिया जाता है, जिससे एक यूनीक कंपोजिट आईडी बन जाता है.
उदाहरण: 123 का AdGroupId + 45678 का ~ + AdGroupAdId
= 123~45678 का कंपोजिट विज्ञापन ग्रुप विज्ञापन आईडी.
अनुरोध के हेडर
यहां दिए गए सेक्शन में मौजूद एचटीटीपी हेडर (या gRPC मेटाडेटा) को अनुरोध के मुख्य हिस्से में शामिल किया जाना चाहिए.
अनुमति देना
आपको फ़ॉर्म में OAuth2 ऐक्सेस टोकन शामिल करना होगा:
Authorization: Bearer [OAUTH_2.0_ACCESS_TOKEN]
टोकन से, किसी क्लाइंट की ओर से काम करने वाले मैनेजर खाते या सीधे अपने सब-मैनेजर या क्लाइंट खाते को मैनेज करने वाले विज्ञापन देने वाले की पहचान होनी चाहिए. ज़्यादा जानने के लिए, Search Ads 360 के मैनेजर खातों के बारे में जानकारी और पुष्टि देखें.
लॉगिन ग्राहक आईडी हेडर
सब-मैनेजर या क्लाइंट खाते को ऐक्सेस करने के लिए, मैनेजर खाते का इस्तेमाल करते समय login-customer-id हेडर ज़रूरी है. सीधे किसी सब-मैनेजर या क्लाइंट खाते को ऐक्सेस करते समय, ऐसा करना ज़रूरी नहीं है. हालांकि, यह ज़रूरी नहीं है, लेकिन हमारा सुझाव है कि पुष्टि किए गए उन उपयोगकर्ताओं के लिए हमेशा login-customer-id डालें जिनके पास एक से ज़्यादा खातों का ऐक्सेस है. इससे, जानकारी साफ़ तौर पर नहीं दी जाएगी. साथ ही, अनजाने में गलत खाते का संदर्भ सेट नहीं किया जा सकेगा.
अनुरोध में हाइफ़न (-) के बिना, अनुमति वाले उपयोगकर्ता का ग्राहक आईडी शामिल होना चाहिए, उदाहरण के लिए:
https://searchads360.googleapis.com/VERSION_NUMBER/customers/CUSTOMER_ID/campaignBudgets
login-customer-id सेट करना, Search Ads 360 यूज़र इंटरफ़ेस (यूआई) में खाता चुनने के बराबर है. इसके लिए, साइन इन करने के बाद सबसे ऊपर दाईं ओर अपनी प्रोफ़ाइल इमेज पर क्लिक करें.
रिस्पॉन्स हेडर
यहां दिए गए हेडर (या gRPC ट्रेलिंग-मेटाडेटा) जवाब के मुख्य हिस्से के साथ दिखाए जाते हैं. हमारा सुझाव है कि डीबग करने के लिए, इन वैल्यू को लॉग करें.
अनुरोध का आईडी
request-id हेडर एक ऐसी स्ट्रिंग है जिससे अनुरोध की खास तौर पर पहचान की जाती है.