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

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

Drive API चालू करें

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

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

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

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

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

  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 में अपने ऐप्लिकेशन को लिस्ट करने से पहले, आपको इस यूआरएल के मालिकाना हक की पुष्टि करनी होगी.
    • Drive के यूज़र इंटरफ़ेस (यूआई) से ऐप्लिकेशन में डेटा भेजने के लिए, डिफ़ॉल्ट रूप से इस यूआरएल में state क्वेरी पैरामीटर जोड़ा जाता है. state पैरामीटर के कॉन्टेंट के बारे में जानकारी के लिए, state पैरामीटर देखें.
  9. (ज़रूरी नहीं) डिफ़ॉल्ट MIME टाइप और डिफ़ॉल्ट फ़ाइल एक्सटेंशन फ़ील्ड में डिफ़ॉल्ट MIME टाइप और फ़ाइल एक्सटेंशन डालें. डिफ़ॉल्ट MIME टाइप और फ़ाइल एक्सटेंशन उन फ़ाइलों को दिखाते हैं जिन्हें आपके ऐप्लिकेशन को खोलने के लिए खास तौर पर बनाया गया है. उदाहरण के लिए, आपका ऐप्लिकेशन इमेज पर लेयर बनाने और उनमें बदलाव करने के लिए पहले से मौजूद फ़ॉर्मैट खोल सकता है. सिर्फ़ स्टैंडर्ड मीडिया टाइप शामिल करें और पक्का करें कि उनमें टाइपिंग की कोई गलती न हो. अगर आपका ऐप्लिकेशन सिर्फ़ शॉर्टकट या तीसरे पक्ष की शॉर्टकट फ़ाइलें खोलता है, तो MIME टाइप को खाली छोड़ा जा सकता है.

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

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

    • इस यूआरएल में पूरी तरह क्वालिफ़ाइड डोमेन नेम होना चाहिए, क्योंकि localhost काम नहीं करता.
    • Google Workspace Marketplace में अपने ऐप्लिकेशन को लिस्ट करने से पहले, आपको इस यूआरएल के मालिकाना हक की पुष्टि करनी होगी.
    • Drive के यूज़र इंटरफ़ेस (यूआई) से ऐप्लिकेशन में डेटा भेजने के लिए, डिफ़ॉल्ट रूप से इस यूआरएल में state क्वेरी पैरामीटर जोड़ा जाता है. 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 दस्तावेज़ को खोलने पर किया जाता है. यूआरएल खोलें
{resourceKeys} फ़ाइल आईडी की JSON डिक्शनरी, जिसे उनसे जुड़ी संसाधन कुंजियों के साथ मैप किया गया है. यूआरएल खोलें
{folderId} पैरंट फ़ोल्डर का आईडी. नया URL
{folderResourceKey} पैरंट फ़ोल्डर की संसाधन कुंजी. नया URL
{userId} वह प्रोफ़ाइल आईडी जिससे उपयोगकर्ता की पहचान होती है. यूआरएल और नया यूआरएल खोलें
{action} की जा रही कार्रवाई. ओपन यूआरएल का इस्तेमाल करते समय वैल्यू open है या नए यूआरएल का इस्तेमाल करते समय 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 के यूज़र इंटरफ़ेस (यूआई) के "इससे खोलें" संदर्भ मेन्यू के साथ इंटिग्रेट करें देखें.