Chat ऐप्लिकेशन और Google Chat API के अनुरोधों की पुष्टि करना और अनुमति देना

पुष्टि करने और अनुमति देने की प्रोसेस का इस्तेमाल, पहचान की पुष्टि करने और संसाधनों को ऐक्सेस करने के लिए किया जाता है. इस दस्तावेज़ में बताया गया है कि Chat ऐप्लिकेशन और Chat API के अनुरोधों के लिए, पुष्टि करने और अनुमति देने की प्रोसेस कैसे काम करती है.

प्रोसेस से जुड़ी खास जानकारी

नीचे दिए गए डायग्राम में, Google Chat के लिए पुष्टि करने और अनुमति देने के हाई-लेवल के चरण दिखाए गए हैं:

Google Chat में पुष्टि करने और अनुमति देने का तरीका
पहली इमेज. Google Chat में पुष्टि करने और अनुमति देने के लिए, सामान्य तरीके से किए जाने वाले चरण.

  1. Google Cloud प्रोजेक्ट को कॉन्फ़िगर करें, Chat API चालू करें, और अपने Chat ऐप्लिकेशन को कॉन्फ़िगर करें: डेवलपमेंट के दौरान, आपको एक Google Cloud प्रोजेक्ट बनाना होता है. Google Cloud प्रोजेक्ट में, Chat API चालू करें, Chat ऐप्लिकेशन को कॉन्फ़िगर करें, और पुष्टि करने की सुविधा सेट अप करें. ज़्यादा जानकारी के लिए, Google Workspace पर डेवलप करना और Chat ऐप्लिकेशन बनाना लेख पढ़ें.

  2. Chat API को कॉल करना: जब आपका ऐप्लिकेशन Chat API को कॉल करता है, तो वह Chat API को पुष्टि करने के क्रेडेंशियल भेजता है. अगर आपका ऐप्लिकेशन, सेवा खाते से पुष्टि करता है, तो क्रेडेंशियल आपके ऐप्लिकेशन के कोड के हिस्से के तौर पर भेजे जाते हैं. अगर आपके ऐप्लिकेशन को Chat API को कॉल करने के लिए, उपयोगकर्ता की ऐसी पुष्टि की ज़रूरत है जिसे अब तक अनुमति नहीं दी गई है, तो यह उपयोगकर्ता को साइन इन करने के लिए कहता है.

  3. संसाधनों का अनुरोध करना: आपका ऐप्लिकेशन, उन स्कोप के साथ ऐक्सेस का अनुरोध करता है जिन्हें आपने पुष्टि करने की सुविधा सेट अप करते समय तय किया था.

  4. सहमति मांगना: अगर आपका ऐप्लिकेशन, उपयोगकर्ता के तौर पर पुष्टि कर रहा है, तो Google, OAuth की सहमति वाली स्क्रीन दिखाता है. इससे उपयोगकर्ता यह तय कर पाता है कि उसे आपके ऐप्लिकेशन को अनुरोध किए गए डेटा का ऐक्सेस देना है या नहीं. सेवा खाते से पुष्टि करने के लिए, उपयोगकर्ता की सहमति की ज़रूरत नहीं होती.

  5. संसाधनों के लिए मंज़ूरी पा चुका अनुरोध भेजें: अगर उपयोगकर्ता अनुमति के दायरे में आने वाली कार्रवाइयों के लिए सहमति देता है, तो आपका ऐप्लिकेशन क्रेडेंशियल और उपयोगकर्ता की मंज़ूरी वाले दायरे को एक अनुरोध में बंडल करता है. ऐक्सेस टोकन पाने के लिए, यह अनुरोध Google ऑथराइज़ेशन सर्वर को भेजा जाता है.

  6. Google, ऐक्सेस टोकन दिखाता है: ऐक्सेस टोकन में, अनुमति दिए गए स्कोप की सूची होती है. अगर स्कोप की दिखाई गई सूची, अनुरोध किए गए स्कोप से ज़्यादा पाबंदियां लगाती है, तो आपका ऐप्लिकेशन उन सभी सुविधाओं को बंद कर देता है जिन पर टोकन की वजह से पाबंदियां लगी हैं.

  7. अनुरोध किए गए संसाधनों को ऐक्सेस करना: आपका ऐप्लिकेशन, Google से मिले ऐक्सेस टोकन का इस्तेमाल करके Chat API को शुरू करता है और Chat API के संसाधनों को ऐक्सेस करता है.

  8. रीफ़्रेश टोकन पाएं (ज़रूरी नहीं): अगर आपके ऐप्लिकेशन को एक ऐक्सेस टोकन की लाइफ़टाइम के बाद भी Google Chat API को ऐक्सेस करना है, तो वह रीफ़्रेश टोकन पा सकता है. ज़्यादा जानकारी के लिए, Google APIs को ऐक्सेस करने के लिए OAuth 2.0 का इस्तेमाल करना लेख पढ़ें.

  9. ज़्यादा संसाधनों का अनुरोध करना: अगर आपके ऐप्लिकेशन को ज़्यादा ऐक्सेस की ज़रूरत है, तो वह उपयोगकर्ता से नए स्कोप का ऐक्सेस देने के लिए कहता है. इससे, ऐक्सेस टोकन पाने के लिए नया अनुरोध किया जाता है (तीसरे से छठे चरण तक).

