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.app.memberships

Google Chat में, 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.app.spaces

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 में मैसेज और प्रतिक्रियाएं देखना.
पाबंदी है
https://www.googleapis.com/auth/chat.app.messages.readonly

Chat ऐप्लिकेशन के तौर पर, Google Chat में मैसेज और प्रतिक्रियाएं देखना.

इसके लिए, एडमिन की अनुमति ज़रूरी है.

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

इस प्रोग्राम में शामिल होने पर, आपको कुछ सुविधाओं को रिलीज़ होने से पहले ही इस्तेमाल करने का ऐक्सेस मिलता है.
पाबंदी है
Google Drive  
https://www.googleapis.com/auth/drive.file Drive में नई फ़ाइलें बनाएं या किसी ऐप्लिकेशन से खोली गई मौजूदा फ़ाइलों में बदलाव करें. इसके अलावा, Google Picker API या ऐप्लिकेशन के फ़ाइल पिकर का इस्तेमाल करते समय, उपयोगकर्ता के साथ शेयर की गई फ़ाइलों में बदलाव करें. संवेदनशील नहीं है
https://www.googleapis.com/auth/drive Drive में मौजूद अपनी सभी फ़ाइलें देखें और उन्हें मैनेज करें. सभी देशों/इलाकों में उपलब्ध नहीं है
https://www.googleapis.com/auth/drive.readonly Drive में मौजूद अपनी सभी फ़ाइलें देखें और डाउनलोड करें. सभी देशों/इलाकों में उपलब्ध नहीं है
https://www.googleapis.com/auth/drive.metadata अपनी Drive में मौजूद फ़ाइलों का मेटाडेटा देखें और मैनेज करें. सभी देशों/इलाकों में उपलब्ध नहीं है
https://www.googleapis.com/auth/drive.metadata.readonly Drive में मौजूद फ़ाइलों का मेटाडेटा देखें. सभी देशों/इलाकों में उपलब्ध नहीं है
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 के स्कोप के बारे में ज़्यादा जानने के लिए, OAuth 2.0 का इस्तेमाल करके, Google API को ऐक्सेस करना लेख पढ़ें.

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

OAuth की पुष्टि

कुछ OAuth स्कोप का इस्तेमाल करने के लिए, यह ज़रूरी हो सकता है कि आपका ऐप्लिकेशन OAuth ऐप्लिकेशन की पुष्टि करने से जुड़े सहायता केंद्र पर जाए. OAuth ऐप्लिकेशन के बारे में अक्सर पूछे जाने वाले सवाल पढ़ें. इससे आपको यह तय करने में मदद मिलेगी कि आपके ऐप्लिकेशन की पुष्टि कब होनी चाहिए और किस तरह की पुष्टि ज़रूरी है. 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
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

डेवलपर प्रीव्यू: इसमें ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी (सिर्फ़ Google Chat ऐप्लिकेशन के लिए) ज़रूरी है. साथ ही, हर इवेंट टाइप के लिए, काम करने वाला स्कोप ज़रूरी है:

  • chat.app.memberships
  • chat.app.spaces
  • chat.app.messages.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
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

डेवलपर प्रीव्यू: इसमें ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी (सिर्फ़ Google Chat ऐप्लिकेशन के लिए) ज़रूरी है. साथ ही, हर इवेंट टाइप के लिए, काम करने वाला स्कोप ज़रूरी है:

  • chat.app.memberships
  • chat.app.spaces
  • chat.app.messages.readonly
सदस्यता फिर से चालू करना —

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

  • chat.messages
  • chat.messages.readonly
  • chat.messages.reactions
  • chat.messages.reactions.readonly
  • chat.memberships
  • chat.memberships.readonly
  • chat.spaces
  • chat.spaces.readonly
  • drive.file
  • drive
  • drive.readonly
  • drive.metadata
  • drive.metadata.readonly
  • meetings.space.created
  • meetings.space.readonly

डेवलपर प्रीव्यू: इसमें ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी (सिर्फ़ Google Chat ऐप्लिकेशन के लिए) ज़रूरी है. साथ ही, हर इवेंट टाइप के लिए, काम करने वाला स्कोप ज़रूरी है:

  • chat.app.memberships
  • chat.app.spaces
  • chat.app.messages.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
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी (डेवलपर प्रीव्यू में उपलब्ध) की मदद से:
  • chat.app.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
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी (डेवलपर प्रीव्यू में उपलब्ध) की मदद से:
  • chat.app.memberships
स्पेस को अपडेट किया गया है या मिटाया गया है.
  • google.workspace.chat.space.v1.updated
  • google.workspace.chat.space.v1.deleted
 उपयोगकर्ता की पुष्टि करने की सुविधा के साथ:
  • chat.spaces
  • chat.spaces.readonly
ऐप्लिकेशन की पुष्टि और एडमिन की मंज़ूरी (डेवलपर प्रीव्यू में उपलब्ध) की मदद से:
  • chat.app.spaces
Google Drive  
कोई फ़ाइल बनाई गई हो, उसमें बदलाव किया गया हो, उसे एक जगह से दूसरी जगह ले जाया गया हो, मिटाया गया हो, ट्रैश में डाला गया हो या ट्रैश से हटाया गया हो.
  • google.workspace.drive.file.v3.added
  • google.workspace.drive.file.v3.moved
  • google.workspace.drive.file.v3.contentChanged
  • google.workspace.drive.file.v3.deleted
  • google.workspace.drive.file.v3.trashed
  • google.workspace.drive.file.v3.untrashed
  • drive
  • drive.file
  • drive.metadata
किसी फ़ाइल पर ऐक्सेस का अनुरोध किया गया हो या उसे स्वीकार कर लिया गया हो.
  • google.workspace.drive.accessProposal.v3.created
  • google.workspace.drive.accessProposal.v3.resolved
  • drive
  • drive.file
  • drive.metadata
  • drive.metadata
  • drive.metadata.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