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

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

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

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

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

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

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

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

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

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

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

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

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

एपीआई वर्शन

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

  • v1: स्टेबल.

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

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