Google Drive API के दायरे चुनें

इस दस्तावेज़ में, Google Drive API के लिए अनुमति देने और पुष्टि करने के बारे में जानकारी दी गई है. इस दस्तावेज़ को पढ़ने से पहले, पुष्टि और अनुमति के बारे में जानें पर जाकर, Google Workspace की पुष्टि और अनुमति से जुड़ी सामान्य जानकारी ज़रूर पढ़ें.

अनुमति देने के लिए OAuth 2.0 को कॉन्फ़िगर करना

अपने ऐप्लिकेशन को अनुमति देने के लिए, Google Drive API को दो जगहों पर OAuth स्कोप तय करने की ज़रूरत होती है: Google Cloud Console और आपका ऐप्लिकेशन.

Google Cloud Console में, आपको उन स्कोप के बारे में बताना होगा जिनकी आपके ऐप्लिकेशन को ज़रूरत है. इसके लिए, OAuth के लिए सहमति देने वाली स्क्रीन के कॉन्फ़िगरेशन का इस्तेमाल करें. ये अनुमतियां, सबसे ज़्यादा लेवल की अनुमतियां होती हैं. आपका ऐप्लिकेशन इनके लिए कभी भी अनुरोध कर सकता है. यह Google से किया गया एक औपचारिक अनुरोध है. साथ ही, जिन स्कोप का एलान किया गया है उन्हें Google, सहमति वाली स्क्रीन पर उपयोगकर्ताओं को दिखाता है. इससे उपयोगकर्ता को यह समझने में मदद मिलती है कि आपका ऐप्लिकेशन किस डेटा और कार्रवाइयों का ऐक्सेस मांग रहा है.

OAuth को सहमति देने वाली स्क्रीन को कॉन्फ़िगर करें और स्कोप चुनें. इससे यह तय किया जा सकेगा कि उपयोगकर्ताओं और ऐप्लिकेशन की समीक्षा करने वालों को कौनसी जानकारी दिखेगी. साथ ही, अपने ऐप्लिकेशन को रजिस्टर करें, ताकि बाद में उसे पब्लिश किया जा सके.

अपने ऐप्लिकेशन में, एपीआई शुरू करते समय आपको उस सेशन के लिए ज़रूरी स्कोप का साफ़ तौर पर अनुरोध करना होगा. Google Cloud Console, आपके ऐप्लिकेशन को अनुमति के सबसे ऊंचे लेवल का अनुरोध करने की अनुमति देता है. वहीं, कोड यह तय करता है कि किसी उपयोगकर्ता के लिए, अनुमति का कौनसा लेवल सही है. इससे यह पक्का करने में मदद मिलती है कि ऐप्लिकेशन सिर्फ़ उस काम के लिए ज़रूरी अनुमतियां मांगे जिसके लिए उसे बनाया गया है.

अपने ऐप्लिकेशन के कोड में, एक या उससे ज़्यादा OAuth स्कोप को एक साथ ऐरे के तौर पर एलान किया जा सकता है.

यहां दिए गए कोड सैंपल में, एक से ज़्यादा OAuth स्कोप के बारे में बताने का तरीका दिखाया गया है:

Java

List<String> SCOPES = Arrays.asList(
  DriveScopes.DRIVE_FILE,
  DriveScopes.DRIVE_METADATA_READONLY
);

Python

SCOPES = [
  "https://www.googleapis.com/auth/drive.file",
  "https://www.googleapis.com/auth/drive.metadata.readonly",
]

Node.js

const SCOPES = [
  'https://www.googleapis.com/auth/drive.file',
  'https://www.googleapis.com/auth/drive.metadata.readonly'
];

पूरे कोड सैंपल में स्कोप को कैसे डिक्लेयर और इस्तेमाल किया जाता है, यह जानने के लिए क्विकस्टार्ट देखें.

Drive API के स्कोप

