Script Service

اسکریپت

این سرویس دسترسی به محرک های اسکریپت و انتشار اسکریپت را فراهم می کند.

کلاس ها

نام توضیح مختصر
AuthMode شمارشی که مشخص می‌کند کدام دسته از سرویس‌های مجاز Apps Script می‌تواند از طریق یک تابع راه‌اندازی شده اجرا شود.
AuthorizationInfo شی مورد استفاده برای تعیین اینکه آیا کاربر نیاز به مجوز این اسکریپت برای استفاده از یک یا چند سرویس دارد یا خیر و برای ارائه URL برای گفتگوی مجوز استفاده می شود.
AuthorizationStatus شمارشی که وضعیت مجوز یک اسکریپت را نشان می دهد.
CalendarTriggerBuilder سازنده برای محرک های تقویم.
ClockTriggerBuilder سازنده برای تریگرهای ساعت.
DocumentTriggerBuilder سازنده برای محرک های سند.
EventType شمارشی که نوع رویداد راه اندازی شده را نشان می دهد.
FormTriggerBuilder سازنده برای محرک های فرم.
InstallationSource شمارشی که نشان می دهد چگونه اسکریپت به عنوان یک افزونه برای کاربر فعلی نصب شد.
ScriptApp دسترسی و دستکاری انتشار اسکریپت و محرک ها.
Service دسترسی و دستکاری انتشار اسکریپت.
SpreadsheetTriggerBuilder سازنده برای محرک های صفحه گسترده.
StateTokenBuilder به اسکریپت‌ها اجازه می‌دهد تا توکن‌های حالت ایجاد کنند که می‌توانند در APIهای برگشت تماس (مانند جریان‌های OAuth) استفاده شوند.
Trigger یک محرک اسکریپت.
TriggerBuilder یک سازنده عمومی برای محرک های اسکریپت.
TriggerSource شمارشی که نشان دهنده منبع رویدادی است که باعث شلیک ماشه می شود.

AuthMode

خواص

ویژگی تایپ کنید شرح
NONE Enum حالتی که اجازه دسترسی به خدماتی که نیاز به مجوز دارند را نمی دهد.
CUSTOM_FUNCTION Enum حالتی که امکان دسترسی به زیرمجموعه محدودی از خدمات را برای استفاده در عملکردهای صفحه گسترده سفارشی فراهم می کند.
LIMITED Enum حالتی که امکان دسترسی به زیرمجموعه محدودی از خدمات را فراهم می کند.
FULL Enum حالتی که امکان دسترسی به تمام خدماتی که نیاز به مجوز دارند را می دهد.

AuthorizationInfo

مواد و روش ها

روش نوع برگشت توضیح مختصر
getAuthorizationStatus() AuthorizationStatus مقداری را دریافت می‌کند که نشان می‌دهد آیا کاربر باید برای استفاده از یک یا چند سرویس به این اسکریپت مجوز دهد (برای مثال ScriptApp.AuthorizationStatus.REQUIRED ).
getAuthorizationUrl() String URL مجوزی را دریافت می کند که می تواند برای اعطای دسترسی به اسکریپت استفاده شود.

AuthorizationStatus

خواص

ویژگی تایپ کنید شرح
REQUIRED Enum کاربر برای استفاده از یک یا چند سرویس باید به این اسکریپت مجوز دهد.
NOT_REQUIRED Enum کاربر تمام مجوزهایی را که در حال حاضر نیاز دارد به این اسکریپت داده است.

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

خواص

ویژگی تایپ کنید شرح
CLOCK Enum هنگامی که رویداد زمان محور به زمان خاصی برسد، ماشه فعال می شود.
ON_OPEN Enum هنگامی که کاربر فایل Google Docs، Sheets یا Forms را باز می کند، ماشه فعال می شود.
ON_EDIT Enum هنگامی که کاربر فایل کاربرگ‌نگار Google را ویرایش می‌کند، ماشه فعال می‌شود (به عنوان مثال، با وارد کردن یک مقدار جدید در یک سلول، که به‌عنوان ویرایش به‌جای تغییر حساب می‌شود).
ON_FORM_SUBMIT Enum هنگامی که کاربر به فرم Google پاسخ می دهد، ماشه فعال می شود.
ON_CHANGE Enum هنگامی که کاربر فایل کاربرگ‌نگار Google را تغییر می‌دهد، ماشه فعال می‌شود (به‌عنوان مثال، با افزودن یک ردیف، که به‌جای ویرایش به‌عنوان تغییر حساب می‌شود).
ON_EVENT_UPDATED Enum هنگامی که رویدادی در تقویم مشخص شده Google ایجاد، به‌روزرسانی یا حذف شود، ماشه فعال می‌شود.

