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 API को ऐक्सेस करने के लिए OAuth 2.0 का इस्तेमाल करना लेख पढ़ें.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  1. कोई चैट ऐप्लिकेशन, 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 में बातचीत शुरू करना और स्पेस बनाना. साथ ही, Chat में मेटाडेटा देखना या उसे अपडेट करना. इसमें इतिहास सेव करने और ऐक्सेस से जुड़ी सेटिंग शामिल हैं. इसके लिए, एडमिन की अनुमति ज़रूरी है.

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

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

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 में चैट ऐप्लिकेशन के तौर पर, बातचीत और स्पेस मिटाना. साथ ही, उनसे जुड़ी फ़ाइलों का ऐक्सेस हटाना. इसके लिए, एडमिन की अनुमति ज़रूरी है.

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

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

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

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

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

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

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

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

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

  • https://www.googleapis.com/auth/chat.bot: आपका चैट ऐप्लिकेशन, Google Chat API के उन तरीकों को कॉल कर सकता है जो अनुमति के इस दायरे के साथ काम करते हैं. इससे, उन संसाधनों को बनाया, अपडेट किया, पाया, मिटाया जा सकता है या उनकी सूची बनाई जा सकती है जिनका ऐक्सेस आपके चैट ऐप्लिकेशन के पास है. जैसे, उन स्पेस में मौजूद मैसेज जिनमें असली उपयोगकर्ता आपके चैट ऐप्लिकेशन को जोड़ते हैं. आपका चैट ऐप्लिकेशन, अनुमति के इस स्कोप को खुद ही अनुमति दे सकता है. इसके लिए, किसी एडमिन या असली उपयोगकर्ता की अनुमति की ज़रूरत नहीं होती.
  • https://www.googleapis.com/auth/chat.app.*: इन स्कोप का इस्तेमाल करने के लिए, एडमिन से एक बार अनुमति लेनी होगी. एडमिन से अनुमति पाने के लिए, आपको चैट ऐप्लिकेशन के सेवा खाते को एडमिन से अनुमति पाने के लिए तैयार करना होगा. इसके लिए, 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 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
Messages  
कोई मैसेज बनाना उपयोगकर्ता की पुष्टि की मदद से:
  • 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.readstate
उपयोगकर्ता के लिए स्पेस की सेटिंग
किसी उपयोगकर्ता के स्पेस की सूचना सेटिंग पाना — उपयोगकर्ता की पुष्टि की मदद से:
  • 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 ऐप्लिकेशन के इंटरैक्शन इवेंट के लिए

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

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