जब चैट ऐप्लिकेशन के लिए पुष्टि करना ज़रूरी हो

चैट ऐप्लिकेशन, उपयोगकर्ता के इंटरैक्शन के जवाब में या एसिंक्रोनस तरीके से मैसेज भेज सकते हैं. ये बॉट, उपयोगकर्ता की ओर से टास्क भी पूरे कर सकते हैं. जैसे, कोई चैट स्पेस बनाना या किसी चैट स्पेस में शामिल लोगों की सूची पाना.

चैट ऐप्लिकेशन को उपयोगकर्ता के इंटरैक्शन का जवाब देने के लिए पुष्टि करने की ज़रूरत नहीं होती. हालांकि, अगर चैट ऐप्लिकेशन, जवाब को प्रोसेस करते समय Chat API या किसी अन्य Google API को कॉल करता है, तो पुष्टि करना ज़रूरी है.

एसिंक्रोनस मैसेज भेजने या उपयोगकर्ता की ओर से टास्क पूरे करने के लिए, Chat ऐप्लिकेशन Chat API को RESTful अनुरोध भेजते हैं. इसके लिए, पुष्टि और अनुमति की ज़रूरत होती है.

उपयोगकर्ता के इंटरैक्शन के जवाबों के लिए पुष्टि करने की ज़रूरत नहीं होती

Google Chat ऐप्लिकेशन को इंटरैक्शन इवेंट पाने और उनका जवाब देने के लिए, उपयोगकर्ता या Chat ऐप्लिकेशन के तौर पर पुष्टि करने की ज़रूरत नहीं होती.

जब भी कोई उपयोगकर्ता किसी Chat ऐप्लिकेशन से इंटरैक्ट करता है या उसे शुरू करता है, तब Google Chat ऐप्लिकेशन को इंटरैक्शन इवेंट मिलते हैं. इनमें ये शामिल हैं:

  • कोई उपयोगकर्ता, Chat ऐप्लिकेशन को मैसेज भेजता है.
  • कोई उपयोगकर्ता, Chat ऐप्लिकेशन को @mention करता है.
  • कोई उपयोगकर्ता, Chat ऐप्लिकेशन की किसी कमांड का इस्तेमाल करता है.

नीचे दिए गए डायग्राम में, Chat का इस्तेमाल करने वाले व्यक्ति और Chat ऐप्लिकेशन के बीच अनुरोध और जवाब का क्रम दिखाया गया है:

Chat ऐप्लिकेशन के इंटरैक्शन इवेंट के लिए, अनुमति की ज़रूरत नहीं है
दूसरी इमेज.Chat ऐप्लिकेशन के इंटरैक्शन इवेंट के लिए पुष्टि करने की ज़रूरत नहीं होती.

  1. उपयोगकर्ता, Google Chat में Chat ऐप्लिकेशन को मैसेज भेजता है.
  2. Google Chat, मैसेज को ऐप्लिकेशन पर फ़ॉरवर्ड करता है.
  3. ऐप्लिकेशन को मैसेज मिलता है. इसके बाद, वह मैसेज को प्रोसेस करता है और Google Chat को जवाब भेजता है.
  4. Google Chat, उपयोगकर्ता या स्पेस के लिए जवाब दिखाता है.

यह क्रम, Chat ऐप्लिकेशन के हर इंटरैक्शन इवेंट के लिए दोहराया जाता है.

