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|nullتعرض هذه الدالة عنوان URL للتفويض يمكن استخدامه لمنح إذن الوصول إلى النص البرمجي.
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" أو "جداول بيانات 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|nullيحصل على رمز مميّز لهوية OpenID Connect للمستخدم الفعّال، إذا تم منح النطاق openid.
getInstallationSource()InstallationSourceتعرض هذه الدالة قيمة تعدادية تشير إلى كيفية تثبيت البرنامج النصي كإضافة للمستخدم الحالي (على سبيل المثال، ما إذا كان المستخدم قد ثبّته شخصيًا من خلال "سوق Chrome الإلكتروني"، أو ما إذا كان مشرف النطاق قد ثبّته لجميع المستخدمين).
getOAuthToken()Stringتعرض هذه الطريقة رمز الدخول المميز من الإصدار 2.0 من OAuth للمستخدم الفعلي.
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" في تشغيل المشغّل.