REST Resource: projects.deployments

संसाधन: डिप्लॉयमेंट

Google Workspace ऐड-ऑन को डिप्लॉय करना

JSON के काेड में दिखाना
{
  "name": string,
  "oauthScopes": [
    string
  ],
  "addOns": {
    object (AddOns)
  },
  "etag": string
}
फ़ील्ड
name

string

डप्लॉयमेंट रिसॉर्स का नाम. उदाहरण: projects/123/deployments/my_deployment.

oauthScopes[]

string

Google OAuth के उन दायरों की सूची जिनके लिए, ऐड-ऑन एंडपॉइंट को लागू करने से पहले असली उपयोगकर्ता से सहमति का अनुरोध करना है.

addOns

object (AddOns)

Google Workspace ऐड-ऑन का कॉन्फ़िगरेशन.

etag

string

इस वैल्यू का हिसाब सर्वर, स्टोरेज में मौजूद डिप्लॉयमेंट के वर्शन के आधार पर लगाता है. इसे अपडेट और मिटाने के अनुरोधों पर भेजा जा सकता है, ताकि यह पक्का किया जा सके कि क्लाइंट के पास आगे बढ़ने से पहले अप-टू-डेट वैल्यू है.

AddOns

Google Workspace ऐड-ऑन का कॉन्फ़िगरेशन.

JSON के काेड में दिखाना
{
  "common": {
    object (CommonAddOnManifest)
  },
  "gmail": {
    object (GmailAddOnManifest)
  },
  "drive": {
    object (DriveAddOnManifest)
  },
  "calendar": {
    object (CalendarAddOnManifest)
  },
  "docs": {
    object (DocsAddOnManifest)
  },
  "meet": {
    object (MeetAddOnManifest)
  },
  "sheets": {
    object (SheetsAddOnManifest)
  },
  "slides": {
    object (SlidesAddOnManifest)
  },
  "httpOptions": {
    object (HttpOptions)
  }
}
फ़ील्ड
common

object (CommonAddOnManifest)

यह कॉन्फ़िगरेशन, सभी Google Workspace ऐड-ऑन के लिए सामान्य होता है.

gmail

object (GmailAddOnManifest)

Gmail ऐड-ऑन का कॉन्फ़िगरेशन.

drive

object (DriveAddOnManifest)

Drive के ऐड-ऑन का कॉन्फ़िगरेशन.

calendar

object (CalendarAddOnManifest)

Calendar ऐड-ऑन का कॉन्फ़िगरेशन.

docs

object (DocsAddOnManifest)

Docs ऐड-ऑन का कॉन्फ़िगरेशन.

meet

object (MeetAddOnManifest)

Meet ऐड-ऑन का कॉन्फ़िगरेशन.

sheets

object (SheetsAddOnManifest)

Sheets ऐड-ऑन का कॉन्फ़िगरेशन.

slides

object (SlidesAddOnManifest)

Slides ऐड-ऑन का कॉन्फ़िगरेशन.

httpOptions

object (HttpOptions)

ऐड-ऑन के एचटीटीपी एंडपॉइंट पर अनुरोध भेजने के विकल्प

CommonAddOnManifest

ऐड-ऑन का कॉन्फ़िगरेशन, जिसे ऐड-ऑन होस्ट करने वाले सभी ऐप्लिकेशन के साथ शेयर किया जाता है.

JSON के काेड में दिखाना
{
  "name": string,
  "logoUrl": string,
  "layoutProperties": {
    object (LayoutProperties)
  },
  "addOnWidgetSet": {
    object (AddOnWidgetSet)
  },
  "useLocaleFromApp": boolean,
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "universalActions": [
    {
      object (UniversalActionExtensionPoint)
    }
  ],
  "openLinkUrlPrefixes": array
}
फ़ील्ड
name

string

ज़रूरी है. ऐड-ऑन का डिसप्ले नेम.

logoUrl

string

ज़रूरी है. ऐड-ऑन टूलबार में दिखने वाले लोगो की इमेज का यूआरएल.

layoutProperties

object (LayoutProperties)

ऐड-ऑन कार्ड के लिए सामान्य लेआउट प्रॉपर्टी.

addOnWidgetSet

object (AddOnWidgetSet)

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

useLocaleFromApp

boolean