अपने ऐप्लिकेशन को दिए गए ऐक्सेस का लेवल तय करने के लिए, आपको अनुमति के स्कोप की पहचान करनी होगी और उन्हें ज़ाहिर करना होगा. अनुमति का दायरा, OAuth 2.0 यूआरआई स्ट्रिंग होती है. इसमें Google Workspace ऐप्लिकेशन का नाम, ऐक्सेस किए जाने वाले डेटा का टाइप, और ऐक्सेस का लेवल शामिल होता है. स्कोप, Google Workspace डेटा के साथ काम करने के लिए आपके ऐप्लिकेशन के अनुरोध होते हैं. इनमें उपयोगकर्ताओं के Google खाते का डेटा भी शामिल होता है.

जब आपका ऐप्लिकेशन इंस्टॉल किया जाता है, तो उपयोगकर्ता से ऐप्लिकेशन के इस्तेमाल किए गए स्कोप की पुष्टि करने के लिए कहा जाता है. आम तौर पर, आपको सबसे कम स्कोप चुनना चाहिए. साथ ही, ऐसे स्कोप के लिए अनुरोध करने से बचना चाहिए जिनकी आपके ऐप्लिकेशन को ज़रूरत नहीं है. उपयोगकर्ता, सीमित और साफ़ तौर पर बताए गए स्कोप को आसानी से ऐक्सेस दे देते हैं.

जब भी हो सके, ऐसे स्कोप का इस्तेमाल करें जिनमें संवेदनशील जानकारी शामिल न हो. इनसे हर फ़ाइल के लिए ऐक्सेस मिलता है. साथ ही, ऐप्लिकेशन को सिर्फ़ उन सुविधाओं का ऐक्सेस मिलता है जिनकी उसे ज़रूरत होती है.

गैर-संवेदनशील स्कोप

ज़्यादातर इस्तेमाल के उदाहरणों के लिए, Drive API के इन स्कोप का सुझाव दिया जाता है:

स्कोप कोड ब्यौरा
https://www.googleapis.com/auth/drive.appdata
https://www.googleapis.com/auth/drive.appfolder		 Google Drive में, ऐप्लिकेशन के कॉन्फ़िगरेशन डेटा को देखें और मैनेज करें.
https://www.googleapis.com/auth/drive.install ऐप्लिकेशन को "इससे खोलें" या "नया" मेन्यू में विकल्प के तौर पर दिखने की अनुमति दें.
https://www.googleapis.com/auth/drive.file Drive में नई फ़ाइलें बनाना या किसी ऐप्लिकेशन से खोली गई मौजूदा फ़ाइलों में बदलाव करना. इसके अलावा, Google Picker API या ऐप्लिकेशन के फ़ाइल पिकर का इस्तेमाल करते समय, उपयोगकर्ता की ओर से ऐप्लिकेशन के साथ शेयर की गई फ़ाइलों में बदलाव करना.

संवेदनशील स्कोप

स्कोप कोड ब्यौरा
https://www.googleapis.com/auth/drive.apps.readonly वे ऐप्लिकेशन देखें जिन्हें आपकी Drive का डेटा ऐक्सेस करने की अनुमति है.

पाबंदी वाले स्कोप

स्कोप कोड ब्यौरा
https://www.googleapis.com/auth/drive Drive में मौजूद अपनी सभी फ़ाइलें देखें और उन्हें मैनेज करें.
https://www.googleapis.com/auth/drive.readonly Drive में मौजूद अपनी सभी फ़ाइलें देखें और डाउनलोड करें.
https://www.googleapis.com/auth/drive.activity अपने Drive में मौजूद फ़ाइलों का गतिविधि रिकॉर्ड देखें और उसमें जानकारी जोड़ें.
https://www.googleapis.com/auth/drive.activity.readonly अपने Drive में मौजूद फ़ाइलों का गतिविधि रिकॉर्ड देखें.
https://www.googleapis.com/auth/drive.meet.readonly Google Meet के ज़रिए बनाई गई या उसमें बदलाव की गई Drive फ़ाइलों को देखना.
https://www.googleapis.com/auth/drive.metadata अपनी Drive में मौजूद फ़ाइलों का मेटाडेटा देखें और मैनेज करें.
https://www.googleapis.com/auth/drive.metadata.readonly Drive में मौजूद फ़ाइलों का मेटाडेटा देखें.
https://www.googleapis.com/auth/drive.scripts अपनी Google Apps Script की स्क्रिप्ट का व्यवहार बदलें.

