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)

कैलेंडर ऐड-ऑन कॉन्फ़िगरेशन.

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)

इस ऐड-ऑन से मिलने वाले कॉन्फ़्रेंस सलूशन के बारे में बताता है.

createSettingsUrlFunction

string

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

eventOpenTrigger

object (CalendarExtensionPoint)

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

eventUpdateTrigger

object (CalendarExtensionPoint)

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

eventAttachmentTrigger

object (MenuItemExtensionPoint)

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

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

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

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

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