Script Service

स्क्रिप्ट

इस सेवा की मदद से, स्क्रिप्ट ट्रिगर और स्क्रिप्ट पब्लिश करने की सुविधा मिलती है.

क्लास

नामसंक्षिप्त विवरण
AuthModeयह एक गिनती है. इससे यह पता चलता है कि Apps Script, ट्रिगर किए गए फ़ंक्शन के ज़रिए किन कैटगरी की सेवाओं को लागू कर सकता है.
AuthorizationInfoयह एक ऐसा ऑब्जेक्ट है जो यह जांच करता है कि उपयोगकर्ता ने स्क्रिप्ट के लिए ज़रूरी स्कोप के लिए अनुमति दी है या नहीं.
AuthorizationStatusयह एक इन्यूमरेशन है, जो स्क्रिप्ट की अनुमति की स्थिति के बारे में बताता है.
CalendarTriggerBuilderकैलेंडर ट्रिगर के लिए बिल्डर.
ClockTriggerBuilderक्लॉक ट्रिगर के लिए बिल्डर.
DocumentTriggerBuilderयह दस्तावेज़ ट्रिगर बनाने वाला टूल है.
EventTypeयह एक गिनती है, जो ट्रिगर किए गए इवेंट के टाइप के बारे में बताती है.
FormTriggerBuilderयह फ़ॉर्म ट्रिगर बनाने वाला टूल है.
InstallationSourceयह एक गिनती है, जिससे पता चलता है कि मौजूदा उपयोगकर्ता के लिए स्क्रिप्ट को ऐड-ऑन के तौर पर कैसे इंस्टॉल किया गया.
ScriptAppस्क्रिप्ट पब्लिश करने और ट्रिगर को ऐक्सेस और उनमें बदलाव करने की अनुमति देता है.
Serviceस्क्रिप्ट पब्लिश करने की सुविधा को ऐक्सेस और उसमें बदलाव करना.
SpreadsheetTriggerBuilderस्प्रेडशीट ट्रिगर बनाने वाला टूल.
StateTokenBuilderयह कुकी, स्क्रिप्ट को ऐसे स्टेट टोकन बनाने की अनुमति देती है जिनका इस्तेमाल कॉलबैक एपीआई (जैसे कि OAuth फ़्लो) में किया जा सकता है.
Triggerस्क्रिप्ट ट्रिगर.
TriggerBuilderस्क्रिप्ट ट्रिगर के लिए सामान्य बिल्डर.
TriggerSourceयह एक गिनती है, जिससे उस इवेंट के सोर्स का पता चलता है जिसकी वजह से ट्रिगर चालू हुआ.

AuthMode

प्रॉपर्टी

प्रॉपर्टीटाइपब्यौरा
NONEEnumऐसा मोड जिसमें उन सेवाओं को ऐक्सेस करने की अनुमति नहीं होती जिनके लिए अनुमति ज़रूरी है.
CUSTOM_FUNCTIONEnumयह एक ऐसा मोड है जो कस्टम स्प्रेडशीट फ़ंक्शन में इस्तेमाल करने के लिए, सेवाओं के सीमित सबसेट को ऐक्सेस करने की अनुमति देता है.
LIMITEDEnumयह एक ऐसा मोड है जिसमें कुछ ही सेवाओं का ऐक्सेस मिलता है.
FULLEnumयह एक ऐसा मोड है जो उन सभी सेवाओं को ऐक्सेस करने की अनुमति देता है जिनके लिए अनुमति लेना ज़रूरी है.

AuthorizationInfo

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
getAuthorizationStatus()AuthorizationStatusयह फ़ंक्शन ऐसी वैल्यू देता है जिससे पता चलता है कि उपयोगकर्ता को एक या उससे ज़्यादा सेवाओं (उदाहरण के लिए, ScriptApp.AuthorizationStatus.REQUIRED) का इस्तेमाल करने के लिए, इस स्क्रिप्ट को अनुमति देनी होगी या नहीं.
getAuthorizationUrl()String|nullअनुमति देने वाला यूआरएल मिलता है. इसका इस्तेमाल स्क्रिप्ट को ऐक्सेस करने की अनुमति देने के लिए किया जा सकता है.
getAuthorizedScopes()String[]|nullइस तरीके से, स्क्रिप्ट के लिए अनुमति वाले स्कोप की सूची मिलती है.

