Google Workspace ऐड-ऑन के लिए मेनिफ़ेस्ट फ़ाइल

Apps Script प्रोजेक्ट, स्क्रिप्ट और उसके काम करने के तरीके के बारे में कुछ जानकारी कॉन्फ़िगर करने के लिए मेनिफ़ेस्ट फ़ाइल का इस्तेमाल करता है. मेनिफ़ेस्ट को देखने और उसमें बदलाव करने का तरीका जानने के लिए, मेनिफ़ेस्ट देखें.

इस दस्तावेज़ में, Google Workspace ऐड-ऑन के लिए मेनिफ़ेस्ट को कॉन्फ़िगर करने की जानकारी दी गई है.

Google Workspace ऐड-ऑन के लिए मेनिफ़ेस्ट स्ट्रक्चर

Google Workspace ऐड-ऑन, Apps Script प्रोजेक्ट मेनिफ़ेस्ट फ़ाइल का इस्तेमाल करके, ऐड-ऑन के दिखने और उसके व्यवहार के कई पहलुओं को तय करते हैं. Google Workspace ऐड-ऑन के लिए मेनिफ़ेस्ट प्रॉपर्टी को, मेनिफ़ेस्ट ऑब्जेक्ट स्ट्रक्चर के addOns सेक्शन में व्यवस्थित किया जाता है.

Google Workspace ऐड-ऑन मेनिफ़ेस्ट कॉन्फ़िगरेशन का सैंपल

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

• मेनिफ़ेस्ट का addOns.common सेक्शन, ऐड-ऑन के नाम, लोगो के यूआरएल, रंग, और अन्य सामान्य होस्ट-इंडिपेंडेंट सेटिंग के बारे में बताता है.
• मेनिफ़ेस्ट में एक सामान्य होम पेज के बारे में बताया गया है. हालांकि, इसमें Calendar, Drive, Docs, Sheets, और Slides के लिए बने खास होम पेज भी शामिल हैं. Gmail डिफ़ॉल्ट होम पेज का इस्तेमाल करता है.
• सैंपल मेनिफ़ेस्ट सेटिंग से ये सुविधाएं चालू होती हैं:
  • कैलेंडर eventOpen और eventUpdated ट्रिगर और दो कैलेंडर कॉन्फ़्रेंस समाधान.
  • दुनिया भर में लागू होने वाली दो कार्रवाइयां.
  • onItemsSelectedTrigger ड्राइव.
  • Gmail में ईमेल लिखने की कार्रवाई और संदर्भ के हिसाब से ट्रिगर.
  • Docs linkPreviewTrigger. इस ट्रिगर के बारे में जानने के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.
  • Docs, Sheets, और Slides के लिए फ़ाइल से जुड़े इंटरफ़ेस.
• oauthScopes फ़ील्ड, प्रोजेक्ट के लिए अनुमति देने वाले स्कोप सेट करता है. आम तौर पर, यह ऐड-ऑन के लिए ज़रूरी होता है.
• urlFetchWhitelist फ़ील्ड एक ऐसा फ़ील्ड है जो यह पक्का करता है कि फ़ेच किए गए एंडपॉइंट, एचटीटीपीएस यूआरएल प्रीफ़िक्स की तय सूची से मेल खाते हों. ज़्यादा जानकारी के लिए, जिन यूआरएल को आपने अनुमति दी है उनकी सूची में शामिल यूआरएल देखें.

सैंपल में दिए गए लिंक, मेनिफ़ेस्ट रेफ़रंस दस्तावेज़ में उस फ़ील्ड की जानकारी पर ले जाते हैं.

ध्यान दें: मेनिफ़ेस्ट में ऐसे अन्य कॉम्पोनेंट शामिल होते हैं जो Apps Script प्रॉपर्टी से जुड़े होते हैं. addOns फ़ील्ड में मौजूद फ़ील्ड, सीधे तौर पर Google Workspace ऐड-ऑन से जुड़े होते हैं. यह उदाहरण पूरी मेनिफ़ेस्ट फ़ाइल का सिर्फ़ एक हिस्सा है और यह पूरी तरह से काम करने वाला मेनिफ़ेस्ट नहीं है.

