Drive यूज़र इंटरफ़ेस (यूआई) इंटिग्रेशन कॉन्फ़िगर करना

जब कोई उपयोगकर्ता कोई फ़ाइल बनाता या खोलता है, तो Google Drive में अपना ऐप्लिकेशन दिखाने के लिए, आपको सबसे पहले Drive के यूज़र इंटरफ़ेस (यूआई) इंटिग्रेशन को सेट अप करना होगा. Google Workspace Marketplace में अपने ऐप्लिकेशन को लिस्ट करने के लिए भी कॉन्फ़िगरेशन ज़रूरी है.

Drive API को चालू करना

Google API का इस्तेमाल करने से पहले, आपको उन्हें Google Cloud प्रोजेक्ट में चालू करना होगा. एक Google Cloud प्रोजेक्ट में, एक या इससे ज़्यादा एपीआई चालू किए जा सकते हैं.

Google Drive के यूज़र इंटरफ़ेस (यूआई) के साथ इंटिग्रेट करने के लिए, आपको Drive API को चालू करना होगा. इससे आपको एपीआई और यूज़र इंटरफ़ेस (यूआई) इंटिग्रेशन की सुविधाओं का ऐक्सेस मिलता है.

Drive के यूज़र इंटरफ़ेस (यूआई) का इंटिग्रेशन सेट अप करना

  1. Google API Console में, मेन्यू > एपीआई और सेवाएं > चालू किए गए एपीआई और सेवाएं पर जाएं.

    'चालू एपीआई और सेवाएं' पर जाएं

  2. एपीआई और सेवाओं के डैशबोर्ड में सबसे नीचे, Google Drive API पर क्लिक करें. इसके बाद, Google Drive API का कॉन्फ़िगरेशन पेज दिखेगा.
  3. Drive यूज़र इंटरफ़ेस (यूआई) इंटिग्रेशन टैब को चुनें.
  4. (ज़रूरी नहीं) ऐप्लिकेशन का नाम फ़ील्ड में कोई नाम डालें. ऐप्लिकेशन का नाम, Drive की सेटिंग में मौजूद 'ऐप्लिकेशन मैनेज करें' टैब में उपयोगकर्ताओं को दिखता है.
  5. (ज़रूरी नहीं) कम शब्दों में जानकारी फ़ील्ड में, एक लाइन में कम शब्दों में जानकारी डालें. Drive की सेटिंग में, 'ऐप्लिकेशन मैनेज करें' टैब में उपयोगकर्ताओं को कम शब्दों में जानकारी दिखती है.
  6. (ज़रूरी नहीं) ज़्यादा जानकारी फ़ील्ड में पूरी जानकारी डालें.
  7. एक या इससे ज़्यादा ऐप्लिकेशन आइकॉन अपलोड करें, ताकि उन्हें उपयोगकर्ता की कनेक्ट की गई Drive ऐप्लिकेशन की सूची में और "इसमें खोलें" कॉन्टेक्स्ट मेन्यू में दिखाया जा सके. आइकॉन, PNG फ़ॉर्मैट में होने चाहिए और उनका बैकग्राउंड पारदर्शी होना चाहिए. Drive में आइकॉन दिखने में 24 घंटे लग सकते हैं.

  8. Drive के यूज़र इंटरफ़ेस (यूआई) के "इसके साथ खोलें" मेन्यू आइटम का इस्तेमाल करने के लिए, यूआरएल खोलें फ़ील्ड में अपने ऐप्लिकेशन का यूआरएल डालें. इस यूआरएल का इस्तेमाल, "इसमें खोलें" कॉन्टेक्स्ट मेन्यू करता है.

    • इस यूआरएल में पूरी तरह क्वालिफ़ाइड डोमेन नेम होना चाहिए. localhost काम नहीं करता.
    • यह यूआरएल, आपके ऐप्लिकेशन के उपयोगकर्ताओं के लिए ऐक्सेस किया जा सकने वाला होना चाहिए. अगर आपके पास ऐप्लिकेशन के कई वर्शन हैं, जैसे कि एक वर्शन सार्वजनिक तौर पर रिलीज़ करने के लिए और दूसरा वर्शन चुनिंदा उपयोगकर्ताओं के लिए, तो हर वर्शन के लिए एक यूनीक यूआरएल का इस्तेमाल किया जाना चाहिए. इसके बाद, हर वर्शन के लिए अलग-अलग ऐप्लिकेशन कॉन्फ़िगरेशन बनाए जा सकते हैं.
    • Google Workspace Marketplace में अपना ऐप्लिकेशन लिस्ट करने से पहले, आपको इस यूआरएल के मालिकाना हक की पुष्टि करनी होगी.
    • डिफ़ॉल्ट रूप से, इस यूआरएल में state क्वेरी पैरामीटर जोड़ा जाता है, ताकि Drive के यूज़र इंटरफ़ेस (यूआई) से आपके ऐप्लिकेशन में डेटा भेजा जा सके. state पैरामीटर के कॉन्टेंट के बारे में जानकारी पाने के लिए, state पैरामीटर देखें.
  9. (ज़रूरी नहीं) डिफ़ॉल्ट एमआईएमई टाइप और डिफ़ॉल्ट फ़ाइल एक्सटेंशन फ़ील्ड में, डिफ़ॉल्ट एमआईएमई टाइप और फ़ाइल एक्सटेंशन डालें. डिफ़ॉल्ट एमआईएमई टाइप और फ़ाइल एक्सटेंशन, उन फ़ाइलों को दिखाते हैं जिन्हें खोलने के लिए आपका ऐप्लिकेशन खास तौर पर बनाया गया है. उदाहरण के लिए, आपका ऐप्लिकेशन इमेज को लेयर करने और उनमें बदलाव करने के लिए, पहले से मौजूद फ़ॉर्मैट खोल सकता है. सिर्फ़ स्टैंडर्ड मीडिया टाइप शामिल करें. साथ ही, पक्का करें कि उनमें टाइपिंग की कोई गलती और गलत वर्तनी न हो. अगर आपका ऐप्लिकेशन सिर्फ़ शॉर्टकट या तीसरे पक्ष की शॉर्टकट फ़ाइलें खोलता है, तो एमआईएमई टाइप को खाली छोड़ा जा सकता है.

  10. (ज़रूरी नहीं) सेकंडरी एमआईएमई टाइप और सेकंडरी फ़ाइल एक्सटेंशन फ़ील्ड में, सेकंडरी एमआईएमई टाइप और फ़ाइल एक्सटेंशन डालें. सेकंडरी एमआईएमई टाइप और फ़ाइल एक्सटेंशन, उन फ़ाइलों को दिखाते हैं जिन्हें आपका ऐप्लिकेशन खोल सकता है. हालांकि, ये आपके ऐप्लिकेशन के लिए खास नहीं होते. उदाहरण के लिए, आपका ऐप्लिकेशन कोई इमेज-एडिटिंग ऐप्लिकेशन हो सकता है, जो PNG और JPG इमेज खोलता है. सिर्फ़ स्टैंडर्ड मीडिया टाइप शामिल करें. साथ ही, पक्का करें कि उनमें टाइपिंग की कोई गलती और गलत वर्तनी न हो. अगर आपका ऐप्लिकेशन सिर्फ़ शॉर्टकट या तीसरे पक्ष की शॉर्टकट फ़ाइलें खोलता है, तो एमआईएमई टाइप को खाली छोड़ा जा सकता है.

  11. Drive के यूज़र इंटरफ़ेस (यूआई) के "नया" बटन का इस्तेमाल करने और उपयोगकर्ताओं को आपके ऐप्लिकेशन की मदद से फ़ाइल बनाने की सुविधा देने के लिए, फ़ाइलें बनाना बॉक्स को चुनें. नया यूआरएल और वैकल्पिक दस्तावेज़ का नाम फ़ील्ड दिखते हैं.

    • इस यूआरएल में पूरी तरह क्वालिफ़ाइड डोमेन नेम होना चाहिए. localhost काम नहीं करता.
    • Google Workspace Marketplace में अपना ऐप्लिकेशन लिस्ट करने से पहले, आपको इस यूआरएल के मालिकाना हक की पुष्टि करनी होगी.
    • डिफ़ॉल्ट रूप से, इस यूआरएल में state क्वेरी पैरामीटर जोड़ा जाता है, ताकि Drive के यूज़र इंटरफ़ेस (यूआई) से आपके ऐप्लिकेशन में डेटा भेजा जा सके. state पैरामीटर के कॉन्टेंट के बारे में जानकारी पाने के लिए, state पैरामीटर देखें.
  12. नया यूआरएल फ़ील्ड में कोई यूआरएल डालें. इस यूआरएल का इस्तेमाल "नया" बटन करता है, ताकि उपयोगकर्ता को आपके ऐप्लिकेशन पर रीडायरेक्ट किया जा सके.

  13. (ज़रूरी नहीं) अगर आपको अपने ऐप्लिकेशन में Google Workspace के साथ काम करने वाली फ़ाइलें खोलनी हैं, तो इंपोर्ट करना बॉक्स को चुनें.

  14. (ज़रूरी नहीं) अगर आपके ऐप्लिकेशन को शेयर की गई ड्राइव में मौजूद फ़ाइलें मैनेज करनी हैं, तो शेयर की गई ड्राइव के लिए सहायता बॉक्स को चुनें. अपने ऐप्लिकेशन में शेयर की गई ड्राइव की सुविधा को चालू करने के बारे में ज़्यादा जानने के लिए, शेयर की गई ड्राइव की सुविधा को चालू करना लेख पढ़ें.

  15. सबमिट करें पर क्लिक करें.

