इस पेज का अनुवाद Cloud Translation API से किया गया है.

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

ऐप्लिकेशन और उसके काम करने के तरीके के बारे में कुछ जानकारी कॉन्फ़िगर करने के लिए ऐड-ऑन, मेनिफ़ेस्ट फ़ाइल का इस्तेमाल करता है.

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

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

Google Workspace ऐड-ऑन, मेनिफ़ेस्ट फ़ाइल का इस्तेमाल करके यह तय करता है कि ऐड-ऑन किस तरह दिखेगा और किस तरह काम करेगा.

Google Workspace ऐड-ऑन के लिए, मेनिफ़ेस्ट प्रॉपर्टी को मेनिफ़ेस्ट ऑब्जेक्ट स्ट्रक्चर के addOns सेक्शन में व्यवस्थित किया जाता है.

Apps Script मेनिफ़ेस्ट फ़ाइलों के बारे में जानकारी के लिए, मेनिफ़ेस्ट स्ट्रक्चर देखें.
एचटीटीपी एंडपॉइंट के साथ बनाए गए ऐड-ऑन के लिए, मेनिफ़ेस्ट फ़ाइलों के बारे में जानकारी पाने के लिए, REST रिसॉर्स: projects.deployments देखें

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

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

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

सैंपल में दिए गए लिंक, Apps Script और एचटीटीपी Google Workspace ऐड-ऑन से जुड़े मेनिफ़ेस्ट रेफ़रंस दस्तावेज़ में उस फ़ील्ड की जानकारी पर ले जाते हैं.

Apps Script

{
  "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://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"
        }
      ],
      "createActionTriggers": [
        {
          "id": "exampleId",
          "labelText": "Example label text",
          "localizedLabelText": {
            "es": "Label text localized in Spanish"
          },
          "runFunction": "exampleFunction",
          "logoUrl": "https://www.example.com/images/case.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/"
  ]
}

HTTP

{
  "addOns": {
    "calendar": {
      "currentEventAccess": "READ_WRITE",
      "eventOpenTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventOpen"
      },
      "eventUpdateTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventUpdate"
      },
      "eventAttachmentTrigger": {
        "label": "My Event Attachment",
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarEventAddAttachment"
      },
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCalendarHomePageOpen",
        "enabled": true
      }
    },
    "common": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=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://www.example.com/"
      ],
      "universalActions": [{
        "label": "Open settings",
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=getSettingsCard"
      }, {
        "label": "Open Help URL",
        "openLink": "https://www.example.com/help"
      }],
      "useLocaleFromApp": true
    },
    "drive": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveHomePageOpen",
        "enabled": true
      },
      "onItemsSelectedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onDriveItemsSelected"
      }
    },
    "gmail": {
      "composeTrigger": {
        "actions": [
          {
            "label": "Add images to email",
            "runFunction": "https://myownpersonaldomain.com/mypage?trigger=getInsertImageComposeCards"
          }
        ],
        "draftAccess": "METADATA"
      },
      "contextualTriggers": [
        {
          "unconditional": {},
          "onTriggerFunction": "https://myownpersonaldomain.com/mypage?trigger=onGmailMessageOpen"
        }
      ]
    },
    "docs": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      },
      "linkPreviewTriggers": [
        {
          "runFunction": "https://myownpersonaldomain.com/mypage?trigger=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"
        }
      ],
      "createActionTriggers": [
        {
          "id": "exampleId",
          "labelText": "Example label text",
          "localizedLabelText": {
            "es": "Label text localized in Spanish"
          },
          "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onCreateAction",
          "logoUrl": "https://www.example.com/images/case.png"
        }
      ]
    },
    "sheets": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onFileScopeGrantedEditors"
      }
    },
    "slides": {
      "homepageTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=onEditorsHomepage"
      },
      "onFileScopeGrantedTrigger": {
        "runFunction": "https://myownpersonaldomain.com/mypage?trigger=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"
  ]
}

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

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

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

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

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

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

अपनी मेनिफ़ेस्ट फ़ाइल में, अनुमति वाली सूची की जानकारी देते समय 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 (वाइल्डकार्ड का इस्तेमाल सबसे पहले प्रीफ़िक्स के तौर पर किया जाना चाहिए)