{
  "addOns": {
    "calendar": {
      "createSettingsUrlFunction": "getConferenceSettingsPageUrl",
      "conferenceSolution": [{
        "id": "my-video-conf",
        "logoUrl": "https://lh3.googleusercontent.com/...",
        "name": "My Video Conference",
        "onCreateFunction": "onCreateMyVideoConference"
      }, {
        "id": "my-streamed-conf",
        "logoUrl": "https://lh3.googleusercontent.com/...",
        "name": "My Streamed Conference",
        "onCreateFunction": "onCreateMyStreamedConference"
      }],
      "currentEventAccess": "READ_WRITE",
      "eventOpenTrigger": {
        "runFunction": "onCalendarEventOpen"
      },
      "eventUpdateTrigger": {
        "runFunction": "onCalendarEventUpdate"
      },
      "eventAttachmentTrigger": {
        "label": "My Event Attachment",
        "runFunction": "onCalendarEventAddAttachment"
      },
      "homepageTrigger": {
        "runFunction": "onCalendarHomePageOpen",
        "enabled": true
      }
    },
    "common": {
      "homepageTrigger": {
        "runFunction": "onDefaultHomePageOpen",
        "enabled": true
      },
      "layoutProperties": {
        "primaryColor": "#ff392b",
        "secondaryColor": "#d68617"
      },
      "logoUrl": "https://ssl.gstatic.com/docs/script/images/logo/script-64.png",
      "name": "Demo Google Workspace Add-on",
      "openLinkUrlPrefixes": [
        "https://mail.google.com/",
        "https://script.google.com/a/google.com/d/",
        "https://drive.google.com/a/google.com/file/d/",
        "https://en.wikipedia.org/wiki/",
        "https://www.example.com/"
      ],
      "universalActions": [{
        "label": "Open settings",
        "runFunction": "getSettingsCard"
      }, {
        "label": "Open Help URL",
        "openLink": "https://www.example.com/help"
      }],
      "useLocaleFromApp": true
    },
    "drive": {
      "homepageTrigger": {
        "runFunction": "onDriveHomePageOpen",
        "enabled": true
      },
      "onItemsSelectedTrigger": {
        "runFunction": "onDriveItemsSelected"
      }
    },
    "gmail": {
      "composeTrigger": {
        "selectActions": [
          {
            "text": "Add images to email",
            "runFunction": "getInsertImageComposeCards"
          }
        ],
        "draftAccess": "METADATA"
      },
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "onGmailMessageOpen"
        }
      ]
    },
    "docs": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      },
      "linkPreviewTriggers": [
        {
        "runFunction": "onLinkPreview",
        "patterns": [
            {
              "hostPattern": "example.com",
              "pathPrefix": "example-path"
            }
        ],
        "labelText": "Link preview",
        "localizedLabelText": {
          "es": "Link preview localized in Spanish"
        },
        "logoUrl": "https://www.example.com/images/smart-chip-icon.png"
        }
      ]
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      }
    },
    "slides": {
      "homepageTrigger": {
        "runFunction": "onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "onFileScopeGrantedEditors"
      }
    }
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/calendar.addons.execute",
    "https://www.googleapis.com/auth/calendar.addons.current.event.read",
    "https://www.googleapis.com/auth/calendar.addons.current.event.write",
    "https://www.googleapis.com/auth/drive.addons.metadata.readonly",
    "https://www.googleapis.com/auth/gmail.addons.current.action.compose",
    "https://www.googleapis.com/auth/gmail.addons.current.message.metadata",
    "https://www.googleapis.com/auth/userinfo.email",
    "https://www.googleapis.com/auth/script.external_request",
    "https://www.googleapis.com/auth/script.locale",
    "https://www.googleapis.com/auth/script.scriptapp",
    "https://www.googleapis.com/auth/drive.file",
    "https://www.googleapis.com/auth/documents.currentonly",
    "https://www.googleapis.com/auth/spreadsheets.currentonly",
    "https://www.googleapis.com/auth/presentations.currentonly",
    "https://www.googleapis.com/auth/workspace.linkpreview"
  ],
  "urlFetchWhitelist": [
    "https://www.example.com/myendpoint/"
  ]
}

अनुमति वाली सूची में शामिल यूआरएल

अनुमति वाले डोमेन की सूची का इस्तेमाल उन यूआरएल की पहचान करने के लिए किया जाता है जिन्हें स्क्रिप्ट या ऐड-ऑन से ऐक्सेस करने के लिए, पहले से मंज़ूरी दी गई हो. अनुमति वाली सूची की मदद से उपयोगकर्ता के डेटा को सुरक्षित रखा जाता है. अनुमति वाली सूची तय करने पर, स्क्रिप्ट प्रोजेक्ट उन यूआरएल को ऐक्सेस नहीं कर पाते जिन्हें अनुमति वाली सूची में नहीं जोड़ा गया है.

टेस्ट डिप्लॉयमेंट इंस्टॉल करते समय, यह फ़ील्ड ज़रूरी नहीं होता. हालांकि, वर्शन वाला डिप्लॉयमेंट बनाते समय यह ज़रूरी होता है.

अगर आपकी स्क्रिप्ट या ऐड-ऑन ये कार्रवाइयां करता है, तो अनुमति वाले डोमेन की सूची का इस्तेमाल किया जाता है:

• Apps Script UrlFetch सेवा का इस्तेमाल करके, किसी बाहरी जगह (जैसे कि एचटीटीपीएस एंडपॉइंट) से जानकारी फ़ेच या फ़ेच करता है. अनुमति वाली सूची में शामिल यूआरएल को फ़ेच करने के लिए, अपनी मेनिफ़ेस्ट फ़ाइल में urlFetchWhitelist फ़ील्ड शामिल करें.
• उपयोगकर्ता की कार्रवाई के जवाब में, यूआरएल खोलता या दिखाता है. यह Google Workspace के ऐड-ऑन के लिए ज़रूरी है, जो Google के बाहर के यूआरएल खोलते हैं या दिखाते हैं. अनुमति वाली सूची में शामिल यूआरएल को खोलने के लिए, अपनी मेनिफ़ेस्ट फ़ाइल में addOns.common.openLinkUrlPrefixes फ़ील्ड को शामिल करें.