एसिंक्रोनस मैसेज के लिए पुष्टि करना ज़रूरी है

एसिंक्रोनस मैसेज तब भेजे जाते हैं, जब कोई Chat ऐप्लिकेशन Chat API से अनुरोध करता है. इसके लिए, पुष्टि करना और अनुमति देना ज़रूरी है.

Chat API को कॉल करके, Chat ऐप्लिकेशन Google Chat पर मैसेज पोस्ट कर सकते हैं. साथ ही, किसी उपयोगकर्ता की ओर से टास्क पूरे कर सकते हैं और डेटा ऐक्सेस कर सकते हैं. उदाहरण के लिए, सर्वर में रुकावट का पता चलने के बाद, Chat ऐप्लिकेशन Chat API को कॉल करके ये काम कर सकता है:

  • आउटेज की जांच करने और उसे ठीक करने के लिए, एक Chat स्पेस बनाएं.
  • Chat स्पेस में लोगों को जोड़ें.
  • Chat स्पेस में मैसेज पोस्ट करके, आउटेज के बारे में जानकारी दें.

नीचे दिए गए डायग्राम में, Chat ऐप्लिकेशन और Chat स्पेस के बीच एसिंक्रोनस मैसेज सीक्वेंस दिखाया गया है:

एसिंक्रोनस मैसेज के लिए पुष्टि करना ज़रूरी है
तीसरी इमेज. एसिंक्रोनस मैसेज के लिए, पुष्टि करना ज़रूरी है.

  1. Chat ऐप्लिकेशन, spaces.messages.create मेथड का इस्तेमाल करके Chat API को कॉल करके एक मैसेज बनाता है. साथ ही, एचटीटीपी अनुरोध में उपयोगकर्ता के क्रेडेंशियल शामिल करता है.
  2. Google Chat, सेवा खाते या उपयोगकर्ता के क्रेडेंशियल की मदद से Chat ऐप्लिकेशन की पुष्टि करता है.
  3. Google Chat, ऐप्लिकेशन के मैसेज को किसी तय किए गए Chat स्पेस में रेंडर करता है.

Chat API के स्कोप

OAuth के लिए सहमति की स्क्रीन को कॉन्फ़िगर करें और स्कोप चुनें, ताकि यह तय किया जा सके कि उपयोगकर्ताओं और ऐप्लिकेशन की समीक्षा करने वालों को कौनसी जानकारी दिखेगी. साथ ही, अपने ऐप्लिकेशन को रजिस्टर करें, ताकि बाद में उसे पब्लिश किया जा सके.

अपने ऐप्लिकेशन को दिए गए ऐक्सेस का लेवल तय करने के लिए, आपको अनुमति के स्कोप की पहचान करनी होगी और उन्हें ज़ाहिर करना होगा. अनुमति का दायरा, OAuth 2.0 यूआरआई स्ट्रिंग होता है. इसमें Google Workspace ऐप्लिकेशन का नाम, ऐक्सेस किए जाने वाले डेटा का टाइप, और ऐक्सेस का लेवल शामिल होता है.

गैर-संवेदनशील स्कोप

स्कोप कोड ब्यौरा
https://www.googleapis.com/auth/chat.bot

इस कुकी की मदद से, Chat ऐप्लिकेशन चैट देख सकते हैं और मैसेज भेज सकते हैं.

यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती.

संवेदनशील स्कोप

