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