ध्यान दें: व्हाइटलिस्ट, जैसा कि urlFetchWhitelist में इस्तेमाल किया गया है, अब काम नहीं करता है. यह अनुमति वाले डोमेन की सूची से बदल दिया गया है. ज़्यादा जानकारी के लिए, बिना किसी भेदभाव के सभी को शामिल करने वाला दस्तावेज़ लिखना देखें.

अनुमति वाली सूची में प्रीफ़िक्स जोड़ना

अपनी मेनिफ़ेस्ट फ़ाइल में, addOns.common.openLinkUrlPrefixes या urlFetchWhitelist फ़ील्ड को शामिल करके, अनुमति वाले डोमेन की सूची तय करते समय, आपको यूआरएल प्रीफ़िक्स की सूची शामिल करनी होगी. मेनिफ़ेस्ट में जोड़े गए प्रीफ़िक्स को इन शर्तों के मुताबिक होना चाहिए:

• हर प्रीफ़िक्स एक मान्य यूआरएल होना चाहिए.
• हर प्रीफ़िक्स में https:// का इस्तेमाल होना चाहिए, http:// का नहीं.
• हर प्रीफ़िक्स का एक पूरा डोमेन होना चाहिए.
• हर प्रीफ़िक्स में कोई खाली पाथ नहीं होना चाहिए. उदाहरण के लिए, https://www.google.com/ मान्य है, लेकिन https://www.google.com नहीं.
• यूआरएल सबडोमेन प्रीफ़िक्स से मैच करने के लिए, वाइल्डकार्ड का इस्तेमाल किया जा सकता है.
• सभी लिंक से मैच करने के लिए, addOns.common.openLinkUrlPrefixes फ़ील्ड में एक * वाइल्डकार्ड का इस्तेमाल किया जा सकता है. हालांकि, ऐसा करने का सुझाव नहीं दिया जाता, क्योंकि इससे उपयोगकर्ता का डेटा खतरे में पड़ सकता है और ऐड-ऑन की समीक्षा की प्रोसेस ज़्यादा समय तक चल सकती है. वाइल्डकार्ड का इस्तेमाल सिर्फ़ तब करें, जब ऐड-ऑन के फ़ंक्शन के लिए इसकी ज़रूरत हो.

कोई यूआरएल, अनुमति वाली सूची में शामिल प्रीफ़िक्स से मेल खाता है या नहीं, यह तय करने के लिए इन नियमों का पालन करना ज़रूरी है:

• पाथ मैचिंग, केस-सेंसिटिव (बड़े और छोटे अक्षरों में अंतर) होती है.
• अगर प्रीफ़िक्स, यूआरएल से मेल खाता है, तो यह एक मैच होता है.
• अगर यूआरएल वही है या प्रीफ़िक्स का चाइल्ड है, तो यह एक मैच होता है.

उदाहरण के लिए, प्रीफ़िक्स https://example.com/foo इन यूआरएल से मेल खाता है:

• https://example.com/foo
• https://example.com/foo/
• https://example.com/foo/bar
• https://example.com/foo?bar
• https://example.com/foo#bar

वाइल्डकार्ड का इस्तेमाल करना

urlFetchWhitelist और addOns.common.openLinkUrlPrefixes, दोनों फ़ील्ड के सबडोमेन से मैच करने के लिए, किसी एक वाइल्डकार्ड वर्ण (*) का इस्तेमाल किया जा सकता है. एक से ज़्यादा सबडोमेन से मैच करने के लिए, एक से ज़्यादा वाइल्डकार्ड का इस्तेमाल नहीं किया जा सकता. साथ ही, वाइल्डकार्ड में यूआरएल का शुरुआती प्रीफ़िक्स दिखना चाहिए.

उदाहरण के लिए, प्रीफ़िक्स https://*.example.com/foo इन यूआरएल से मेल खाता है:

• https://subdomain.example.com/foo
• https://any.number.of.subdomains.example.com/foo

प्रीफ़िक्स https://*.example.com/foo इन यूआरएल से मेल नहीं खाता:

• https://subdomain.example.com/bar (सफ़िक्स मेल नहीं खाता)
• https://example.com/foo (कम से कम एक सबडोमेन मौजूद होना चाहिए)

जब मेनिफ़ेस्ट को सेव करने की कोशिश की जाती है, तो प्रीफ़िक्स के कुछ नियम लागू होते हैं. उदाहरण के लिए, अगर सेव करने की कोशिश करते समय ये प्रीफ़िक्स आपके मेनिफ़ेस्ट में मौजूद हैं, तो गड़बड़ी की वजह बनती है:

• https://*.*.example.com/foo (एक से ज़्यादा वाइल्डकार्ड इस्तेमाल नहीं किए जा सकते हैं)
• https://subdomain.*.example.com/foo (वाइल्डकार्ड को शुरू होने वाले प्रीफ़िक्स के तौर पर इस्तेमाल किया जाना चाहिए)