स्कोप कोड ब्यौरा
https://www.googleapis.com/auth/chat.spaces Chat में बातचीत शुरू करना और स्पेस बनाना. साथ ही, Chat में मेटाडेटा देखना या उसमें बदलाव करना. इसमें इतिहास सेव करने और ऐक्सेस से जुड़ी सेटिंग शामिल हैं.
https://www.googleapis.com/auth/chat.spaces.create Chat में नई बातचीत शुरू करना.
https://www.googleapis.com/auth/chat.spaces.readonly Chat में चैट और स्पेस देखना.
https://www.googleapis.com/auth/chat.memberships Chat में होने वाली बातचीत में सदस्यों को देखना, जोड़ना, हटाना, और उनकी भूमिकाएं अपडेट करना.
https://www.googleapis.com/auth/chat.memberships.app Google Chat में होने वाली बातचीत में खुद को जोड़ना और हटाना.
https://www.googleapis.com/auth/chat.memberships.readonly Chat पर होने वाली बातचीत में, सदस्यों को देखना.
https://www.googleapis.com/auth/chat.messages.create Chat में मैसेज लिखना और भेजना.
https://www.googleapis.com/auth/chat.messages.reactions Chat में, मैसेज पर दी गई प्रतिक्रियाएं देखना, जोड़ना, और मिटाना.
https://www.googleapis.com/auth/chat.messages.reactions.create Chat में किसी मैसेज पर प्रतिक्रियाएं जोड़ना.
https://www.googleapis.com/auth/chat.messages.reactions.readonly Chat में किसी मैसेज पर मिली प्रतिक्रियाएं देखना.
https://www.googleapis.com/auth/chat.users.readstate Chat में की गई किसी भी बातचीत को पिछली बार पढ़े जाने का समय देखना और उसमें बदलाव करना.
https://www.googleapis.com/auth/chat.users.readstate.readonly Chat में की गई बातचीत को पिछली बार पढ़े जाने का समय देखना.
https://www.googleapis.com/auth/chat.admin.spaces.readonly Chat में, एडमिन के डोमेन के मालिकाना हक वाली चैट और स्पेस देखना.
https://www.googleapis.com/auth/chat.admin.spaces Chat में, एडमिन के डोमेन के मालिकाना हक वाली चैट और स्पेस देखना या उनमें बदलाव करना.
https://www.googleapis.com/auth/chat.admin.memberships.readonly Chat में, एडमिन के डोमेन के मालिकाना हक वाली बातचीत में सदस्यों और मैनेजर की जानकारी देखना.
https://www.googleapis.com/auth/chat.admin.memberships Chat में, एडमिन के डोमेन की बातचीत में सदस्यों और मैनेजर की जानकारी देखना, उन्हें जोड़ना, हटाना, और भूमिकाएं अपडेट करना.
https://www.googleapis.com/auth/chat.app.spaces

Chat ऐप्लिकेशन के तौर पर, Chat में बातचीत और स्पेस बनाना. साथ ही, मेटाडेटा देखना या उसे अपडेट करना. इसमें इतिहास सेव करने और ऐक्सेस करने की सेटिंग शामिल हैं. इसके लिए, एडमिन की मंज़ूरी ज़रूरी है.

यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती.

https://www.googleapis.com/auth/chat.app.spaces.readonly

Chat ऐप्लिकेशन के तौर पर Chat में मेटाडेटा (इसमें इतिहास सेव करने की सेटिंग शामिल है) देखना. इसके लिए, एडमिन की मंज़ूरी ज़रूरी है.

यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती.

https://www.googleapis.com/auth/chat.app.spaces.create

Chat ऐप्लिकेशन के तौर पर, Chat में नई बातचीत शुरू करना और स्पेस बनाना. इसके लिए, एडमिन की मंज़ूरी ज़रूरी है.

यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती.

https://www.googleapis.com/auth/chat.app.memberships

Chat ऐप्लिकेशन के तौर पर, Chat में बातचीत और स्पेस में मौजूद सदस्यों को देखना, उन्हें जोड़ना, हटाना, और उनकी भूमिकाएं अपडेट करना. इसके लिए, एडमिन की मंज़ूरी ज़रूरी है.

यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती.

https://www.googleapis.com/auth/chat.app.memberships.readonly

Chat ऐप्लिकेशन के तौर पर, Chat में होने वाली बातचीत और स्पेस में मौजूद सदस्यों को देखना. इसके लिए, एडमिन की मंज़ूरी ज़रूरी है.

यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती.

https://www.googleapis.com/auth/chat.customemojis Chat में अपनी पसंद के मुताबिक इमोजी बनाएं, देखें, और मिटाएं.
https://www.googleapis.com/auth/chat.customemojis.readonly Chat में कस्टम इमोजी देखना.
https://www.googleapis.com/auth/chat.users.spacesettings Chat में उपयोगकर्ता के स्पेस की सेटिंग देखना और उनमें बदलाव करना.
https://www.googleapis.com/auth/chat.users.sections Chat में मौजूद सेक्शन देखना, बनाना, अपडेट करना, और मिटाना. Chat में मौजूद सेक्शन के आइटम की सूची बनाना और आइटम एक से दूसरी जगह ले जाना.
https://www.googleapis.com/auth/chat.users.sections.readonly Chat में मौजूद आपके सेक्शन और उनमें मौजूद आइटम देखना.

