Google Drive के इंटरफ़ेस बनाना

Google Workspace के ऐड-ऑन, उपयोगकर्ता के Google Drive का इस्तेमाल करने पर, पसंद के मुताबिक इंटरफ़ेस उपलब्ध करा सकते हैं. इसकी मदद से, उपयोगकर्ता को ज़्यादा काम की जानकारी दी जा सकती है, टास्क अपने-आप होने की सुविधा चालू की जा सकती है, और तीसरे पक्ष के सिस्टम को Google Drive से कनेक्ट किया जा सकता है.

ऐड-ऑन का यूज़र इंटरफ़ेस (यूआई) ऐक्सेस करना

Google Workspace के किसी ऐड-ऑन को Google Drive में खोला जा सकता है. इसके लिए ज़रूरी है कि उसका आइकॉन, Drive के यूज़र इंटरफ़ेस की दाईं ओर मौजूद आइकॉन कॉलम में दिखे. Google Workspace ऐड-ऑन, होम पेज इंटरफ़ेस, आइटम चुनने का इंटरफ़ेस या दोनों तय कर सकता है:

• अगर कोई उपयोगकर्ता Google Drive में रहते हुए, ऐड-ऑन आइकॉन पर क्लिक करता है, तो ऐड-ऑन उससे जुड़ा drive.homepageTrigger फ़ंक्शन (अगर मौजूद हो) को लागू करता है. यह फ़ंक्शन, Google Drive में होम पेज कार्ड बनाता है और उसे डिसप्ले के लिए दिखाता है. अगर कोई drive.homepageTrigger फ़ंक्शन तय नहीं किया गया है, तो इसके बजाय एक सामान्य होम पेज कार्ड दिखाया जाता है.
• अगर उपयोगकर्ता Google Drive में एक या उससे ज़्यादा आइटम चुनता है और फिर ऐड-ऑन आइकॉन पर क्लिक करता है या ऐड-ऑन खुला होने पर आइटम चुनता है, तो ऐड-ऑन उससे जुड़ा drive.onItemsSelectedTrigger संदर्भ फ़ंक्शन (अगर मौजूद हो) को लागू करता है. यह फ़ंक्शन, ऐड-ऑन के Google Drive के काम के हिसाब से "चुने गए आइटम" इंटरफ़ेस को बनाता है और उसे Google Drive में डिसप्ले के लिए दिखाता है.

ऐड-ऑन के लिए Drive का इंटरफ़ेस बनाना

Google Drive के साथ काम करने वाले इंटरफ़ेस बनाने के लिए, ये सामान्य तरीके अपनाएं:

1. तय करें कि आपको अपने ऐड-ऑन के लिए, Drive पर इस्तेमाल किया जाने वाला होम पेज बनाना है या नहीं. यह भी तय करें कि जब उपयोगकर्ता Drive के आइटम चुनता है, तो आपको कॉन्टेक्स्ट के हिसाब से इंटरफ़ेस उपलब्ध कराना है या नहीं.
2. ऐड-ऑन स्क्रिप्ट प्रोजेक्ट के मेनिफ़ेस्ट में, सही addOns.common और addOns.drive फ़ील्ड जोड़ें. साथ ही, ज़रूरी Drive स्कोप भी जोड़ें.
3. अगर Drive के लिए खास होम पेज दिया जा रहा है, तो इस इंटरफ़ेस को बनाने के लिए, drive.homepageTrigger फ़ंक्शन लागू करें. आपके पास एक से ज़्यादा Google Workspace होस्ट के लिए, common.homepageTrigger इंटरफ़ेस का इस्तेमाल करने का विकल्प भी है.
4. अगर Drive में कॉन्टेक्स्ट के हिसाब से आइटम चुनने का इंटरफ़ेस उपलब्ध कराया जा रहा है, तो आपको इस इंटरफ़ेस को बनाने के लिए, drive.onItemsSelectedTrigger कॉन्टेक्स्ट ट्रिगर फ़ंक्शन लागू करना होगा. ज़्यादा जानकारी के लिए, चुने गए आइटम के लिए Drive का कॉन्टेक्स्टुअल इंटरफ़ेस देखें.
5. उपयोगकर्ता के यूज़र इंटरफ़ेस (यूआई) इंटरैक्शन, जैसे कि बटन क्लिक का जवाब देने के लिए, इससे जुड़े कॉलबैक फ़ंक्शन लागू करें.

Drive के होम पेज

Google Drive में, Google Workspace ऐड-ऑन के होम पेज दिखाए जा सकते हैं. Google Drive में अपने ऐड-ऑन का सामान्य होम पेज दिखाने के लिए, पक्का करें कि ऐड-ऑन के मेनिफ़ेस्ट में addOns.drive फ़ील्ड मौजूद हो.

इसके अलावा, Drive के लिए खास तौर पर बनाया गया होम पेज उपलब्ध कराने के लिए, ऐड-ऑन मेनिफ़ेस्ट में drive.homepageTrigger जोड़ें.