होस्ट ऐप्लिकेशन से स्थान-भाषा की जानकारी पास करनी है या नहीं.

homepageTrigger

object (HomepageExtensionPoint)

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

universalActions[]

object (UniversalActionExtensionPoint)

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

openLinkUrlPrefixes

array (ListValue format)

OpenLink ऐक्शन के लिए, सिर्फ़ ऐसे यूआरएल का इस्तेमाल किया जा सकता है जिनमें HTTPS, MAILTO या TEL स्कीम हो. HTTPS लिंक के लिए, यूआरएल को अनुमति वाली सूची में दिए गए किसी एक प्रीफ़िक्स से मेल खाना भी ज़रूरी है. अगर प्रीफ़िक्स में स्कीम शामिल नहीं है, तो HTTPS को माना जाता है. HTTP लिंक को HTTPS लिंक में अपने-आप बदल दिया जाता है.

LayoutProperties

कार्ड लेआउट की प्रॉपर्टी, ऐड-ऑन होस्ट करने वाले सभी ऐप्लिकेशन के साथ शेयर की जाती हैं.

JSON के काेड में दिखाना
{
  "primaryColor": string,
  "secondaryColor": string,
  "useNewMaterialDesign": boolean
}
फ़ील्ड
primaryColor

string

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

secondaryColor

string

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

useNewMaterialDesign
(deprecated)

boolean

यह कुकी, कार्ड के लिए मटीरियल डिज़ाइन चालू करती है.

AddOnWidgetSet

ऐड-ऑन के लिए इस्तेमाल किया गया विजेट सबसेट.

JSON के काेड में दिखाना
{
  "usedWidgets": [
    enum (WidgetType)
  ]
}
फ़ील्ड
usedWidgets[]

enum (WidgetType)

किसी ऐड-ऑन में इस्तेमाल किए गए विजेट की सूची.

WidgetType

विजेट का टाइप. WIDGET_TYPE_UNSPECIFIED बुनियादी विजेट सेट है.

Enums
WIDGET_TYPE_UNSPECIFIED डिफ़ॉल्ट विजेट सेट किया गया.
DATE_PICKER तारीख चुनने वाला टूल.
STYLED_BUTTONS स्टाइल किए गए बटन में, फ़िल्ड बटन और बंद किए गए बटन शामिल होते हैं.
PERSISTENT_FORMS परसिस्टेंट फ़ॉर्म की मदद से, कार्रवाइयों के दौरान फ़ॉर्म की वैल्यू को सेव किया जा सकता है.
UPDATE_SUBJECT_AND_RECIPIENTS किसी ड्राफ़्ट का विषय और पाने वाले लोगों की जानकारी अपडेट करें.
GRID_WIDGET ग्रिड विजेट.
ADDON_COMPOSE_UI_ACTION Gmail के ऐड-ऑन की ऐसी कार्रवाई जो ऐड-ऑन के कंपोज़ यूज़र इंटरफ़ेस (यूआई) पर लागू होती है.

HomepageExtensionPoint

ऐड-ऑन के होम पेज व्यू का एलान करने के लिए, यह सामान्य फ़ॉर्मैट है.

JSON के काेड में दिखाना
{
  "runFunction": string,
  "enabled": boolean
}
फ़ील्ड
runFunction

string

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

enabled

boolean

ज़रूरी नहीं. अगर इसे false पर सेट किया जाता है, तो इस संदर्भ में होम पेज व्यू बंद हो जाता है.

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

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

UniversalActionExtensionPoint

यूनिवर्सल ऐक्शन मेन्यू आइटम एक्सटेंशन पॉइंट को दिखाने का फ़ॉर्मैट.

