Google Chat API की खास जानकारी

इस पेज पर, Google Chat API और उसके रेफ़रंस दस्तावेज़ का इस्तेमाल करने के तरीके के बारे में खास जानकारी दी गई है.

Google Chat API में gRPC और REST इंटरफ़ेस, दोनों मौजूद हैं. साथ ही, इसमें दोनों के साथ काम करने वाली क्लाइंट लाइब्रेरी भी हैं. अगर दी गई क्लाइंट लाइब्रेरी आपकी ज़रूरतों को पूरा नहीं करती हैं, तो आपके पास gRPC या REST इंटरफ़ेस का इस्तेमाल करने वाली अपनी क्लाइंट लाइब्रेरी लिखने का विकल्प होता है.

क्लाइंट लाइब्रेरी

ज़्यादातर डेवलपर के लिए, Google Chat API को कॉल करने का सुझाव दिया जाता है. इसके लिए, अपनी पसंद की भाषा के लिए, आधिकारिक तौर पर उपलब्ध क्लाउड क्लाइंट लाइब्रेरी का इस्तेमाल करें. जैसे, Python, Java या Node.js.

अगर Google Apps Script का इस्तेमाल करके कोडिंग की जा रही है, तो क्लाइंट लाइब्रेरी इंस्टॉल करने के बजाय Chat की ऐडवांस सेवा का इस्तेमाल करें.

टाइप, तरीका, और फ़ील्ड के नाम

क्लाइंट लाइब्रेरी, gRPC या REST का इस्तेमाल करने के आधार पर, Google Chat API के लिए टाइप, तरीका, और फ़ील्ड के नाम कुछ हद तक अलग-अलग होते हैं:

  • क्लाउड क्लाइंट लाइब्रेरी को gRPC सेवाओं और उनके तरीकों के हिसाब से व्यवस्थित किया जाता है. Google API क्लाइंट लाइब्रेरी को सेवाओं के तौर पर व्यवस्थित किया जाता है. इनमें ऐसे ऑब्जेक्ट या क्लास होते हैं जो REST संसाधनों से मेल खाते हैं. इनमें मिलते-जुलते तरीके भी शामिल होते हैं.
  • gRPC को सेवाओं और उनके तरीकों के हिसाब से व्यवस्थित किया जाता है.
  • REST को संसाधन के पदानुक्रमों और उनके तरीकों के हिसाब से व्यवस्थित किया जाता है.
  • gRPC फ़ील्ड के नाम, स्नेक केस का इस्तेमाल करते हैं.
  • REST फ़ील्ड के नामों में कैमल केस का इस्तेमाल किया जाता है. हालांकि, एपीआई सेवा कैमल केस या स्नेक केस, दोनों को स्वीकार करेगी.
  • क्लाइंट लाइब्रेरी के फ़ील्ड के नामों में, टाइटल केस, कैमल केस या स्नेक केस का इस्तेमाल किया जाता है. यह इस बात पर निर्भर करता है कि भाषा के लिए कौनसे केस का इस्तेमाल करना सही है.

प्रोटोकॉल बफ़र

चाहे क्लाइंट लाइब्रेरी, REST या gRPC का इस्तेमाल किया जा रहा हो, प्रोटोकॉल बफ़र का इस्तेमाल करके, बुनियादी सेवा को तय किया जाता है. खास तौर पर, यह सेवा proto3 का इस्तेमाल करती है.

एपीआई को कॉल करते समय, कुछ अनुरोध या जवाब फ़ील्ड के लिए प्रोटोकॉल बफ़र के जाने-माने टाइप के बारे में बुनियादी जानकारी होना ज़रूरी है.

इसके अलावा, REST API को कॉल करते समय, प्रोटोकॉल बफ़र के लिए डिफ़ॉल्ट वैल्यू के व्यवहार की वजह से, JSON जवाब में फ़ील्ड मौजूद नहीं हो सकते. इन फ़ील्ड को डिफ़ॉल्ट वैल्यू पर सेट किया गया है. इसलिए, इन्हें जवाब में शामिल नहीं किया गया है.

एपीआई वर्शन

एपीआई के ये वर्शन उपलब्ध हैं:

  • v1: स्टेबल.

डेवलपर के लिए झलक

दस्तावेज़ में, आपको ऐसे एपीआई तरीके या फ़ील्ड दिख सकते हैं जो सिर्फ़ Developer Preview Program के ज़रिए उपलब्ध हैं. झलक के तौर पर उपलब्ध नई सुविधाओं को आज़माने, उनकी झलक देखने, और उनके बारे में सुझाव/राय/शिकायत देने के लिए, Developer Preview Program में शामिल हों.