Google Workspace Events API के दायरे चुनें

इस दस्तावेज़ में, Google Workspace Events API से जुड़ी अनुमति और पुष्टि करने की जानकारी दी गई है. इस दस्तावेज़ को पढ़ने से पहले, पुष्टि करने और अनुमति देने के बारे में जानें पर जाकर, Google Workspace के पुष्टि करने और अनुमति देने के सामान्य तरीके के बारे में ज़रूर पढ़ें.

अनुमति के लिए OAuth 2.0 को कॉन्फ़िगर करना

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

Google Workspace Events API के स्कोप

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

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

हमारा सुझाव है कि जहां भी हो सके वहां ग़ैर-संवेदनशील स्कोप का इस्तेमाल करें. ऐसा करने से, हर फ़ाइल के लिए ऐक्सेस स्कोप मिलता है और ऐप्लिकेशन के लिए ज़रूरी फ़ंक्शन के ऐक्सेस को सीमित किया जा सकता है.

Google Workspace Events API, Google Workspace के उन ऐप्लिकेशन के स्कोप का इस्तेमाल करता है जिनमें सदस्यताएं लेने की सुविधा उपलब्ध है. अगर आपका ऐप्लिकेशन पहले से ही उन स्कोप का इस्तेमाल करता है जो आपकी सदस्यता के लिए ज़रूरी हैं, तो आपको Google Workspace Events API का इस्तेमाल करने के लिए, अतिरिक्त स्कोप जोड़ने की ज़रूरत नहीं है.

नीचे दी गई टेबल में, Google Workspace Events API के साथ काम करने वाले स्कोप दिखाए गए हैं:

स्कोप कोड ब्यौरा इस्तेमाल
Google Chat  
https://www.googleapis.com/auth/chat.bot इससे Google Chat ऐप्लिकेशन, चैट देख सकते हैं और मैसेज भेज सकते हैं. इससे, आपको Chat ऐप्लिकेशन की सभी सुविधाओं का ऐक्सेस मिलता है. संवेदनशील नहीं
https://www.googleapis.com/auth/chat.memberships Google Chat में होने वाली बातचीत में सदस्यों को देखना, नए सदस्य जोड़ना, और उन्हें हटाना.
संवेदनशील
https://www.googleapis.com/auth/chat.memberships.readonly Google Chat में होने वाली बातचीत में शामिल सदस्यों को देखें.
संवेदनशील
https://www.googleapis.com/auth/chat.spaces Google Chat में बातचीत और स्पेस बनाना. साथ ही, Google Chat में मेटाडेटा देखना या उसे अपडेट करना. इसमें इतिहास सेव करने की सेटिंग भी शामिल है. संवेदनशील
https://www.googleapis.com/auth/chat.spaces.readonly Google Chat में मौजूद चैट और स्पेस देखना.
संवेदनशील
https://www.googleapis.com/auth/chat.messages.reaction सेकंड Chat में मैसेज पर प्रतिक्रियाएं जोड़ना, देखना, और मिटाना.
संवेदनशील
https://www.googleapis.com/auth/chat.messages.reactions.readonly Chat में किसी मैसेज पर मिली प्रतिक्रियाएं देखना.
संवेदनशील
https://www.googleapis.com/auth/chat.messages मैसेज देखें, लिखें, भेजें, अपडेट करें, और मिटाएं. साथ ही, मैसेज में प्रतिक्रियाएं जोड़ें, देखें, और मिटाएं. सभी देशों/इलाकों में उपलब्ध नहीं है
https://www.googleapis.com/auth/chat.messages.readonly Google Chat में मैसेज और प्रतिक्रियाएं देखें.
पाबंदी लगी है
Google Meet  
https://www.googleapis.com/auth/meetings.space.created ऐप्लिकेशन को आपके ऐप्लिकेशन से बनाए गए मीटिंग स्पेस का मेटाडेटा बनाने, उसमें बदलाव करने, और उसे पढ़ने की अनुमति दें.
संवेदनशील
https://www.googleapis.com/auth/meetings.space.readonly ऐप्लिकेशन को किसी भी मीटिंग स्पेस का मेटाडेटा पढ़ने की अनुमति दें जिसका ऐक्सेस उपयोगकर्ता के पास है.
संवेदनशील

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

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

OAuth 2.0 के खास स्कोप के बारे में ज़्यादा जानने के लिए, Google API के लिए OAuth 2.0 स्कोप देखें.

OAuth की मदद से पुष्टि करना

OAuth के कुछ दायरों का इस्तेमाल करने के लिए, हो सकता है कि आपके ऐप्लिकेशन को Google की OAuth पुष्टि करने की प्रोसेस पूरी करनी पड़े. OAuth API की पुष्टि से जुड़े अक्सर पूछे जाने वाले सवाल पढ़ें. इससे आपको यह तय करने में मदद मिलेगी कि आपके ऐप्लिकेशन की पुष्टि कब होनी चाहिए और किस तरह की पुष्टि की ज़रूरत है. Google Drive की सेवा की अन्य शर्तें भी देखें.

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