JSON के काेड में दिखाना
{
  "label": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
फ़ील्ड
label

string

ज़रूरी है. उपयोगकर्ता को दिखने वाला ऐसा टेक्स्ट जिसमें इस एक्सटेंशन पॉइंट को चालू करने पर की गई कार्रवाई के बारे में बताया गया हो. उदाहरण के लिए, "नया संपर्क जोड़ें."

यूनियन फ़ील्ड action_type. ज़रूरी है. यूनिवर्सल ऐक्शन मेन्यू आइटम पर की जा सकने वाली कार्रवाई का टाइप. यह खोलने के लिए लिंक या एक्ज़ीक्यूट करने के लिए एंडपॉइंट हो सकता है. action_type इनमें से सिर्फ़ एक हो सकता है:
runFunction

string

यह एंडपॉइंट, UniversalAction के ज़रिए चलाया जाएगा.

GmailAddOnManifest

Gmail ऐड-ऑन के रंग-रूप और उसे लागू करने के तरीके को पसंद के मुताबिक बनाने वाली प्रॉपर्टी.

JSON के काेड में दिखाना
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "contextualTriggers": [
    {
      object (ContextualTrigger)
    }
  ],
  "universalActions": [
    {
      object (UniversalAction)
    }
  ],
  "composeTrigger": {
    object (ComposeTrigger)
  },
  "authorizationCheckFunction": string
}
फ़ील्ड
homepageTrigger

object (HomepageExtensionPoint)

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

यह पैरामीटर मौजूद होने पर, addons.common.homepageTrigger के कॉन्फ़िगरेशन को बदल देता है.

contextualTriggers[]

object (ContextualTrigger)

यह उन शर्तों के सेट के बारे में बताता है जो ऐड-ऑन को ट्रिगर करती हैं.

universalActions[]

object (UniversalAction)

यह ऐड-ऑन के लिए, यूनिवर्सल ऐक्शन का सेट तय करता है. उपयोगकर्ता, ऐड-ऑन टूलबार मेन्यू से यूनिवर्सल ऐक्शन ट्रिगर करता है.

composeTrigger

object (ComposeTrigger)

यह कंपोज़ टाइम ऐड-ऑन के लिए, कंपोज़ टाइम ट्रिगर तय करता है. यह ट्रिगर है. इसकी वजह से, उपयोगकर्ता के ईमेल लिखने के दौरान ऐड-ऑन कार्रवाई करता है. कंपोज़ करते समय इस्तेमाल किए जाने वाले सभी ऐड-ऑन के पास gmail.addons.current.action.compose स्कोप होना चाहिए. भले ही, इससे ड्राफ़्ट में बदलाव न हो.

authorizationCheckFunction

string

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

ContextualTrigger

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

JSON के काेड में दिखाना
{
  "onTriggerFunction": string,

  // Union field trigger can be only one of the following:
  "unconditional": {
    object (UnconditionalTrigger)
  }
  // End of list of possible types for union field trigger.
}
फ़ील्ड
onTriggerFunction

string

ज़रूरी है. ट्रिगर से मेल खाने वाले मैसेज मिलने पर, जिस एंडपॉइंट को कॉल करना है उसका नाम.

यूनियन फ़ील्ड trigger. ट्रिगर के टाइप से यह तय होता है कि Gmail, ऐड-ऑन को दिखाने के लिए किन शर्तों का इस्तेमाल करेगा. trigger इनमें से सिर्फ़ एक हो सकता है:
unconditional

object (UnconditionalTrigger)

बिना शर्त वाले ट्रिगर, कोई भी ईमेल मैसेज खोलने पर चालू हो जाते हैं.

UnconditionalTrigger

इस टाइप के लिए कोई फ़ील्ड नहीं है.

यह ट्रिगर तब चालू होता है, जब कोई ईमेल मैसेज खोला जाता है.

UniversalAction

ऐसी कार्रवाई जो ऐड-ऑन के टूलबार मेन्यू में हमेशा उपलब्ध रहती है. भले ही, मैसेज का कॉन्टेक्स्ट कुछ भी हो.

JSON के काेड में दिखाना
{
  "text": string,

  // Union field action_type can be only one of the following:
  "openLink": string,
  "runFunction": string
  // End of list of possible types for union field action_type.
}
फ़ील्ड
text

string

ज़रूरी है. उपयोगकर्ता को दिखने वाला टेक्स्ट, जिसमें कार्रवाई के बारे में बताया गया हो. उदाहरण के लिए, "नया संपर्क जोड़ें."

यूनियन फ़ील्ड action_type. कार्रवाई के टाइप से यह तय होता है कि उपयोगकर्ता के कार्रवाई शुरू करने पर, Gmail कैसा व्यवहार करेगा. action_type इनमें से सिर्फ़ एक हो सकता है:
runFunction

string

