Search Ads 360 Reporting API को किए जाने वाले कॉल आम तौर पर, आपके क्लाइंट लाइब्रेरी से किए जाते हैं. ज़्यादा जानकारी के लिए क्लाइंट लाइब्रेरी के बारे में जानकारी देखें. हालांकि, टेस्टिंग और डीबग करने के दौरान, अनुरोध के स्ट्रक्चर की जानकारी काम की हो सकती है.
Search Ads 360 Reporting API एक gRPC एपीआई है, जिसमें REST बाइंडिंग है. इसका मतलब है कि एपीआई को दो तरीकों से कॉल किया जा सकता है:
- पसंदीदा तरीका
- क्लाइंट लाइब्रेरी का इस्तेमाल करें:
- प्रोटोकॉल बफ़र के तौर पर, अनुरोध का मुख्य हिस्सा बनाएं.
- HTTP/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 हेडर एक ऐसी स्ट्रिंग है जो अनुरोध की खास तौर पर पहचान करती है.