एडिटर मेनिफ़ेस्ट रिसॉर्स

रिसॉर्स कॉन्फ़िगरेशन जिसका इस्तेमाल, एडिटर में Google Workspace ऐड-ऑन का कॉन्टेंट और उसके काम करने के तरीके के बारे में बताने के लिए किया जाता है. Google Workspace ऐड-ऑन मेनिफ़ेस्ट में, वे सभी कॉम्पोनेंट शामिल होने चाहिए जिन्हें ज़रूरी है के तौर पर मार्क किया गया हो. अगर वे Editor को एक्सटेंड करते हैं, तो वे भी ज़रूरी हैं.

संपादक

एडिटर एक्सटेंशन के लिए, Google Workspace ऐड-ऑन मेनिफ़ेस्ट कॉन्फ़िगरेशन. ज़्यादा जानकारी के लिए, Google Workspace ऐड-ऑन की मदद से एडिटर की सेवाओं का दायरा बढ़ाना देखें.

जेएसओएन के काेड में दिखाना
  {
    "homepageTrigger": {
      object (HomepageTrigger)
    },
    "onFileScopeGrantedTrigger": {
      object (OnFileScopeGrantedTrigger)
    },
    "linkPreviewTriggers": [
      {
        object (LinkPreviewTriggers)
      }
    ],
    "createActionTriggers": [
      {
        object (CreateActionTriggers)
      }
  }
फ़ील्ड
homepageTrigger

object (HomepageTrigger)

यह ट्रिगर फ़ंक्शन, होस्ट ऐप्लिकेशन में ऐड-ऑन होम पेज बनाता है. यह addOns.common.homepageTrigger को बदल देता है.

onFileScopeGrantedTrigger

object (OnFileScopeGrantedTrigger)

अगर आपके ऐड-ऑन में, Editor के मौजूदा दस्तावेज़ के हिसाब से काम करने का तरीका शामिल है, तो यह ज़रूरी है. यह तब ट्रिगर होता है, जब उपयोगकर्ता drive.file स्कोप को अनुमति देता है.

linkPreviewTriggers[]

object (LinkPreviewTriggers)

लिंक की झलक के लिए ज़रूरी है. Google Docs, Sheets या Slides की फ़ाइल में लिंक की झलक देखने के लिए ट्रिगर की सूची. ज़्यादा जानकारी के लिए, स्मार्ट चिप में शामिल लिंक की झलक देखना लेख पढ़ें.

createActionTriggers[]

object (createActionTriggers)

तीसरे पक्ष का संसाधन बनाने के लिए ज़रूरी है. @ मेन्यू से तीसरे पक्ष की सेवा में संसाधन बनाने के लिए ट्रिगर की सूची. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से तीसरे पक्ष के संसाधन बनाना लेख पढ़ें.

OnFileScopeGrantedTrigger

कॉन्टेक्स्ट के हिसाब से बनाए गए ट्रिगर का कॉन्फ़िगरेशन, जो CardService.newEditorFileScopeActionResponseBuilder() .requestFileScopeForActiveDocument().build(); का इस्तेमाल करके अनुरोध फ़ाइल के स्कोप डायलॉग और उपयोगकर्ता के drive.file के स्कोप की अनुमति देने पर ट्रिगर होता है.

जेएसओएन के काेड में दिखाना
{
  "runFunction": string
}
फ़ील्ड
runFunction

string

drive.file स्कोप दिए जाने पर, चलाए जाने वाले फ़ंक्शन का नाम. अगर बताया गया है, तो आपको ऐड-ऑन यूज़र इंटरफ़ेस (यूआई) में दिखाने के लिए, Card ऑब्जेक्ट का कलेक्शन बनाने और उसे दिखाने के लिए इस फ़ंक्शन को लागू करना होगा.

LinkPreviewTriggers

किसी ट्रिगर का कॉन्फ़िगरेशन तब फ़ायर होता है, जब कोई उपयोगकर्ता किसी तीसरे पक्ष या Google से बाहर की सेवा पर मौजूद लिंक को Docs, Sheets या Slides की फ़ाइल में टाइप करता है या चिपकाता है.

अगर Google Workspace ऐड-ऑन के लिए इस ट्रिगर को सेट अप करना है, तो स्मार्ट चिप की मदद से लिंक की झलक देखना लेख देखें.

जेएसओएन के काेड में दिखाना
{
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
  "patterns": [
    {
      object(patterns)
    }
  ]
}
फ़ील्ड
labelText

string

ज़रूरी है. उदाहरण के तौर पर दिए गए स्मार्ट चिप का टेक्स्ट, जो लोगों को लिंक की झलक देखने के लिए कहता है, जैसे कि Example: Support case. यह टेक्स्ट स्टैटिक होता है और उपयोगकर्ताओं के ऐड-ऑन लागू करने से पहले दिखता है.
localizedLabelText

map (key: string, value: string)

ज़रूरी नहीं. labelText का मैप, जिसे दूसरी भाषाओं में अनुवाद करना है. भाषा को ISO 639 और देश/इलाके के हिसाब से ISO 3166 में फ़ॉर्मैट करें. इन्हें अलग करने के लिए, हाइफ़न - का इस्तेमाल करें. उदाहरण के लिए, en-US.

अगर मैप की कुंजियों में किसी उपयोगकर्ता की स्थान-भाषा मौजूद है, तो उसे labelText का स्थानीय भाषा में वर्शन दिखता है.

patterns[]

object (UriPattern)

ज़रूरी है. यूआरएल पैटर्न का कलेक्शन, जो लिंक की झलक देखने के लिए ऐड-ऑन को ट्रिगर करता है.
runFunction

string

ज़रूरी है. जब उपयोगकर्ता https://www.googleapis.com/auth/workspace.linkpreview स्कोप को अनुमति देता है, तब चलाए जाने वाले फ़ंक्शन का नाम. अगर बताया गया है, तो आपको यह फ़ंक्शन लागू करना होगा, ताकि ऐसे इवेंट ऑब्जेक्ट को स्वीकार किया जा सके जिसमें EDITOR_NAME.matchedUrl.url, तर्क के तौर पर शामिल हो. साथ ही, यह एक ऐसा Card ऑब्जेक्ट दिखाता हो जो ऐड-ऑन यूज़र इंटरफ़ेस (यूआई) में लिंक की झलक दिखाता हो.
logoUrl

string

ज़रूरी नहीं. स्मार्ट चिप और झलक दिखाने वाले कार्ड में दिखने वाला आइकॉन. अगर ऐड-ऑन हटाया जाता है, तो यह अपने टूलबार आइकॉन logoUrl का इस्तेमाल करता है.

UriPattern

हर उस यूआरएल पैटर्न का कॉन्फ़िगरेशन जो लिंक की झलक को ट्रिगर करता है.

जेएसओएन के काेड में दिखाना
{
  "hostPattern": string,
  "pathPrefix" : string
}
फ़ील्ड
hostPattern

string

हर यूआरएल पैटर्न की झलक के लिए ज़रूरी है.यूआरएल पैटर्न का डोमेन. ऐड-ऑन उन लिंक की झलक दिखाता है जिनके यूआरएल में यह डोमेन शामिल होता है. subdomain.example.com जैसे किसी खास सबडोमेन के लिंक की झलक देखने के लिए, सबडोमेन शामिल करें. पूरे डोमेन के लिंक की झलक देखने के लिए, सबडोमेन के तौर पर तारे के निशान (*) के साथ वाइल्डकार्ड वर्ण डालें.

उदाहरण के लिए, *.example.com, subdomain.example.com और another.subdomain.example.com से मैच करता है.

pathPrefix

string

ज़रूरी नहीं. वह पाथ जो hostPattern के डोमेन को जोड़ता है.

उदाहरण के लिए, अगर यूआरएल होस्ट पैटर्न support.example.com है, तो support.example.com/cases/ पर होस्ट किए गए केस के यूआरएल से मिलान करने के लिए, cases का इस्तेमाल करें.

होस्ट पैटर्न के डोमेन में मौजूद सभी यूआरएल से मिलान करने के लिए, pathPrefix को खाली छोड़ें.

CreateActionTriggers

उस ट्रिगर का कॉन्फ़िगरेशन जो तब फ़ायर होता है, जब कोई उपयोगकर्ता Google Docs @ मेन्यू से तीसरे पक्ष का इंटिग्रेशन मेन्यू आइटम चुनता है.

अगर आपको Google Workspace ऐड-ऑन के लिए इस ट्रिगर को सेट अप करना है, तो स्मार्ट चिप की मदद से तीसरे पक्ष के संसाधन बनाना लेख पढ़ें.

जेएसओएन के काेड में दिखाना
{
  "id": string,
  "labelText": string,
  "localizedLabelText": {
    string: string,
    ...
  },
  "runFunction": string,
  "logoUrl": string,
}
फ़ील्ड
id

string

ज़रूरी है. इस एक्सटेंशन पॉइंट के बीच अंतर करने के लिए, यूनीक आईडी. आईडी में ज़्यादा से ज़्यादा 64 वर्ण हो सकते हैं और यह [a-zA-Z0-9-]+. के फ़ॉर्मैट में होना चाहिए.
labelText

string

ज़रूरी है. @ मेन्यू में दिखने वाला टेक्स्ट, जैसे कि Create support case.
localizedLabelText

map (key: string, value: string)

ज़रूरी नहीं. labelText का मैप, जिसे दूसरी भाषाओं में अनुवाद करना है. भाषा को ISO 639 और देश/इलाके के हिसाब से ISO 3166 में फ़ॉर्मैट करें. इन्हें अलग करने के लिए, हाइफ़न - का इस्तेमाल करें. उदाहरण के लिए, en-US.

अगर मैप की कुंजियों में किसी उपयोगकर्ता की स्थान-भाषा मौजूद है, तो उसे labelText का स्थानीय भाषा में वर्शन दिखता है.

runFunction

string

ज़रूरी है. जब कोई उपयोगकर्ता @ मेन्यू से एक्सटेंशन पॉइंट चुनता है, तब चलाए जाने वाले फ़ंक्शन का नाम. इस फ़ंक्शन को तीसरे पक्ष का संसाधन बनाने के लिए इनपुट के साथ फ़ॉर्म कार्ड देना चाहिए.
logoUrl

string

ज़रूरी नहीं. @ मेन्यू में दिखने वाला आइकॉन. अगर ऐड-ऑन हटाया जाता है, तो यह अपने टूलबार आइकॉन logoUrl का इस्तेमाल करता है.