AuthorizationStatus

प्रॉपर्टी

प्रॉपर्टीटाइपब्यौरा
REQUIREDEnumउपयोगकर्ता को एक या उससे ज़्यादा सेवाओं का इस्तेमाल करने के लिए, इस स्क्रिप्ट को अनुमति देनी होगी.
NOT_REQUIREDEnumउपयोगकर्ता ने इस स्क्रिप्ट को वे सभी अनुमतियां दे दी हैं जिनकी फ़िलहाल ज़रूरत है.

CalendarTriggerBuilder

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
create()Triggerयह ट्रिगर बनाता है और उसे दिखाता है.
onEventUpdated()CalendarTriggerBuilderयह एक ऐसा ट्रिगर तय करता है जो कैलेंडर एंट्री बनाने, अपडेट करने या मिटाने पर चालू होता है.

ClockTriggerBuilder

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
after(durationMilliseconds)ClockTriggerBuilderइससे पता चलता है कि ट्रिगर, मौजूदा समय के बाद कम से कम कितने समय (मिलीसेकंड में) तक चलेगा.
at(date)ClockTriggerBuilderइससे यह तय होता है कि ट्रिगर कब काम करेगा.
atDate(year, month, day)ClockTriggerBuilderइससे पता चलता है कि ट्रिगर, दी गई तारीख पर ट्रिगर होता है. डिफ़ॉल्ट रूप से, यह आधी रात (+/- 15 मिनट) के आस-पास होता है.
atHour(hour)ClockTriggerBuilderयह उस घंटे के बारे में बताता है जब ट्रिगर चालू होता है.
create()Triggerइस फ़ंक्शन से ट्रिगर बनता है.
everyDays(n)ClockTriggerBuilderइससे पता चलता है कि ट्रिगर हर n दिन में चलेगा.
everyHours(n)ClockTriggerBuilderइससे ट्रिगर को हर n घंटे में चलाने के लिए सेट किया जाता है.
everyMinutes(n)ClockTriggerBuilderइस विकल्प का इस्तेमाल, हर n मिनट में ट्रिगर चलाने के लिए किया जाता है.
everyWeeks(n)ClockTriggerBuilderइससे हर n हफ़्ते में ट्रिगर चलाने के बारे में पता चलता है.
inTimezone(timezone)ClockTriggerBuilderयह विकल्प, ट्रिगर के चालू होने पर, दी गई तारीखों/समय के लिए टाइमज़ोन तय करता है.
nearMinute(minute)ClockTriggerBuilderयह उस मिनट के बारे में बताता है जब ट्रिगर चालू होता है. इसमें 15 मिनट का अंतर हो सकता है.
onMonthDay(day)ClockTriggerBuilderइससे महीने की वह तारीख तय की जाती है जब ट्रिगर काम करता है.
onWeekDay(day)ClockTriggerBuilderइससे पता चलता है कि ट्रिगर हफ़्ते के किस दिन चलता है.

DocumentTriggerBuilder

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
create()Triggerयह नया ट्रिगर बनाता है और उसे दिखाता है.
onOpen()DocumentTriggerBuilderयह उस ट्रिगर के बारे में बताता है जो दस्तावेज़ खोले जाने पर सक्रिय होगा.

EventType

प्रॉपर्टी

प्रॉपर्टीटाइपब्यौरा
CLOCKEnumसमय के हिसाब से ट्रिगर होने वाला इवेंट, तय समय पर पहुंचने के बाद ट्रिगर होता है.
ON_OPENEnumउपयोगकर्ता के Google Docs, Sheets या Forms की फ़ाइल खोलने पर, यह ट्रिगर चालू हो जाता है.
ON_EDITEnumउपयोगकर्ता के Google Sheets फ़ाइल में बदलाव करने पर ट्रिगर चालू होता है. उदाहरण के लिए, किसी सेल में नई वैल्यू डालने पर, बदलाव माना जाता है.
ON_FORM_SUBMITEnumजब उपयोगकर्ता Google फ़ॉर्म का जवाब देता है, तब यह ट्रिगर फ़ायर होता है.
ON_CHANGEEnumउपयोगकर्ता के Google Sheets फ़ाइल में बदलाव करने पर, ट्रिगर चालू हो जाता है. उदाहरण के लिए, कोई लाइन जोड़ने पर, बदलाव होता है, न कि बदलाव करना.
ON_EVENT_UPDATEDEnumयह ट्रिगर तब फ़ायर होता है, जब चुने गए Google Calendar पर कोई इवेंट बनाया जाता है, अपडेट किया जाता है या मिटाया जाता है.

FormTriggerBuilder

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
create()Triggerयह नया ट्रिगर बनाता है और उसे दिखाता है.
onFormSubmit()FormTriggerBuilderयह एक ट्रिगर तय करता है, जो फ़ॉर्म में जवाब सबमिट किए जाने पर ट्रिगर होगा.
onOpen()FormTriggerBuilderयह एक ऐसा ट्रिगर तय करता है जो फ़ॉर्म के बदलाव वाले व्यू को खोले जाने पर ट्रिगर होगा.

InstallationSource

प्रॉपर्टी

प्रॉपर्टीटाइपब्यौरा
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumएडमिन ने उपयोगकर्ता के डोमेन के लिए ऐड-ऑन इंस्टॉल किया था.
NONEEnumस्क्रिप्ट, ऐड-ऑन के तौर पर नहीं चल रही है.
WEB_STORE_ADD_ONEnumउपयोगकर्ता ने Chrome Web Store से ऐड-ऑन इंस्टॉल किया है.

ScriptApp

प्रॉपर्टी