ऊपर दी गई टेबल में मौजूद स्कोप, उनकी संवेदनशीलता के बारे में बताते हैं. यह संवेदनशीलता, यहां दी गई परिभाषाओं के हिसाब से तय की जाती है:

अगर आपके ऐप्लिकेशन को किसी अन्य Google API को ऐक्सेस करने की ज़रूरत है, तो उन स्कोप को भी जोड़ा जा सकता है. Google API के स्कोप के बारे में ज़्यादा जानने के लिए, OAuth 2.0 का इस्तेमाल करके, Google API को ऐक्सेस करना लेख पढ़ें.

OAuth 2.0 के कुछ स्कोप के बारे में ज़्यादा जानने के लिए, Google APIs के लिए OAuth 2.0 स्कोप लेख पढ़ें.

पाबंदी वाले स्कोप के लिए ज़रूरी शर्तें

Google Drive के लिए, प्रतिबंधित स्कोप का इस्तेमाल सिर्फ़ कुछ खास तरह के ऐप्लिकेशन कर सकते हैं. ज़रूरी शर्तें पूरी करने के लिए, आपका ऐप्लिकेशन इनमें से किसी एक कैटगरी में होना चाहिए:

  1. बैक अप और सिंक: ये प्लैटफ़ॉर्म के हिसाब से बनाए गए वेब ऐप्लिकेशन होते हैं. ये उपयोगकर्ताओं को Drive की फ़ाइलों को लोकल तौर पर सिंक करने या उनका अपने-आप बैक अप लेने की सुविधा देते हैं.

  2. प्रोडक्टिविटी और शिक्षा: ऐसे ऐप्लिकेशन जिनका मुख्य यूज़र इंटरफ़ेस (यूआई) Drive फ़ाइलों, मेटाडेटा या अनुमतियों के साथ इंटरैक्ट कर सकता है. इन ऐप्लिकेशन में, टास्क मैनेजमेंट, नोट लेने, वर्कग्रुप से बातचीत करने, और क्लासरूम में साथ मिलकर काम करने वाले ऐप्लिकेशन शामिल हैं.

  3. रिपोर्टिंग और सुरक्षा: ऐसे ऐप्लिकेशन जो उपयोगकर्ता या ग्राहक को यह जानकारी देते हैं कि फ़ाइलें कैसे शेयर की जाती हैं या उन्हें कैसे ऐक्सेस किया जाता है.

प्रतिबंधित स्कोप का इस्तेमाल जारी रखने के लिए, आपको अपने ऐप्लिकेशन को प्रतिबंधित स्कोप की पुष्टि के लिए तैयार करना होगा.

पाबंदी वाले स्कोप से किसी मौजूदा ऐप्लिकेशन को माइग्रेट करना

अगर आपका Drive ऐप्लिकेशन, प्रतिबंधित स्कोप का इस्तेमाल करता है, तो हमारा सुझाव है कि आप Drive API के ऐसे स्कोप पर माइग्रेट करें जो संवेदनशील न हो. drive.file जैसे संवेदनशील स्कोप का इस्तेमाल न करने पर, हर फ़ाइल के लिए ऐक्सेस दिया जाता है. साथ ही, किसी ऐप्लिकेशन को ज़रूरी सुविधाओं का सीमित ऐक्सेस मिलता है.

कई ऐप्लिकेशन, बिना किसी बदलाव के हर फ़ाइल के हिसाब से ऐक्सेस करने की सुविधा पर स्विच कर सकते हैं.

