Base Service

پایه

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

کلاس ها

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

Blob

روش ها

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

Blob Source

روش ها

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

Browser

خواص

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

روش ها

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

Button

خواص

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

Button Set

خواص

اموال تایپ کنید توضیحات
OK Enum یک دکمه "OK"، نشان دهنده یک پیام اطلاعاتی است که فقط می تواند رد شود.
OK_CANCEL Enum یک دکمه "OK" و یک دکمه "لغو" که به کاربر اجازه می دهد یا عملیات را ادامه دهد یا متوقف کند.
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 Script.
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 برای فایل اسلایدهای Google.
FOLDER Enum نمایش نوع MIME برای یک پوشه Google Drive.
SHORTCUT Enum نمایش نوع MIME برای میانبر Google Drive.
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 برای فایل سند Microsoft Word (معمولاً .docx).
MICROSOFT_WORD_LEGACY Enum نمایش نوع MIME برای یک فایل قدیمی Microsoft Word (معمولاً .doc).
ZIP Enum نمایش نوع MIME برای یک فایل آرشیو ZIP (معمولا .zip).

Month

خواص

اموال تایپ کنید توضیحات
JANUARY Enum ژانویه (1 ماه).
FEBRUARY Enum فوریه (ماه 2).
MARCH Enum مارس (ماه 3).
APRIL Enum آوریل (ماه 4).
MAY Enum اردیبهشت (5 ماه).
JUNE Enum ژوئن (ماه 6).
JULY Enum جولای (ماه 7).
AUGUST Enum آگوست (ماه 8).
SEPTEMBER Enum سپتامبر (9 ماه).
OCTOBER Enum اکتبر (10 ماه).
NOVEMBER Enum نوامبر (11 ماه).
DECEMBER Enum دسامبر (12 ماه).

Prompt Response

روش ها

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

Rgb Color

روش ها

روش نوع برگشت شرح مختصر
as Hex String() String رنگ را به عنوان یک رشته هگزادسیمال 7 کاراکتری (#rrggbb) یا رشته هگزادسیمال 9 کاراکتری (#aarrggbb) به سبک CSS برمی‌گرداند.
get Blue() Integer کانال آبی این رنگ به صورت عددی از 0 تا 255 است.
get Color Type() Color Type نوع این رنگ را دریافت کنید.
get Green() Integer کانال سبز این رنگ به صورت عددی از 0 تا 255 می باشد.
get Red() Integer کانال قرمز این رنگ به صورت عددی از 0 تا 255 است.

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 یک عدد که نشان دهنده دکمه های گفتگوی از پیش تعیین شده و محلی شده است که توسط یک هشدار یا Prompt Response.getSelectedButton() بازگردانده می شود تا نشان دهد کاربر روی کدام دکمه در یک گفتگو کلیک کرده است.
Button Set Button Set یک عدد که مجموعه‌های از پیش تعیین‌شده و بومی‌سازی شده‌ای از یک یا چند دکمه گفتگو را نشان می‌دهد که می‌توانند به یک هشدار یا یک درخواست اضافه شوند.

روش ها

روش نوع برگشت شرح مختصر
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 یک کادر محاوره ای مدال را در ویرایشگر کاربر با محتوای سمت مشتری سفارشی باز می کند.
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 یک پیام سطح ERROR خالی را به Stackdriver Logging ارسال می کند.
error(formatOrObject, values) void یک پیام سطح ERROR را به Stackdriver Logging ارسال می کند.
info() void پیام سطح INFO خالی را به Stackdriver Logging ارسال می کند.
info(formatOrObject, values) void یک پیام سطح اطلاعات را به 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 یک پیام سطح هشدار را به Stackdriver Logging ارسال می کند.