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अनुमति देने वाला यूआरएल पाता है. इसका इस्तेमाल, स्क्रिप्ट का ऐक्सेस देने के लिए किया जा सकता है.

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यह एक ऑब्जेक्ट दिखाता है. इसका इस्तेमाल यह तय करने के लिए किया जाता है कि उपयोगकर्ता को एक या उससे ज़्यादा सेवाओं का इस्तेमाल करने के लिए, इस स्क्रिप्ट को अनुमति देनी होगी या नहीं. साथ ही, अनुमति देने के लिए डायलॉग बॉक्स का यूआरएल भी दिखाता है.
getIdentityToken()Stringअगर openid स्कोप दिया गया है, तो असरदार उपयोगकर्ता के लिए OpenID Connect आइडेंटिटी टोकन मिलता है.
getInstallationSource()InstallationSourceयह एक वैल्यू दिखाता है, जिससे पता चलता है कि मौजूदा उपयोगकर्ता के लिए, स्क्रिप्ट को ऐड-ऑन के तौर पर कैसे इंस्टॉल किया गया. उदाहरण के लिए, क्या उपयोगकर्ता ने इसे 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इंस्टॉल किए जा सकने वाले ट्रिगर बनाने की प्रोसेस शुरू करता है. ट्रिगर होने पर, यह किसी फ़ंक्शन को कॉल करता है.

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 से ट्रिगर चालू होता है.