अगर फ़ाइल चुनने के लिए अपने फ़ाइल पिकर का इस्तेमाल किया जा रहा है, तो हमारा सुझाव है कि Google Picker API पर स्विच करें. यह अलग-अलग स्कोप के साथ पूरी तरह से काम करता है.

Drive फ़ाइल के स्कोप के फ़ायदे

Google Picker API के साथ drive.file OAuth स्कोप का इस्तेमाल करने से, आपके ऐप्लिकेशन के लिए उपयोगकर्ता अनुभव और सुरक्षा, दोनों को बेहतर बनाया जा सकता है.

drive.file OAuth स्कोप की मदद से, लोग यह चुन सकते हैं कि उन्हें आपके ऐप्लिकेशन के साथ कौनसी फ़ाइलें शेयर करनी हैं. इससे उन्हें ज़्यादा कंट्रोल मिलता है. साथ ही, उन्हें यह भरोसा होता है कि आपके ऐप्लिकेशन के पास उनकी फ़ाइलों का सीमित और ज़्यादा सुरक्षित ऐक्सेस है. इसके उलट, Drive की सभी फ़ाइलों का ऐक्सेस मांगने पर, लोग आपके ऐप्लिकेशन का इस्तेमाल करने से कतरा सकते हैं.

drive.file स्कोप का इस्तेमाल करने की कुछ वजहें यहां दी गई हैं:

  • इस्तेमाल में आसानी: drive.file स्कोप, Drive API के सभी REST संसाधनों के साथ काम करता है. इसका मतलब है कि इसका इस्तेमाल उसी तरह किया जा सकता है जिस तरह OAuth के बड़े स्कोप का इस्तेमाल किया जाता है.

  • सुविधाएं: Google Picker API, Drive के यूज़र इंटरफ़ेस (यूआई) जैसा इंटरफ़ेस उपलब्ध कराता है. इसमें Drive की फ़ाइलों की झलक और थंबनेल दिखाने वाले कई व्यू शामिल हैं. साथ ही, इसमें एक इनलाइन, मोडल विंडो भी शामिल है, ताकि उपयोगकर्ता कभी भी मुख्य ऐप्लिकेशन न छोड़ें.

  • आसानी: Google Picker की फ़ाइलों पर फ़िल्टर का इस्तेमाल करते समय, ऐप्लिकेशन Drive की कुछ फ़ाइल टाइप (जैसे कि Google Docs, Sheets, और फ़ोटो) के लिए फ़िल्टर लागू कर सकते हैं.

  • पुष्टि करने की आसान प्रक्रिया: drive.file संवेदनशील जानकारी नहीं है. इसलिए, इसकी पुष्टि करने की प्रक्रिया ज़्यादा आसान होती है.

रीफ़्रेश टोकन को सुरक्षित तरीके से सेव करना

Drive API का इस्तेमाल करके निजी डेटा ऐक्सेस करने के लिए, आपके ऐप्लिकेशन को एक ऐक्सेस टोकन पाना होगा. इससे उस एपीआई को ऐक्सेस करने की अनुमति मिलती है. एक ऐक्सेस टोकन से, कई एपीआई को अलग-अलग लेवल का ऐक्सेस दिया जा सकता है. यह ऐक्सेस, आपके अनुरोध किए गए स्कोप के हिसाब से तय होता है.

ऐक्सेस टोकन की समयसीमा कम होती है. इसलिए, Drive API को लंबे समय तक ऐक्सेस करने के लिए, आपको रीफ़्रेश टोकन का इस्तेमाल करना होगा. रीफ़्रेश टोकन की मदद से, आपका ऐप्लिकेशन नए ऐक्सेस टोकन का अनुरोध कर सकता है.

रीफ़्रेश टोकन को सुरक्षित और लंबे समय तक इस्तेमाल की जा सकने वाली स्टोरेज में सेव करें. साथ ही, जब तक वे मान्य हैं, तब तक उनका इस्तेमाल जारी रखें.

ज़्यादा जानकारी के लिए, OAuth 2.0 का इस्तेमाल करके Google API ऐक्सेस करना लेख पढ़ें.