यह एक ऐसा एंडपॉइंट होता है जिसे तब कॉल किया जाता है, जब उपयोगकर्ता कार्रवाई को ट्रिगर करता है. ज़्यादा जानकारी के लिए, यूनिवर्सल ऐक्शन गाइड देखें.

ComposeTrigger

यह ट्रिगर तब चालू होता है, जब उपयोगकर्ता कोई ईमेल लिख रहा होता है.

JSON के काेड में दिखाना
{
  "actions": [
    {
      object (MenuItemExtensionPoint)
    }
  ],
  "draftAccess": enum (DraftAccess)
}
फ़ील्ड
actions[]

object (MenuItemExtensionPoint)

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

draftAccess

enum (DraftAccess)

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

DraftAccess

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

Enums
UNSPECIFIED अगर draftaccess के लिए कोई वैल्यू सेट नहीं की जाती है, तो यह डिफ़ॉल्ट वैल्यू होती है.
NONE जब कंपोज़ ऐड-ऑन ट्रिगर होता है, तब कंपोज़ ट्रिगर ड्राफ़्ट के किसी भी डेटा को ऐक्सेस नहीं कर सकता.
METADATA यह कुकी, कंपोज़ ट्रिगर को ड्राफ़्ट के मेटाडेटा को ऐक्सेस करने की अनुमति देती है. ऐसा तब होता है, जब कंपोज़ ऐड-ऑन ट्रिगर होता है. इसमें ऑडियंस की सूची शामिल होती है. जैसे, ड्राफ़्ट किए गए मैसेज की 'ये लोग' और 'इन लोगों को भी भेजें' सूची.

DriveAddOnManifest

ये प्रॉपर्टी, Drive ऐड-ऑन के दिखने के तरीके और उसके काम करने के तरीके को पसंद के मुताबिक बनाती हैं.

JSON के काेड में दिखाना
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onItemsSelectedTrigger": {
    object (DriveExtensionPoint)
  }
}
फ़ील्ड
homepageTrigger

object (HomepageExtensionPoint)

यह पैरामीटर मौजूद होने पर, addons.common.homepageTrigger के कॉन्फ़िगरेशन को बदल देता है.

onItemsSelectedTrigger

object (DriveExtensionPoint)

यह उस व्यवहार से मेल खाता है जो Drive के काम के व्यू में आइटम चुने जाने पर लागू होता है. जैसे, मेरी ड्राइव की दस्तावेज़ सूची.

DriveExtensionPoint

Drive ऐड-ऑन के ट्रिगर का एलान करने के लिए सामान्य फ़ॉर्मैट.

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

string

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

CalendarAddOnManifest

ये प्रॉपर्टी, Calendar ऐड-ऑन के दिखने के तरीके और उसके काम करने के तरीके को पसंद के मुताबिक बनाती हैं.

JSON के काेड में दिखाना
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "conferenceSolution": [
    {
      object (ConferenceSolution)
    }
  ],
  "createSettingsUrlFunction": string,
  "eventOpenTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventUpdateTrigger": {
    object (CalendarExtensionPoint)
  },
  "calendarNotificationTrigger": {
    object (CalendarExtensionPoint)
  },
  "eventAttachmentTrigger": {
    object (MenuItemExtensionPoint)
  },
  "currentEventAccess": enum (EventAccess)
}
फ़ील्ड
homepageTrigger

object (HomepageExtensionPoint)

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

यह पैरामीटर मौजूद होने पर, addons.common.homepageTrigger के कॉन्फ़िगरेशन को बदल देता है.

conferenceSolution[]

object (ConferenceSolution)

ज़रूरी नहीं. इस ऐड-ऑन से मिलने वाले कॉन्फ़्रेंस के समाधानों के बारे में बताता है. तीसरे पक्ष के कॉन्फ़्रेंसिंग ऐड-ऑन, सिर्फ़ Apps Script में बनाए जा सकते हैं.

createSettingsUrlFunction

string

यह एक ऐसा एंडपॉइंट है जो ऐड-ऑन के सेटिंग पेज का यूआरएल बनाता है.

eventOpenTrigger

object (CalendarExtensionPoint)

यह एक ऐसा एंडपॉइंट है जो किसी इवेंट को देखने या उसमें बदलाव करने के लिए खोले जाने पर ट्रिगर होता है.