पाबंदी वाले स्कोप

स्कोप कोड ब्यौरा
https://www.googleapis.com/auth/chat.delete Chat में हुई बातचीत और स्पेस मिटाना. साथ ही, उनसे जुड़ी फ़ाइलों का ऐक्सेस हटाना.
https://www.googleapis.com/auth/chat.import स्पेसेज़, मैसेज, और पैसे चुकाकर ली जाने वाली सदस्यताओं को Chat में इंपोर्ट करना. ज़्यादा जानकारी के लिए, Chat ऐप्लिकेशन को डेटा इंपोर्ट करने की अनुमति देना लेख पढ़ें
https://www.googleapis.com/auth/chat.messages मैसेज देखना, लिखना, भेजना, अपडेट करना, और मिटाना. इसके अलावा, मैसेज में प्रतिक्रियाएं जोड़ना, देखना, और मिटाना.
https://www.googleapis.com/auth/chat.messages.readonly Chat में मैसेज और प्रतिक्रियाएं देखना.
https://www.googleapis.com/auth/chat.app.messages.readonly

Chat ऐप्लिकेशन के तौर पर, Chat में मैसेज और प्रतिक्रियाएं देखना. इसके लिए, एडमिन की मंज़ूरी ज़रूरी है.

यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती.

https://www.googleapis.com/auth/chat.admin.delete एडमिन के डोमेन के स्पेस और बातचीत को मिटाना. साथ ही, Chat में, उन स्पेस और बातचीत से जुड़ी फ़ाइलों का ऐक्सेस हटाना.
https://www.googleapis.com/auth/chat.app.delete

Chat ऐप्लिकेशन के तौर पर, Chat में हुई बातचीत और स्पेस मिटाना. साथ ही, उनसे जुड़ी फ़ाइलों का ऐक्सेस हटाना. इसके लिए, एडमिन की मंज़ूरी ज़रूरी है.

यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती.

ऊपर दी गई टेबल में मौजूद स्कोप, उनकी संवेदनशीलता के बारे में बताते हैं. संवेदनशीलता के बारे में यहां दी गई परिभाषाओं के हिसाब से बताया गया है:

अगर आपके ऐप्लिकेशन को किसी अन्य Google API को ऐक्सेस करने की ज़रूरत है, तो उन स्कोप को भी जोड़ा जा सकता है. Google API के स्कोप के बारे में ज़्यादा जानने के लिए, Google API को ऐक्सेस करने के लिए OAuth 2.0 का इस्तेमाल करना लेख पढ़ें.

Google Workspace API के स्कोप के बारे में ज़्यादा जानने के लिए, OAuth की सहमति वाली स्क्रीन कॉन्फ़िगर करना और स्कोप चुनना लेख पढ़ें.

पुष्टि करने के ज़रूरी तरीके

Chat ऐप्लिकेशन, Chat API के साथ इन दो तरीकों से पुष्टि कर सकते हैं और अनुमति दे सकते हैं:

उपयोगकर्ता की पुष्टि करना
उपयोगकर्ता की पुष्टि करने की सुविधा की मदद से, Chat ऐप्लिकेशन को उपयोगकर्ता का डेटा ऐक्सेस करने और उसकी ओर से कार्रवाइयां करने की अनुमति मिलती है. OAuth के दायरे से, अनुमति वाले डेटा और कार्रवाइयों के बारे में पता चलता है. अगर Chat ऐप्लिकेशन को एडमिन ने इंस्टॉल नहीं किया है या उसे पूरे डोमेन के लिए डेलिगेशन की अनुमति नहीं दी गई है, तो जब Chat ऐप्लिकेशन किसी उपयोगकर्ता की ओर से पहली बार कोई कार्रवाई करता है, तब उपयोगकर्ता को OAuth की सहमति वाली स्क्रीन का इस्तेमाल करके, Chat ऐप्लिकेशन को अनुमति देनी होगी.
ऐप्लिकेशन की पुष्टि करना

