Base Service

پایه

این سرویس دسترسی به اطلاعات کاربر مانند آدرس‌های ایمیل و نام‌های کاربری را فراهم می‌کند. همچنین گزارش‌های اسکریپت و کادرهای گفتگو را در برنامه‌های Google Workspace کنترل می‌کند.

کلاس‌ها

نام شرح مختصر
Blob یک شیء تبادل داده برای سرویس‌های Apps Script.
Blob Source رابطی برای اشیایی که می‌توانند داده‌های خود را به صورت Blob صادر کنند.
Browser این کلاس دسترسی به کادرهای محاوره‌ای مخصوص Google Sheets را فراهم می‌کند.
Button یک enum که دکمه‌های محاوره‌ای از پیش تعیین‌شده و محلی‌شده را نشان می‌دهد که توسط یک alert یا Prompt Response.getSelectedButton() برگردانده می‌شود تا نشان دهد کاربر روی کدام دکمه در یک محاوره کلیک کرده است.
Button Set یک enum که نشان‌دهنده‌ی مجموعه‌های از پیش تعیین‌شده و محلی‌شده‌ای از یک یا چند دکمه‌ی محاوره‌ای است که می‌توانند به یک alert یا prompt اضافه شوند.
Color Type انواع رنگ‌ها
Logger این کلاس به توسعه‌دهنده اجازه می‌دهد تا در صورت مرتبط بودن اسکریپت با یک پروژه ابری استاندارد، در گزارش اجرا و در Google Cloud Logging بنویسد.
Menu یک منوی سفارشی در نمونه‌ای از رابط کاربری برای یک برنامه گوگل.
Mime Type یک نوع شمارش که دسترسی به اعلان‌های نوع MIME را بدون تایپ صریح رشته‌ها فراهم می‌کند.
Month یک نوع داده شمارشی (enum) که ماه‌های سال را نشان می‌دهد.
Prompt Response پاسخی به یک کادر prompt که در محیط رابط کاربری یک برنامه گوگل نمایش داده می‌شود.
Rgb Color رنگی که توسط کانال‌های رنگی قرمز، سبز و آبی تعریف می‌شود.
Session کلاس Session دسترسی به اطلاعات session، مانند آدرس ایمیل کاربر (در برخی شرایط) و تنظیمات زبان را فراهم می‌کند.
Ui نمونه‌ای از محیط رابط کاربری برای یک برنامه گوگل که به اسکریپت اجازه می‌دهد ویژگی‌هایی مانند منوها، دیالوگ‌ها و نوارهای کناری را اضافه کند.
User نماینده‌ی یک کاربر، مناسب برای اسکریپت‌نویسی.
Weekday یک enum که روزهای هفته را نشان می‌دهد.
console این کلاس به توسعه‌دهنده اجازه می‌دهد تا در صورت مرتبط بودن اسکریپت با یک پروژه ابری استاندارد، در گزارش اجرا و در Google Cloud Logging بنویسد.

Blob

روش‌ها

روش نوع بازگشتی شرح مختصر
copy Blob() Blob یک کپی از این blob را برمی‌گرداند.
get As(contentType) Blob داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده، برمی‌گرداند.
get Bytes() Byte[] داده‌های ذخیره شده در این blob را دریافت می‌کند.
get Content Type() String نوع محتوای بایت‌های موجود در این blob را دریافت می‌کند.
get Data As String() String داده‌های این blob را به صورت یک رشته با کدگذاری UTF-8 دریافت می‌کند.
get Data As String(charset) String داده‌های این blob را به صورت یک رشته با کدگذاری مشخص شده دریافت می‌کند.
get Name() String نام این لکه را دریافت می‌کند.
is Google Type() Boolean برمی‌گرداند که آیا این blob یک فایل Google Workspace (Sheets، Docs و غیره) است یا خیر.
set Bytes(data) Blob داده‌های ذخیره شده در این blob را تنظیم می‌کند.
set Content Type(contentType) Blob نوع محتوای بایت‌های موجود در این blob را تنظیم می‌کند.
set Content Type From Extension() Blob نوع محتوای بایت‌های موجود در این blob را بر اساس پسوند فایل تنظیم می‌کند.
set Data From String(string) Blob داده‌های این blob را از یک رشته با کدگذاری UTF-8 تنظیم می‌کند.
set Data From String(string, charset) Blob داده‌های این blob را از یک رشته با کدگذاری مشخص شده تنظیم می‌کند.
set Name(name) Blob نام این blob را تنظیم می‌کند.

