Package google.apps.script.type

इंडेक्स

AddOnWidgetSet (मैसेज)
AddOnWidgetSet.WidgetType (enum)
CommonAddOnManifest (मैसेज)
CreateActionExtensionPoint (मैसेज)
GranularOauthPermissionSupport (enum)
HomepageExtensionPoint (मैसेज)
HttpAuthorizationHeader (enum)
HttpOptions (मैसेज)
LayoutProperties (मैसेज)
LinkPreviewExtensionPoint (मैसेज)
MenuItemExtensionPoint (मैसेज)
UniversalActionExtensionPoint (मैसेज)
UriPattern (मैसेज)

AddOnWidgetSet

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

फ़ील्ड

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

usedWidgets[]

WidgetType

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

WidgetType

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

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

CommonAddOnManifest

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

फ़ील्ड
`name`	`string` ज़रूरी है. ऐड-ऑन का डिसप्ले नेम.
`logoUrl`	`string` ज़रूरी है. ऐड-ऑन टूलबार में दिखने वाले लोगो की इमेज का यूआरएल.
`layoutProperties`	`LayoutProperties` ऐड-ऑन कार्ड के लिए सामान्य लेआउट प्रॉपर्टी.
`addOnWidgetSet`	`AddOnWidgetSet` ऐड-ऑन में इस्तेमाल किए गए विजेट. इस फ़ील्ड की वैल्यू न देने पर, डिफ़ॉल्ट सेट का इस्तेमाल किया जाता है.
`useLocaleFromApp`	`bool` होस्ट ऐप्लिकेशन से स्थान-भाषा की जानकारी पास करनी है या नहीं.
`homepageTrigger`	`HomepageExtensionPoint` यह एक ऐसे एंडपॉइंट के बारे में बताता है जिसे किसी भी कॉन्टेक्स्ट में, किसी भी होस्ट में लागू किया जाएगा. इस फ़ंक्शन से जनरेट किए गए सभी कार्ड, उपयोगकर्ता के लिए हमेशा उपलब्ध रहेंगे. हालांकि, जब यह ऐड-ऑन ज़्यादा टारगेट किए गए ट्रिगर का एलान करता है, तब ये कार्ड कॉन्टेक्स्ट के हिसाब से दिखाए जाने वाले कॉन्टेंट के पीछे छिप सकते हैं.
`universalActions[]`	`UniversalActionExtensionPoint` यह यूनिवर्सल ऐक्शन मेन्यू में एक्सटेंशन पॉइंट की सूची तय करता है. यह ऐड-ऑन के लिए सेटिंग मेन्यू के तौर पर काम करता है. एक्सटेंशन पॉइंट, खोलने के लिए लिंक यूआरएल या फ़ॉर्म सबमिट करने के लिए एक्ज़ीक्यूट किया जाने वाला एंडपॉइंट हो सकता है.
`openLinkUrlPrefixes`	`ListValue` OpenLink ऐक्शन में, सिर्फ़ `HTTPS`, `MAILTO` या `TEL` स्कीम वाले यूआरएल का इस्तेमाल किया जा सकता है. `HTTPS` लिंक के लिए, यूआरएल को अनुमति वाली सूची में दिए गए किसी एक प्रीफ़िक्स से मेल खाना भी ज़रूरी है. अगर प्रीफ़िक्स में स्कीम शामिल नहीं है, तो `HTTPS` को स्कीम माना जाता है. `HTTP` लिंक को `HTTPS` लिंक में अपने-आप बदल दिया जाता है.

CreateActionExtensionPoint

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