eventUpdateTrigger

object (CalendarExtensionPoint)

यह एक ऐसा एंडपॉइंट है जो ओपन इवेंट के अपडेट होने पर ट्रिगर होता है.

calendarNotificationTrigger

object (CalendarExtensionPoint)

ज़रूरी नहीं. यह तब ट्रिगर होता है, जब उपयोगकर्ता के सब्सक्राइब किए गए कैलेंडर के लिए कोई इवेंट बनाया या अपडेट किया जाता है. यह सुविधा, सिर्फ़ Alt-Runtime add-ons की ओर से CalendarSubscriptionActionMarkup का इस्तेमाल करके बनाए गए ट्रिगर पर लागू होती है. यह Apps Script add-ons और Apps Script installable triggers पर लागू नहीं होता.

eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

currentEventAccess

enum (EventAccess)

यह कुकी, इवेंट ऐड-ऑन ट्रिगर होने पर डेटा ऐक्सेस करने का लेवल तय करती है.

ConferenceSolution

यह कुकी, कॉन्फ़्रेंस से जुड़ी वैल्यू तय करती है. तीसरे पक्ष के कॉन्फ़्रेंसिंग ऐड-ऑन, सिर्फ़ Apps Script में बनाए जा सकते हैं.

JSON के काेड में दिखाना
{
  "onCreateFunction": string,
  "id": string,
  "name": string,
  "logoUrl": string
}
फ़ील्ड
onCreateFunction

string

ज़रूरी है. कॉन्फ़्रेंस का डेटा बनाए जाने पर कॉल करने के लिए एंडपॉइंट.

id

string

ज़रूरी है. एक ऐड-ऑन में, कॉन्फ़्रेंसिंग के सभी समाधानों के लिए आईडी यूनीक होने चाहिए. ऐसा न होने पर, ऐड-ऑन ट्रिगर होने पर कॉन्फ़्रेंसिंग के गलत समाधान का इस्तेमाल किया जा सकता है. ऐड-ऑन का डिसप्ले नेम बदला जा सकता है, लेकिन आईडी नहीं बदला जाना चाहिए.

name

string

ज़रूरी है. कॉन्फ़्रेंस की सुविधा देने वाले समाधान का डिसप्ले नेम.

logoUrl

string

ज़रूरी है. कॉन्फ़्रेंस के समाधान के लोगो की इमेज का यूआरएल.

CalendarExtensionPoint

कैलेंडर ऐड-ऑन के ट्रिगर का एलान करने के लिए सामान्य फ़ॉर्मैट.

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

string

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

EventAccess

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

Enums
UNSPECIFIED जब eventAccess के लिए कोई वैल्यू सेट नहीं की जाती है, तब यह डिफ़ॉल्ट वैल्यू होती है.
METADATA इस स्कोप से, इवेंट ट्रिगर को इवेंट के मेटाडेटा को ऐक्सेस करने की अनुमति मिलती है. जैसे, इवेंट आईडी और कैलेंडर आईडी.
READ इससे इवेंट ट्रिगर को, इवेंट के सभी फ़ील्ड का ऐक्सेस मिलता है. इनमें मेटाडेटा, शामिल होने वाले लोग, और कॉन्फ़्रेंस का डेटा शामिल है.
WRITE इससे इवेंट ट्रिगर को इवेंट के मेटाडेटा का ऐक्सेस मिलता है. साथ ही, सभी कार्रवाइयां करने की सुविधा मिलती है. जैसे, शामिल होने वाले लोगों को जोड़ना और कॉन्फ़्रेंस का डेटा सेट करना.
READ_WRITE इससे इवेंट ट्रिगर को, इवेंट के सभी फ़ील्ड का ऐक्सेस मिलता है. इनमें मेटाडेटा, शामिल होने वाले लोग, और कॉन्फ़्रेंस का डेटा शामिल है. साथ ही, इससे सभी कार्रवाइयां करने की सुविधा मिलती है.

DocsAddOnManifest

ये प्रॉपर्टी, Google Docs ऐड-ऑन के दिखने के तरीके और उसके काम करने के तरीके को पसंद के मुताबिक बनाती हैं.

JSON के काेड में दिखाना
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (DocsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ],
  "createActionTriggers": [
    {
      object (CreateActionExtensionPoint)
    }
  ]
}
फ़ील्ड
homepageTrigger