प्रॉपर्टीटाइपब्यौरा
AuthModeAuthModeयह एक गिनती है. इससे यह पता चलता है कि Apps Script, ट्रिगर किए गए फ़ंक्शन के ज़रिए किन कैटगरी की सेवाओं को लागू कर सकता है.
AuthorizationStatusAuthorizationStatusयह एक इन्यूमरेशन है, जो स्क्रिप्ट की अनुमति की स्थिति के बारे में बताता है.
EventTypeEventTypeयह एक गिनती है, जो ट्रिगर किए गए इवेंट के टाइप के बारे में बताती है.
InstallationSourceInstallationSourceयह एक गिनती है, जिससे पता चलता है कि स्क्रिप्ट को उपयोगकर्ता के लिए ऐड-ऑन के तौर पर कैसे इंस्टॉल किया गया था.
TriggerSourceTriggerSourceयह एक गिनती है, जिससे उस इवेंट के सोर्स का पता चलता है जिसकी वजह से ट्रिगर चालू हुआ.
WeekDayWeekdayयह हफ़्ते के दिनों को दिखाने वाला एक इन्यूमरेशन है.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
deleteTrigger(trigger)voidयह फ़ंक्शन, दिए गए ट्रिगर को हटा देता है, ताकि वह अब न चले.
getAuthorizationInfo(authMode)AuthorizationInfoयह एक ऐसा ऑब्जेक्ट देता है जो यह जांच करता है कि उपयोगकर्ता ने स्क्रिप्ट की सभी ज़रूरी शर्तों के लिए अनुमति दी है या नहीं.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoयह एक ऐसा ऑब्जेक्ट देता है जो यह जांच करता है कि उपयोगकर्ता ने अनुरोध किए गए स्कोप के लिए अनुमति दी है या नहीं.
getIdentityToken()String|nullअगर openid स्कोप की अनुमति दी गई है, तो यह असरदार उपयोगकर्ता के लिए OpenID Connect आइडेंटिटी टोकन पाता है.
getInstallationSource()InstallationSourceयह फ़ंक्शन, enum वैल्यू दिखाता है. इससे पता चलता है कि स्क्रिप्ट को मौजूदा उपयोगकर्ता के लिए ऐड-ऑन के तौर पर कैसे इंस्टॉल किया गया था. उदाहरण के लिए, उपयोगकर्ता ने इसे Chrome Web Store से खुद इंस्टॉल किया था या डोमेन एडमिन ने इसे सभी उपयोगकर्ताओं के लिए इंस्टॉल किया था.
getOAuthToken()Stringयह फ़ंक्शन, असली उपयोगकर्ता के लिए OAuth 2.0 ऐक्सेस टोकन को वापस लाता है.
getProjectTriggers()Trigger[]यह मौजूदा प्रोजेक्ट और मौजूदा उपयोगकर्ता से जुड़े सभी इंस्टॉल किए जा सकने वाले ट्रिगर को दिखाता है.
getScriptId()Stringस्क्रिप्ट प्रोजेक्ट का यूनीक आईडी मिलता है.
getService()Serviceयह फ़ंक्शन, स्क्रिप्ट को वेब ऐप्लिकेशन के तौर पर पब्लिश करने की प्रोसेस को कंट्रोल करने के लिए इस्तेमाल किया जाने वाला ऑब्जेक्ट देता है.
getUserTriggers(document)Trigger[]यह फ़ंक्शन, दिए गए दस्तावेज़ में इस उपयोगकर्ता के मालिकाना हक वाले सभी इंस्टॉल किए जा सकने वाले ट्रिगर को सिर्फ़ इस स्क्रिप्ट या ऐड-ऑन के लिए पाता है.
getUserTriggers(form)Trigger[]यह फ़ंक्शन, इस स्क्रिप्ट या ऐड-ऑन के लिए, दिए गए फ़ॉर्म में इस उपयोगकर्ता के मालिकाना हक वाले सभी इंस्टॉल किए जा सकने वाले ट्रिगर को वापस लाता है.
getUserTriggers(spreadsheet)Trigger[]यह फ़ंक्शन, दी गई स्प्रेडशीट में इस उपयोगकर्ता के मालिकाना हक वाले सभी इंस्टॉल किए जा सकने वाले ट्रिगर को सिर्फ़ इस स्क्रिप्ट या ऐड-ऑन के लिए दिखाता है.
invalidateAuth()voidयह फ़ंक्शन, उस उपयोगकर्ता के लिए अनुमति रद्द करता है जिसके पास मौजूदा स्क्रिप्ट को चलाने की अनुमति है.
newStateToken()StateTokenBuilderयह एक ऐसे स्टेट टोकन के लिए बिल्डर बनाता है जिसका इस्तेमाल, कॉलबैक एपीआई (जैसे कि OAuth फ़्लो) में किया जा सकता है.
newTrigger(functionName)TriggerBuilderयह फ़ंक्शन, इंस्टॉल किए जा सकने वाले ट्रिगर को बनाने की प्रोसेस शुरू करता है. ट्रिगर चालू होने पर, यह दिए गए फ़ंक्शन को कॉल करता है.
requireAllScopes(authMode)voidयह कुकी पुष्टि करती है कि उपयोगकर्ता ने स्क्रिप्ट के लिए अनुरोध किए गए सभी स्कोप के लिए सहमति दी है या नहीं.
requireScopes(authMode, oAuthScopes)voidयह कुकी पुष्टि करती है कि उपयोगकर्ता ने अनुरोध किए गए स्कोप के लिए सहमति दी है या नहीं.

Service

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
getUrl()Stringअगर वेब ऐप्लिकेशन को डिप्लॉय किया गया है, तो यह फ़ंक्शन उसका यूआरएल दिखाता है. अगर वेब ऐप्लिकेशन को डिप्लॉय नहीं किया गया है, तो यह फ़ंक्शन null दिखाता है.
isEnabled()Booleanअगर स्क्रिप्ट को वेब ऐप्लिकेशन के तौर पर ऐक्सेस किया जा सकता है, तो true दिखाता है.

SpreadsheetTriggerBuilder

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
create()Triggerयह ट्रिगर बनाता है और उसे दिखाता है.
onChange()SpreadsheetTriggerBuilderयह एक ऐसा ट्रिगर तय करता है जो स्प्रेडशीट के कॉन्टेंट या स्ट्रक्चर में बदलाव होने पर ट्रिगर होगा.
onEdit()SpreadsheetTriggerBuilderयह एक ऐसा ट्रिगर तय करता है जो स्प्रेडशीट में बदलाव होने पर ट्रिगर होगा.
onFormSubmit()SpreadsheetTriggerBuilderयह एक ऐसा ट्रिगर तय करता है जो स्प्रेडशीट में फ़ॉर्म सबमिट किए जाने पर चालू होगा.
onOpen()SpreadsheetTriggerBuilderयह उस ट्रिगर के बारे में बताता है जो स्प्रेडशीट खोलने पर सक्रिय होगा.

StateTokenBuilder

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
createToken()Stringयह कुकी, स्टेट टोकन के एन्क्रिप्ट (सुरक्षित) किए गए स्ट्रिंग वर्शन को बनाती है.
withArgument(name, value)StateTokenBuilderटोकन में कोई आर्ग्युमेंट जोड़ता है.
withMethod(method)StateTokenBuilderयह कुकी, कॉलबैक फ़ंक्शन सेट करती है.
withTimeout(seconds)StateTokenBuilderयह कुकी, टोकन के मान्य रहने की अवधि (सेकंड में) सेट करती है.

Trigger

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
getEventType()EventTypeयह उस इवेंट टाइप को दिखाता है जिस पर ट्रिगर चालू होता है.
getHandlerFunction()Stringयह फ़ंक्शन, ट्रिगर चालू होने पर कॉल किए जाने वाले फ़ंक्शन को दिखाता है.
getTriggerSource()TriggerSourceयह उन इवेंट का सोर्स दिखाता है जो ट्रिगर को सक्रिय करेंगे.
getTriggerSourceId()Stringसोर्स के हिसाब से आईडी दिखाता है.
getUniqueId()Stringयह एक यूनीक आइडेंटिफ़ायर दिखाता है. इसका इस्तेमाल, ट्रिगर के बीच अंतर करने के लिए किया जा सकता है.

TriggerBuilder

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
forDocument(document)DocumentTriggerBuilderयह फ़ंक्शन, दिए गए दस्तावेज़ से जुड़ा DocumentTriggerBuilder बनाता है और उसे दिखाता है.
forDocument(key)DocumentTriggerBuilderयह फ़ंक्शन, दिए गए आईडी वाले दस्तावेज़ से जुड़ा DocumentTriggerBuilder बनाता है और उसे दिखाता है.
forForm(form)FormTriggerBuilderयह दिए गए फ़ॉर्म से जुड़ा FormTriggerBuilder बनाता है और उसे दिखाता है.
forForm(key)FormTriggerBuilderयह फ़ंक्शन, दिए गए आईडी वाले फ़ॉर्म से जुड़ा FormTriggerBuilder बनाता है और उसे दिखाता है.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderयह दी गई स्प्रेडशीट से जुड़ा SpreadsheetTriggerBuilder बनाता है और उसे दिखाता है.
forSpreadsheet(key)SpreadsheetTriggerBuilderयह फ़ंक्शन, दिए गए आईडी वाली स्प्रेडशीट से जुड़ी SpreadsheetTriggerBuilder बनाता है और उसे दिखाता है.
forUserCalendar(emailId)CalendarTriggerBuilderयह फ़ंक्शन, कैलेंडर ट्रिगर बनाने के लिए बिल्डर ऑब्जेक्ट दिखाता है.
timeBased()ClockTriggerBuilderयह फ़ंक्शन, समय के हिसाब से ट्रिगर बनाने के लिए ClockTriggerBuilder बनाता है और उसे दिखाता है.

TriggerSource

प्रॉपर्टी

प्रॉपर्टीटाइपब्यौरा
SPREADSHEETSEnumGoogle Sheets की वजह से ट्रिगर फ़ायर होता है.
CLOCKEnumसमय के हिसाब से ट्रिगर होने वाले इवेंट की वजह से, ट्रिगर चालू होता है.
FORMSEnumGoogle Forms की वजह से ट्रिगर चालू होता है.
DOCUMENTSEnumGoogle Docs की वजह से ट्रिगर चालू होता है.
CALENDAREnumGoogle Calendar, ट्रिगर को चालू करता है.