इस दस्तावेज़ में, Gmail API के लिए अनुमति देने और पुष्टि करने से जुड़ी जानकारी दी गई है. इस दस्तावेज़ को पढ़ने से पहले, पुष्टि और अनुमति के बारे में जानें पर जाकर, Google Workspace की पुष्टि और अनुमति से जुड़ी सामान्य जानकारी ज़रूर पढ़ें.
अनुमति देने के लिए OAuth 2.0 को कॉन्फ़िगर करना
OAuth को सहमति देने वाली स्क्रीन को कॉन्फ़िगर करें और स्कोप चुनें. इससे यह तय किया जा सकेगा कि उपयोगकर्ताओं और ऐप्लिकेशन की समीक्षा करने वालों को कौनसी जानकारी दिखेगी. साथ ही, अपने ऐप्लिकेशन को रजिस्टर करें, ताकि बाद में उसे पब्लिश किया जा सके.
Gmail API के स्कोप
अपने ऐप्लिकेशन को दिए गए ऐक्सेस के लेवल के बारे में बताने के लिए, आपको अनुमति के स्कोप की पहचान करनी होगी और उन्हें ज़ाहिर करना होगा. ऑथराइज़ेशन स्कोप, OAuth 2.0 यूआरआई स्ट्रिंग होती है. इसमें Google Workspace ऐप्लिकेशन का नाम, ऐक्सेस किए जाने वाले डेटा का टाइप, और ऐक्सेस का लेवल शामिल होता है. स्कोप, Google Workspace डेटा के साथ काम करने के लिए आपके ऐप्लिकेशन के अनुरोध होते हैं. इनमें उपयोगकर्ताओं के Google खाते का डेटा भी शामिल होता है.
जब आपका ऐप्लिकेशन इंस्टॉल किया जाता है, तो उपयोगकर्ता से ऐप्लिकेशन के इस्तेमाल किए गए स्कोप की पुष्टि करने के लिए कहा जाता है. आम तौर पर, आपको सबसे ज़्यादा फ़ोकस वाला स्कोप चुनना चाहिए. साथ ही, ऐसे स्कोप के लिए अनुरोध करने से बचना चाहिए जिनकी आपके ऐप्लिकेशन को ज़रूरत नहीं है. उपयोगकर्ता, सीमित और साफ़ तौर पर बताए गए स्कोप को आसानी से ऐक्सेस दे देते हैं.
Gmail API के साथ इन स्कोप का इस्तेमाल किया जा सकता है:
| स्कोप कोड | ब्यौरा | इस्तेमाल |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
ऐड-ऑन इस्तेमाल करते समय, ड्राफ़्ट मैनेज करना और ईमेल भेजना. | संवेदनशील नहीं है |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
ऐड-ऑन के साथ इंटरैक्ट करते समय अपने ईमेल मैसेज देखें. | संवेदनशील नहीं है |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
ऐड-ऑन चलते समय अपने ईमेल संदेश का मेटाडेटा देखें. | संवेदनशील |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
जब ऐड-ऑन चल रहा हो, तब अपने ईमेल मैसेज देखें. | संवेदनशील |
https://www.googleapis.com/auth/gmail.labels |
सिर्फ़ लेबल बनाना, पढ़ना, अपडेट करना, और मिटाना. | संवेदनशील नहीं है |
https://www.googleapis.com/auth/gmail.send |
सिर्फ़ मैसेज भेजें. मेलबॉक्स में, पढ़ने या बदलाव करने के अधिकार नहीं हैं. | संवेदनशील |
https://www.googleapis.com/auth/gmail.readonly |
सभी संसाधनों और उनके मेटाडेटा को पढ़ने का ऐक्सेस. हालांकि, लिखने का ऐक्सेस नहीं होता. | सभी देशों/इलाकों में उपलब्ध नहीं है |
https://www.googleapis.com/auth/gmail.compose |
ड्राफ़्ट बनाना, पढ़ना, अपडेट करना, और मिटाना. मैसेज और ड्राफ़्ट भेजना. | सभी देशों/इलाकों में उपलब्ध नहीं है |
https://www.googleapis.com/auth/gmail.insert |
सिर्फ़ मैसेज इंपोर्ट और डाले जा सकते हैं. | सभी देशों/इलाकों में उपलब्ध नहीं है |
https://www.googleapis.com/auth/gmail.modify |
पढ़ने/लिखने से जुड़ी सभी कार्रवाइयां. हालांकि, थ्रेड और मैसेज को तुरंत और हमेशा के लिए मिटाने की कार्रवाई को छोड़कर. इसमें ट्रैश को अनदेखा किया जाता है. | सभी देशों/इलाकों में उपलब्ध नहीं है |
https://www.googleapis.com/auth/gmail.metadata |
लेबल, इतिहास के रिकॉर्ड, और ईमेल मैसेज हेडर के साथ-साथ, रिसॉर्स का मेटाडेटा पढ़ें. हालांकि, मैसेज का मुख्य हिस्सा या अटैचमेंट नहीं पढ़े जा सकते. | सभी देशों/इलाकों में उपलब्ध नहीं है |
https://www.googleapis.com/auth/gmail.settings.basic |
ईमेल की बुनियादी सेटिंग मैनेज करना. | सभी देशों/इलाकों में उपलब्ध नहीं है |
https://www.googleapis.com/auth/gmail.settings.sharing |
संवेदनशील मेल की सेटिंग मैनेज करना. इसमें ईमेल फ़ॉरवर्ड करने के नियम और ईमेल पते के अन्य नाम शामिल हैं.
ध्यान दें: इस स्कोप के तहत आने वाली कार्रवाइयों को सिर्फ़ एडमिन इस्तेमाल कर सकते हैं. ये सिर्फ़ Google Workspace के उन ग्राहकों के लिए उपलब्ध हैं जो डोमेन-वाइड डेलिगेशन वाले सेवा खाते का इस्तेमाल करते हैं. |
सभी देशों/इलाकों में उपलब्ध नहीं है |
https://mail.google.com/ |
खाते के सभी मेलबॉक्स का पूरा ऐक्सेस. इसमें थ्रेड और मैसेज को हमेशा के लिए मिटाना भी शामिल है. इस स्कोप का अनुरोध सिर्फ़ तब किया जाना चाहिए, जब आपके ऐप्लिकेशन को थ्रेड और मैसेज को तुरंत और हमेशा के लिए मिटाना हो. इसके लिए, ट्रैश को अनदेखा किया जाता है. अन्य सभी कार्रवाइयां, कम अनुमतियों वाले स्कोप के साथ की जा सकती हैं. | सभी देशों/इलाकों में उपलब्ध नहीं है |
ऊपर दी गई टेबल में मौजूद 'इस्तेमाल' कॉलम से, हर स्कोप की संवेदनशीलता के बारे में पता चलता है. यह जानकारी, यहां दी गई परिभाषाओं के हिसाब से होती है:
सामान्य——इन स्कोप से, अनुमति के लिए सबसे कम ऐक्सेस मिलता है. साथ ही, इनके लिए सिर्फ़ ऐप्लिकेशन की बुनियादी पुष्टि की ज़रूरत होती है. इस ज़रूरी शर्त के बारे में जानकारी पाने के लिए, पुष्टि कराने की तैयारी करने का तरीका लेख पढ़ें.
संवेदनशील—इन स्कोप से, Google के उपयोगकर्ता डेटा को ऐक्सेस करने की अनुमति मिलती है. साथ ही, इनके लिए संवेदनशील स्कोप की पुष्टि करने की प्रोसेस पूरी करना ज़रूरी होता है. इस ज़रूरी शर्त के बारे में जानने के लिए, Google API सेवाएं: उपयोगकर्ता के डेटा की नीति देखें. इन स्कोप के लिए, सुरक्षा जांच की ज़रूरत नहीं होती.
सीमित—इन स्कोप से, Google के उपयोगकर्ता डेटा को बड़े पैमाने पर ऐक्सेस किया जा सकता है. साथ ही, इनके लिए आपको सीमित स्कोप की पुष्टि करने की प्रोसेस से गुज़रना होगा. इस ज़रूरी शर्त के बारे में जानकारी पाने के लिए, Google API सेवाएं: उपयोगकर्ता के डेटा से जुड़ी नीति और एपीआई के कुछ स्कोप के लिए अतिरिक्त ज़रूरी शर्तें देखें. अगर सर्वर पर पाबंदी वाले स्कोप का डेटा सेव किया जाता है या उसे ट्रांसमिट किया जाता है, तो आपको सुरक्षा जांच करानी होगी.
उपयोगकर्ता के डेटा को ऐक्सेस करने का अनुरोध करने पर, Gmail API के इस्तेमाल और ऐक्सेस से जुड़ी ज़्यादा जानकारी के लिए, Gmail API सेवाओं की उपयोगकर्ता के डेटा और डेवलपर से जुड़ी नीति पढ़ें.
अगर आपके ऐप्लिकेशन को किसी अन्य Google API को ऐक्सेस करने की ज़रूरत है, तो उन स्कोप को भी जोड़ा जा सकता है. Google API के स्कोप के बारे में ज़्यादा जानने के लिए, OAuth 2.0 का इस्तेमाल करके, Google API को ऐक्सेस करना लेख पढ़ें.
OAuth की पुष्टि
कुछ संवेदनशील OAuth स्कोप का इस्तेमाल करने के लिए, यह ज़रूरी हो सकता है कि आपका ऐप्लिकेशन Google की OAuth पुष्टि की प्रोसेस से गुज़रे. OAuth की पुष्टि करने के बारे में अक्सर पूछे जाने वाले सवाल पढ़ें. इससे आपको यह तय करने में मदद मिलेगी कि आपके ऐप्लिकेशन की पुष्टि कब होनी चाहिए और किस तरह की पुष्टि ज़रूरी है. Google API सेवाएं: उपयोगकर्ता के डेटा की नीति भी देखें.