इस सेक्शन में बताया गया है कि पुष्टि करने के लिए किस तरह के तरीके ज़रूरी हैं या काम करते हैं. साथ ही, Google Workspace Events API के हर तरीके के लिए काम करने वाले स्कोप की जानकारी भी दी गई है.

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

इस टेबल में दिखाया गया है कि Google Workspace Events API के हर तरीके के लिए पुष्टि करने के कौनसे दायरे और टाइप ज़रूरी हैं या काम करते हैं:

तरीका उपयोगकर्ता की पुष्टि करना ज़रूरी है या यह सुविधा काम करती है ऐप्लिकेशन की पुष्टि करने की सुविधा काम करती है (सिर्फ़ Google Chat ऐप्लिकेशन के लिए) अनुमति के दायरे
सदस्यता बनाना —

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

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
सदस्यता लेना उपयोगकर्ता की पुष्टि करने के लिए, इस तरीके के लिए ज़रूरी है कि सदस्यता के लिए कम से कम एक इवेंट टाइप काम करता हो.

ऐप्लिकेशन की पुष्टि करने की सुविधा के साथ (सिर्फ़ Google Chat के ऐप्लिकेशन के लिए):

  • chat.bot
सदस्यताओं की सूची उपयोगकर्ता की पुष्टि करने के लिए, इस तरीके के लिए ज़रूरी है कि सदस्यता के लिए कम से कम एक इवेंट टाइप काम करता हो.

ऐप्लिकेशन की पुष्टि करने की सुविधा के साथ (सिर्फ़ Google Chat के ऐप्लिकेशन के लिए):

  • chat.bot
सदस्यता अपडेट करना —

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

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
सदस्यता को फिर से चालू करना —

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

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • meetings.space.created
  • meetings.space.readonly
सदस्यता मिटाना उपयोगकर्ता की पुष्टि करने के लिए, इस तरीके के लिए ज़रूरी है कि सदस्यता के लिए कम से कम एक इवेंट टाइप काम करता हो.

ऐप्लिकेशन की पुष्टि करने की सुविधा के साथ (सिर्फ़ Google Chat के ऐप्लिकेशन के लिए):

  • chat.bot

इवेंट टाइप के हिसाब से स्कोप

उपयोगकर्ता की पुष्टि करने की सुविधा का इस्तेमाल करके, Google Workspace Events API को कॉल करते समय, आपको एक या उससे ज़्यादा ऐसे स्कोप बताने होंगे जो सदस्यता के इवेंट टाइप से जुड़े हों.

इस टेबल में दिखाया गया है कि हर तरह के इवेंट के लिए, अनुमति के कौनसे दायरे काम करते हैं:

इवेंट इवेंट टाइप अनुमति पाने के लिंक
Google Chat  
कोई मैसेज पोस्ट या अपडेट किया गया हो.
  • google.workspace.chat.message.v1.created
  • google.workspace.chat.message.v1.updated
  • chat.messages
  • chat.messages.readonly
कोई प्रतिक्रिया जोड़ी या मिटाई जाती है या एक से ज़्यादा प्रतिक्रियाओं में बदलाव किया जाता है.
  • google.workspace.chat.reaction.v1.created
  • google.workspace.chat.reaction.v1.deleted
  • google.workspace.chat.reaction.v1.batchChanged
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.messages
  • chat.messages.readonly
सदस्यता बनाई गई, अपडेट की गई या हटाई गई हो या एक से ज़्यादा सदस्यताओं में बदलाव किया गया हो.
  • google.workspace.chat.membership.v1.created
  • google.workspace.chat.membership.v1.updated
  • google.workspace.chat.membership.v1.deleted
  • google.workspace.chat.membership.v1.batchChanged
  • chat.memberships
  • chat.memberships.readonly
किसी स्पेस को अपडेट किया गया है या मिटाया गया है.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
  • chat.spaces
  • chat.spaces.readonly
Google Meet  
कॉन्फ़्रेंस शुरू या खत्म होती है.
  • google.workspace.meet.conference.v2.started
  • google.workspace.meet.conference.v2.ended
  • meetings.space.created
  • meetings.space.readonly
कोई उपयोगकर्ता, कॉन्फ़्रेंस में शामिल होता है या उसे छोड़ता है.
  • google.workspace.meet.participant.v2.joined
  • google.workspace.meet.participant.v2.left
  • meetings.space.created
  • meetings.space.readonly
रिकॉर्डिंग जनरेट की गई.
  • google.workspace.meet.recording.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly
ट्रांसक्रिप्ट जनरेट की गई.
  • google.workspace.meet.transcript.v2.fileGenerated
  • meetings.space.created
  • meetings.space.readonly