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

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

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

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

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

अगर Google Apps Script के साथ कोडिंग की जा रही है, तो Chat की बेहतर सेवा तो आपको यह सुविधा मिलेगी.

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

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

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

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

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

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

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

एपीआई वर्शन

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

  • v1: स्थिर.

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

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