REST Resource: projects.deployments

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

Google Workspace ऐड-ऑन का डिप्लॉयमेंट

जेएसओएन के काेड में दिखाना
{
  "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 ऐड-ऑन का कॉन्फ़िगरेशन.

जेएसओएन के काेड में दिखाना
{
  "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

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

जेएसओएन के काेड में दिखाना
{
  "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

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

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

string

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

secondaryColor

string

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

useNewMaterialDesign

boolean

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

AddOnWidgetSet

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

जेएसओएन के काेड में दिखाना
{
  "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

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

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

string

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

enabled

boolean

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

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

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

UniversalActionExtensionPoint

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

जेएसओएन के काेड में दिखाना
{
  "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 ऐड-ऑन के लुक और उसे लागू करने की प्रोसेस को पसंद के मुताबिक बनाने वाली प्रॉपर्टी.

जेएसओएन के काेड में दिखाना
{
  "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

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

जेएसओएन के काेड में दिखाना
{
  "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

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

जेएसओएन के काेड में दिखाना
{
  "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

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

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

object (MenuItemExtensionPoint)

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

draftAccess

enum (DraftAccess)

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

DraftAccess

'लिखें' ट्रिगर के लिए ज़रूरी डेटा के ऐक्सेस का लेवल तय करने वाली एनम.

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

DriveAddOnManifest

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

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

object (HomepageExtensionPoint)

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

onItemsSelectedTrigger

object (DriveExtensionPoint)

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

DriveExtensionPoint

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

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

string

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

CalendarAddOnManifest

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

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

object (HomepageExtensionPoint)

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

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

conferenceSolution[]

object (ConferenceSolution)

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

createSettingsUrlFunction

string

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

eventOpenTrigger

object (CalendarExtensionPoint)

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

eventUpdateTrigger

object (CalendarExtensionPoint)

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

currentEventAccess

enum (EventAccess)

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

ConferenceSolution

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

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

string

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

id

string

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

name

string

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

logoUrl

string

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

CalendarExtensionPoint

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

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

string

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

EventAccess

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

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

DocsAddOnManifest

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

जेएसओएन के काेड में दिखाना
{
  "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 ऐड-ऑन के ट्रिगर का एलान करने का सामान्य फ़ॉर्मैट.

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

string

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

LinkPreviewExtensionPoint

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

जेएसओएन के काेड में दिखाना
{
  "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

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

जेएसओएन के काेड में दिखाना
{
  "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 ऐप्लिकेशन में संसाधन बनाने वाले वर्कफ़्लो को शुरू करता है. ज़्यादा जानकारी के लिए, @ मेन्यू से तीसरे पक्ष के संसाधन बनाना देखें.

जेएसओएन के काेड में दिखाना
{
  "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 ऐड-ऑन के लुक और उसे लागू करने की प्रोसेस को पसंद के मुताबिक बनाने वाली प्रॉपर्टी.

जेएसओएन के काेड में दिखाना
{
  "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 ऐड-ऑन ट्रिगर का एलान करने के लिए सामान्य फ़ॉर्मैट.

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

string

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

SlidesAddOnManifest

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

जेएसओएन के काेड में दिखाना
{
  "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 ऐड-ऑन के ट्रिगर का एलान करने के लिए सामान्य फ़ॉर्मैट.

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

string

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

HttpOptions

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

जेएसओएन के काेड में दिखाना
{
  "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

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