इस दस्तावेज़ में, 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 |
इससे Chat ऐप्लिकेशन, चैट देख सकते हैं और मैसेज भेज सकते हैं. इससे Chat ऐप्लिकेशन के लिए उपलब्ध सभी सुविधाओं का ऐक्सेस मिलता है. | संवेदनशील नहीं है | ||
https://www.googleapis.com/auth/chat.memberships |
Chat में होने वाली बातचीत में सदस्यों को देखना, नए सदस्य जोड़ना, और उन्हें हटाना. | संवेदनशील |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Chat पर होने वाली बातचीत में, सदस्यों को देखना. | संवेदनशील |
||
https://www.googleapis.com/auth/chat.app.memberships |
Chat ऐप्लिकेशन के तौर पर Chat में, बातचीत और स्पेस में मौजूद सदस्यों को देखना, उन्हें जोड़ना, हटाना, और उनकी भूमिकाएं अपडेट करना. इसके लिए, एडमिन की अनुमति ज़रूरी है. यह स्कोप, सेवा खातों के साथ सिर्फ़ ऐप्लिकेशन की पुष्टि करने की सुविधा देता है. इस स्कोप का इस्तेमाल करके, उपयोगकर्ता के क्रेडेंशियल या डोमेन-वाइड डेलिगेशन से पुष्टि नहीं की जा सकती. इस प्रोग्राम के तहत, कुछ सुविधाओं को सार्वजनिक तौर पर उपलब्ध होने से पहले इस्तेमाल करने का ऐक्सेस मिलता है. |
संवेदनशील |
||
https://www.googleapis.com/auth/chat.spaces |
Chat में बातचीत और स्पेसेज़ बनाना. साथ ही, बातचीत और स्पेसेज़ का मेटाडेटा (इसमें इतिहास की सेटिंग शामिल है) देखना या उसे अपडेट करना. | संवेदनशील | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Chat में मौजूद चैट और स्पेसेज़ देखना. | संवेदनशील |
||
https://www.googleapis.com/auth/chat.app.spaces |
Chat ऐप्लिकेशन के तौर पर, 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 |
Chat में मैसेज और प्रतिक्रियाएं देखना. | पाबंदी है |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Chat ऐप्लिकेशन के तौर पर, 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 ऐप्लिकेशन के बारे में अक्सर पूछे जाने वाले सवाल पढ़ें. इससे आपको यह तय करने में मदद मिलेगी कि आपके ऐप्लिकेशन की पुष्टि कब होनी चाहिए और किस तरह की पुष्टि ज़रूरी है. Drive की सेवा की शर्तें भी देखें.
पुष्टि करने के ज़रूरी तरीके
इस सेक्शन में बताया गया है कि किस तरह की पुष्टि ज़रूरी है या काम करती है. साथ ही, Google Workspace Events API के हर तरीके के लिए, इस्तेमाल किए जा सकने वाले स्कोप के बारे में बताया गया है.
Chat इवेंट की सदस्यताओं के लिए, Google Workspace Events API, कुछ तरीकों को कॉल करने के लिए उपयोगकर्ता और ऐप्लिकेशन, दोनों की पुष्टि करने की सुविधा देता है. अगर कोई एपीआई तरीका, दोनों क्रेडेंशियल के साथ काम करता है, तो कॉल में इस्तेमाल किए गए क्रेडेंशियल के टाइप का असर, मिले नतीजे पर पड़ता है. उदाहरण के लिए, अगर आपने उपयोगकर्ता की पुष्टि करने के लिए subscriptions.list तरीके का इस्तेमाल किया है, तो एपीआई उन सदस्यताओं की सूची दिखाता है जिन्हें पुष्टि किया गया उपयोगकर्ता ऐक्सेस कर सकता है. ऐप्लिकेशन की पुष्टि करने की सुविधा का इस्तेमाल करने पर, एपीआई उन सदस्यताओं की सूची दिखाता है जिन्हें ऐप्लिकेशन ऐक्सेस कर सकता है. Chat में पुष्टि करने के तरीकों के बारे में ज़्यादा जानने के लिए, Chat ऐप्लिकेशन और Chat API के अनुरोधों की पुष्टि करना और उन्हें अनुमति देना लेख पढ़ें.
इस टेबल में दिखाया गया है कि Google Workspace Events API के हर तरीके के लिए, किस तरह के स्कोप और पुष्टि करने के तरीके ज़रूरी हैं या इस्तेमाल किए जा सकते हैं:
| तरीका | उपयोगकर्ता की पुष्टि करना ज़रूरी है या पुष्टि की जा सकती है | ऐप्लिकेशन की पुष्टि करने की सुविधा उपलब्ध है (सिर्फ़ Chat ऐप्लिकेशन के लिए) | अनुमति के लिए उपलब्ध स्कोप | |
|---|---|---|---|---|
| सदस्यता बनाना | — |
उपयोगकर्ता की पुष्टि करने के लिए, हर इवेंट टाइप के लिए, काम करने वाला स्कोप ज़रूरी है:
डेवलपर प्रीव्यू: ऐप्लिकेशन की पुष्टि करने और एडमिन की मंज़ूरी लेने (सिर्फ़ Chat ऐप्लिकेशन के लिए) की सुविधा के साथ, हर इवेंट टाइप के लिए काम करने वाला स्कोप ज़रूरी है:
|
||
| सदस्यता लेना |
उपयोगकर्ता की पुष्टि करने के लिए, इस तरीके में ऐसे स्कोप की ज़रूरत होती है जो सदस्यता के लिए कम से कम एक इवेंट टाइप के साथ काम करता हो.
ऐप्लिकेशन की पुष्टि करने की सुविधा (सिर्फ़ Chat ऐप्लिकेशन के लिए):
|
|||
| सदस्यताओं की सूची |
उपयोगकर्ता की पुष्टि करने के लिए, इस तरीके में ऐसे स्कोप की ज़रूरत होती है जो सदस्यता के लिए कम से कम एक इवेंट टाइप के साथ काम करता हो.
ऐप्लिकेशन की पुष्टि करने की सुविधा (सिर्फ़ Chat ऐप्लिकेशन के लिए):
|
|||
| सदस्यता अपडेट करना | — |
उपयोगकर्ता की पुष्टि करने के लिए, हर इवेंट टाइप के लिए, काम करने वाला स्कोप ज़रूरी है:
डेवलपर प्रीव्यू: ऐप्लिकेशन की पुष्टि करने और एडमिन से अनुमति लेने (सिर्फ़ Chat ऐप्लिकेशन के लिए) की सुविधा के साथ, हर इवेंट टाइप के लिए काम करने वाला स्कोप ज़रूरी है:
|
||
| सदस्यता फिर से चालू करना | — |
उपयोगकर्ता की पुष्टि करने के लिए, हर इवेंट टाइप के लिए, काम करने वाला स्कोप ज़रूरी है:
डेवलपर प्रीव्यू: ऐप्लिकेशन की पुष्टि करने और एडमिन की मंज़ूरी लेने (सिर्फ़ Chat ऐप्लिकेशन के लिए) की सुविधा के साथ, हर इवेंट टाइप के लिए काम करने वाला स्कोप ज़रूरी है:
|
||
| सदस्यता मिटाना |
उपयोगकर्ता की पुष्टि करने के लिए, इस तरीके में ऐसे स्कोप की ज़रूरत होती है जो सदस्यता के लिए कम से कम एक इवेंट टाइप के साथ काम करता हो.
ऐप्लिकेशन की पुष्टि करने की सुविधा (सिर्फ़ Chat ऐप्लिकेशन के लिए):
|
|||
इवेंट टाइप के हिसाब से स्कोप
उपयोगकर्ता की पुष्टि करने के लिए, Google Workspace Events API का इस्तेमाल करते समय, आपको एक या उससे ज़्यादा ऐसे स्कोप तय करने होंगे जो सदस्यता के इवेंट टाइप से मेल खाते हों.
इस टेबल में दिखाया गया है कि हर इवेंट टाइप के लिए, अनुमति के कौनसे स्कोप इस्तेमाल किए जा सकते हैं:
| इवेंट | इवेंट के टाइप | अनुमति पाने के लिंक | ||||||
|---|---|---|---|---|---|---|---|---|
| Chat | ||||||||
| कोई मैसेज पोस्ट या अपडेट किया जाता है. |
|
उपयोगकर्ता की पुष्टि करने की सुविधा के साथ:
|
||||||
| प्रतिक्रिया जोड़ी या मिटाई जाती है या कई प्रतिक्रियाएं बदली जाती हैं. |
|
|
||||||
| पैसे चुकाकर ली गई सदस्यता बनाई जाती है, अपडेट की जाती है या हटाई जाती है. इसके अलावा, एक से ज़्यादा सदस्यताओं में बदलाव किया जाता है. |
|
उपयोगकर्ता की पुष्टि करने की सुविधा के साथ:
|
||||||
| स्पेस को अपडेट किया गया है या मिटाया गया है. |
|
उपयोगकर्ता की पुष्टि करने की सुविधा के साथ:
|
||||||
| Drive | ||||||||
| कोई फ़ाइल बनाई गई हो, उसमें बदलाव किया गया हो, उसे एक जगह से दूसरी जगह ले जाया गया हो, मिटाया गया हो, उसका नाम बदला गया हो, उसे ट्रैश में डाला गया हो या ट्रैश से हटाया गया हो. |
|
|
||||||
| किसी फ़ाइल पर ऐक्सेस का अनुरोध किया गया हो या उसे स्वीकार कर लिया गया हो. |
|
|
||||||
| किसी फ़ाइल पर अनुमति का अनुरोध रद्द कर दिया गया हो, पूरा हो गया हो, बनाया गया हो, रीसेट कर दिया गया हो, समीक्षक बदल दिए गए हों या समीक्षकों ने जवाब दिया हो. |
|
|
||||||
| किसी फ़ाइल पर टिप्पणी बनाई जाती है, मिटाई जाती है, उसमें बदलाव किया जाता है, उसे फिर से खोला जाता है या उसका समाधान किया जाता है. |
|
|
||||||
| किसी फ़ाइल पर जवाब बनाया, मिटाया या उसमें बदलाव किया जाता है. |
|
|
||||||
| किसी फ़ाइल पर अनुमति बनाई जाती है, मिटाई जाती है या उसमें बदलाव किया जाता है. |
|
|
||||||
| Meet | ||||||||
| कोई कॉन्फ़्रेंस शुरू या खत्म होता है. |
|
|
||||||
| कोई व्यक्ति किसी कॉन्फ़्रेंस में शामिल होता है या उसे छोड़ता है. |
|
|
||||||
| रिकॉर्डिंग जनरेट की गई. |
|
|
||||||
| ट्रांसक्रिप्ट जनरेट की गई. |
|
|
||||||