फ़ील्ड
`id`	`string` ज़रूरी है. इस एक्सटेंशन पॉइंट को अलग दिखाने के लिए यूनीक आईडी. आईडी में ज़्यादा से ज़्यादा 64 वर्ण हो सकते हैं. साथ ही, यह `[a-zA-Z0-9-]+` फ़ॉर्मैट में होना चाहिए.
`labelText`	`string` ज़रूरी है. संसाधन बनाने के एंट्री पॉइंट के लिए आइकॉन के साथ दिखने वाला टेक्स्ट. जैसे, `Create support case`. यह टेक्स्ट स्टैटिक होता है और उपयोगकर्ताओं को ऐड-ऑन चलाने से पहले दिखता है.
`localizedLabelText`	`map<string, string>` ज़रूरी नहीं. `labelText` का मैप, ताकि इसे अन्य भाषाओं में बदला जा सके. भाषा को ISO 639 फ़ॉर्मैट में और देश/इलाके को ISO 3166 फ़ॉर्मैट में लिखें. दोनों के बीच में हाइफ़न `-` लगाएं. उदाहरण के लिए, `en-US`. अगर उपयोगकर्ता की जगह-भाषा, मैप की कुंजियों में मौजूद है, तो उसे `labelText` का स्थानीय भाषा में अनुवाद किया गया वर्शन दिखेगा.
`runFunction`	`string` ज़रूरी है. लिंक बनाने के लिए, संसाधन बनाने का वर्कफ़्लो ट्रिगर होने पर इस एंडपॉइंट को एक्ज़ीक्यूट किया जाता है.
`logoUrl`	`string` ज़रूरी नहीं. यह आइकॉन, संसाधन बनाने के एंट्री पॉइंट के लिए दिखता है. अगर इसे शामिल नहीं किया जाता है, तो मेन्यू आपके ऐड-ऑन के टूलबार आइकॉन `logoUrl` का इस्तेमाल करता है.

GranularOauthPermissionSupport

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

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

HomepageExtensionPoint

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

फ़ील्ड

फ़ील्ड
`runFunction`	`string` ज़रूरी है. यह एक्सटेंशन पॉइंट चालू होने पर, इस एंडपॉइंट को एक्ज़ीक्यूट किया जाता है.
`enabled`	`BoolValue` ज़रूरी नहीं. अगर इसे `false` पर सेट किया जाता है, तो इस संदर्भ में होम पेज व्यू बंद हो जाता है. अगर इसे सेट नहीं किया जाता है, तो यह डिफ़ॉल्ट रूप से `true` पर सेट होता है. अगर किसी ऐड-ऑन के कस्टम होम पेज व्यू को बंद कर दिया जाता है, तो उपयोगकर्ताओं को सामान्य खास जानकारी वाला कार्ड दिखाया जाता है.

runFunction

string

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

enabled

BoolValue

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

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

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

HttpAuthorizationHeader

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

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

HttpOptions

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

फ़ील्ड

फ़ील्ड
`authorizationHeader`	`HttpAuthorizationHeader` `HTTP` Authorization हेडर में भेजे गए टोकन के लिए कॉन्फ़िगरेशन.
`granularOauthPermissionSupport`	`GranularOauthPermissionSupport` इससे पता चलता है कि ऐड-ऑन ने अलग से अनुमति लेने की सुविधा चालू की है या नहीं.

authorizationHeader

HttpAuthorizationHeader

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

granularOauthPermissionSupport

GranularOauthPermissionSupport

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

LayoutProperties

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

फ़ील्ड

फ़ील्ड
`primaryColor`	`string` ऐड-ऑन का मुख्य रंग. इससे टूलबार का रंग सेट किया जाता है. अगर कोई प्राइमरी रंग सेट नहीं किया गया है, तो फ़्रेमवर्क की ओर से दी गई डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है.
`secondaryColor`	`string` ऐड-ऑन का सेकंडरी कलर. इससे बटन का रंग सेट किया जाता है. अगर प्राइमरी कलर सेट है, लेकिन सेकंडरी कलर सेट नहीं है, तो सेकंडरी कलर, प्राइमरी कलर के जैसा ही होगा. अगर प्राइमरी और सेकंडरी, दोनों में से कोई भी रंग सेट नहीं किया गया है, तो फ़्रेमवर्क की ओर से दी गई डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है.
`useNewMaterialDesign (deprecated)`	`bool` इस आइटम का अब इस्तेमाल नहीं किया जा रहा है! यह कुकी, कार्ड के लिए मटीरियल डिज़ाइन को चालू करती है.

