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

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

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

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

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

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

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

क्लाइंट लाइब्रेरी, gRPC या REST का इस्तेमाल करने पर, Google Chat API के टाइप, तरीके, और फ़ील्ड के नाम में थोड़ा अंतर होता है:

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

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

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

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

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

एपीआई वर्शन

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

  • v1: यह वर्शन स्थिर है.

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

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