Blob Source

روش‌ها

روش نوع بازگشتی شرح مختصر
get As(contentType) Blob داده‌های درون این شیء را به صورت یک blob تبدیل‌شده به نوع محتوای مشخص‌شده، برمی‌گرداند.
get Blob() Blob داده‌های درون این شیء را به صورت یک blob برمی‌گرداند.

Browser

خواص

ملک نوع توضیحات
Buttons Button Set

روش‌ها

روش نوع بازگشتی شرح مختصر
input Box(prompt) String|null یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.
input Box(prompt, buttons) String|null یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.
input Box(title, prompt, buttons) String|null یک کادر محاوره‌ای با کادر ورودی متن در مرورگر کاربر ظاهر می‌شود.
msg Box(prompt) String|null یک کادر محاوره‌ای حاوی پیام داده شده و یک دکمه‌ی تأیید در مرورگر کاربر ظاهر می‌شود.
msg Box(prompt, buttons) String|null یک کادر محاوره‌ای حاوی پیام داده شده و دکمه‌های مشخص شده در مرورگر کاربر، نمایش می‌دهد.
msg Box(title, prompt, buttons) String|null یک کادر محاوره‌ای با عنوان، پیام و دکمه‌های مشخص شده در مرورگر کاربر نمایش داده می‌شود.

Button

خواص

ملک نوع توضیحات
CLOSE Enum دکمه‌ی استاندارد بستن که در نوار عنوان هر پنجره‌ی محاوره‌ای نمایش داده می‌شود.
OK Enum یک دکمه «تأیید»، که نشان می‌دهد عملیات باید ادامه یابد.
CANCEL Enum دکمه‌ی «لغو»، که نشان می‌دهد عملیات نباید ادامه یابد.
YES Enum دکمه «بله»، که نشان‌دهنده پاسخ مثبت به یک سوال است.
NO Enum دکمه «خیر»، که نشان‌دهنده پاسخ منفی به یک سوال است.

Button Set

خواص

ملک نوع توضیحات
OK Enum یک دکمه‌ی «تأیید»، نشان‌دهنده‌ی یک پیام اطلاعاتی است که فقط می‌توان آن را نادیده گرفت.
OK_CANCEL Enum یک دکمه «تایید» و یک دکمه «لغو»، که به کاربر اجازه می‌دهد عملیات را ادامه دهد یا متوقف کند.
YES_NO Enum یک دکمه «بله» و یک دکمه «خیر»، که به کاربر اجازه می‌دهد به یک سوال بله/خیر پاسخ دهد.
YES_NO_CANCEL Enum یک دکمه «بله»، یک دکمه «خیر» و یک دکمه «لغو»، که به کاربر اجازه می‌دهد به یک سوال بله/خیر پاسخ دهد یا عملیات را متوقف کند.

Color Type

خواص

ملک نوع توضیحات
UNSUPPORTED Enum نوع رنگی که پشتیبانی نمی‌شود.
RGB Enum رنگی که توسط کانال‌های رنگی قرمز، سبز و آبی تعریف می‌شود.
THEME Enum رنگی که به یک ورودی در طرح رنگ قالب اشاره دارد.

Logger

روش‌ها

