Script Service

اسکریپت

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

کلاس‌ها

نام شرح مختصر
Auth Mode یک شمارش که مشخص می‌کند کدام دسته از سرویس‌های مجاز Apps Script قادر به اجرای یک تابع فعال‌شده هستند.
Authorization Info شیء‌ای که بررسی می‌کند آیا کاربر مجوز لازم برای محدوده‌های مورد نیاز اسکریپت را اعطا کرده است یا خیر.
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|null URL مجوزی را که می‌تواند برای اعطای دسترسی به اسکریپت استفاده شود، دریافت می‌کند.
get Authorized Scopes() String[]|null لیستی از محدوده‌های مجاز برای اسکریپت را دریافت می‌کند.

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 زمان اجرای trigger را مشخص می‌کند.
at Date(year, month, day) Clock Trigger Builder مشخص می‌کند که تریگر در تاریخ داده شده، به طور پیش‌فرض نزدیک نیمه‌شب (+/- ۱۵ دقیقه) فعال شود.
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 دقیقه‌ای را که تریگر در آن اجرا می‌شود (به‌علاوه یا منهای ۱۵ دقیقه) مشخص می‌کند.
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 Sheets را ویرایش کند (برای مثال، با وارد کردن یک مقدار جدید در یک سلول که به عنوان یک ویرایش به جای یک تغییر محسوب می‌شود).
ON_FORM_SUBMIT Enum این تریگر زمانی فعال می‌شود که کاربر به یک فرم گوگل پاسخ دهد.
ON_CHANGE Enum این تریگر زمانی فعال می‌شود که کاربر فایل Google Sheets را تغییر دهد (برای مثال، با اضافه کردن یک ردیف که به عنوان یک تغییر به جای ویرایش محسوب می‌شود).
ON_EVENT_UPDATED Enum این تریگر زمانی فعال می‌شود که یک رویداد در تقویم گوگل مشخص‌شده ایجاد، به‌روزرسانی یا حذف شود.

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 افزونه توسط کاربر از فروشگاه وب کروم نصب شده است.

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 شیء‌ای را دریافت می‌کند که بررسی می‌کند آیا کاربر مجوز لازم برای تمام الزامات اسکریپت را اعطا کرده است یا خیر.
get Authorization Info(authMode, oAuthScopes) Authorization Info شیء‌ای را دریافت می‌کند که بررسی می‌کند آیا کاربر مجوز دسترسی به محدوده‌های درخواستی را اعطا کرده است یا خیر.
get Identity Token() String|null اگر دامنه openid اعطا شده باشد، یک توکن هویت Open ID Connect برای کاربر مؤثر دریافت می‌کند.
get Installation Source() Installation Source یک مقدار شمارشی را برمی‌گرداند که نشان می‌دهد اسکریپت چگونه به عنوان یک افزونه برای کاربر فعلی نصب شده است (برای مثال، آیا کاربر آن را شخصاً از طریق فروشگاه وب کروم نصب کرده است یا اینکه یک مدیر دامنه آن را برای همه کاربران نصب کرده است).
get OAuth Token() String توکن دسترسی OAuth 2.0 را برای کاربر فعال دریافت می‌کند.
get Project Triggers() Trigger[] تمام 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 فرآیند ایجاد یک تریگر قابل نصب را آغاز می‌کند که هنگام اجرا، یک تابع مشخص را فراخوانی می‌کند.
require All Scopes(authMode) void تأیید می‌کند که آیا کاربر برای تمام حوزه‌های درخواست‌شده توسط اسکریپت رضایت داده است یا خیر.
require Scopes(authMode, oAuthScopes) void تأیید می‌کند که آیا کاربر برای محدوده‌های درخواستی رضایت داده است یا خیر.

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 یک تابع فراخوانی (callback) تنظیم می‌کند.
with Timeout(seconds) State Token Builder مدت زمان (بر حسب ثانیه) اعتبار توکن را تعیین می‌کند.

Trigger

روش‌ها

روش نوع بازگشتی شرح مختصر
get Event Type() Event Type نوع رویدادی را که تریگر در آن فعال می‌شود، برمی‌گرداند.
get Handler Function() String تابعی را برمی‌گرداند که هنگام فعال شدن تریگر فراخوانی خواهد شد.
get Trigger Source() Trigger Source منبع رویدادهایی را که باعث فعال شدن trigger می‌شوند، برمی‌گرداند.
get Trigger Source Id() String شناسه (id) مختص منبع را برمی‌گرداند.
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 گوگل شیت باعث فعال شدن تریگر می‌شود.
CLOCK Enum یک رویداد وابسته به زمان باعث فعال شدن ماشه می‌شود.
FORMS Enum گوگل فرم باعث فعال شدن تریگر می‌شود.
DOCUMENTS Enum گوگل داکس باعث فعال شدن ماشه می‌شود.
CALENDAR Enum تقویم گوگل باعث فعال شدن ماشه می‌شود.