Class Trigger
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
العامل المشغِّل
مشغِّل نص برمجي
مستندات تفصيلية
getEventType()
تعرِض هذه السمة نوع الحدث الذي يتم تشغيل العامل المشغِّل عند حدوثه.
const triggers = ScriptApp.getProjectTriggers();
for (let i = 0; i < triggers.length; i++) {
if (triggers[i].getEventType() === ScriptApp.EventType.CLOCK) {
// Some code here - other options are:
// ScriptApp.EventType.ON_EDIT
// ScriptApp.EventType.ON_FORM_SUBMIT
// ScriptApp.EventType.ON_OPEN
}
}
الإرجاع
EventType: نوع الحدث الذي يُشغِّل هذا المشغِّل
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/script.scriptapp
getHandlerFunction()
تُرجِع الدالة التي سيتمّ استدعاؤها عند بدء الإجراء المشغِّل.
// Create a trigger for the script.
ScriptApp.newTrigger('myFunction')
.forSpreadsheet('id of my spreadsheet')
.onEdit()
.create();
Logger.log(ScriptApp.getProjectTriggers()[0]
.getHandlerFunction()); // logs "myFunction"
الإرجاع
String: اسم الطريقة
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/script.scriptapp
getTriggerSource()
تعرِض هذه الدالة مصدر الأحداث التي ستؤدي إلى تنشيط العامل المشغِّل.
على سبيل المثال، سيعرض عامل التشغيل onEdit لجدول البيانات SPREADSHEETS، أو سيعرض عامل التشغيل المستنِد إلى الوقت
CLOCK.
const triggers = ScriptApp.getProjectTriggers();
for (let i = 0; i < triggers.length; i++) {
if (triggers[i].getTriggerSource() === ScriptApp.TriggerSource.CLOCK) {
Logger.log(`${triggers[i].getUniqueId()} source is clock`);
} else if (
triggers[i].getTriggerSource() === ScriptApp.TriggerSource.SPREADSHEETS) {
Logger.log(`${triggers[i].getUniqueId()} source is spreadsheets`);
}
}
الإرجاع
TriggerSource - الناشر الذي يتم تشغيل الإجراء له
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/script.scriptapp
getTriggerSourceId()
لعرض رقم التعريف الخاص بالمصدر.
على سبيل المثال، إذا كان مصدر العامل المشغِّل هو جدول بيانات، سيكون هذا هو رقم تعريف
جدول البيانات. بالنسبة إلى أحداث الساعة، يتم عرض قيمة فارغة.
الإرجاع
String: رقم تعريف الكيان في الناشر الذي يتم تشغيل هذا الإجراء من أجله
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/script.scriptapp
getUniqueId()
تعرِض هذه السمة معرّفًا فريدًا يمكن استخدامه للتمييز بين عوامل التشغيل.
الإرجاع
String: المعرّف الفريد للعامل المشغِّل
التفويض
تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/script.scriptapp
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-26 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eA script trigger is a function that automatically runs in response to a certain event, like opening a document, editing a cell, or a timed event.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eTrigger\u003c/code\u003e object provides methods to access information about the trigger such as its event type, associated function, source, source ID, and a unique identifier.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetEventType()\u003c/code\u003e, \u003ccode\u003egetHandlerFunction()\u003c/code\u003e, \u003ccode\u003egetTriggerSource()\u003c/code\u003e, \u003ccode\u003egetTriggerSourceId()\u003c/code\u003e, and \u003ccode\u003egetUniqueId()\u003c/code\u003e methods provide information on the trigger's configuration and behavior.\u003c/p\u003e\n"],["\u003cp\u003eAll methods associated with the Trigger object necessitate authorization with the scope \u003ccode\u003ehttps://www.googleapis.com/auth/script.scriptapp\u003c/code\u003e.\u003c/p\u003e\n"]]],["This document details the functionality of script triggers, which are automated actions. Key actions include retrieving information about a trigger using five methods: `getEventType()`, which identifies the event type that activates the trigger; `getHandlerFunction()`, which returns the function executed when the trigger fires; `getTriggerSource()`, which specifies the event source; `getTriggerSourceId()`, which provides the source's ID; and `getUniqueId()`, which offers a unique identifier for the trigger. All methods require specific authorization scopes.\n"],null,["# Class Trigger\n\nTrigger\n\nA script trigger. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------|---------------------------------------------------------------|---------------------------------------------------------------------------------------|\n| [getEventType()](#getEventType()) | [EventType](/apps-script/reference/script/event-type) | Returns the event type that the trigger fires on. |\n| [getHandlerFunction()](#getHandlerFunction()) | `String` | Returns the function that will be called when the trigger fires. |\n| [getTriggerSource()](#getTriggerSource()) | [TriggerSource](/apps-script/reference/script/trigger-source) | Returns the source of events that will cause the trigger to fire. |\n| [getTriggerSourceId()](#getTriggerSourceId()) | `String` | Returns the id specific to the source. |\n| [getUniqueId()](#getUniqueId()) | `String` | Returns a unique identifier that can be used to distinguish triggers from each other. |\n\nDetailed documentation\n----------------------\n\n### `get``Event``Type()`\n\nReturns the event type that the trigger fires on.\n\n```javascript\nconst triggers = ScriptApp.getProjectTriggers();\nfor (let i = 0; i \u003c triggers.length; i++) {\n if (triggers[i].getEventType() === ScriptApp.EventType.CLOCK) {\n // Some code here - other options are:\n // ScriptApp.EventType.ON_EDIT\n // ScriptApp.EventType.ON_FORM_SUBMIT\n // ScriptApp.EventType.ON_OPEN\n }\n}\n```\n\n#### Return\n\n\n[EventType](/apps-script/reference/script/event-type) --- the event type that this is a trigger for\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/script.scriptapp`\n\n*** ** * ** ***\n\n### `get``Handler``Function()`\n\nReturns the function that will be called when the trigger fires.\n\n```javascript\n// Create a trigger for the script.\nScriptApp.newTrigger('myFunction')\n .forSpreadsheet('id of my spreadsheet')\n .onEdit()\n .create();\nLogger.log(ScriptApp.getProjectTriggers()[0]\n .getHandlerFunction()); // logs \"myFunction\"\n```\n\n#### Return\n\n\n`String` --- the method name\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/script.scriptapp`\n\n*** ** * ** ***\n\n### `get``Trigger``Source()`\n\nReturns the source of events that will cause the trigger to fire.\n\nFor example, a spreadsheet onEdit trigger would return SPREADSHEETS, or a time based trigger\nwould return CLOCK.\n\n```javascript\nconst triggers = ScriptApp.getProjectTriggers();\nfor (let i = 0; i \u003c triggers.length; i++) {\n if (triggers[i].getTriggerSource() === ScriptApp.TriggerSource.CLOCK) {\n Logger.log(`${triggers[i].getUniqueId()} source is clock`);\n } else if (\n triggers[i].getTriggerSource() === ScriptApp.TriggerSource.SPREADSHEETS) {\n Logger.log(`${triggers[i].getUniqueId()} source is spreadsheets`);\n }\n}\n```\n\n#### Return\n\n\n[TriggerSource](/apps-script/reference/script/trigger-source) --- the publisher this is a trigger for\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/script.scriptapp`\n\n*** ** * ** ***\n\n### `get``Trigger``Source``Id()`\n\nReturns the id specific to the source.\n\nFor example, if the trigger source is a spreadsheet, this would be the id of the\nspreadsheet. For clock events this returns null.\n\n#### Return\n\n\n`String` --- the id of the entity in the publisher that this is a trigger for\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/script.scriptapp`\n\n*** ** * ** ***\n\n### `get``Unique``Id()`\n\nReturns a unique identifier that can be used to distinguish triggers from each other.\n\n#### Return\n\n\n`String` --- the unique identifier of the trigger\n\n#### Authorization\n\nScripts that use this method require authorization with one or more of the following [scopes](/apps-script/concepts/scopes#setting_explicit_scopes):\n\n- `https://www.googleapis.com/auth/script.scriptapp`"]]
