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

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

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

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

Google Workspace इवेंट एपीआई के स्कोप

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

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

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

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

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

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

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

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

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

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

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

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

OAuth की पुष्टि करना

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

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

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

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

इस टेबल में बताया गया है कि Google Workspace Event 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 इवेंट एपीआई को कॉल करने पर, आपको सदस्यता के इवेंट टाइप से जुड़े एक या एक से ज़्यादा स्कोप तय करने होंगे.

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

इवेंट इवेंट के टाइप अनुमति के ये दायरे इस्तेमाल किए जा सकते हैं
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
सदस्यता बनाई जाती है, अपडेट की जाती है या हटा दी जाती है या एक से ज़्यादा सदस्यताएं बदल दी जाती हैं.
  • 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