روش نوع بازگشتی شرح مختصر
clear() void لاگ را پاک می‌کند.
get Log() String لیست کاملی از پیام‌های موجود در لاگ فعلی را برمی‌گرداند.
log(data) Logger داده‌ها را در لاگ می‌نویسد.
log(format, values) Logger با استفاده از قالب و مقادیر ارائه شده، یک رشته قالب‌بندی شده را در کنسول ثبت وقایع می‌نویسد.

روش‌ها

روش نوع بازگشتی شرح مختصر
add Item(caption, functionName) Menu یک آیتم به منو اضافه می‌کند.
add Separator() Menu یک جداکننده بصری به منو اضافه می‌کند.
add Sub Menu(menu) Menu یک زیرمنو به منو اضافه می‌کند.
add To Ui() void منو را در نمونه رابط کاربری ویرایشگر درج می‌کند.

Mime Type

خواص

ملک نوع توضیحات
GOOGLE_APPS_SCRIPT Enum نمایش نوع MIME برای یک پروژه اسکریپت Google Apps.
GOOGLE_DRAWINGS Enum نمایش نوع MIME برای یک فایل Google Drawings.
GOOGLE_DOCS Enum نمایش نوع MIME برای یک فایل Google Docs.
GOOGLE_FORMS Enum نمایش نوع MIME برای یک فایل Google Forms.
GOOGLE_SHEETS Enum نمایش نوع MIME برای یک فایل Google Sheets.
GOOGLE_SITES Enum نمایش نوع MIME برای یک فایل Google Sites.
GOOGLE_SLIDES Enum نمایش نوع MIME برای یک فایل اسلایدهای گوگل.
FOLDER Enum نمایش نوع MIME برای یک پوشه گوگل درایو.
SHORTCUT Enum نمایش نوع MIME برای میانبر گوگل درایو.
BMP Enum نمایش نوع MIME برای یک فایل تصویری BMP (معمولاً ‎.bmp).
GIF Enum نمایش نوع MIME برای یک فایل تصویری GIF (معمولاً .gif).
JPEG Enum نمایش نوع MIME برای یک فایل تصویری JPEG (معمولاً .jpg).
PNG Enum نمایش نوع MIME برای یک فایل تصویری PNG (معمولاً ‎.png).
SVG Enum نمایش نوع MIME برای یک فایل تصویری SVG (معمولاً .svg).
PDF Enum نمایش نوع MIME برای یک فایل PDF (معمولاً .pdf).
CSS Enum نمایش نوع MIME برای یک فایل متنی CSS (معمولاً ‎.css).
CSV Enum نمایش نوع MIME برای یک فایل متنی CSV (معمولاً ‎.csv).
HTML Enum نمایش نوع MIME برای یک فایل متنی HTML (معمولاً ‎.html).
JAVASCRIPT Enum نمایش نوع MIME برای یک فایل متنی جاوا اسکریپت (معمولاً .js).
PLAIN_TEXT Enum نمایش نوع MIME برای یک فایل متنی ساده (معمولاً ‎.txt).
RTF Enum نمایش نوع MIME برای یک فایل متنی غنی (معمولاً ‎.rtf).
OPENDOCUMENT_GRAPHICS Enum نمایش نوع MIME برای یک فایل گرافیکی OpenDocument (معمولاً .odg).
OPENDOCUMENT_PRESENTATION Enum نمایش نوع MIME برای یک فایل ارائه OpenDocument (معمولاً .odp).
OPENDOCUMENT_SPREADSHEET Enum نمایش نوع MIME برای یک فایل صفحه گسترده OpenDocument (معمولاً ‎.ods).
OPENDOCUMENT_TEXT Enum نمایش نوع MIME برای یک فایل پردازش متن OpenDocument (معمولاً .odt).
MICROSOFT_EXCEL Enum نمایش نوع MIME برای یک فایل صفحه گسترده مایکروسافت اکسل (معمولاً ‎.xlsx).
MICROSOFT_EXCEL_LEGACY Enum نمایش نوع MIME برای یک فایل قدیمی مایکروسافت اکسل (معمولاً ‎.xls).
MICROSOFT_POWERPOINT Enum نمایش نوع MIME برای فایل ارائه مایکروسافت پاورپوینت (معمولاً ‎.pptx).
MICROSOFT_POWERPOINT_LEGACY Enum نمایش نوع MIME برای یک فایل قدیمی مایکروسافت پاورپوینت (معمولاً .ppt).
MICROSOFT_WORD Enum نمایش نوع MIME برای یک فایل سند مایکروسافت ورد (معمولاً ‎.docx).
MICROSOFT_WORD_LEGACY Enum نمایش نوع MIME برای یک فایل قدیمی مایکروسافت ورد (معمولاً ‎.doc).
ZIP Enum نمایش نوع MIME برای یک فایل آرشیو ZIP (معمولاً ‎.zip).

