Python क्लाइंट लाइब्रेरी को GitHub पर होस्ट किया जाता है और पैकेज PyPI पर उपलब्ध होता है.
ज़रूरी शर्तें
लाइब्रेरी के लिए, Python 3.8 या इसके बाद का वर्शन ज़रूरी है.
ज़रूरी शर्तें
लाइब्रेरी इंस्टॉल करने से पहले, आपके पास डेवलपर टोकन और क्लाइंट ग्राहक आईडी होना चाहिए. उन्हें हासिल करने के निर्देश ज़रूरी शर्तों वाले सेक्शन में दिए गए हैं. ध्यान दें कि आपको बाद के चरणों में, ज़रूरी अन्य OAuth2 टोकन जनरेट करने होंगे.
रनटाइम और डिपेंडेंसी के साथ काम करने की सुविधा
Python क्लाइंट लाइब्रेरी, Python सॉफ़्टवेयर फ़ाउंडेशन के पब्लिश किए गए काम करने वाले वर्शन सेक्शन में मौजूद Python रनटाइम के साथ काम करती है. हालांकि, "सुविधा" या "प्री-रिलीज़" स्टेटस वाले वर्शन के साथ काम नहीं करती.
Python रनटाइम के नए वर्शन को अपनाते समय, हमारा मकसद Python क्लाइंट लाइब्रेरी का नया वर्शन रिलीज़ करना है. यह वर्शन, रिलीज़ होने के बाद की तिमाही के आखिर तक, नए रनटाइम के साथ काम करेगा. उदाहरण के लिए, अगर अक्टूबर में कोई नया रनटाइम रिलीज़ किया जाता है, तो अगले साल मार्च के आखिर तक Python क्लाइंट लाइब्रेरी का काम करने वाला वर्शन उपलब्ध हो जाएगा.
python.org के काम न करने वाले वर्शन सेक्शन में, समयसीमा खत्म होने की तारीख के बाद Python रनटाइम का इस्तेमाल नहीं किया जा सकता.
हम Python क्लाइंट लाइब्रेरी का ऐसा वर्शन रिलीज़ कर सकते हैं जो काम न करने वाले Python रनटाइम के साथ काम न करे. ऐसा, रनटाइम के ईओएल (इस्तेमाल की समयसीमा खत्म होने) के बाद कभी भी किया जा सकता है.
डिपेंडेंसी के लिए, हम उन पैकेज के साथ काम करना जारी रखेंगे जिन्हें Google मैनेज करता है. खास तौर पर, उन पैकेज के साथ जिन्हें Python क्लाइंट लाइब्रेरी ने ज़रूरी के तौर पर सूची में शामिल किया है. साथ ही, हम उन पैकेज के साथ भी काम करना जारी रखेंगे जिन्हें Google की ओएसएस में बदलाव से जुड़ी नीति के मुताबिक "काम करता है" माना जाता है.
काम करने वाले Python रनटाइम और डिपेंडेंसी की पूरी सूची देखने के लिए, डिपेंडेंसी पेज देखें.
इंस्टॉल करना
PyPi से लाइब्रेरी इंस्टॉल करने और इस पेज पर वापस लौटने के लिए, हमारे इंस्टॉलेशन दस्तावेज़ों में दिए गए निर्देशों का पालन करें.
कॉन्फ़िगरेशन
लाइब्रेरी इंस्टॉल करने के बाद, आपको इसके लिए कॉन्फ़िगरेशन सेट अप करना होगा. लाइब्रेरी को कॉन्फ़िगर करने के कई तरीके हैं. इनके बारे में हमारे कॉन्फ़िगरेशन दस्तावेज़ में बताया गया है.
पुष्टि करना
कॉन्फ़िगरेशन टाइप चुनने के बाद, एपीआई को अनुरोध करने के लिए ज़रूरी OAuth2 टोकन जनरेट किए जा सकते हैं. OAuth2 के कई फ़्लो काम करते हैं. इनके बारे में नीचे दी गई सूची में बताया गया है. फ़्लो के बीच के अंतर और अपने ऐप्लिकेशन के लिए सबसे सही विकल्प चुनने में मदद पाने के लिए, हमारा OAuth दस्तावेज़ देखें.
एपीआई अनुरोध करना
अपने कॉन्फ़िगरेशन में OAuth2 टोकन शामिल करने के बाद, एपीआई अनुरोध किया जा सकता है. कैंपेन पाएं उदाहरण देखें. इससे, यह जांचने का आसान तरीका पता चलता है कि लाइब्रेरी को एपीआई अनुरोध करने के लिए सही तरीके से कॉन्फ़िगर किया गया है या नहीं.
get_campaigns.py सैंपल चलाने के लिए, स्थानीय तौर पर इंस्टॉल की गई googleads-python क्लाइंट लाइब्रेरी की रूट डायरेक्ट्री में, यह कमांड चलाएं:
$ python examples/basic_operations/get_campaigns.py -c \
INSERT_YOUR_CUSTOMER_ID_HERE
अन्य संसाधन
एपीआई अनुरोध करने के बाद, क्लाइंट लाइब्रेरी का इस्तेमाल इन कामों के लिए करें: