Package google.apps.script.type

इंडेक्स

AddOnWidgetSet

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

फ़ील्ड
usedWidgets[]

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 ऐड-ऑन की ऐसी कार्रवाई जो ऐड-ऑन के 'लिखें' यूज़र इंटरफ़ेस (यूआई) पर लागू होती है.

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

HomepageExtensionPoint

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

फ़ील्ड
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 अनुमति हेडर में भेजे गए टोकन के लिए कॉन्फ़िगरेशन.

LayoutProperties

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

फ़ील्ड
primaryColor

string

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

secondaryColor

string

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

useNewMaterialDesign

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

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

फ़ील्ड
runFunction

string

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

label

string

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

logoUrl

string

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

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

UniversalActionExtensionPoint

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

फ़ील्ड
label

string

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

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