FormTriggerBuilder

مواد و روش ها

روش نوع برگشت توضیح مختصر
create() Trigger ماشه جدید را ایجاد و برمی گرداند.
onFormSubmit() FormTriggerBuilder ماشه ای را مشخص می کند که هنگام ارسال پاسخ به فرم فعال می شود.
onOpen() FormTriggerBuilder ماشه ای را مشخص می کند که با باز شدن نمای ویرایش فرم فعال شود.

InstallationSource

خواص

ویژگی تایپ کنید شرح
APPS_MARKETPLACE_DOMAIN_ADD_ON Enum افزونه توسط سرپرست برای دامنه کاربر نصب شده است.
NONE Enum اسکریپت به عنوان یک افزونه اجرا نمی شود.
WEB_STORE_ADD_ON Enum افزونه توسط کاربر از فروشگاه وب Chrome نصب شده است.

ScriptApp

خواص

ویژگی تایپ کنید شرح
AuthMode AuthMode شمارشی که مشخص می‌کند کدام دسته از سرویس‌های مجاز Apps Script می‌تواند از طریق یک تابع راه‌اندازی شده اجرا شود.
AuthorizationStatus AuthorizationStatus شمارشی که وضعیت مجوز یک اسکریپت را نشان می دهد.
EventType EventType شمارشی که نوع رویداد راه اندازی شده را نشان می دهد.
InstallationSource InstallationSource شمارشی که نشان می دهد چگونه اسکریپت به عنوان یک افزونه برای کاربر نصب شده است.
TriggerSource TriggerSource شمارشی که نشان دهنده منبع رویدادی است که باعث شلیک ماشه می شود.
WeekDay Weekday شمارشی که بیانگر روزهای هفته است.

مواد و روش ها

روش نوع برگشت توضیح مختصر
deleteTrigger(trigger) void ماشه داده شده را حذف می کند تا دیگر اجرا نشود.
getAuthorizationInfo(authMode) AuthorizationInfo برای تعیین اینکه آیا کاربر برای استفاده از یک یا چند سرویس باید به این اسکریپت مجوز دهد یا خیر و برای ارائه URL برای گفتگوی مجوز، یک شی را دریافت می کند.
getIdentityToken() String در صورتی که محدوده openid داده شده باشد، یک رمز هویت OpenID Connect برای کاربر موثر دریافت می کند.
getInstallationSource() InstallationSource یک مقدار enum را برمی‌گرداند که نشان می‌دهد چگونه اسکریپت به‌عنوان یک افزونه برای کاربر فعلی نصب شده است (برای مثال، اینکه آیا کاربر آن را شخصاً از طریق فروشگاه وب 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 سازنده ای برای یک نشانه وضعیت ایجاد می کند که می تواند در یک API برگشتی (مانند جریان OAuth) استفاده شود.
newTrigger(functionName) TriggerBuilder فرآیند ایجاد یک تریگر قابل نصب را آغاز می کند که هنگام روشن شدن، یک تابع معین را فراخوانی می کند.

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

خواص

ویژگی تایپ کنید شرح
SPREADSHEETS Enum Google Sheets باعث فعال شدن ماشه می شود.
CLOCK Enum یک رویداد زمان محور باعث شلیک ماشه می شود.
FORMS Enum Google Forms باعث فعال شدن ماشه می شود.
DOCUMENTS Enum Google Docs باعث فعال شدن ماشه می شود.
CALENDAR Enum Google Calendar باعث فعال شدن ماشه می شود.