Script Service

Script

توفّر هذه الخدمة إمكانية الوصول إلى عوامل تشغيل النصوص البرمجية ونشرها.

صفوف

الاسموصف قصير
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تحصل على عنوان URL للتفويض الذي يمكن استخدامه لمنح إذن الوصول إلى النص البرمجي.
getAuthorizedScopes()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" أو "جداول بيانات Google" أو "نماذج Google".
ON_EDITEnumيتم تنشيط العامل المشغِّل بعد أن يعدّل المستخدم ملف "جداول بيانات Google" (على سبيل المثال، من خلال إدخال قيمة جديدة في خلية، ما يُعدّ تعديلاً بدلاً من تغيير).
ON_FORM_SUBMITEnumيتم بدء الإجراء المشغِّل بعد أن يردّ المستخدم على نموذج Google.
ON_CHANGEEnumيتم تنشيط العامل المشغِّل بعد أن يغيّر المستخدم ملف "جداول بيانات Google" (على سبيل المثال، من خلال إضافة صف، يُحتسَب ذلك كتغيير بدلاً من تعديل).
ON_EVENT_UPDATEDEnumيتم تشغيل عامل التفعيل بعد إنشاء حدث أو تعديله أو حذفه في "تقويم Google" المحدّد.

FormTriggerBuilder

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
create()Triggerلإنشاء عامل التشغيل الجديد وإرجاعه
onFormSubmit()FormTriggerBuilderتُحدِّد عامل تشغيل سيتم تفعيله عند إرسال ردّ إلى النموذج.
onOpen()FormTriggerBuilderتُستخدَم لتحديد عامل تشغيل سيتم تشغيله عند فتح طريقة عرض تعديل النموذج.

InstallationSource

الخصائص

الموقعالنوعالوصف
APPS_MARKETPLACE_DOMAIN_ADD_ONEnumتم تثبيت الإضافة من قِبل المشرف لنطاق المستخدم.
NONEEnumلا يتم تشغيل النص البرمجي كإضافة.
WEB_STORE_ADD_ONEnumثبَّت المستخدم الإضافة من "سوق Chrome الإلكتروني".

ScriptApp

الخصائص

الموقعالنوعالوصف
AuthModeAuthModeقائمة تحدّد فئات الخدمات المعتمَدة التي يمكن لخدمة Apps Script تنفيذها من خلال دالة يتم تنشيطها.
AuthorizationStatusAuthorizationStatusتشير هذه السمة إلى حالة التفويض لنص برمجي.
EventTypeEventTypeتشير هذه السمة إلى نوع الحدث الذي تم تشغيله.
InstallationSourceInstallationSourceتشير هذه السمة إلى كيفية تثبيت النص البرمجي للمستخدم كإضافة.
TriggerSourceTriggerSourceتشير هذه السمة إلى مصدر الحدث الذي يؤدي إلى بدء تشغيل العامل المشغِّل.
WeekDayWeekdayقائمة تمثل أيام الأسبوع

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
deleteTrigger(trigger)voidتزيل هذه العملية عامل التفعيل المحدّد كي لا يتم تشغيله بعد ذلك.
getAuthorizationInfo(authMode)AuthorizationInfoتحصل على عنصر يتحقّق مما إذا كان المستخدم قد منح الإذن لجميع متطلبات الرمز البرمجي.
getAuthorizationInfo(authMode, oAuthScopes)AuthorizationInfoتحصل على عنصر يتحقّق مما إذا كان المستخدم قد منح تفويضًا بالنطاقات المطلوبة.
getIdentityToken()Stringالحصول على رمز تعريف OpenID Connect للمستخدِم الفعّال، في حال منح نطاق openid
getInstallationSource()InstallationSourceتعرِض هذه السمة قيمة عنصر محدّد تشير إلى كيفية تثبيت النص البرمجي كإضافة للمستخدِم الحالي (على سبيل المثال، ما إذا كان المستخدِم قد ثبَّته شخصيًا من خلال "سوق Chrome الإلكتروني"، أو ما إذا كان مشرف نطاق قد ثبَّته لجميع المستخدِمين).
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تعرِض هذه السمة عنوان URL لتطبيق الويب في حال تم نشره، وتعرض 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

الخصائص

الموقعالنوعالوصف
SPREADSHEETSEnumتؤدي "جداول بيانات Google" إلى بدء تشغيل العامل المشغِّل.
CLOCKEnumيؤدي الحدث المستنِد إلى الوقت إلى تشغيل عامل التشغيل.
FORMSEnumتؤدي "نماذج Google" إلى بدء تشغيل عامل التفعيل.
DOCUMENTSEnumتؤدي "مستندات Google" إلى بدء تشغيل عامل التفعيل.
CALENDAREnumيتسبب "تقويم Google" في بدء تشغيل العامل المشغِّل.