primaryColor

string

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

secondaryColor

string

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

useNewMaterialDesign
(deprecated)

bool

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

LinkPreviewExtensionPoint

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

फ़ील्ड
`labelText`	`string` ज़रूरी है. उदाहरण के तौर पर, स्मार्ट चिप का टेक्स्ट. इससे लोगों को लिंक की झलक देखने के लिए कहा जाता है. जैसे, `Example: Support case`. यह टेक्स्ट स्टैटिक होता है और उपयोगकर्ताओं को ऐड-ऑन चलाने से पहले दिखता है.
`localizedLabelText`	`map<string, string>` ज़रूरी नहीं. `labelText` का मैप, ताकि इसे अन्य भाषाओं में बदला जा सके. भाषा को ISO 639 फ़ॉर्मैट में और देश/इलाके को ISO 3166 फ़ॉर्मैट में लिखें. दोनों के बीच में हाइफ़न `-` लगाएं. उदाहरण के लिए, `en-US`. अगर उपयोगकर्ता की जगह-भाषा, मैप की कुंजियों में मौजूद है, तो उसे `labelText` का स्थानीय भाषा में अनुवाद किया गया वर्शन दिखेगा.
`patterns[]`	`UriPattern` ज़रूरी है. यूआरएल पैटर्न की एक ऐसी कैटगरी जो लिंक की झलक दिखाने के लिए ऐड-ऑन को ट्रिगर करती है.
`runFunction`	`string` ज़रूरी है. लिंक की झलक ट्रिगर होने पर, इस एंडपॉइंट को एक्ज़ीक्यूट किया जाता है.
`logoUrl`	`string` ज़रूरी नहीं. यह आइकॉन, स्मार्ट चिप और झलक दिखाने वाले कार्ड में दिखता है. अगर इसे शामिल नहीं किया जाता है, तो ऐड-ऑन अपने टूलबार आइकॉन `logoUrl` का इस्तेमाल करता है.

MenuItemExtensionPoint

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

फ़ील्ड

फ़ील्ड
`runFunction`	`string` ज़रूरी है. यह एक्सटेंशन पॉइंट चालू होने पर, इस एंडपॉइंट को एक्ज़ीक्यूट किया जाता है.
`label`	`string` ज़रूरी है. उपयोगकर्ता को दिखने वाला ऐसा टेक्स्ट जिसमें इस एक्सटेंशन पॉइंट को चालू करने पर की गई कार्रवाई के बारे में बताया गया हो. उदाहरण के लिए, "इनवॉइस डालें."
`logoUrl`	`string` ऐड-ऑन टूलबार में दिखने वाले लोगो की इमेज का यूआरएल. अगर इसे सेट नहीं किया जाता है, तो यह ऐड-ऑन के प्राइमरी लोगो के यूआरएल पर डिफ़ॉल्ट रूप से सेट हो जाता है.

runFunction

string

label

string

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

logoUrl

string

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

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

UniversalActionExtensionPoint

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

फ़ील्ड
`label`	`string` ज़रूरी है. उपयोगकर्ता को दिखने वाला ऐसा टेक्स्ट जिसमें इस एक्सटेंशन पॉइंट को चालू करने पर की गई कार्रवाई के बारे में बताया गया हो. उदाहरण के लिए, "नया संपर्क जोड़ें."
यूनियन फ़ील्ड `action_type`. ज़रूरी है. यूनिवर्सल ऐक्शन मेन्यू आइटम पर की जा सकने वाली कार्रवाई का टाइप. यह खोलने के लिए लिंक या एक्ज़ीक्यूट करने के लिए एंडपॉइंट हो सकता है. `action_type` इनमें से सिर्फ़ एक हो सकता है:
`openLink`	`string` UniversalAction से खोला जाने वाला यूआरएल.
`runFunction`	`string` यह UniversalAction से चलाया जाने वाला एंडपॉइंट है.

UriPattern

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

फ़ील्ड

फ़ील्ड
`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` को खाली छोड़ दें.

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 को खाली छोड़ दें.