दोनों ही मामलों में, आपको अपने ऐड-ऑन के स्क्रिप्ट प्रोजेक्ट में, होम पेज ट्रिगर फ़ंक्शन का नाम देना होगा. ज़रूरत पड़ने पर, Drive का होम पेज बनाने के लिए, इस फ़ंक्शन को अपने-आप कॉल किया जाता है. होम पेज बनाने वाले एक Card या Card ऑब्जेक्ट के अरे को बनाने और दिखाने के लिए, आपको यह फ़ंक्शन लागू करना होगा. होम पेज ट्रिगर फ़ंक्शन को पैरामीटर के तौर पर एक इवेंट ऑब्जेक्ट दिया जाता है. इसमें क्लाइंट के प्लैटफ़ॉर्म जैसी कुछ सामान्य जानकारी होती है. होम पेज को अपनी ज़रूरत के मुताबिक बनाने के लिए, इवेंट ऑब्जेक्ट के डेटा का इस्तेमाल किया जा सकता है.

चुने गए आइटम के लिए, काम के हिसाब से इंटरफ़ेस दिखाना

Google Drive, कॉन्टेक्स्ट के हिसाब से ट्रिगर पर निर्भर करता है. इससे यह तय होता है कि जब कोई उपयोगकर्ता Google Drive के एक या उससे ज़्यादा आइटम चुनता है, तो कौनसा इंटरफ़ेस दिखाया जाए. ट्रिगर ट्रिगर होने पर, वह ऐड-ऑन मेनिफ़ेस्ट में drive.onItemsSelectedTrigger.runFunction फ़ील्ड में बताए गए संदर्भ के हिसाब से ट्रिगर फ़ंक्शन को लागू करता है.

Drive के लिए, संदर्भ के हिसाब से आइटम चुनने वाला इंटरफ़ेस बनाने के लिए, आपको ये काम करने होंगे:

1. पक्का करें कि ऐड-ऑन के मेनिफ़ेस्ट में https://www.googleapis.com/auth/drive.addons.metadata.readonly scope शामिल हो

2. पक्का करें कि मेनिफ़ेस्ट में drive.onItemsSelectedTrigger सेक्शन शामिल हो.

3. drive.onItemsSelectedTrigger फ़ील्ड में दिए गए नाम वाले फ़ंक्शन को लागू करें. यह फ़ंक्शन, आर्ग्युमेंट के तौर पर इवेंट ऑब्जेक्ट स्वीकार करता है और एक Card ऑब्जेक्ट या Card ऑब्जेक्ट का अरे दिखाता है.

4. किसी भी कार्ड की तरह, आपको इंटरफ़ेस के लिए विजेट इंटरैक्टिविटी देने के लिए इस्तेमाल किए जाने वाले सभी कॉलबैक फ़ंक्शन लागू करने होंगे. उदाहरण के लिए, अगर इंटरफ़ेस में कोई बटन शामिल किया जाता है, तो उसमें कोई कार्रवाई और लागू किया गया कॉलबैक फ़ंक्शन होना चाहिए, जो बटन पर क्लिक करने पर चलता है.

इवेंट ऑब्जेक्ट

इवेंट ऑब्जेक्ट बनाया जाता है और उन फ़ंक्शन को कॉल करने पर, drive.homepageTrigger या drive.onItemsSelectedTrigger ट्रिगर फ़ंक्शन को पास किया जाता है. ट्रिगर फ़ंक्शन, ऐड-ऑन कार्ड बनाने या ऐड-ऑन के व्यवहार को कंट्रोल करने के तरीके का पता लगाने के लिए, इस इवेंट ऑब्जेक्ट में मौजूद जानकारी का इस्तेमाल कर सकता है.

इवेंट ऑब्जेक्ट का पूरा स्ट्रक्चर, इवेंट ऑब्जेक्ट में बताया गया है. जब Drive, ऐड-ऑन का होस्ट ऐप्लिकेशन होता है, तो संदर्भ के हिसाब से इवेंट ऑब्जेक्ट में Drive इवेंट ऑब्जेक्ट फ़ील्ड शामिल होता है. इसमें Drive से जुड़ी क्लाइंट की जानकारी होती है.

आइटम चुनने के ट्रिगर के लिए, संदर्भ के हिसाब से Drive इवेंट ऑब्जेक्ट में उन आइटम की जानकारी शामिल होती है जिन्हें उपयोगकर्ता ने ट्रिगर होने पर चुना है. जब कोई उपयोगकर्ता Drive में एक से ज़्यादा आइटम चुनता है, तो उनमें से किसी एक आइटम को मुख्य तौर पर चुना जाता है. इस आइटम को सक्रिय कर्सर आइटम कहा जाता है.

इस उदाहरण में, Drive इवेंट ऑब्जेक्ट दिखाया गया है, जिसे drive.onItemsSelectedTrigger फ़ंक्शन में पास किया गया है:

    {
      "commonEventObject": { ... },
      "drive": {
        "activeCursorItem":{
          "addonHasFileScopePermission": true,
          "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
          "iconUrl": "https://drive-thirdparty.googleusercontent.com...",
          "mimeType":"application/pdf",
          "title":"How to get started with Drive"
        },
        "selectedItems": [
          {
            "addonHasFileScopePermission": true,
            "id":"0B_sX1fXRRU6Ac3RhcnRlcl9maWxl",
            "iconUrl":"https://drive-thirdparty.googleusercontent.com...",
            "mimeType":"application/pdf",
            "title":"How to get started with Drive"
          },
          ...
        ]
      },
      ...
    }