वर्शन

Business Profile के कुछ एपीआई, एक से ज़्यादा वर्शन और रिलीज़ चैनल में उपलब्ध हैं. वर्शन, अनुरोध यूआरएल का वह सेगमेंट होता है जो होस्टनेम के बाद आता है, जैसे कि v1 या v1alpha. इस पेज पर बताया गया है कि वर्शन को नंबर कैसे दिए जाते हैं, हर रिलीज़ चैनल कितना स्टेबल है, और ऐल्फ़ा चैनल को कैसे कॉल किया जाता है.

वर्शन नंबरिंग

एपीआई के हर वर्शन में एक मेजर वर्शन नंबर और एक वैकल्पिक चैनल सफ़िक्स होता है:

  • मेजर वर्शन (v1, v2, ...): यह वर्शन स्टेबल होता है और सामान्य रूप से उपलब्ध होता है. मेजर वर्शन में सिर्फ़ ऐसे बदलाव किए जाते हैं जो पुराने सिस्टम के साथ काम करते हैं. जैसे, नए तरीके, नए फ़ील्ड या नई enum वैल्यू. ऐसे बदलाव जो पुराने सिस्टम के साथ काम नहीं करते, उन्हें नए मेजर वर्शन में रिलीज़ किया जाता है.
  • ऐल्फ़ा चैनल (v1alpha, v2alpha, ...): यह किसी मेजर वर्शन का प्री-रिलीज़ चैनल होता है. इसमें उस मेजर वर्शन की सभी सुविधाएं शामिल होती हैं. साथ ही, इसमें ऐसी सुविधाएं भी शामिल होती हैं जो अब तक सामान्य रूप से उपलब्ध नहीं हैं.

रिलीज़ चैनल

चैनल स्थिरता सामग्री
सामान्य रूप से उपलब्ध (v1) स्थिर. किसी मेजर वर्शन में किए गए बदलाव, पुराने सिस्टम के साथ काम करते हैं. जब किसी मेजर वर्शन को बंद कर दिया जाता है, तो वह बंद होने की सूचना के बाद कम से कम 12 महीनों तक उपलब्ध रहता है. बंद किए जाने वाले वर्शन और बंद होने की तारीखें, बंद किए जाने का शेड्यूल पेज पर पब्लिश की जाती हैं. सामान्य रूप से उपलब्ध सुविधाएं.
ऐल्फ़ा (v1alpha) रिलीज़ से पहले, बिना किसी स्टेबिलिटी कमिटमेंट और तय लाइफ़स्पैन के. ऐल्फ़ा वर्शन में उपलब्ध सुविधाओं में बदलाव किया जा सकता है या उन्हें बंद किया जा सकता है. हालांकि, ऐसा करने से कम से कम 30 दिन पहले आपको इसकी सूचना दी जाएगी. प्रोडक्शन इंटिग्रेशन में ऐल्फ़ा वर्शन वाली सुविधाओं का इस्तेमाल न करें. v1 में मौजूद सभी सुविधाएं. साथ ही, ऐसी सुविधाएं जो अब तक सामान्य रूप से उपलब्ध नहीं हैं.

सुविधाएं एक चैनल से दूसरे चैनल पर कैसे मूव होती हैं

जब कोई सुविधा v1alpha से v1 में शामिल हो जाती है, तब भी वह v1alpha में उपलब्ध रहती है.

सिर्फ़ v1alpha में उपलब्ध सुविधाओं के लिए गाइड और रेफ़रंस पेजों को, ऐल्फ़ा के तौर पर मार्क किया गया है. नई ऐल्फ़ा और सामान्य तौर पर उपलब्ध सुविधाओं के साथ-साथ, ऐल्फ़ा सुविधाओं में किए गए बदलावों या उन्हें हटाने की जानकारी, नए अपडेट और हर एपीआई के बदलाव लॉग में दी जाती है.

ऐल्फ़ा चैनल का इस्तेमाल करना

अल्फ़ा चैनल को कॉल करने के लिए, अनुरोध के यूआरएल में v1 को v1alpha से बदलें. उदाहरण के लिए:

GET https://mybusinessbusinessinformation.googleapis.com/v1alpha/locations/{locationId}?readMask={readMask}

दोनों चैनल एक ही एपीआई से जुड़े हैं. इसलिए, इनमें ये चीज़ें एक जैसी होती हैं:

  • Google Cloud console में एपीआई चालू करना.
  • OAuth 2.0 स्कोप और ऐक्सेस से जुड़ी ज़रूरी शर्तें.
  • संसाधन के नाम, जैसे कि locations/{locationId}.
  • कोटा. v1 और v1alpha के लिए किए गए अनुरोधों की गिनती, हर प्रोजेक्ट के लिए तय किए गए कोटे के हिसाब से की जाती है. ज़्यादा जानकारी के लिए, कोटा की सीमाएं देखें.
  • कारोबार का मौजूदा डेटा. v1alpha से किए गए बदलाव, v1 में दिखते हैं. इसी तरह, से किए गए बदलाव, में दिखते हैं.

क्लाइंट लाइब्रेरी और सार्वजनिक एपीआई डायरेक्ट्री में सिर्फ़ v1 शामिल है. v1alpha को कॉल करने के लिए, सीधे REST अनुरोध भेजें.

सबसे सही तरीके

  • प्रोडक्शन इंटिग्रेशन के लिए, v1 जैसे स्टेबल वर्शन का इस्तेमाल करें.
  • ऐल्फ़ा चैनल का इस्तेमाल करें, जैसे कि v1alpha. इससे नई सुविधाओं को सामान्य रूप से उपलब्ध होने से पहले ही इस्तेमाल किया जा सकता है. सुझाव/राय देने या शिकायत करने के लिए, सहायता देखें.
  • अपने क्लाइंट को ऐसे फ़ील्ड और enum वैल्यू को स्वीकार करने की अनुमति दें जिन्हें वह नहीं पहचानता.
  • ऐल्फ़ा वर्शन में उपलब्ध किसी सुविधा का इस्तेमाल करने से पहले, उसकी गाइड और बदलाव लॉग देखें. इससे आपको पता चलेगा कि उस सुविधा के इस्तेमाल पर कौनसी पाबंदियां लागू होती हैं.