सिमैंटिक वर्शनिंग
Google Ads API, सिमैंटिक वर्शनिंग का पालन करता है. इसमें मुख्य और माइनर वर्शन नंबर होता है. वर्शन को MAJOR.MINOR या vMAJOR.MINOR के तौर पर लिखा जाता है.
उदाहरण के लिए, v25.0 (या v25) मुख्य वर्शन है, जबकि v25.1 माइनर वर्शन है.
मौजूदा और पिछले वर्शन के बारे में ज़्यादा जानने के लिए, रिलीज़ नोट देखें.
मेजर वर्शन
मेजर रिलीज़ वर्शन में, पुराने सिस्टम के साथ काम न करने वाले बदलाव किए जाते हैं. मेजर वर्शन का शुरुआती रिलीज़ वर्शन, शून्य पर खत्म होता है (vX.0 या vX, जहां X मेजर वर्शन नंबर है).
हर मुख्य वर्शन का अलग REST और gRPC एंडपॉइंट पाथ (vX) होता है. इसमें माइनर वर्शन का सफ़िक्स शामिल नहीं होता. इस यूआरएल में, X मुख्य वर्शन नंबर है. उदाहरण के लिए, v25:
https://googleads.googleapis.com/vX
अगर आपको पुराने मेजर वर्शन से अपग्रेड करना है, तो नए मेजर वर्शन के एंडपॉइंट पर स्विच करते समय, आपके कोड में बदलाव करने पड़ सकते हैं. अगर हमारी क्लाइंट लाइब्रेरी का इस्तेमाल किया जा रहा है, तो क्लाइंट लाइब्रेरी के उस वर्शन पर अपग्रेड करें जो नए मेजर वर्शन के साथ काम करता है. जब कोई मेजर वर्शन रिलीज़ होता है, तो हम आपको अपग्रेड गाइड उपलब्ध कराते हैं. इससे आपको अपने कोड में हुए किसी भी नुकसान पहुंचा सकने वाले बदलाव को ठीक करने में मदद मिलती है.
ब्रेकिंग चेंज के उदाहरण:
- किसी सेवा, इंटरफ़ेस, फ़ील्ड, तरीके या enum वैल्यू को हटाना या उसका नाम बदलना.
- किसी फ़ील्ड का टाइप बदलना.
- किसी संसाधन के नाम का फ़ॉर्मैट बदलना.
- एचटीटीपी डेफ़िनिशन में यूआरएल का फ़ॉर्मैट बदलना.
- आउटपुट फ़ॉर्मैट में बदलाव करना. जैसे, डिफ़ॉल्ट वैल्यू बदलना.
- गड़बड़ी की वजह को A से बदलकर B किया गया.
माइनर वर्शन
माइनर वर्शन में, सिर्फ़ पुराने वर्शन के साथ काम करने वाले बदलाव किए जाते हैं. माइनर वर्शन के लिए,
vMAJOR.MINOR में MINOR की वैल्यू शून्य से ज़्यादा होती है. उदाहरण के लिए,
v25.1.
जब कोई माइनर वर्शन रिलीज़ किया जाता है, तो मौजूदा मेजर वर्शन एंडपॉइंट (https://googleads.googleapis.com/vX) अपने-आप अपडेट हो जाता है. आपको अपने एंडपॉइंट यूआरएल में वर्शन पाथ बदलने की ज़रूरत नहीं है. साथ ही, मौजूदा कोड बिना किसी रुकावट के काम करता रहता है.
माइनर वर्शन में ऐसी सुविधाएं या अपडेट जोड़े जाते हैं जिनसे आपके मौजूदा कोड पर कोई असर नहीं पड़ता. क्लाइंट लाइब्रेरी के साथ माइनर वर्शन के फ़ील्ड या सुविधाओं का इस्तेमाल करने के लिए, अपनी क्लाइंट लाइब्रेरी को उस रिलीज़ पर अपग्रेड करें जिसमें माइनर वर्शन की परिभाषाएं शामिल हों.
बंद होने वाली सुविधाएं और सेवाएं
समय-समय पर, Google Ads API के पुराने वर्शन बंद कर दिए जाते हैं:
- बंद कर दिया गया है: जब कोई मेजर वर्शन (जैसे कि
v25) रिलीज़ किया जाता है, तो सभी पुराने मेजर वर्शन को बंद कर दिया जाता है. बंद किए गए वर्शन के लिए किए गए एपीआई कॉल, बंद होने की तारीख तक काम करते रहेंगे. साथ ही, मौजूदा क्लाइंट लाइब्रेरी रिलीज़ में इनका इस्तेमाल किया जा सकेगा. हालांकि, इसके बाद की क्लाइंट लाइब्रेरी रिलीज़ में, पैकेज का साइज़ कम करने के लिए, बंद किए गए एपीआई वर्शन शामिल नहीं किए जाएंगे. - बंद होना: किसी वर्शन के बंद होने की तारीख पर, उसे बंद कर दिया जाता है. साथ ही, उसके एंडपॉइंट पर किए गए सभी एपीआई कॉल पूरे नहीं हो पाते.
हम वर्शन बंद होने से पहले, डेवलपर ब्लॉग पर एलान पोस्ट करते हैं. चालू, बंद किए गए, और बंद होने की तारीखों के लिए बंद होने और बंद होने के शेड्यूल की जानकारी देखें.