उपयोगकर्ताओं को उन ऐड-ऑन और अन्य ऐप्लिकेशन को अनुमति देनी होगी जो उनका डेटा ऐक्सेस करते हैं या उनकी ओर से काम करने की अनुमति न हो. जब कोई उपयोगकर्ता पहली बार ऐड-ऑन चलाता है, तो ऐड-ऑन यूज़र इंटरफ़ेस (यूआई), जिसमें ऑथराइज़ेशन फ़्लो शुरू करने के लिए, अनुमति देने वाला प्रॉम्प्ट दिखता है.
इस फ़्लो के दौरान, प्रॉम्प्ट उपयोगकर्ता को यह बताता है कि ऐप्लिकेशन को क्या चाहिए करने की अनुमति है. उदाहरण के लिए, हो सकता है कि किसी ऐड-ऑन को या उनके कैलेंडर में इवेंट बनाने के लिए. ऐड-ऑन की स्क्रिप्ट प्रोजेक्ट इन अलग-अलग अनुमतियों को 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 Workspace ऐड-ऑन के लिए, अक्सर इस्तेमाल किए जाने वाले दायरों के बारे में बताया गया है. इनकी मदद से Google Calendar को बेहतर बनाया जा सकता है.
दायरा | |
---|---|
इवेंट का मेटाडेटा ऐक्सेस करना |
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 में चुना गया है. मेटाडेटा, आइटम के आईडी तक सीमित होता है, टाइटल, MIME टाइप, आइकॉन यूआरएल वगैरह का इस्तेमाल करें. साथ ही, यह भी बताएं कि ऐड-ऑन के पास ये काम करने की अनुमति है या नहीं आइटम ऐक्सेस करें. |
हर फ़ाइल का ऐक्सेस |
https://www.googleapis.com/auth/drive.file
इसका सुझाव तब दिया जाता है, जब ऐड-ऑन को अलग से किसी Drive को ऐक्सेस करना हो
फ़ाइलें शामिल हैं.
इस टूल का इस्तेमाल करके, ऐप्लिकेशन के बनाए या खोले गए फ़ाइलों को हर फ़ाइल का ऐक्सेस देता है
Apps Script बेहतर ड्राइव
सेवा. हालांकि, इस यूआरएल का इस्तेमाल करके,
Drive की बुनियादी सेवा,
हालांकि. फ़ाइल की अनुमति हर फ़ाइल के आधार पर दी जाती है और
उपयोगकर्ता की ओर से ऐप्लिकेशन की अनुमति हटाने पर, इसे रद्द कर दिया जाता है. |
Gmail ऐड-ऑन के दायरे
कुछ ऐसे स्कोप हैं जिन्हें खास तौर पर उपयोगकर्ता के Gmail को सुरक्षित रखने के लिए, Google Workspace ऐड-ऑन डेटा शामिल है. आपको ऐसा ज़रूर करना चाहिए इन स्कोप को साफ़ तौर पर जोड़ें ऐड-ऑन मेनिफ़ेस्ट के साथ-साथ, आपको ऐड-ऑन कोड का होना ज़रूरी है.
यहां 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
ईमेल का पूरा मेटाडेटा और कॉन्टेंट पढ़ें. साथ ही, खुले हुए मैसेज को भी पढ़ें. इस तरह के अन्य मैसेज पढ़ने के लिए ज़रूरी है उपयोग करते समय या पूरा मेल थ्रेड पढ़ते समय. |
ऐक्सेस टोकन
उपयोगकर्ता के डेटा को सुरक्षित रखने के लिए, Gmail के किन दायरों का इस्तेमाल
सिर्फ़ Google Workspace ऐड-ऑन के इस्तेमाल की अनुमति
उपयोगकर्ता के डेटा का कुछ समय के लिए ऐक्सेस. अस्थायी ऐक्सेस सक्षम करने के लिए, आपको
फ़ंक्शन 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 ऐप्लिकेशन में, संसाधन का लिंक डालें. और जानने के लिए, देखें @ मेन्यू से तीसरे पक्ष के संसाधन बनाएं. |