object (HomepageExtensionPoint)

यह पैरामीटर मौजूद होने पर, addons.common.homepageTrigger के कॉन्फ़िगरेशन को बदल देता है.

onFileScopeGrantedTrigger

object (DocsExtensionPoint)

इस दस्तावेज़/उपयोगकर्ता के जोड़े के लिए, फ़ाइल के स्कोप के लिए अनुमति मिलने पर इस एंडपॉइंट को लागू किया जाएगा.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Google दस्तावेज़ में लिंक की झलक देखने के लिए, एक्सटेंशन पॉइंट की सूची. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.

createActionTriggers[]

object (CreateActionExtensionPoint)

Google Workspace ऐप्लिकेशन में तीसरे पक्ष के संसाधन बनाने के लिए, एक्सटेंशन पॉइंट की सूची. ज़्यादा जानकारी के लिए, @ मेन्यू से तीसरे पक्ष के संसाधन बनाना लेख पढ़ें.

DocsExtensionPoint

Docs ऐड-ऑन के ट्रिगर का एलान करने के लिए सामान्य फ़ॉर्मैट.

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

string

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

LinkPreviewExtensionPoint

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

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

string

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

localizedLabelText

map (key: string, value: string)

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

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

एक ऑब्जेक्ट, जिसमें "key": value जोड़े की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

patterns[]

object (UriPattern)

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

runFunction

string

ज़रूरी है. लिंक की झलक दिखने पर, इस एंडपॉइंट को एक्ज़ीक्यूट किया जाता है.

logoUrl

string

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

UriPattern

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

