उपयोगकर्ताओं को उन ऐड-ऑन और अन्य ऐप्लिकेशन को अनुमति देनी होगी जो उनके डेटा को ऐक्सेस करते हैं या उनकी ओर से काम करते हैं. जब कोई उपयोगकर्ता पहली बार कोई ऐड-ऑन चलाता है, तो ऐड-ऑन का यूज़र इंटरफ़ेस (यूआई), अनुमति देने का अनुरोध दिखाता है. इससे अनुमति देने का फ़्लो शुरू होता है.
इस फ़्लो के दौरान, प्रॉम्प्ट से उपयोगकर्ता को पता चलता है कि ऐप्लिकेशन को किस काम के लिए अनुमति चाहिए. उदाहरण के लिए, हो सकता है कि कोई ऐड-ऑन, उपयोगकर्ता का ईमेल मैसेज पढ़ने या उसके कैलेंडर में इवेंट बनाने के लिए अनुमति चाहे. ऐड-ऑन का स्क्रिप्ट प्रोजेक्ट, इन अलग-अलग अनुमतियों को OAuth स्कोप के तौर पर तय करता है.
आपके मेनिफ़ेस्ट में स्कोप का एलान किया जाता है
यूआरएल स्ट्रिंग का इस्तेमाल करके. अनुमति देने के दौरान, Apps Script फ़ाइल के तौर पर
उपयोगकर्ता के लिए दायरे के बारे में ऐसी जानकारी जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. उदाहरण के लिए, आपका Google Workspace ऐड-ऑन
"मौजूदा मैसेज पढ़ें" का इस्तेमाल कर सकते हैं होता है, जो आपके मेनिफ़ेस्ट में
https://www.googleapis.com/auth/gmail.addons.current.message.readonly
. इस दौरान
अनुमति देने का फ़्लो, इस दायरे वाला ऐड-ऑन उपयोगकर्ता से, अनुमति देने के लिए कहता है
ऐड-ऑन: ऐड-ऑन चलने के दौरान अपने ईमेल मैसेज देखें.
दायरे देखना
अपने स्क्रिप्ट प्रोजेक्ट के लिए ज़रूरी स्कोप देखने के लिए, यह तरीका अपनाएं:
- स्क्रिप्ट प्रोजेक्ट खोलें.
- बाईं ओर, खास जानकारी पर क्लिक करें .
- "प्रोजेक्ट के OAuth दायरे" में जाकर, दायरे देखें.
प्रोजेक्ट मेनिफ़ेस्ट में, oauthScopes
फ़ील्ड में जाकर भी स्क्रिप्ट प्रोजेक्ट के मौजूदा स्कोप देखे जा सकते हैं. हालांकि, ऐसा सिर्फ़ तब किया जा सकता है, जब आपने उन स्कोप को साफ़ तौर पर सेट किया हो.
साफ़ तौर पर दायरे सेट करना
Apps Script, स्क्रिप्ट के कोड को स्कैन करके यह अपने-आप तय करता है कि स्क्रिप्ट को कौनसे स्कोप की ज़रूरत है. इसके लिए, वह उन फ़ंक्शन कॉल के लिए कोड को स्कैन करता है जिनमें स्कोप की ज़रूरत होती है. ज़्यादातर स्क्रिप्ट के लिए यह इससे आपका समय बचता है. हालांकि, पब्लिश किए गए ऐड-ऑन के लिए आपको कसरत करनी चाहिए उन्हें स्कोप का ज़्यादा कंट्रोल मिलता है.
उदाहरण के लिए, Apps Script किसी ऐड-ऑन स्क्रिप्ट प्रोजेक्ट को डिफ़ॉल्ट रूप से बहुत ज़्यादा अनुमति वाला स्कोप https://mail.google.com
दे सकता है. जब कोई उपयोगकर्ता किसी स्क्रिप्ट को अनुमति देता है
बिना पाबंदी वाले प्रोजेक्ट को हटाया जाता है, तो प्रोजेक्ट को उपयोगकर्ता के Gmail का पूरा ऐक्सेस दिया जाता है
जोड़ें. पब्लिश किए गए ऐड-ऑन के लिए, आपको इस स्कोप को ज़्यादा सीमित सेट से बदलना होगा. यह सेट, ऐड-ऑन की ज़रूरतों को पूरा करता हो, न कि उससे ज़्यादा.
स्क्रिप्ट प्रोजेक्ट के मेनिफ़ेस्ट फ़ाइल में बदलाव करके, उन स्कोप को साफ़ तौर पर सेट किया जा सकता है जिनका इस्तेमाल प्रोजेक्ट करता है. मेनिफ़ेस्ट फ़ील्ड
oauthScopes
, ऐड-ऑन के इस्तेमाल किए गए सभी स्कोप का ऐरे होता है. अपने प्रोजेक्ट के स्कोप सेट करने के लिए, ये काम करें:
- उन दायरे को देखें जिनका फ़िलहाल आपका ऐड-ऑन इस्तेमाल कर रहा है. तय करें कि किन बदलावों की ज़रूरत है. जैसे, छोटे दायरे का इस्तेमाल करना.
- अपने ऐड-ऑन की मेनिफ़ेस्ट फ़ाइल खोलें.
oauthScopes
लेबल वाले टॉप-लेवल फ़ील्ड को ढूंढें. अगर यह मौजूद नहीं है, तो आप इसे जोड़ सकते हैं.oauthScopes
फ़ील्ड में स्ट्रिंग का कलेक्शन तय होता है. स्कोप सेट करने के लिए तो आपका प्रोजेक्ट इस्तेमाल करता है, तो इस कलेक्शन के कॉन्टेंट को उन स्कोप से बदलें उसे इसका इस्तेमाल करना चाहिए. उदाहरण के लिए, Gmail की सुविधाओं को बढ़ाने वाले Google Workspace ऐड-ऑन के लिए, आपके पास ये विकल्प हो सकते हैं:{ ... "oauthScopes": [ "https://www.googleapis.com/auth/gmail.addons.current.message.metadata", "https://www.googleapis.com/auth/userinfo.email" ], ... }
मेनिफ़ेस्ट फ़ाइल में किए गए बदलावों को सेव करें.
OAuth की मदद से पुष्टि करना
कुछ संवेदनशील OAuth दायरों का इस्तेमाल करने के लिए, आपको ऐड-ऑन को इस्तेमाल करने की ज़रूरत पड़ सकती है OAuth क्लाइंट की पुष्टि करना इससे पहले कि आप उसे पब्लिश करें. ज़्यादा जानकारी के लिए, ये गाइड देखें:
- Apps Script के लिए OAuth क्लाइंट की पुष्टि करना
- ऐसे ऐप्लिकेशन जिनकी पुष्टि नहीं हुई है
- OAuth की पुष्टि से जुड़े अक्सर पूछे जाने वाले सवाल
- Google API सेवा: उपयोगकर्ता के डेटा से जुड़ी नीति
पाबंदी वाले दायरे
कुछ दायरों पर पाबंदी लगाई गई है. साथ ही, ऐसे दूसरे नियमों के तहत आते हैं जिनसे मदद उपयोगकर्ता के डेटा को सुरक्षित रखने के लिए किया जा सकता है. अगर आपको Gmail या Editor का कोई ऐसा ऐड-ऑन पब्लिश करना है जो पाबंदी वाले एक या उससे ज़्यादा स्कोप का इस्तेमाल करता है, तो पब्लिश करने से पहले ऐड-ऑन को सभी पाबंदियों का पालन करना होगा.
पब्लिश करने से पहले, पाबंदी वाले दायरों की पूरी सूची देखें. अगर आपका ऐड-ऑन इनमें से किसी का इस्तेमाल करता है, तो पब्लिश करने से पहले आपको खास एपीआई स्कोप के लिए ज़रूरी शर्तों का पालन करना होगा.
Calendar के दायरे
यहां Google Calendar के साथ काम करने वाले Google Workspace ऐड-ऑन के लिए, अक्सर इस्तेमाल होने वाले स्कोप दिए गए हैं.
दायरा | |
---|---|
इवेंट का मेटाडेटा ऐक्सेस करना |
https://www.googleapis.com/auth/calendar.addons.execute
अगर ऐड-ऑन, Calendar इवेंट का मेटाडेटा ऐक्सेस करता है, तो यह ज़रूरी है. इससे ऐड-ऑन को इवेंट का मेटाडेटा ऐक्सेस करने की अनुमति मिलती है. |
उपयोगकर्ता का जनरेट किया गया इवेंट डेटा पढ़ सकता है |
https://www.googleapis.com/auth/calendar.addons.current.event.read
अगर ऐड-ऑन को उपयोगकर्ता का जनरेट किया गया इवेंट डेटा पढ़ने की ज़रूरत है, तो यह ज़रूरी है.
ऐड-ऑन को उपयोगकर्ता के जनरेट किए गए इवेंट डेटा को ऐक्सेस करने की अनुमति देता है. यह डेटा सिर्फ़ तब उपलब्ध होता है, जब
|
यूज़र जनरेटेड इवेंट डेटा में बदलाव करने की अनुमति दें |
https://www.googleapis.com/auth/calendar.addons.current.event.write
अगर ऐड-ऑन को उपयोगकर्ता से जनरेट किया गया इवेंट डेटा लिखना है, तो यह ज़रूरी है.
उपयोगकर्ता के जनरेट किए गए इवेंट डेटा में बदलाव करने की अनुमति देता है. यह डेटा सिर्फ़ तब उपलब्ध होता है, जब
|
Drive के स्कोप
यहां Google Workspace के उन ऐड-ऑन के लिए अक्सर इस्तेमाल होने वाले स्कोप दिए गए हैं जो Google Drive की सुविधाओं को बेहतर बनाते हैं.
दायरा | |
---|---|
चुने गए आइटम का मेटाडेटा पढ़ें |
https://www.googleapis.com/auth/drive.addons.metadata.readonly
अगर ऐड-ऑन, संदर्भ के हिसाब से काम करने वाला इंटरफ़ेस लागू करता है, तो यह एट्रिब्यूट ज़रूरी है. यह इंटरफ़ेस, तब ट्रिगर होता है, जब कोई उपयोगकर्ता Drive में आइटम चुनता है. इससे, ऐड-ऑन को उन आइटम का सीमित मेटाडेटा पढ़ने की अनुमति मिलती है जिन्हें उपयोगकर्ता ने Google Drive में चुना है. मेटाडेटा में आइटम का आईडी, टाइटल, एमआईएम टाइप, आइकॉन का यूआरएल, और यह जानकारी शामिल होती है कि ऐड-ऑन के पास आइटम को ऐक्सेस करने की अनुमति है या नहीं. |
हर फ़ाइल के लिए ऐक्सेस |
https://www.googleapis.com/auth/drive.file
अगर ऐड-ऑन को Drive की अलग-अलग फ़ाइलों को ऐक्सेस करना है, तो इसका सुझाव दिया जाता है.
इस टूल का इस्तेमाल करके, ऐप्लिकेशन के बनाए या खोले गए फ़ाइलों को हर फ़ाइल का ऐक्सेस देता है
Apps Script बेहतर ड्राइव
सेवा. हालांकि, इस यूआरएल का इस्तेमाल करके,
Drive की बुनियादी सेवा,
हालांकि. फ़ाइल का ऐक्सेस, हर फ़ाइल के हिसाब से दिया जाता है. साथ ही, उपयोगकर्ता के ऐप्लिकेशन से फ़ाइल का ऐक्सेस हटाने पर, यह ऐक्सेस रद्द कर दिया जाता है. |
Gmail ऐड-ऑन के दायरे
कुछ स्कोप खास तौर पर Google Workspace के ऐड-ऑन के लिए बनाए गए हैं. इनकी मदद से, उपयोगकर्ता के Gmail डेटा को सुरक्षित रखा जा सकता है. आपको ऐसा ज़रूर करना चाहिए इन स्कोप को साफ़ तौर पर जोड़ें अपने ऐड-ऑन मेनिफ़ेस्ट के साथ-साथ, ऐड-ऑन कोड का होना ज़रूरी है.
यहां Google Workspace के ऐड-ऑन के लिए, अक्सर इस्तेमाल किए जाने वाले दायरे दिए गए हैं. ये वे दायरे हैं जो Gmail का दायरा बढ़ाते हैं; ज़रूरी लेबल वाले आइटम को आपके अगर आपके ऐड-ऑन की अवधि ज़्यादा होती है, तो Google Workspace ऐड-ऑन मेनिफ़ेस्ट Gmail.
अपने ऐड-ऑन में, बहुत बड़े https://mail.google.com
स्कोप को छोटे स्कोप के सेट से भी बदलना न भूलें. इससे आपके ऐड-ऑन को ज़रूरी इंटरैक्शन मिल पाएंगे.
दायरा | |
---|---|
नए ड्राफ़्ट बनाएं |
https://www.googleapis.com/auth/gmail.addons.current.action.compose
अगर ऐड-ऑन का इस्तेमाल किया जाता है, तो यह ज़रूरी है कार्रवाई ट्रिगर कंपोज़ करें. इसकी मदद से, ऐड-ऑन कुछ समय के लिए नए ड्राफ़्ट मैसेज और जवाब बना सकता है. ज़्यादा जानकारी के लिए, मैसेज का ड्राफ़्ट लिखना देखें; इस स्कोप का इस्तेमाल अक्सर ऐक्शन लिखने के साथ भी किया जाता है. इसके लिए, ऐक्सेस टोकन की ज़रूरत होती है. |
खुले हुए मैसेज का मेटाडेटा पढ़ें |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata
खुले हुए मैसेज के मेटाडेटा (जैसे कि
विषय या ईमेल पाने वाले लोग). मैसेज का कॉन्टेंट पढ़ने की अनुमति नहीं देता और इसके लिए ऐक्सेस टोकन की ज़रूरत होती है. अगर ऐड-ऑन, कार्रवाई लिखने के ट्रिगर में मेटाडेटा का इस्तेमाल करता है, तो यह ज़रूरी है. कॉम्पोज़ ऐक्शन के लिए, यह स्कोप तब ज़रूरी है, जब कॉम्पोज़ ट्रिगर को मेटाडेटा का ऐक्सेस चाहिए. इस स्कोप की मदद से किसी जवाब की ऐक्सेस पाने वाले लोगों की सूचियां (पाने वाला:, कॉपी: और गुप्त कॉपी:) ट्रिगर करें ईमेल ड्राफ़्ट. |
खुले हुए मैसेज का कॉन्टेंट पढ़ना |
https://www.googleapis.com/auth/gmail.addons.current.message.action
उपयोगकर्ता के इंटरैक्शन पर, खुले हुए मैसेज के कॉन्टेंट का ऐक्सेस देता है. उदाहरण के लिए, जब कोई ऐड-ऑन मेन्यू आइटम चुना जाता है. इसके लिए, ऐक्सेस टोकन की ज़रूरत होती है. |
खुली हुई थ्रेड का कॉन्टेंट देखें |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly
ओपन मैसेज के मेटाडेटा और कॉन्टेंट का कुछ समय के लिए ऐक्सेस देता है. साथ ही ओपन में अन्य संदेशों की सामग्री की ऐक्सेस देता है थ्रेड. ऐक्सेस टोकन ज़रूरी है. |
किसी भी मैसेज का कॉन्टेंट और मेटाडेटा पढ़ सकता है |
https://www.googleapis.com/auth/gmail.readonly
किसी भी ईमेल का मेटाडेटा और कॉन्टेंट पढ़ना. इसमें, खोला गया ईमेल भी शामिल है. इस तरह के अन्य मैसेज पढ़ने के लिए ज़रूरी है उपयोग करते समय या पूरा मेल थ्रेड पढ़ते समय. |
ऐक्सेस टोकन
उपयोगकर्ता के डेटा को सुरक्षित रखने के लिए, Google Workspace के ऐड-ऑन में इस्तेमाल किए गए Gmail स्कोप, उपयोगकर्ता के डेटा का सिर्फ़ कुछ समय के लिए ऐक्सेस देते हैं. कुछ समय के लिए ऐक्सेस देने की सुविधा चालू करने के लिए, आपको आर्ग्युमेंट के तौर पर ऐक्सेस टोकन का इस्तेमाल करके, फ़ंक्शन GmailApp.setCurrentMessageAccessToken(accessToken)
को कॉल करना होगा. आपको किसी
ऐक्शन इवेंट ऑब्जेक्ट है.
यहां, मैसेज के मेटाडेटा को ऐक्सेस करने की अनुमति देने के लिए, ऐक्सेस टोकन सेट करने का उदाहरण दिया गया है. इस उदाहरण के लिए सिर्फ़ यह ज़रूरी स्कोप है
https://www.googleapis.com/auth/gmail.addons.current.message.metadata
.
function readSender(e) {
var accessToken = e.gmail.accessToken;
var messageId = e.gmail.messageId;
// The following function enables short-lived access to the current
// message in Gmail. Access to other Gmail messages or data isn't
// permitted.
GmailApp.setCurrentMessageAccessToken(accessToken);
var mailMessage = GmailApp.getMessageById(messageId);
return mailMessage.getFrom();
}
एडिटर के दायरे
यहां Google Workspace ऐड-ऑन के लिए, अक्सर इस्तेमाल किए जाने वाले दायरे दिए गए हैं. ये दायरे, Docs, Sheets, और अन्य Google Workspace ऐड-ऑन और Slides.
दायरा | |
---|---|
Docs में फ़ाइल का मौजूदा ऐक्सेस |
https://www.googleapis.com/auth/documents.currentonly
अगर ऐड-ऑन, Apps Script Docs API को ऐक्सेस करता है, तो यह ज़रूरी है. खुले हुए दस्तावेज़ के कॉन्टेंट का कुछ समय के लिए ऐक्सेस देता है. |
Sheets की फ़ाइल का मौजूदा ऐक्सेस |
https://www.googleapis.com/auth/spreadsheets.currentonly
अगर ऐड-ऑन, Apps Script Sheets API को ऐक्सेस करता है, तो यह ज़रूरी है. खुली स्प्रेडशीट के कॉन्टेंट का कुछ समय के लिए ऐक्सेस देता है. |
मौजूदा Slides फ़ाइल का ऐक्सेस |
https://www.googleapis.com/auth/presentations.currentonly
अगर ऐड-ऑन, Apps Script Slides API को ऐक्सेस करता है, तो यह ज़रूरी है. खुले हुए प्रज़ेंटेशन के कॉन्टेंट का कुछ समय के लिए ऐक्सेस देता है. |
हर फ़ाइल का ऐक्सेस |
https://www.googleapis.com/auth/drive.file
|
अन्य दायरे
अगर आपके ऐड-ऑन में Apps Script की दूसरी सेवाएं इस्तेमाल की जाती हैं, तो इसके लिए अतिरिक्त दायरों की ज़रूरत पड़ सकती है. ज़्यादातर मामलों में, Apps Script को इन स्कोप का पता लगाने और मैनिफ़ेस्ट को अपने-आप अपडेट करने की अनुमति दी जा सकती है. अपने मेनिफ़ेस्ट के दायरे की सूची में बदलाव करते समय, किसी भी दायरे को तब तक न हटाएं, जब तक कि उसे किसी ज़्यादा सही विकल्प से बदला न जाए. जैसे, किसी छोटे दायरे से.
रेफ़रंस के लिए, यहां Apps Script के उन दायरों की सूची दी गई है जिनका इस्तेमाल अक्सर Google Workspace ऐड-ऑन के साथ इस्तेमाल करने पर:
दायरा | |
---|---|
उपयोगकर्ता का ईमेल पता पढ़ें |
https://www.googleapis.com/auth/userinfo.email
प्रोजेक्ट को मौजूदा उपयोगकर्ता का ईमेल पता पढ़ने की अनुमति देता है. |
बाहरी सेवाओं को कॉल करने की अनुमति दें |
https://www.googleapis.com/auth/script.external_request
प्रोजेक्ट को यह काम करने की अनुमति देता है
|
उपयोगकर्ता की स्थान-भाषा और टाइमज़ोन देखें |
https://www.googleapis.com/auth/script.locale
इससे प्रोजेक्ट को, मौजूदा उपयोगकर्ता की स्थानीय भाषा और टाइमज़ोन के बारे में पता चलता है. देखें ज़्यादा जानकारी के लिए, उपयोगकर्ता की स्थान-भाषा और टाइमज़ोन को ऐक्सेस किया जा रहा है. |
ट्रिगर बनाएं |
https://www.googleapis.com/auth/script.scriptapp
इससे प्रोजेक्ट को ट्रिगर बनाने की अनुमति मिलती है. |
तीसरे पक्ष के लिंक की झलक देखें |
https://www.googleapis.com/auth/workspace.linkpreview
अगर ऐड-ऑन की झलक, तीसरे पक्ष की सेवा के लिंक दिखाती है, तो यह ज़रूरी है. इससे उपयोगकर्ता, Google Workspace ऐप्लिकेशन में मौजूद लिंक को उस समय देख सकता है, जब उपयोगकर्ता उससे इंटरैक्ट कर रहा हो. और जानने के लिए, देखें स्मार्ट चिप की मदद से लिंक की झलक देखना. |
तीसरे पक्ष के संसाधन बनाएं |
https://www.googleapis.com/auth/workspace.linkcreate
अगर ऐड-ऑन, तीसरे पक्ष की सेवा में रिसॉर्स बनाता है, तो यह एट्रिब्यूट देना ज़रूरी है. इससे प्रोजेक्ट को वह जानकारी पढ़ने की अनुमति मिलती है जिसे उपयोगकर्ता सबमिट करते हैं संसाधन बनाने के लिए फ़ॉर्म और Google Workspace ऐप्लिकेशन में, संसाधन का लिंक डालें. और जानने के लिए, देखें @ मेन्यू से तीसरे पक्ष के संसाधन बनाएं. |