अपने पहले क्लाइंट ऐप्लिकेशन को कोड करना शुरू करने से पहले, आपको कुछ ऐसी चीज़ें करनी होंगी जो आपने नहीं की हैं.
Google खाता बनाएं और Search Ads 360 की अनुमतियां पाएं
Search Ads 360 एपीआई का इस्तेमाल करने के लिए, आपके पास एक Google खाता और उस खाते के लिए Search Ads 360 से सही अनुमतियां होनी चाहिए:
अगर आपके पास पहले से कोई Google खाता नहीं है, तो एक खाता बनाएं.
Search Ads 360 एजेंसी मैनेजर से अपने Google खाते के लिए, Search Ads 360 का उपयोगकर्ता बनाने का अनुरोध करें.
रिपोर्ट डाउनलोड करने के लिए, आपके पास उन विज्ञापन देने वालों के लिए देखने की अनुमति होनी चाहिए जिनके साथ आप काम करेंगे.
कन्वर्ज़न जोड़ने या उनमें बदलाव करने के लिए, आपके पास उन विज्ञापन देने वालों के लिए बदलाव करने की अनुमति होनी चाहिए जिनके साथ आप काम करेंगे. शेयर किए गए Floodlight कॉन्फ़िगरेशन में, आपको हर उस विज्ञापन देने वाले के लिए बदलाव करने की अनुमति चाहिए जिसमें कन्वर्ज़न अपलोड करने हैं. आपको पैरंट विज्ञापन देने वाले के ऐक्सेस की ज़रूरत नहीं है और न ही आपको उन विज्ञापन देने वालों के ऐक्सेस की ज़रूरत है जिनमें आप कन्वर्ज़न अपलोड नहीं कर रहे हैं. अगर क्लिक के लिए कन्वर्ज़न एट्रिब्यूट करने के लिए क्लिक आईडी का इस्तेमाल किया जाता है, तो पक्का करें कि आपके पास क्लिक आईडी जनरेट करने वाले विज्ञापन देने वाले को बदलाव करने का ऐक्सेस हो. अगर किसी ऐसे विज्ञापन देने वाले का क्लिक आईडी दिया जाता है जिसके पास बदलाव करने का ऐक्सेस नहीं है, तो वह अनुरोध स्वीकार नहीं किया जाएगा.
एजेंसी मैनेजर, खास खाते को ऐक्सेस करने वाले विज्ञापन देने वाले उपयोगकर्ता के तौर पर, आपका खाता सेट अप कर सकता है. इसके अलावा, वह एजेंसी उपयोगकर्ता जैसे किसी ऊंचे लेवल का खाता भी सेट अप कर सकता है, जिसके पास एजेंसी के सभी विज्ञापन देने वालों का ऐक्सेस हो.
एपीआई कन्वर्ज़न सेवा चालू करना
अगर कन्वर्ज़न के बारे में डेटा अपलोड करना है, तो एजेंसी मैनेजर के अधिकार वाले Search Ads 360 उपयोगकर्ता को, Search Ads 360 यूज़र इंटरफ़ेस (यूआई) में साइन इन करना होगा और एपीआई कन्वर्ज़न सेवा को चालू करना होगा. निर्देशों के लिए, Search Ads 360 का सहायता केंद्र देखें.
अपने क्लाइंट के लिए Google API (एपीआई) कंसोल प्रोजेक्ट और OAuth क्रेडेंशियल बनाएं
- Google API (एपीआई) कंसोल
सेट अप टूल शुरू करें.
सेट अप टूल से आपको एक प्रोजेक्ट बनाने (या किसी मौजूदा प्रोजेक्ट का इस्तेमाल करने), Search Ads 360 एपीआई को चालू करने, और OAuth 2.0 क्रेडेंशियल बनाने में मदद मिलती है. - अपना ऐप्लिकेशन रजिस्टर करें पेज पर, कोई मौजूदा प्रोजेक्ट चुनें या प्रोजेक्ट बनाएं को चुनें. इसके बाद, जारी रखें पर क्लिक करें.
- जब Google API (एपीआई) कंसोल Search Ads 360 एपीआई को चालू कर दे, तब क्रेडेंशियल पर जाएं बटन पर क्लिक करें.
- क्रेडेंशियल बनाएं पेज पर, यह जानकारी डालें:
- आप किस एपीआई का इस्तेमाल कर रहे हैं?: Search Ads 360 एपीआई
- आपको किस डेटा का ऐक्सेस मिलेगा?: उपयोगकर्ता डेटा
- आगे बढ़ें बटन पर क्लिक करें.
सेट अप टूल, अब 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 सॉफ़्टवेयर आर्किटेक्चर की एक शैली है, जो डेटा का अनुरोध करने और उसमें बदलाव करने के लिए एक सुविधाजनक और एक जैसा तरीका देती है.
REST शब्द को "रिप्रज़ेंटेशनल स्टेट ट्रांसफ़र" कहते हैं. Google API के संदर्भ में, इसका मतलब है कि Google के पास सेव किए गए डेटा को फिर से पाने और उनमें बदलाव करने के लिए, एचटीटीपी कार्रवाइयों का इस्तेमाल करना.
RESTful सिस्टम में, रिसॉर्स को डेटा स्टोर में स्टोर किया जाता है; क्लाइंट अनुरोध भेजता है कि सर्वर कोई खास कार्रवाई करता है (जैसे कि संसाधन बनाना, वापस पाना, अपडेट करना या मिटाना), और सर्वर कार्रवाई करता है और अक्सर बताए गए रिसॉर्स के रूप में एक जवाब भेजता है.
Google के RESTful एपीआई में, क्लाइंट POST, GET, PUT, या DELETE जैसी एचटीटीपी कार्रवाई का इस्तेमाल करके कार्रवाई तय करता है. यह संसाधन को नीचे दिए गए फ़ॉर्म के वैश्विक-यूनीक यूआरआई से तय करता है:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
सभी एपीआई रिसॉर्स में यूनीक एचटीटीपी-सुलभता यूआरआई होते हैं. REST की मदद से, डेटा को कैश मेमोरी में सेव किया जाता है. साथ ही, इसे वेब पर मौजूद इन्फ़्रास्ट्रक्चर के साथ काम करने के लिए, ऑप्टिमाइज़ किया जाता है.
आपको एचटीटीपी 1.1 स्टैंडर्ड के दस्तावेज़ में, मैथड डेफ़िनिशन की जानकारी मिल सकती है. इनमें GET, POST, PUT, और DELETE के लिए खास जानकारी शामिल है.
Search Ads 360 एपीआई में REST
Search Ads 360 एपीआई ऑपरेशन, सीधे REST एचटीटीपी ऐक्शन पर मैप करते हैं.
Search Ads 360 एपीआई यूआरआई का खास फ़ॉर्मैट यह है:
https://www.googleapis.com/doubleclicksearch/v2/resourcePath?parameters
एपीआई में काम करने वाले हर ऑपरेशन के लिए इस्तेमाल किए जाने वाले यूआरआई के पूरे सेट की खास जानकारी एपीआई के संदर्भ में दी गई है.
JSON की बुनियादी बातें जानें
अगर आप REST का इस्तेमाल करते हैं, तो आपको अनुरोध के मुख्य हिस्से के लिए JSON फ़ॉर्मैट का इस्तेमाल करना होगा. आपके पास यह तय करने का विकल्प होता है कि रिस्पॉन्स, JSON या CSV फ़ॉर्मैट में हों या नहीं.
JSON (JavaScript ऑब्जेक्ट नोटेशन) एक सामान्य, भाषा-स्वतंत्र डेटा फ़ॉर्मैट है. यह आर्बिट्ररी डेटा स्ट्रक्चर के बारे में आसान टेक्स्ट दिखाता है. ज़्यादा जानकारी के लिए, json.org देखें.