drive.install स्कोप का अनुरोध करना

ऐप्लिकेशन को "इसके साथ खोलें" या "नया" मेन्यू में एक विकल्प के तौर पर दिखाने के लिए, Drive के यूज़र इंटरफ़ेस (यूआई) के साथ इंटिग्रेट करने के लिए, https://www.googleapis.com/auth/drive.install स्कोप का अनुरोध करें. इस स्कोप का अनुरोध करने पर, उपयोगकर्ताओं को इस तरह का डायलॉग बॉक्स दिखता है:

Google Drive के यूज़र इंटरफ़ेस (यूआई) का इंस्टॉलेशन डायलॉग.
पहली इमेज. Drive के यूज़र इंटरफ़ेस (यूआई) के लिए स्कोप का इस्तेमाल करते समय, इंस्टॉल करने वाला डायलॉग बॉक्स.

Drive ऐप्लिकेशन के लिए अनुरोध किए जा सकने वाले स्कोप और उनके लिए अनुरोध करने के तरीके के बारे में ज़्यादा जानने के लिए, एपीआई के लिए अनुमति और पुष्टि करने की जानकारी देखें.

state पैरामीटर

डिफ़ॉल्ट रूप से, Drive के यूज़र इंटरफ़ेस (यूआई) से आपके ऐप्लिकेशन में डेटा भेजने के लिए, यूआरएल खोलने और नए यूआरएल, दोनों में state पैरामीटर जोड़ा जाता है. इस पैरामीटर में, JSON कोड में बदली गई स्ट्रिंग होती है. इसमें टेंप्लेट वैरिएबल और आपके ऐप्लिकेशन को किए गए अनुरोध का डेटा शामिल होता है. शामिल किए गए वैरिएबल, इस्तेमाल किए गए यूआरएल के टाइप (यूआरएल खोलें या नया यूआरएल) पर निर्भर करते हैं:

टेंप्लेट वैरिएबल ब्यौरा यूआरएल ऐप्लिकेशन
{ids} खोली जा रही फ़ाइलों के आईडी की कॉमा लगाकर अलग की गई सूची. यूआरएल खोलें
{exportIds} एक्सपोर्ट की जा रही फ़ाइलों के आईडी की कॉमा लगाकर अलग की गई लिस्ट. इसका इस्तेमाल सिर्फ़ Google Workspace की फ़ाइलें खोलने के लिए किया जाता है. यूआरएल खोलें
{resourceKeys} फ़ाइल आईडी की JSON डिक्शनरी, जो उनकी संसाधन कुंजियों से मैप की गई है. यूआरएल खोलें
{folderId} पैरंट फ़ोल्डर का आईडी. नया URL
{folderResourceKey} पैरंट फ़ोल्डर की संसाधन कुंजी. नया URL
{userId} उपयोगकर्ता की पहचान करने वाला प्रोफ़ाइल आईडी. यूआरएल और नया यूआरएल खोलें
{action} की जा रही कार्रवाई. Open URL का इस्तेमाल करने पर, वैल्यू open होती है या New URL का इस्तेमाल करने पर, वैल्यू create होती है. यूआरएल और नया यूआरएल खोलें

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

नए यूआरएल के लिए, JSON में राज्य की जानकारी का उदाहरण

नए यूआरएल के लिए state की जानकारी यह है:

{
  "action":"create",
  "folderId":"FOLDER_ID",
  "folderResourceKey":"FOLDER_RESOURCE_KEY",
  "userId":"USER_ID"
}

किसी ओपन यूआरएल के लिए, JSON में राज्य की जानकारी का उदाहरण

यूआरएल खोलने के लिए, state की जानकारी यह है:

{
  "ids": ["ID"],
  "resourceKeys":{"RESOURCE_KEYS":"RESOURCE_KEYS"},
  "action":"open",
  "userId":"USER_ID"
}

आईडी और संसाधन कुंजियों का इस्तेमाल, फ़ाइल का मेटाडेटा फ़ेच करने और फ़ाइल का कॉन्टेंट डाउनलोड करने के लिए किया जाता है. जब आपके ऐप्लिकेशन के पास फ़ाइल आईडी और ऐक्सेस टोकन हो, तो वह अनुमतियों की जांच कर सकता है, फ़ाइल का मेटाडेटा फ़ेच कर सकता है, और फ़ाइल का कॉन्टेंट डाउनलोड कर सकता है. इसके बारे में files.get तरीके में बताया गया है.

इंस्टॉल किए गए ऐप्लिकेशन में, Drive के यूज़र इंटरफ़ेस (यूआई) से लॉन्च की गई कार्रवाइयों को बनाने, मैनेज करने, और खोलने की सुविधा होनी चाहिए. ज़्यादा जानने के लिए, Drive के यूज़र इंटरफ़ेस (यूआई) के "नया" बटन के साथ इंटिग्रेट करना या Drive के यूज़र इंटरफ़ेस (यूआई) के "इसके साथ खोलें" कॉन्टेक्स्ट मेन्यू के साथ इंटिग्रेट करना लेख पढ़ें.