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)
  },
  "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 ऐड-ऑन कॉन्फ़िगरेशन.

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

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 जब ड्राफ़्ट के लिए कुछ भी सेट नहीं होता है, तब यह डिफ़ॉल्ट वैल्यू होती है.
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)
  },
  "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)

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

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

createActionTriggers[]

object (CreateActionExtensionPoint)

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

DocsExtensionPoint

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

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

string

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

LinkPreviewExtensionPoint

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

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 का इस्तेमाल करता है.

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)
}
फ़ील्ड
authorizationHeader

enum (HttpAuthorizationHeader)

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

HttpAuthorizationHeader

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

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

तरीके

create

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

delete

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

get

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

getInstallStatus

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

install

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

list

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

replaceDeployment

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

uninstall

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