Month

خواص

ملک نوع توضیحات
JANUARY Enum ژانویه (ماه اول).
FEBRUARY Enum فوریه (ماه دوم).
MARCH Enum مارس (ماه سوم).
APRIL Enum آوریل (ماه چهارم).
MAY Enum ماه مه (ماه پنجم).
JUNE Enum ژوئن (ماه ششم).
JULY Enum ژوئیه (ماه هفتم).
AUGUST Enum آگوست (ماه هشتم).
SEPTEMBER Enum سپتامبر (ماه نهم).
OCTOBER Enum اکتبر (ماه دهم).
NOVEMBER Enum نوامبر (ماه یازدهم).
DECEMBER Enum دسامبر (ماه دوازدهم).

Prompt Response

روش‌ها

روش نوع بازگشتی شرح مختصر
get Response Text() String متنی را که کاربر در فیلد ورودی کادر محاوره‌ای وارد کرده است، برمی‌گرداند.
get Selected Button() Button دکمه‌ای را که کاربر برای بستن پنجره‌ی محاوره‌ای کلیک کرده است، برمی‌گرداند.

Rgb Color

روش‌ها

روش نوع بازگشتی شرح مختصر
as Hex String() String رنگ را به صورت یک رشته هگزادسیمال ۷ کاراکتری به سبک CSS (#rrggbb) یا رشته هگزادسیمال ۹ کاراکتری (#aarrggbb) برمی‌گرداند.
get Blue() Integer کانال آبی این رنگ، به صورت عددی از ۰ تا ۲۵۵.
get Color Type() Color Type نوع این رنگ را بدست آورید.
get Green() Integer کانال سبز این رنگ، به صورت عددی از ۰ تا ۲۵۵.
get Red() Integer کانال قرمز این رنگ، به صورت عددی از ۰ تا ۲۵۵.

Session

روش‌ها

روش نوع بازگشتی شرح مختصر
get Active User() User اطلاعات مربوط به کاربر فعلی را دریافت می‌کند.
get Active User Locale() String تنظیمات زبان کاربر فعلی را به صورت یک رشته دریافت می‌کند - برای مثال، en برای انگلیسی.
get Effective User() User اطلاعاتی در مورد کاربری که اسکریپت تحت اختیار او در حال اجرا است، دریافت می‌کند.
get Script Time Zone() String منطقه زمانی اسکریپت را دریافت می‌کند.
get Temporary Active User Key() String یک کلید موقت دریافت می‌کند که مختص کاربر فعال است اما هویت کاربر را فاش نمی‌کند.

Ui

خواص

ملک نوع توضیحات
Button Button یک enum که دکمه‌های محاوره‌ای از پیش تعیین‌شده و محلی‌شده را نشان می‌دهد که توسط یک alert یا Prompt Response.getSelectedButton() برگردانده می‌شود تا نشان دهد کاربر روی کدام دکمه در یک محاوره کلیک کرده است.
Button Set Button Set یک enum که نشان‌دهنده‌ی مجموعه‌های از پیش تعیین‌شده و محلی‌شده‌ای از یک یا چند دکمه‌ی محاوره‌ای است که می‌توانند به یک هشدار یا اعلان اضافه شوند.

روش‌ها

روش نوع بازگشتی شرح مختصر
alert(prompt) Button یک کادر محاوره‌ای در ویرایشگر کاربر با پیام داده شده و یک دکمه "OK" باز می‌کند.
alert(prompt, buttons) Button یک کادر محاوره‌ای در ویرایشگر کاربر با پیام داده شده و مجموعه‌ای از دکمه‌ها باز می‌کند.
alert(title, prompt, buttons) Button یک کادر محاوره‌ای در ویرایشگر کاربر با عنوان، پیام و مجموعه‌ای از دکمه‌های داده شده باز می‌کند.
create Addon Menu() Menu یک سازنده ایجاد می‌کند که می‌تواند برای درج یک زیرمنو در منوی افزونه‌های ویرایشگر استفاده شود.
create Menu(caption) Menu یک سازنده ایجاد می‌کند که می‌تواند برای افزودن منو به رابط کاربری ویرایشگر استفاده شود.
prompt(prompt) Prompt Response یک کادر محاوره‌ای ورودی در ویرایشگر کاربر با پیام داده شده و یک دکمه "OK" باز می‌کند.
prompt(prompt, buttons) Prompt Response یک کادر محاوره‌ای ورودی در ویرایشگر کاربر با پیام داده شده و مجموعه‌ای از دکمه‌ها باز می‌کند.
prompt(title, prompt, buttons) Prompt Response یک کادر محاوره‌ای ورودی در ویرایشگر کاربر با عنوان، پیام و مجموعه‌ای از دکمه‌های داده شده باز می‌کند.
show Modal Dialog(userInterface, title) void یک کادر محاوره‌ای modal را در ویرایشگر کاربر با محتوای سفارشی سمت کلاینت باز می‌کند.
show Modeless Dialog(userInterface, title) void یک کادر محاوره‌ای بدون مدل در ویرایشگر کاربر با محتوای سفارشی سمت کلاینت باز می‌کند.
show Sidebar(userInterface) void یک نوار کناری در ویرایشگر کاربر با محتوای سفارشی سمت کلاینت باز می‌کند.

User

روش‌ها

روش نوع بازگشتی شرح مختصر
get Email() String در صورت وجود، آدرس ایمیل کاربر را دریافت می‌کند.

Weekday

خواص

ملک نوع توضیحات
SUNDAY Enum یکشنبه.
MONDAY Enum دوشنبه.
TUESDAY Enum سه‌شنبه
WEDNESDAY Enum چهارشنبه.
THURSDAY Enum پنجشنبه.
FRIDAY Enum جمعه.
SATURDAY Enum شنبه.

console

روش‌ها

روش نوع بازگشتی شرح مختصر
error() void یک پیام با سطح خطای خالی به Stackdriver Logging ارسال می‌کند.
error(formatOrObject, values) void یک پیام سطح خطا (ERROR) را به Stackdriver Logging ارسال می‌کند.
info() void پیام سطح INFO خالی را به Stackdriver Logging ارسال می‌کند.
info(formatOrObject, values) void یک پیام سطح INFO را به Stackdriver Logging ارسال می‌کند.
log() void یک پیام سطح DEBUG خالی به Stackdriver Logging ارسال می‌کند.
log(formatOrObject, values) void یک پیام سطح DEBUG را به Stackdriver Logging ارسال می‌کند.
time(label) void تایمری را شروع می‌کند که می‌توانید از آن برای پیگیری مدت زمان انجام یک عملیات استفاده کنید.
time End(label) void تایمری را که قبلاً با فراخوانی console.time() شروع شده بود، متوقف می‌کند.
warn() void یک پیام سطح هشدار خالی به Stackdriver Logging ارسال می‌کند.
warn(formatOrObject, values) void یک پیام سطح هشدار (WARNING) را به Stackdriver Logging ارسال می‌کند.