JSON के काेड में दिखाना
{
  "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 को खाली छोड़ दें.

CreateActionExtensionPoint

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

JSON के काेड में दिखाना
{
  "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 का स्थानीय भाषा में अनुवाद किया गया वर्शन दिखेगा.

एक ऑब्जेक्ट, जिसमें "key": value जोड़े की सूची शामिल हो. उदाहरण: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

runFunction

string

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

logoUrl

string

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

MeetAddOnManifest

Meet ऐड-ऑन मेनिफ़ेस्ट.

JSON के काेड में दिखाना
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "web": {
    object (Web)
  },
  "supportsCollaboration": boolean,
  "termsUri": string
}
फ़ील्ड
homepageTrigger

object (HomepageExtensionPoint)

यह पैरामीटर मौजूद होने पर, addons.common.homepageTrigger के कॉन्फ़िगरेशन को बदल देता है.

web

object (Web)

Meet के वेब क्लाइंट को बेहतर बनाने वाले ऐडऑन के बारे में जानकारी.

supportsCollaboration

boolean

क्या ऐड-ऑन, साथ मिलकर काम करने या दूसरों को ऐड-ऑन का इस्तेमाल करने के लिए न्योता देने की सुविधा देता है.

termsUri

string

अगर कोई ऐड-ऑन है, तो उसके लिए सेवा की शर्तों का लिंक दिखाया जाना चाहिए.

वेब

Meet के वेब क्लाइंट को बेहतर बनाने वाले ऐडऑन के बारे में जानकारी.

JSON के काेड में दिखाना
{
  "sidePanelUri": string,
  "sidePanelUrl": string,
  "mainStageUri": string,
  "supportsScreenSharing": boolean,
  "supportsCollaboration": boolean,
  "supportsPopOut": boolean,
  "hostOrigins": [
    string
  ],
  "addOnOrigins": [
    string
  ],
  "openState": enum (State),
  "supportsCollaborationHostControls": boolean,
  "logoUrl": string,
  "darkModeLogoUrl": string,
  "displayFlow": enum (DisplayFlow)
}
फ़ील्ड
sidePanelUri
(deprecated)

string

साइड पैनल iframe के लिए यूआरआई.

sidePanelUrl

string

साइड पैनल iframe का यूआरएल.

mainStageUri
(deprecated)

string

"मुख्य स्टेज" iframe के लिए यूआरआई.

supportsScreenSharing

boolean

क्या ऐडऑन, मुख्य स्टेज पर स्क्रीन शेयर करने की सुविधा देता है.

supportsCollaboration
(deprecated)

boolean

क्या ऐड-ऑन, साथ मिलकर काम करने या दूसरों को ऐड-ऑन का इस्तेमाल करने के लिए न्योता देने की सुविधा देता है. अब इस फ़ील्ड का इस्तेमाल नहीं किया जा सकता. कृपया MeetAddOnManifest में टॉप लेवल फ़ील्ड का इस्तेमाल करें.

supportsPopOut

boolean

इससे पता चलता है कि ऐडऑन, ब्राउज़र के Picture-in-Picture मोड में काम करता है या नहीं.

hostOrigins[]
(deprecated)

string

अब इस्तेमाल में नहीं है, लेगसी नाम. ऐसे ऑरिजिन जिन्हें तीसरे पक्ष की साइट वाले iframe की frame-src प्रॉपर्टी में जोड़ा जाना चाहिए. इसके बजाय, addonorigins का इस्तेमाल करें.

addOnOrigins[]

string

ऐसे ऑरिजिन जिन्हें तीसरे पक्ष की साइट वाले iframe की frame-src प्रॉपर्टी में जोड़ा जाना चाहिए.

openState

enum (State)

ऐड-ऑन को खोलने पर दिखने वाली शुरुआती स्थिति.

supportsCollaborationHostControls

boolean

क्या साथ मिलकर काम करने की सुविधा देने वाला ऐड-ऑन, होस्ट कंट्रोल के साथ काम करता है.

logoUrl

string

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

darkModeLogoUrl

string

logourl का गहरे रंग वाला मोड.

displayFlow
(deprecated)

enum (DisplayFlow)

ऐड-ऑन लॉन्च होने पर, डिसप्ले फ़्लो कैसा होगा.

राज्य

ऐड-ऑन के खुलने की शुरुआती स्थिति तय करने के लिए enum.

Enums
STATE_UNSPECIFIED ऐडऑन के साथ शुरुआती स्थिति की जानकारी नहीं दी गई है.
SIDE_PANEL_ONLY ऐड-ऑन सिर्फ़ साइड पैनल के साथ खुलता है.
MAIN_STAGE_ONLY ऐड-ऑन सिर्फ़ मुख्य स्टेज के साथ खुलता है.
SIDE_PANEL_AND_MAIN_STAGE ऐड-ऑन, साइड पैनल और मुख्य स्टेज, दोनों के साथ खुलता है.

DisplayFlow

इस enum का इस्तेमाल, ऐड-ऑन के लॉन्च होने पर, उसे दिखाने का तरीका तय करने के लिए किया जाता है

Enums
DISPLAY_FLOW_UNSPECIFIED डिसप्ले फ़्लो के बारे में जानकारी नहीं दी गई है.
FOCUS ऐड-ऑन को "फ़ोकस" डिसप्ले फ़्लो में लॉन्च किया जाना चाहिए.
AUGMENT ऐड-ऑन को "बढ़ाएं" डिसप्ले फ़्लो में लॉन्च किया जाना चाहिए.

SheetsAddOnManifest

ये प्रॉपर्टी, Google Sheets ऐड-ऑन के दिखने के तरीके और उसके काम करने के तरीके को पसंद के मुताबिक बनाती हैं.

JSON के काेड में दिखाना
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SheetsExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
फ़ील्ड
homepageTrigger

object (HomepageExtensionPoint)

यह पैरामीटर मौजूद होने पर, addons.common.homepageTrigger के कॉन्फ़िगरेशन को बदल देता है.

onFileScopeGrantedTrigger

object (SheetsExtensionPoint)

इस दस्तावेज़/उपयोगकर्ता के जोड़े के लिए, फ़ाइल के स्कोप के लिए अनुमति मिलने पर इस एंडपॉइंट को लागू किया जाएगा.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Google Sheets दस्तावेज़ में लिंक की झलक देखने के लिए, एक्सटेंशन पॉइंट की सूची. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.

SheetsExtensionPoint

Sheets ऐड-ऑन के ट्रिगर का एलान करने का सामान्य फ़ॉर्मैट.

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

string

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

SlidesAddOnManifest

ये प्रॉपर्टी, Google Slides ऐड-ऑन के दिखने के तरीके और उसे लागू करने के तरीके को पसंद के मुताबिक बनाती हैं.

JSON के काेड में दिखाना
{
  "homepageTrigger": {
    object (HomepageExtensionPoint)
  },
  "onFileScopeGrantedTrigger": {
    object (SlidesExtensionPoint)
  },
  "linkPreviewTriggers": [
    {
      object (LinkPreviewExtensionPoint)
    }
  ]
}
फ़ील्ड
homepageTrigger

object (HomepageExtensionPoint)

यह पैरामीटर मौजूद होने पर, addons.common.homepageTrigger के कॉन्फ़िगरेशन को बदल देता है.

onFileScopeGrantedTrigger

object (SlidesExtensionPoint)

इस दस्तावेज़/उपयोगकर्ता के जोड़े के लिए, फ़ाइल के स्कोप के लिए अनुमति मिलने पर इस एंडपॉइंट को लागू किया जाएगा.

linkPreviewTriggers[]

object (LinkPreviewExtensionPoint)

Google Slides दस्तावेज़ में लिंक की झलक देखने के लिए, एक्सटेंशन पॉइंट की सूची. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.

SlidesExtensionPoint

Slides ऐड-ऑन के ट्रिगर का एलान करने का सामान्य फ़ॉर्मैट.

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

string

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

HttpOptions

ऐड-ऑन HTTP एंडपॉइंट पर अनुरोध भेजने के विकल्प.

JSON के काेड में दिखाना
{
  "authorizationHeader": enum (HttpAuthorizationHeader),
  "granularOauthPermissionSupport": enum (GranularOauthPermissionSupport)
}
फ़ील्ड
authorizationHeader

enum (HttpAuthorizationHeader)

HTTP Authorization हेडर में भेजे गए टोकन के लिए कॉन्फ़िगरेशन.

granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

इससे पता चलता है कि ऐड-ऑन ने अलग से अनुमति लेने की सुविधा चालू की है या नहीं.

HttpAuthorizationHeader

ऐड-ऑन HTTP के अनुरोधों में अनुमति देने वाला हेडर भेजा गया.

Enums
HTTP_AUTHORIZATION_HEADER_UNSPECIFIED डिफ़ॉल्ट वैल्यू, SYSTEM_ID_TOKEN के बराबर होती है.
SYSTEM_ID_TOKEN प्रोजेक्ट के लिए खास तौर पर बनाए गए Google Workspace ऐड-ऑन के सिस्टम सेवा खाते (डिफ़ॉल्ट) के लिए आईडी टोकन भेजें.
USER_ID_TOKEN असली उपयोगकर्ता के लिए आईडी टोकन भेजें.
NONE पुष्टि करने वाला हेडर न भेजें.

GranularOauthPermissionSupport

इससे पता चलता है कि ऐड-ऑन ने अलग से अनुमति लेने की सुविधा चालू की है या नहीं.

Enums
GRANULAR_OAUTH_PERMISSION_SUPPORT_UNSPECIFIED डिफ़ॉल्ट वैल्यू का इस्तेमाल नहीं किया जाना चाहिए.
OPT_IN ऐड-ऑन ने OAuth के लिए सहमति देने की सुविधा के लिए ऑप्ट-इन किया हो.
OPT_OUT ऐड-ऑन को, OAuth के लिए बारीकी से तय की गई सहमति की सुविधा से ऑप्ट आउट किया गया है.

तरीके

create

यह दिए गए नाम और कॉन्फ़िगरेशन के साथ एक डिप्लॉयमेंट बनाता है.

delete

इस नाम के डिप्लॉयमेंट को मिटाता है.

get

यह फ़ंक्शन, बताए गए नाम के साथ डिप्लॉयमेंट को वापस लाता है.

getInstallStatus

इस तरीके से, टेस्ट डिप्लॉयमेंट के इंस्टॉल होने की स्थिति मिलती है.

install

यह कुकी, आपके खाते में टेस्टिंग के लिए डिप्लॉयमेंट इंस्टॉल करती है.

list

किसी प्रोजेक्ट के सभी डिप्लॉयमेंट की सूची बनाता है.

replaceDeployment

यह कमांड, दिए गए नाम का डिप्लॉयमेंट बनाती है या उसे बदलती है.

uninstall

यह फ़ंक्शन, उपयोगकर्ता के खाते से टेस्ट डिप्लॉयमेंट को अनइंस्टॉल करता है.