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

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

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

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

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

• Google Cloud Console में, Google 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 पैरामीटर लेख पढ़ें.
   चेतावनी: OAuth 2.0 के लिए सहमति लेने वाली स्क्रीन को अपने-आप दिखाने का विकल्प अब काम नहीं करता. इस बॉक्स पर सही का निशान न लगाएं.
   ऐप्लिकेशन को अनुमति देने के सभी अनुरोध शुरू करने होंगे.

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

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

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

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 स्कोप का अनुरोध करें. इस स्कोप का अनुरोध करने पर, उपयोगकर्ताओं को इस तरह का डायलॉग दिखता है:

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

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

ध्यान दें: अगर आपने Drive ऐप्लिकेशन को Google Workspace Marketplace पर पब्लिश किया है, तो उपयोगकर्ता और डोमेन एडमिन, Google Workspace Marketplace से सीधे ऐप्लिकेशन को खोजकर इंस्टॉल कर सकते हैं.

state पैरामीटर

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

टेंप्लेट वैरिएबल	ब्यौरा	यूआरएल के लिए आवेदन करना
{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 तरीके में बताए गए तरीके से किया जा सकता है.

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

मिलते-जुलते विषय

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