ऐप्लिकेशन की पुष्टि करने की सुविधा की मदद से, Chat ऐप्लिकेशन, सेवा खाते के क्रेडेंशियल का इस्तेमाल कर सकता है. साथ ही, डेटा को ऐक्सेस कर सकता है और खुद ही कार्रवाइयां पूरी कर सकता है. Chat ऐप्लिकेशन, संसाधनों को ऐक्सेस करने और उनके साथ काम करने के लिए, अपने क्रेडेंशियल का इस्तेमाल करता है. इसलिए, असली उपयोगकर्ताओं को Chat ऐप्लिकेशन के एपीआई कॉल को स्वीकार करने की ज़रूरत नहीं होती. साथ ही, ऐसी स्क्रीन जहां OAuth के लिए सहमति दी जाती है, उसमें ऐप्लिकेशन के ऑथराइज़ेशन के लिए इस्तेमाल होने वाले OAuth ऑथराइज़ेशन स्कोप नहीं जोड़े जा सकते.

OAuth की मदद से अनुमति देने के दो तरह के स्कोप, ऐप्लिकेशन की पुष्टि करने की सुविधा के साथ काम करते हैं:

  • https://www.googleapis.com/auth/chat.bot: आपका Chat ऐप्लिकेशन, Google Chat API के उन तरीकों को कॉल कर सकता है जो इस अनुमति के दायरे में आते हैं. इससे, ऐप्लिकेशन को उन संसाधनों को बनाने, अपडेट करने, पाने, सूची बनाने या मिटाने की अनुमति मिलती है जिन्हें ऐप्लिकेशन ऐक्सेस कर सकता है. जैसे, उन स्पेस में मौजूद मैसेज जिनमें असली उपयोगकर्ता आपके Chat ऐप्लिकेशन को जोड़ते हैं. आपका Chat ऐप्लिकेशन, अनुमति के इस स्कोप को खुद ही अनुमति दे सकता है. इसके लिए, एडमिन या असली उपयोगकर्ता की अनुमति की ज़रूरत नहीं होती.
  • https://www.googleapis.com/auth/chat.app.*: इन स्कोप का इस्तेमाल करने के लिए, एडमिन से एक बार अनुमति लेना ज़रूरी है. एडमिन से मंज़ूरी पाने के लिए, Chat ऐप्लिकेशन के सेवा खाते को एडमिन से मंज़ूरी पाने के लिए तैयार करें. इसके लिए, Google Workspace Marketplace के साथ काम करने वाला OAuth क्लाइंट बनाएं. साथ ही, Google Workspace Marketplace SDK में ऐप्लिकेशन को कॉन्फ़िगर करें. इन स्कोप की मदद से, आपका Chat ऐप्लिकेशन Google Chat API के खास तरीकों को कॉल कर सकता है. उदाहरण के लिए, chat.app.spaces.create से ऐप्लिकेशन को Chat स्पेस बनाने की अनुमति मिलती है.

अगर कोई तरीका, उपयोगकर्ता या ऐप्लिकेशन, दोनों की पुष्टि करने की सुविधा के साथ काम करता है, तो Chat API, इस्तेमाल किए गए पुष्टि के तरीके के आधार पर अलग-अलग नतीजे दिखाता है:

  • ऐप्लिकेशन की पुष्टि करने की सुविधा के साथ, तरीके सिर्फ़ उन संसाधनों को दिखाते हैं जिन्हें Chat ऐप्लिकेशन ऐक्सेस कर सकता है.
  • उपयोगकर्ता की पुष्टि करने की सुविधा की मदद से, ये तरीके सिर्फ़ उन संसाधनों को दिखाते हैं जिन्हें उपयोगकर्ता ऐक्सेस कर सकता है.

उदाहरण के लिए, ऐप्लिकेशन को अनुमति देने की सुविधा के साथ spaces.list() तरीके को कॉल करने पर, उन स्पेस की सूची मिलती है जिनमें Chat ऐप्लिकेशन सदस्य है. उपयोगकर्ता की अनुमति के साथ spaces.list() को कॉल करने पर, उन स्पेस की सूची मिलती है जिनमें उपयोगकर्ता सदस्य है. Chat API को कॉल करते समय, आपको दोनों तरह के पुष्टि करने के तरीकों का इस्तेमाल करना पड़ सकता है. यह आपके Chat ऐप्लिकेशन के डिज़ाइन और सुविधाओं पर निर्भर करता है.

Chat API के एसिंक्रोनस कॉल के लिए

यहां दी गई टेबल में, Chat API के तरीके और उनके साथ काम करने वाले अनुमति के स्कोप दिए गए हैं:

तरीका उपयोगकर्ता की पुष्टि की सुविधा उपलब्ध है ऐप्लिकेशन की पुष्टि करने की सुविधा काम करती है अनुमति पाने के लिंक काम करते हैं
स्पेस  
कोई स्पेस बनाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces.create
  • chat.spaces
  • chat.import
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.spaces.create
  • chat.app.spaces
कोई स्पेस सेट अप करना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces.create
  • chat.spaces
स्पेस पाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces.readonly
  • chat.spaces
एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करना:
  • chat.admin.spaces.readonly
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.spaces
स्पेस की सूची उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces.readonly
  • chat.spaces
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
स्पेस खोजना — एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करने की सुविधा के साथ:
  • chat.admin.spaces.readonly
स्पेस अपडेट करना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces
  • chat.import
एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करना:
  • chat.admin.spaces
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.spaces
किसी स्पेस को मिटाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.delete
  • chat.import
एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करना:
  • chat.admin.delete
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.delete
किसी स्पेस के लिए इंपोर्ट करने की प्रोसेस पूरी करना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.import
कोई डायरेक्ट मैसेज ढूंढना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces.readonly
  • chat.spaces
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
सदस्य  
सदस्यता बनाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.memberships
  • chat.memberships.app
  • chat.import
एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करना:
  • chat.admin.memberships
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.memberships
सदस्यता पाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.memberships.readonly
  • chat.memberships
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करना:
  • chat.admin.memberships.readonly
सदस्यों की सूची उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.memberships.readonly
  • chat.memberships
  • chat.import
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करना:
  • chat.admin.memberships.readonly
किसी सदस्य को मिटाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.memberships
  • chat.memberships.app
  • chat.import
एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करना:
  • chat.admin.memberships
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.memberships
किसी सदस्य की जानकारी अपडेट करना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.memberships
  • chat.import
एडमिन के विशेषाधिकारों का इस्तेमाल करके, उपयोगकर्ता की पुष्टि करना:
  • chat.admin.memberships
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.memberships
मैसेज  
मैसेज बनाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.create
  • chat.messages
  • chat.import
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
मैसेज पाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.readonly
  • chat.messages
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.messages.readonly
मैसेज की सूची उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.readonly
  • chat.messages
  • chat.import
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी के साथ:
  • chat.app.messages.readonly
मैसेज खोजना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.readonly
  • chat.messages
मैसेज अपडेट करना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages
  • chat.import
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
कोई मैसेज मिटाना उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages
  • chat.import
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
मैसेज पिन करना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces.pins
  • chat.spaces
मैसेज अनपिन करना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces.pins
  • chat.spaces
पिन किए गए मैसेज की सूची — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.spaces.pins.readonly
  • chat.spaces.readonly
  • chat.spaces.pins
  • chat.spaces
किसी मैसेज में कार्ड अपडेट करना — ऐप्लिकेशन की पुष्टि की सुविधा का इस्तेमाल करके:
  • chat.bot
प्रतिक्रियाएं  
प्रतिक्रिया बनाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.reactions.create
  • chat.messages.reactions
  • chat.messages
  • chat.import
प्रतिक्रियाओं की सूची — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.reactions.readonly
  • chat.messages.reactions
  • chat.messages.readonly
  • chat.messages
किसी प्रतिक्रिया को मिटाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.reactions
  • chat.messages
  • chat.import
पसंद के मुताबिक इमोजी  
पसंद के मुताबिक इमोजी बनाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.customemojis
पसंद के मुताबिक बनाए गए इमोजी को मिटाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.customemojis
पसंद के मुताबिक बनाया गया इमोजी पाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.customemojis
  • chat.customemojis.readonly
पसंद के मुताबिक बनाए गए इमोजी की सूची — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.customemojis
  • chat.customemojis.readonly
मीडिया और अटैचमेंट  
मीडिया को फ़ाइल अटैचमेंट के तौर पर अपलोड करना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.create
  • chat.messages
  • chat.import
मीडिया डाउनलोड करें उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.messages.readonly
  • chat.messages
ऐप्लिकेशन की पुष्टि की सुविधा के साथ:
  • chat.bot
मैसेज का अटैचमेंट पाना — ऐप्लिकेशन की पुष्टि की सुविधा का इस्तेमाल करके:
  • chat.bot
