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

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

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

अगर Google Drive के यूज़र इंटरफ़ेस की दाईं ओर मौजूद आइकॉन कॉलम में, Google Workspace ऐड-ऑन का आइकॉन दिखता है, तो उसे Google 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 स्कोप शामिल हो

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"
          },
          ...
        ]
      },
      ...
    }