این سرویس دسترسی به محرک های اسکریپت و انتشار اسکریپت را فراهم می کند.
کلاس ها
| نام | شرح مختصر |
|---|---|
Auth Mode | شمارشی که مشخص می‌کند کدام دسته از سرویس‌های مجاز Apps Script می‌تواند از طریق یک تابع راه‌اندازی شده اجرا شود. |
Authorization Info | شی مورد استفاده برای تعیین اینکه آیا کاربر نیاز به مجوز این اسکریپت برای استفاده از یک یا چند سرویس دارد یا خیر و برای ارائه URL برای گفتگوی مجوز استفاده می شود. |
Authorization Status | شمارشی که وضعیت مجوز یک اسکریپت را نشان می دهد. |
Calendar Trigger Builder | سازنده برای محرک های تقویم. |
Clock Trigger Builder | سازنده برای تریگرهای ساعت. |
Document Trigger Builder | سازنده برای محرک های سند. |
Event Type | شمارشی که نوع رویداد راه اندازی شده را نشان می دهد. |
Form Trigger Builder | سازنده برای محرک های فرم. |
Installation Source | شمارشی که نشان می دهد چگونه اسکریپت به عنوان یک افزونه برای کاربر فعلی نصب شد. |
Script App | دسترسی و دستکاری انتشار اسکریپت و محرک ها. |
Service | دسترسی و دستکاری انتشار اسکریپت. |
Spreadsheet Trigger Builder | سازنده برای محرک های صفحه گسترده. |
State Token Builder | به اسکریپت‌ها اجازه می‌دهد تا توکن‌های حالت ایجاد کنند که می‌توانند در APIهای برگشت تماس (مانند جریان‌های OAuth) استفاده شوند. |
Trigger | یک محرک اسکریپت. |
Trigger Builder | یک سازنده عمومی برای محرک های اسکریپت. |
Trigger Source | شمارشی که نشان دهنده منبع رویدادی است که باعث شلیک ماشه می شود. |
Auth Mode
خواص
| اموال | تایپ کنید | توضیحات |
|---|---|---|
NONE | Enum | حالتی که اجازه دسترسی به خدماتی که نیاز به مجوز دارند را نمی دهد. |
CUSTOM_FUNCTION | Enum | حالتی که امکان دسترسی به زیرمجموعه محدودی از خدمات را برای استفاده در عملکردهای صفحه گسترده سفارشی فراهم می کند. |
LIMITED | Enum | حالتی که امکان دسترسی به زیرمجموعه محدودی از خدمات را فراهم می کند. |
FULL | Enum | حالتی که امکان دسترسی به تمام خدماتی که نیاز به مجوز دارند را می دهد. |
Authorization Info
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
get Authorization Status() | Authorization Status | مقداری دریافت می‌کند که نشان می‌دهد آیا کاربر باید برای استفاده از یک یا چند سرویس به این اسکریپت مجوز دهد (مثلاً Script App.AuthorizationStatus.REQUIRED ). |
get Authorization Url() | String | URL مجوزی را دریافت می کند که می تواند برای اعطای دسترسی به اسکریپت استفاده شود. |
Authorization Status
خواص
| اموال | تایپ کنید | توضیحات |
|---|---|---|
REQUIRED | Enum | کاربر برای استفاده از یک یا چند سرویس باید به این اسکریپت مجوز دهد. |
NOT_REQUIRED | Enum | کاربر تمام مجوزهایی را که در حال حاضر نیاز دارد به این اسکریپت داده است. |
Calendar Trigger Builder
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
create() | Trigger | ماشه را ایجاد می کند و آن را برمی گرداند. |
on Event Updated() | Calendar Trigger Builder | ماشه ای را مشخص می کند که هنگام ایجاد، به روز رسانی یا حذف یک ورودی تقویم فعال می شود. |
Clock Trigger Builder
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
after(durationMilliseconds) | Clock Trigger Builder | حداقل مدت زمان (بر حسب میلی ثانیه) را پس از زمان فعلی که ماشه اجرا می کند، مشخص می کند. |
at(date) | Clock Trigger Builder | مشخص می کند که ماشه چه زمانی اجرا شود. |
at Date(year, month, day) | Clock Trigger Builder | مشخص می کند که ماشه در تاریخ معین، به طور پیش فرض نزدیک نیمه شب (+/- 15 دقیقه) فعال می شود. |
at Hour(hour) | Clock Trigger Builder | ساعتی را مشخص می کند که ماشه در آن تریگر اجرا می شود. |
create() | Trigger | ماشه را ایجاد می کند. |
every Days(n) | Clock Trigger Builder | مشخص می کند که تریگر هر n روز یکبار اجرا شود. |
every Hours(n) | Clock Trigger Builder | مشخص می کند که تریگر هر n ساعت یکبار اجرا شود. |
every Minutes(n) | Clock Trigger Builder | مشخص می کند که ماشه هر n دقیقه یکبار اجرا شود. |
every Weeks(n) | Clock Trigger Builder | مشخص می کند که تریگر هر n هفته یکبار اجرا شود. |
in Timezone(timezone) | Clock Trigger Builder | منطقه زمانی را برای تاریخ‌ها/زمان‌های مشخص شده زمانی که تریگر اجرا می‌شود، مشخص می‌کند. |
near Minute(minute) | Clock Trigger Builder | دقیقه ای را که در آن ماشه کار می کند (به اضافه یا منهای 15 دقیقه) مشخص می کند. |
on Month Day(day) | Clock Trigger Builder | تاریخ در ماه اجرا شدن تریگر را مشخص می کند. |
on Week Day(day) | Clock Trigger Builder | روزی از هفته را مشخص می کند که ماشه اجرا می شود. |
Document Trigger Builder
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
create() | Trigger | تریگر جدید را ایجاد و برمی گرداند. |
on Open() | Document Trigger Builder | ماشه ای را مشخص می کند که با باز شدن سند فعال می شود. |
Event Type
خواص
| اموال | تایپ کنید | توضیحات |
|---|---|---|
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 ایجاد، به‌روزرسانی یا حذف شود، ماشه فعال می‌شود. |
Form Trigger Builder
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
create() | Trigger | تریگر جدید را ایجاد و برمی گرداند. |
on Form Submit() | Form Trigger Builder | ماشه ای را مشخص می کند که هنگام ارسال پاسخ به فرم فعال می شود. |
on Open() | Form Trigger Builder | ماشه ای را مشخص می کند که با باز شدن نمای ویرایش فرم فعال شود. |
Installation Source
خواص
| اموال | تایپ کنید | توضیحات |
|---|---|---|
APPS_MARKETPLACE_DOMAIN_ADD_ON | Enum | افزونه توسط سرپرست برای دامنه کاربر نصب شده است. |
NONE | Enum | اسکریپت به عنوان یک افزونه اجرا نمی شود. |
WEB_STORE_ADD_ON | Enum | افزونه توسط کاربر از فروشگاه وب Chrome نصب شده است. |
Script App
خواص
| اموال | تایپ کنید | توضیحات |
|---|---|---|
Auth Mode | Auth Mode | شمارشی که مشخص می‌کند کدام دسته از سرویس‌های مجاز Apps Script می‌تواند از طریق یک تابع راه‌اندازی شده اجرا شود. |
Authorization Status | Authorization Status | شمارشی که وضعیت مجوز یک اسکریپت را نشان می دهد. |
Event Type | Event Type | شمارشی که نوع رویداد راه اندازی شده را نشان می دهد. |
Installation Source | Installation Source | شمارشی که نشان می دهد چگونه اسکریپت به عنوان یک افزونه برای کاربر نصب شده است. |
Trigger Source | Trigger Source | شمارشی که نشان دهنده منبع رویدادی است که باعث شلیک ماشه می شود. |
Week Day | Weekday | شمارشی که بیانگر روزهای هفته است. |
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
delete Trigger(trigger) | void | ماشه داده شده را حذف می کند تا دیگر اجرا نشود. |
get Authorization Info(authMode) | Authorization Info | برای تعیین اینکه آیا کاربر برای استفاده از یک یا چند سرویس باید به این اسکریپت مجوز دهد یا خیر و برای ارائه URL برای گفتگوی مجوز، یک شی را دریافت می کند. |
get Identity Token() | String | در صورتی که محدوده openid اعطا شده باشد، یک رمز هویت Open ID Connect برای کاربر موثر دریافت می کند. |
get Installation Source() | Installation Source | یک مقدار enum را برمی‌گرداند که نشان می‌دهد چگونه اسکریپت به‌عنوان یک افزونه برای کاربر فعلی نصب شده است (برای مثال، اینکه آیا کاربر آن را شخصاً از طریق فروشگاه وب Chrome نصب کرده است یا اینکه یک سرپرست دامنه آن را برای همه کاربران نصب کرده است). |
get OAuth Token() | String | کد دسترسی OAuth 2.0 را برای کاربر مؤثر دریافت می کند. |
get Project Triggers() | Trigger[] | همه محرک های قابل نصب مرتبط با پروژه فعلی و کاربر فعلی را دریافت می کند. |
get Script Id() | String | شناسه منحصر به فرد پروژه اسکریپت را دریافت می کند. |
get Service() | Service | یک شی را برای کنترل انتشار اسکریپت به عنوان یک برنامه وب استفاده می کند. |
get User Triggers(document) | Trigger[] | تمام محرک های قابل نصب متعلق به این کاربر را در سند داده شده، فقط برای این اسکریپت یا افزونه دریافت می کند. |
get User Triggers(form) | Trigger[] | تمام محرک‌های قابل نصب متعلق به این کاربر را در فرم داده شده، فقط برای این اسکریپت یا افزونه دریافت می‌کند. |
get User Triggers(spreadsheet) | Trigger[] | همه محرک‌های قابل نصب متعلق به این کاربر را در صفحه‌گسترده داده شده، فقط برای این اسکریپت یا افزونه دریافت می‌کند. |
invalidate Auth() | void | مجوزی را که کاربر موثر برای اجرای اسکریپت فعلی دارد، بی اعتبار می کند. |
new State Token() | State Token Builder | سازنده ای برای یک نشانه وضعیت ایجاد می کند که می تواند در یک API برگشتی (مانند جریان OAuth) استفاده شود. |
new Trigger(functionName) | Trigger Builder | فرآیند ایجاد یک تریگر قابل نصب را آغاز می کند که هنگام روشن شدن، یک تابع معین را فراخوانی می کند. |
Service
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
get Url() | String | URL برنامه وب را در صورتی که مستقر شده باشد برمی گرداند. در غیر این صورت null برمی گرداند. |
is Enabled() | Boolean | اگر اسکریپت به عنوان یک برنامه وب قابل دسترسی باشد، true برمی‌گرداند. |
Spreadsheet Trigger Builder
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
create() | Trigger | ماشه را ایجاد می کند و آن را برمی گرداند. |
on Change() | Spreadsheet Trigger Builder | ماشه ای را مشخص می کند که با تغییر محتوا یا ساختار صفحه گسترده فعال می شود. |
on Edit() | Spreadsheet Trigger Builder | ماشه ای را مشخص می کند که هنگام ویرایش صفحه گسترده فعال می شود. |
on Form Submit() | Spreadsheet Trigger Builder | ماشه‌ای را مشخص می‌کند که وقتی صفحه‌گسترده فرمی به آن ارسال شود، فعال می‌شود. |
on Open() | Spreadsheet Trigger Builder | ماشه ای را مشخص می کند که با باز شدن صفحه گسترده فعال می شود. |
State Token Builder
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
create Token() | String | یک نمایش رشته رمزگذاری شده از نشانه حالت می سازد. |
with Argument(name, value) | State Token Builder | یک آرگومان به توکن اضافه می کند. |
with Method(method) | State Token Builder | یک عملکرد برگشت به تماس را تنظیم می کند. |
with Timeout(seconds) | State Token Builder | مدت زمانی (بر حسب ثانیه) که توکن برای آن معتبر است را تنظیم می کند. |
Trigger
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
get Event Type() | Event Type | نوع رویدادی را برمی‌گرداند که تریگر در آن فعال می‌شود. |
get Handler Function() | String | تابعی را برمی‌گرداند که هنگام روشن شدن تریگر فراخوانی می‌شود. |
get Trigger Source() | Trigger Source | منبع رویدادهایی را برمی‌گرداند که باعث شلیک ماشه می‌شوند. |
get Trigger Source Id() | String | شناسه اختصاصی منبع را برمی‌گرداند. |
get Unique Id() | String | یک شناسه منحصربه‌فرد را برمی‌گرداند که می‌توان از آن برای تشخیص محرک‌ها از یکدیگر استفاده کرد. |
Trigger Builder
روش ها
| روش | نوع برگشت | شرح مختصر |
|---|---|---|
for Document(document) | Document Trigger Builder | یک Document Trigger Builder متصل به سند داده شده ایجاد و برمی گرداند. |
for Document(key) | Document Trigger Builder | یک Document Trigger Builder متصل به سند با شناسه داده شده ایجاد و برمی گرداند. |
for Form(form) | Form Trigger Builder | Form Trigger Builder متصل به فرم داده شده را ایجاد و برمی گرداند. |
for Form(key) | Form Trigger Builder | یک Form Trigger Builder که با شناسه داده شده به فرم گره خورده است ایجاد و برمی گرداند. |
for Spreadsheet(sheet) | Spreadsheet Trigger Builder | یک Spreadsheet Trigger Builder متصل به صفحه گسترده داده شده ایجاد و برمی گرداند. |
for Spreadsheet(key) | Spreadsheet Trigger Builder | یک Spreadsheet Trigger Builder متصل به صفحه گسترده با شناسه داده شده ایجاد و برمی گرداند. |
for User Calendar(emailId) | Calendar Trigger Builder | سازنده را برای راه‌اندازهای تقویم ساختمان برمی‌گرداند. |
time Based() | Clock Trigger Builder | یک Clock Trigger Builder را برای ساخت تریگرهای مبتنی بر زمان ایجاد و برمی گرداند. |
Trigger Source
خواص
| اموال | تایپ کنید | توضیحات |
|---|---|---|
SPREADSHEETS | Enum | Google Sheets باعث فعال شدن ماشه می شود. |
CLOCK | Enum | یک رویداد زمان محور باعث شلیک ماشه می شود. |
FORMS | Enum | Google Forms باعث فعال شدن ماشه می شود. |
DOCUMENTS | Enum | Google Docs باعث فعال شدن ماشه می شود. |
CALENDAR | Enum | Google Calendar باعث فعال شدن ماشه می شود. |