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

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

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

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

Google Workspace के ऐड-ऑन, मेनिफ़ेस्ट फ़ाइल का इस्तेमाल करके, ऐड-ऑन के दिखने के तरीके और उसके व्यवहार के कई पहलुओं के बारे में बताते हैं.

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

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

Google Chat के लिए मेनिफ़ेस्ट

डेवलपर के लिए झलक: यह सुविधा, Google Workspace के डेवलपर के लिए झलक वाले प्रोग्राम के तहत उपलब्ध है. इस प्रोग्राम में, कुछ सुविधाओं को रिलीज़ होने से पहले इस्तेमाल करने का ऐक्सेस मिलता है.

अगर आपका Google Workspace ऐड-ऑन, Google Chat की सुविधाएं देता है, तो आपको Google Cloud Console में Google Chat API को चालू और कॉन्फ़िगर करके, Google Chat ऐप्लिकेशन को कॉन्फ़िगर करना होगा.

Chat में, मेनिफ़ेस्ट कॉन्फ़िगरेशन की सामान्य सेटिंग (इनमें addons.common भी शामिल है) को अनदेखा किया जाता है. ऐड-ऑन के मेनिफ़ेस्ट का इस्तेमाल करने के बजाय, Chat की इन सेटिंग को कॉन्फ़िगर करने के लिए Chat API का इस्तेमाल किया जाता है:

• Chat ऐप्लिकेशन का नाम, लोगो, और ब्यौरा, जो सिर्फ़ Chat के यूज़र इंटरफ़ेस (यूआई) में दिखता है.
• Chat ऐप्लिकेशन ट्रिगर.

अगर आपने ऐड-ऑन को Apps Script में बनाया है, तो आपको अपने मेनिफ़ेस्ट में ये ऑब्जेक्ट भी जोड़ने या अपडेट करने होंगे:

• addons.chat (ज़रूरी है)
• oauthScopes (अगर आपका Google Chat ऐप्लिकेशन, OAuth के दायरों का इस्तेमाल करता है, तो ज़रूरी है)

किसी ऐड-ऑन के लिए Chat की सेटिंग कॉन्फ़िगर करने का तरीका जानने के लिए, Google Chat ऐप्लिकेशन को कॉन्फ़िगर करना लेख पढ़ें.

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

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

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

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

ध्यान दें: मेनिफ़ेस्ट में अन्य कॉम्पोनेंट शामिल होते हैं. addOns फ़ील्ड में मौजूद फ़ील्ड, सीधे 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 फ़ील्ड शामिल करें.

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