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,

  "openLink": string,
  "runFunction": string
}
फ़ील्ड
label

string

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

ज़रूरी है. यूनिवर्सल ऐक्शन मेन्यू आइटम पर, इस तरह की कार्रवाई की जा सकती है. यह खोलने के लिए कोई लिंक या लागू करने के लिए कोई एंडपॉइंट हो सकता है. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
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,

  "unconditional": {
    object (UnconditionalTrigger)
  }
}
फ़ील्ड
onTriggerFunction

string

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

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

object (UnconditionalTrigger)

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

एक-दूसरे से अलग फ़ील्ड का अंत.

UnconditionalTrigger

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

कोई ईमेल खोलने पर ट्रिगर होने वाला इवेंट.

UniversalAction

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

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

  "openLink": string,
  "runFunction": string
}
फ़ील्ड
text

string

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

कार्रवाई का टाइप यह तय करता है कि जब उपयोगकर्ता कार्रवाई को ट्रिगर करता है, तब Gmail कैसा व्यवहार करेगा. यहां ऐसे फ़ील्ड की सूची दी गई है जो एक-दूसरे से अलग हैं. जवाब में, ज़्यादा से ज़्यादा एक फ़ील्ड सेट किया जाएगा:
runFunction

string

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

एक-दूसरे से अलग फ़ील्ड का अंत.

ComposeTrigger

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

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

object (MenuItemExtensionPoint)

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

draftAccess

enum (DraftAccess)

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

DraftAccess

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

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)

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

createSettingsUrlFunction

string

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

eventOpenTrigger

object (CalendarExtensionPoint)

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

eventUpdateTrigger

object (CalendarExtensionPoint)

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

calendarNotificationTrigger

object (CalendarExtensionPoint)

ज़रूरी नहीं. यह तब ट्रिगर होता है, जब किसी ऐसे कैलेंडर के लिए कोई इवेंट बनाया या अपडेट किया जाता है जिसकी सदस्यता उपयोगकर्ता ने ली है. यह सिर्फ़ उन ट्रिगर पर लागू होता है जिन्हें HTTP endpoints ने CalendarSubscriptionActionMarkup का इस्तेमाल करके बनाया है.

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

Apps Script add-ons और Apps Script installable triggers पर लागू नहीं होता.

eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

currentEventAccess

enum (EventAccess)

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

ConferenceSolution

कॉन्फ़्रेंस से जुड़ी वैल्यू तय करता है.

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

string

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

id

string

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

name

string

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

logoUrl

string

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

CalendarExtensionPoint

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

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

string

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

EventAccess

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

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 Docs दस्तावेज़ में लिंक की झलक देखने के लिए, एक्सटेंशन पॉइंट की सूची. ज़्यादा जानकारी के लिए, स्मार्ट चिप की मदद से लिंक की झलक देखना लेख पढ़ें.

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

क्या ऐड-ऑन, ब्राउज़र में पीआईपी मोड की सुविधा के साथ काम करता है.

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 ऐड-ऑन को "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 ऑथराइज़ेशन हेडर में भेजे गए टोकन के लिए कॉन्फ़िगरेशन.

granularOauthPermissionSupport

enum (GranularOauthPermissionSupport)

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

HttpAuthorizationHeader

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

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

GranularOauthPermissionSupport

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

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

तरीके

create

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

delete

दिए गए नाम वाले डिप्लॉयमेंट को मिटाता है.

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

यह अनुमति मिलने पर, दिए गए नाम के साथ कोई डिप्लॉयमेंट बनाया जा सकता है या उसे बदला जा सकता है.

uninstall

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