उपयोगकर्ता की पढ़ी गई स्थिति
किसी उपयोगकर्ता के स्पेस को पढ़ने की स्थिति की जानकारी पाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.readstate
  • chat.users.readstate.readonly
किसी उपयोगकर्ता के स्पेस में पढ़े जाने की स्थिति अपडेट करना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.readstate
उपयोगकर्ता के थ्रेड को पढ़े जाने की स्थिति की जानकारी पाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.readstate
  • chat.users.readstate.readonly
उपयोगकर्ता के स्पेस की सेटिंग
किसी उपयोगकर्ता के लिए स्पेस की सूचना सेटिंग पाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.spacesettings
किसी उपयोगकर्ता के लिए, स्पेस की सूचना सेटिंग अपडेट करना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.spacesettings
स्पेस इवेंट
स्पेस के इवेंट पाना — उपयोगकर्ता की पुष्टि के लिए, आपको इवेंट के टाइप के आधार पर स्कोप का इस्तेमाल करना होगा:
  • मैसेज से जुड़े इवेंट के लिए:
    • chat.messages
    • chat.messages.readonly
  • प्रतिक्रियाओं से जुड़े इवेंट के लिए:
    • chat.messages.reactions
    • chat.messages.reactions.readonly
    • chat.messages
    • chat.messages.readonly
  • पैसे चुकाकर ली जाने वाली सदस्यताओं से जुड़े इवेंट के लिए:
    • chat.memberships
    • chat.memberships.readonly
  • स्पेस के बारे में इवेंट के लिए:
    • chat.spaces
    • chat.spaces.readonly
स्पेस के इवेंट की सूची बनाना — उपयोगकर्ता की पुष्टि के लिए, आपको अनुरोध में शामिल किए गए हर इवेंट टाइप के लिए स्कोप का इस्तेमाल करना होगा:
  • मैसेज से जुड़े इवेंट के लिए:
    • chat.messages
    • chat.messages.readonly
  • प्रतिक्रियाओं से जुड़े इवेंट के लिए:
    • chat.messages.reactions
    • chat.messages.reactions.readonly
    • chat.messages
    • chat.messages.readonly
  • पैसे चुकाकर ली जाने वाली सदस्यताओं से जुड़े इवेंट के लिए:
    • chat.memberships
    • chat.memberships.readonly
  • स्पेस के बारे में इवेंट के लिए:
    • chat.spaces
    • chat.spaces.readonly
सेक्शन  
कोई सेक्शन बनाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.sections
किसी सेक्शन को मिटाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.sections
सेक्शन की सूची — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.sections
  • chat.users.sections.readonly
कोई सेक्शन अपडेट करना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.sections
सेक्शन को किसी जगह पर रखना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.sections
सेक्शन में मौजूद आइटम  
सेक्शन के किसी आइटम को दूसरी जगह ले जाना — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.sections
सेक्शन में मौजूद आइटम की सूची बनाओ — उपयोगकर्ता की पुष्टि की सुविधा के साथ:
  • chat.users.sections
  • chat.users.sections.readonly

Chat ऐप्लिकेशन के इंटरैक्शन इवेंट के लिए

यहां दी गई टेबल में, उपयोगकर्ताओं के चैट ऐप्लिकेशन के साथ इंटरैक्ट करने के सामान्य तरीके बताए गए हैं. साथ ही, यह भी बताया गया है कि पुष्टि करना ज़रूरी है या नहीं:

स्थिति पुष्टि करने की ज़रूरत नहीं है उपयोगकर्ता की पुष्टि की सुविधा उपलब्ध है ऐप्लिकेशन की पुष्टि करने की सुविधा काम करती है
इनसे मैसेज पाएं:
चैट ऐप्लिकेशन के साथ इंटरैक्ट करने से जुड़े इवेंट — —
Apps Script कॉलबैक — —
Google Cloud Pub/Sub — —
मैसेज के जवाब देना:
सिंक्रोनस तरीके से, Chat ऐप्लिकेशन के इंटरैक्शन इवेंट का इस्तेमाल करके — —
Apps Script कॉलबैक की रिटर्न वैल्यू का इस्तेमाल करके, सिंक्रोनस तरीके से — —
नए मैसेज भेजने के लिए:
इनकमिंग वेबहुक की मदद से — —