अगर आपने पहले से ही अपने पहले क्लाइंट ऐप्लिकेशन को कोड नहीं किया है, तो उसे कोड करने से पहले, आपको कुछ काम करने होंगे.
Google खाता बनाना और Search Ads 360 की अनुमतियां पाना
Search Ads 360 API का इस्तेमाल करने के लिए, आपके पास एक Google खाता होना चाहिए. साथ ही, आपके पास Search Ads 360 से उस खाते को दी गई ज़रूरी अनुमतियां होनी चाहिए:
अगर आपके पास पहले से कोई Google खाता नहीं है, तो नया खाता बनाएं.
Search Ads 360 के एजेंसी मैनेजर से अपने Google खाते के लिए, Search Ads 360 उपयोगकर्ता बनाएं.
रिपोर्ट डाउनलोड करने के लिए, आपके पास विज्ञापन देने वाले उन लोगों या कंपनियों को देखने की अनुमति होनी चाहिए जिनके साथ आपको काम करना है.
कन्वर्ज़न जोड़ने या उनमें बदलाव करने के लिए, आपको उन ऐडवर्टाइज़र के लिए बदलाव करने की अनुमति चाहिए जिनके साथ आपको काम करना है. शेयर किए गए Floodlight कॉन्फ़िगरेशन में, आपके पास उन सभी चाइल्ड ऐडवर्टाइज़र खातों में बदलाव करने की अनुमति होनी चाहिए जिनमें आपको कन्वर्ज़न अपलोड करने हैं. इसके लिए, आपके पास पैरंट ऐडवर्टाइज़र खाते का ऐक्सेस होना ज़रूरी नहीं है. साथ ही, आपको उन चाइल्ड ऐडवर्टाइज़र खातों का ऐक्सेस भी नहीं चाहिए जिनमें कन्वर्ज़न अपलोड नहीं किए जा रहे हैं. अगर कन्वर्ज़न को विज़िट को एट्रिब्यूट करने के लिए, क्लिक आईडी का इस्तेमाल किया जाता है, तो पक्का करें कि आपके पास विज्ञापन देने वाले उस व्यक्ति के खाते में बदलाव करने का ऐक्सेस हो जिसने क्लिक आईडी जनरेट किया है. अगर आपने क्लिक आईडी किसी ऐसे ऐडवर्टाइज़र खाते से लिया है जिसमें बदलाव करने का ऐक्सेस आपके पास नहीं है, तो अनुरोध पूरा नहीं हो पाएगा.
एजेंसी मैनेजर आपके खाते को विज्ञापन देने वाले उपयोगकर्ता के तौर पर सेट अप कर सकता है. इसके लिए, उसे कुछ विज्ञापन देने वालों का ऐक्सेस देना होगा. इसके अलावा, वह आपके खाते को ज़्यादा ऐक्सेस के साथ सेट अप कर सकता है. जैसे, एजेंसी उपयोगकर्ता के तौर पर, जिसमें एजेंसी के सभी विज्ञापन देने वालों का ऐक्सेस होता है.
एपीआई कन्वर्ज़न सेवा चालू करना
अगर आपको कन्वर्ज़न से जुड़ा डेटा अपलोड करना है, तो एजेंसी मैनेजर के अधिकार रखने वाले Search Ads 360 के उपयोगकर्ता को, Search Ads 360 यूज़र इंटरफ़ेस (यूआई) में साइन इन करना होगा और एपीआई कन्वर्ज़न सेवा चालू करनी होगी. निर्देशों के लिए, Search Ads 360 सहायता केंद्र पर जाएं.
अपने क्लाइंट के लिए Google API Console प्रोजेक्ट और OAuth क्रेडेंशियल बनाना
- Google API Console का
सेट अप टूल शुरू करें.
सेटअप टूल की मदद से, प्रोजेक्ट बनाया जा सकता है या किसी मौजूदा प्रोजेक्ट का इस्तेमाल किया जा सकता है. साथ ही, Search Ads 360 एपीआई को चालू किया जा सकता है और OAuth 2.0 क्रेडेंशियल बनाए जा सकते हैं. - अपना ऐप्लिकेशन रजिस्टर करें पेज पर, कोई मौजूदा प्रोजेक्ट चुनें या प्रोजेक्ट बनाएं को चुनें. इसके बाद, जारी रखें पर क्लिक करें.
- Google API Console के Search Ads 360 API को चालू करने के बाद, क्रेडेंशियल पर जाएं बटन पर क्लिक करें.
- क्रेडेंशियल बनाएं पेज पर, यह जानकारी डालें:
- आपने किस एपीआई का इस्तेमाल किया है?: Search Ads 360 API
- आपको किस तरह का डेटा ऐक्सेस करना है?: उपयोगकर्ता डेटा
- आगे बढ़ें बटन पर क्लिक करें.
सेटअप टूल अब आपको OAuth 2.0 क्लाइंट आईडी बनाने में मदद करता है.
- सेटअप टूल में दिए गए बाकी निर्देशों का पालन करें.
sa360Api.py इंस्टॉल करना
Search Ads 360, अनुमति पाने की प्रोसेस को आसान बनाने के लिए एक यूटिलिटी स्क्रिप्ट देता है. अगर आपको पूरा ऐप्लिकेशन डिज़ाइन करने और लिखने से पहले डेटा भेजने और पाने की कोशिश करनी है, तो इस स्क्रिप्ट का इस्तेमाल करके JSON फ़ॉर्मैट में डेटा भेजा और पाया जा सकता है. इस दस्तावेज़ की साइट से, JSON के कई उदाहरण कॉपी किए जा सकते हैं और उन्हें सीधे स्क्रिप्ट में डाला जा सकता है.
स्क्रिप्ट इंस्टॉल करने के लिए:
- Python 2.7 इंस्टॉल करें.
यह स्क्रिप्ट, Python 3.x के साथ काम नहीं करती. - cURL इंस्टॉल करें.
- sa360Api.zip डाउनलोड करें.
sa360Api.zipसेsa360Api.pyनिकालें.sa360Api.pyको एक्ज़ीक्यूटेबल बनाएं.
REST की बुनियादी बातें जानना
एपीआई को शुरू करने के दो तरीके हैं:
- क्लाइंट लाइब्रेरी का इस्तेमाल करना.
- एचटीटीपी अनुरोध भेजना और जवाबों को पार्स करना.
अगर आपको क्लाइंट लाइब्रेरी का इस्तेमाल नहीं करना है, तो आपको REST के बुनियादी सिद्धांतों को समझना होगा.
REST, सॉफ़्टवेयर आर्किटेक्चर की एक स्टाइल है. यह डेटा का अनुरोध करने और उसमें बदलाव करने के लिए, आसान और एक जैसा तरीका उपलब्ध कराती है.
आरईएसटी, "रिप्रज़ेंटेशनल स्टेट ट्रांसफ़र" का छोटा रूप है. Google API के संदर्भ में, इसका मतलब है कि Google के स्टोर किए गए डेटा को वापस लाने और उसमें बदलाव करने के लिए, एचटीटीपी वर्ब का इस्तेमाल करना.
RESTful सिस्टम में, संसाधनों को डेटा स्टोर में सेव किया जाता है. वहीं, क्लाइंट एक अनुरोध भेजता है कि सर्वर किसी खास काम (जैसे, संसाधन बनाना, वापस पाना, अपडेट करना या मिटाना) करता है. इसके बाद, सर्वर कार्रवाई करता है और जवाब देता है. आम तौर पर, यह अनुरोध, बताए गए संसाधन के तौर पर किया जाता है.
Google के RESTful API में, क्लाइंट POST, GET, PUT या DELETE जैसे एचटीटीपी वर्ब का इस्तेमाल करके, कोई कार्रवाई करता है. यह किसी रिसॉर्स को, इस फ़ॉर्मैट में मौजूद दुनिया भर में यूनीक यूआरआई से दिखाता है:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
सभी एपीआई संसाधनों में, एचटीटीपी से ऐक्सेस किए जा सकने वाले यूनीक यूआरआई होते हैं. इसलिए, REST डेटा कैश करने की सुविधा को चालू करती है. साथ ही, उसे वेब के डिस्ट्रिब्यूटेड इन्फ़्रास्ट्रक्चर के साथ काम करने के लिए ऑप्टिमाइज़ किया जाता है.
एचटीटीपी 1.1 स्टैंडर्ड के दस्तावेज़ में, मेथड की परिभाषाएं आपके लिए मददगार हो सकती हैं. इनमें GET, POST, PUT, और DELETE के लिए खास जानकारी शामिल होती है.
Search Ads 360 API में REST
Search Ads 360 API के ऑपरेशन, सीधे तौर पर REST HTTP वर्ब पर मैप होते हैं.
Search Ads 360 API यूआरआई का फ़ॉर्मैट यह है:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
एपीआई में काम करने वाले हर ऑपरेशन के लिए इस्तेमाल किए गए यूआरआई का पूरा सेट, एपीआई रेफ़रंस में दिया गया है.
JSON के बारे में बुनियादी बातें जानें
अगर REST का इस्तेमाल किया जाता है, तो आपको अनुरोध के लिए JSON फ़ॉर्मैट का इस्तेमाल करना होगा. आपके पास यह तय करने का विकल्प होता है कि रिस्पॉन्स, JSON या CSV फ़ॉर्मैट में हों.
JSON (JavaScript Object Notation), डेटा का एक सामान्य फ़ॉर्मैट है. यह किसी भी भाषा पर निर्भर नहीं करता. इसमें डेटा स्ट्रक्चर को टेक्स्ट के तौर पर आसानी से दिखाया जाता है. ज़्यादा जानकारी के लिए, json.org पर जाएं.