Class Spreadsheet

صفحه گسترده

به فایل‌های Google Sheets دسترسی داشته باشید و آن‌ها را تغییر دهید. عملیات رایج اضافه کردن برگه‌های جدید و افزودن همکاران است.

روش ها

روش نوع برگشت شرح مختصر
add Developer Metadata(key) Spreadsheet ابرداده برنامه‌نویس را با کلید مشخص شده به صفحه‌گسترده سطح بالا اضافه می‌کند.
add Developer Metadata(key, visibility) Spreadsheet ابرداده برنامه‌نویس را با کلید مشخص شده و قابلیت مشاهده به صفحه‌گسترده اضافه می‌کند.
add Developer Metadata(key, value) Spreadsheet ابرداده توسعه دهنده را با کلید و مقدار مشخص شده به صفحه گسترده اضافه می کند.
add Developer Metadata(key, value, visibility) Spreadsheet ابرداده توسعه‌دهنده را با کلید، مقدار و قابلیت مشاهده به صفحه گسترده اضافه می‌کند.
add Editor(emailAddress) Spreadsheet کاربر داده شده را به لیست ویرایشگرهای Spreadsheet اضافه می کند.
add Editor(user) Spreadsheet کاربر داده شده را به لیست ویرایشگرهای Spreadsheet اضافه می کند.
add Editors(emailAddresses) Spreadsheet آرایه داده شده از کاربران را به لیست ویرایشگرهای Spreadsheet اضافه می کند.
add Menu(name, subMenus) void یک منوی جدید در رابط کاربر صفحه گسترده ایجاد می کند.
add Viewer(emailAddress) Spreadsheet کاربر داده شده را به لیست بینندگان Spreadsheet اضافه می کند.
add Viewer(user) Spreadsheet کاربر داده شده را به لیست بینندگان Spreadsheet اضافه می کند.
add Viewers(emailAddresses) Spreadsheet آرایه داده شده از کاربران را به لیست بینندگان Spreadsheet اضافه می کند.
append Row(rowContents) Sheet یک ردیف به پایین منطقه داده فعلی در برگه اضافه می کند.
auto Resize Column(columnPosition) Sheet عرض ستون داده شده را متناسب با محتوای آن تنظیم می کند.
copy(name) Spreadsheet صفحه گسترده را کپی می کند و صفحه جدید را برمی گرداند.
create Developer Metadata Finder() Developer Metadata Finder برای یافتن فراداده توسعه‌دهنده در محدوده این صفحه‌گسترده، یک Developer Metadata Finder را برمی‌گرداند.
create Text Finder(findText) Text Finder یک متن یاب برای صفحه گسترده ایجاد می کند که می تواند برای یافتن و جایگزینی متن در صفحه گسترده استفاده شود.
delete Active Sheet() Sheet برگه فعال فعلی را حذف می کند.
delete Column(columnPosition) Sheet ستون را در موقعیت ستون داده شده حذف می کند.
delete Columns(columnPosition, howMany) void تعدادی از ستون هایی که از موقعیت ستون داده شده شروع می شوند را حذف می کند.
delete Row(rowPosition) Sheet ردیف را در موقعیت ردیف داده شده حذف می کند.
delete Rows(rowPosition, howMany) void تعدادی از ردیف هایی که از موقعیت ردیف داده شده شروع می شوند را حذف می کند.
delete Sheet(sheet) void برگه مشخص شده را حذف می کند.
duplicate Active Sheet() Sheet برگه فعال را کپی می کند و آن را به برگه فعال تبدیل می کند.
get Active Cell() Range سلول فعال در این برگه را برمی گرداند.
get Active Range() Range محدوده انتخاب شده را در برگه فعال برمی‌گرداند، یا اگر محدوده فعالی وجود نداشته باشد null .
get Active Range List() Range List لیست محدوده های فعال را در برگه فعال برمی گرداند یا اگر محدوده فعالی وجود نداشته باشد، null برمی گرداند.
get Active Sheet() Sheet برگه فعال را در یک صفحه گسترده دریافت می کند.
get As(contentType) Blob داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید.
get Bandings() Banding[] همه باندهای موجود در این صفحه گسترده را برمی گرداند.
get Blob() Blob داده های داخل این شی را به صورت حباب برگردانید.
get Column Width(columnPosition) Integer عرض ستون داده شده را بر حسب پیکسل دریافت می کند.
get Current Cell() Range سلول فعلی در برگه فعال را برمی‌گرداند یا اگر سلول فعلی وجود نداشته باشد، null برمی‌گرداند.
get Data Range() Range یک Range مربوط به ابعادی که داده در آن وجود دارد را برمی‌گرداند.
get Data Source Formulas() Data Source Formula[] تمام فرمول های منبع داده را دریافت می کند.
get Data Source Pivot Tables() Data Source Pivot Table[] تمام جداول محوری منبع داده را دریافت می کند.
get Data Source Refresh Schedules() Data Source Refresh Schedule[] برنامه‌های به‌روزرسانی این صفحه‌گسترده را دریافت می‌کند.
get Data Source Sheets() Data Source Sheet[] همه برگه های منبع داده را در صفحه گسترده برمی گرداند.
get Data Source Tables() Data Source Table[] تمام جداول منبع داده را دریافت می کند.
get Data Sources() Data Source[] همه منابع داده را در صفحه گسترده برمی گرداند.
get Developer Metadata() Developer Metadata[] فراداده برنامه‌نویس مرتبط با صفحه‌گسترده سطح بالا را دریافت می‌کند.
get Editors() User[] لیست ویرایشگران این Spreadsheet را دریافت می کند.
get Form Url() String نشانی اینترنتی فرمی را که پاسخ‌های خود را به این صفحه‌گسترده ارسال می‌کند، برمی‌گرداند، یا اگر این صفحه‌گسترده هیچ فرم مرتبطی نداشته باشد null .
get Frozen Columns() Integer تعداد ستون های ثابت شده را برمی گرداند.
get Frozen Rows() Integer تعداد ردیف‌های ثابت شده را برمی‌گرداند.
get Id() String یک شناسه منحصر به فرد برای این صفحه گسترده دریافت می کند.
get Images() Over Grid Image[] همه تصاویر خارج از شبکه را بر روی صفحه برمی گرداند.
get Iterative Calculation Convergence Threshold() Number مقدار آستانه استفاده شده در طول محاسبه تکراری را برمی‌گرداند.
get Last Column() Integer موقعیت آخرین ستونی که محتوا دارد را برمی‌گرداند.
get Last Row() Integer موقعیت آخرین ردیفی که محتوا دارد را برمی‌گرداند.
get Max Iterative Calculation Cycles() Integer حداکثر تعداد تکرارها را برای استفاده در حین محاسبه تکراری برمی‌گرداند.
get Name() String نام سند را دریافت می کند.
get Named Ranges() Named Range[] تمام محدوده های نامگذاری شده در این صفحه گسترده را دریافت می کند.
get Num Sheets() Integer تعداد برگه‌های این صفحه‌گسترده را برمی‌گرداند.
get Owner() User مالک سند را برمی‌گرداند، یا برای سندی در درایو مشترک، null .
get Predefined Spreadsheet Themes() Spreadsheet Theme[] لیست تم های از پیش تعریف شده را برمی گرداند.
get Protections(type) Protection[] آرایه ای از اشیاء را دریافت می کند که همه محدوده ها یا صفحات محافظت شده را در صفحه گسترده نشان می دهد.
get Range(a1Notation) Range محدوده مشخص شده در نماد A1 یا R1C1 را برمی‌گرداند.
get Range By Name(name) Range یک محدوده با نام را برمی‌گرداند، یا اگر محدوده‌ای با نام داده‌شده یافت نشد، null برمی‌گرداند.
get Range List(a1Notations) Range List مجموعه Range List را باز می گرداند که محدوده هایی را در همان برگه مشخص شده توسط یک لیست غیرخالی از نمادهای A1 یا نمادهای R1C1 نشان می دهد.
get Recalculation Interval() Recalculation Interval فاصله محاسبه را برای این صفحه‌گسترده برمی‌گرداند.
get Row Height(rowPosition) Integer ارتفاع ردیف داده شده را بر حسب پیکسل دریافت می کند.
get Selection() Selection Selection فعلی را در صفحه گسترده برمی‌گرداند.
get Sheet By Name(name) Sheet برگه ای را با نام داده شده برمی گرداند.
get Sheet Id() Integer شناسه برگه نشان داده شده توسط این شی را برمی گرداند.
get Sheet Name() String نام برگه را برمی گرداند.
get Sheet Values(startRow, startColumn, numRows, numColumns) Object[][] شبکه مستطیلی مقادیر را برای این محدوده که از مختصات داده شده شروع می شود، برمی گرداند.
get Sheets() Sheet[] همه برگه های این صفحه گسترده را دریافت می کند.
get Spreadsheet Locale() String محل صفحه گسترده را دریافت می کند.
get Spreadsheet Theme() Spreadsheet Theme موضوع فعلی صفحه‌گسترده را برمی‌گرداند، یا اگر طرح زمینه اعمال نشود، null است.
get Spreadsheet Time Zone() String منطقه زمانی صفحه گسترده را دریافت می کند.
get Url() String URL صفحه گسترده داده شده را برمی گرداند.
get Viewers() User[] لیست بینندگان و نظر دهندگان را برای این Spreadsheet دریافت می کند.
hide Column(column) void ستون یا ستون ها را در محدوده داده شده پنهان می کند.
hide Row(row) void سطرها را در محدوده داده شده پنهان می کند.
insert Column After(afterPosition) Sheet ستونی را بعد از موقعیت ستون داده شده درج می کند.
insert Column Before(beforePosition) Sheet یک ستون را قبل از موقعیت ستون داده شده درج می کند.
insert Columns After(afterPosition, howMany) Sheet تعداد مشخصی از ستون ها را بعد از موقعیت ستون داده شده درج می کند.
insert Columns Before(beforePosition, howMany) Sheet تعدادی ستون را قبل از موقعیت ستون داده شده درج می کند.
insert Data Source Sheet(spec) Data Source Sheet Data Source Sheet جدیدی را در صفحه گسترده درج می کند و اجرای داده ها را شروع می کند.
insert Image(blobSource, column, row) Over Grid Image یک Spreadsheet به عنوان تصویر در یک سطر و ستون معین در سند درج می کند.
insert Image(blobSource, column, row, offsetX, offsetY) Over Grid Image یک Spreadsheet به عنوان تصویر در یک سطر و ستون معین، با فاصله پیکسلی در سند درج می کند.
insert Image(url, column, row) Over Grid Image یک تصویر را در یک ردیف و ستون معین در سند درج می کند.
insert Image(url, column, row, offsetX, offsetY) Over Grid Image یک تصویر را در یک ردیف و ستون معین، با فاصله پیکسلی در سند درج می کند.
insert Row After(afterPosition) Sheet یک ردیف بعد از موقعیت ردیف داده شده درج می کند.
insert Row Before(beforePosition) Sheet یک ردیف قبل از موقعیت ردیف داده شده درج می کند.
insert Rows After(afterPosition, howMany) Sheet تعدادی ردیف را بعد از موقعیت ردیف داده شده درج می کند.
insert Rows Before(beforePosition, howMany) Sheet تعدادی ردیف را قبل از موقعیت ردیف داده شده درج می کند.
insert Sheet() Sheet با استفاده از نام صفحه پیش فرض، یک صفحه جدید را در صفحه گسترده وارد می کند.
insert Sheet(sheetIndex) Sheet یک صفحه جدید را در فهرست داده شده در صفحه گسترده وارد می کند.
insert Sheet(sheetIndex, options) Sheet یک صفحه جدید را در صفحه گسترده در شاخص داده شده درج می کند و از آرگومان های پیشرفته اختیاری استفاده می کند.
insert Sheet(options) Sheet با استفاده از نام صفحه پیش‌فرض و آرگومان‌های پیشرفته اختیاری، یک صفحه جدید را در صفحه‌گسترده درج می‌کند.
insert Sheet(sheetName) Sheet یک صفحه جدید با نام داده شده را در صفحه گسترده وارد می کند.
insert Sheet(sheetName, sheetIndex) Sheet یک صفحه جدید با نام داده شده در فهرست داده شده در صفحه گسترده وارد می کند.
insert Sheet(sheetName, sheetIndex, options) Sheet یک صفحه جدید با نام داده شده در فهرست داده شده در صفحه گسترده وارد می کند و از آرگومان های پیشرفته اختیاری استفاده می کند.
insert Sheet(sheetName, options) Sheet یک صفحه جدید با نام داده شده در صفحه گسترده وارد می کند و از آرگومان های پیشرفته اختیاری استفاده می کند.
insert Sheet With Data Source Table(spec) Sheet یک صفحه جدید را در صفحه گسترده درج می کند، یک Data Source Table ایجاد می کند که کل صفحه را با مشخصات منبع داده داده شده در بر می گیرد، و اجرای داده ها را شروع می کند.
is Column Hidden By User(columnPosition) Boolean نشان می دهد که آیا ستون داده شده توسط کاربر پنهان شده است یا خیر.
is Iterative Calculation Enabled() Boolean نشان می دهد که آیا محاسبه تکراری در این صفحه گسترده فعال شده است یا خیر.
is Row Hidden By Filter(rowPosition) Boolean نشان می دهد که آیا ردیف داده شده توسط یک فیلتر (نه نمای فیلتر) پنهان شده است یا خیر.
is Row Hidden By User(rowPosition) Boolean نشان می دهد که آیا ردیف داده شده توسط کاربر پنهان شده است یا خیر.
move Active Sheet(pos) void برگه فعال را به موقعیت داده شده در لیست برگه ها منتقل می کند.
move Chart To Object Sheet(chart) Sheet یک برگه Sheet Type.OBJECT جدید ایجاد می کند و نمودار ارائه شده را به آن منتقل می کند.
refresh All Data Sources() void همه منابع داده پشتیبانی شده و اشیاء منبع داده مرتبط آنها را بازخوانی می کند، از اشیاء منبع داده نامعتبر صرف نظر می کند.
remove Editor(emailAddress) Spreadsheet کاربر داده شده را از لیست ویرایشگرهای Spreadsheet حذف می کند.
remove Editor(user) Spreadsheet کاربر داده شده را از لیست ویرایشگرهای Spreadsheet حذف می کند.
remove Menu(name) void منویی را که با add Menu(name, subMenus) اضافه شده است حذف می کند.
remove Named Range(name) void یک محدوده نامگذاری شده با نام داده شده را حذف می کند.
remove Viewer(emailAddress) Spreadsheet کاربر داده شده را از لیست بینندگان و نظر دهندگان Spreadsheet حذف می کند.
remove Viewer(user) Spreadsheet کاربر داده شده را از لیست بینندگان و نظر دهندگان Spreadsheet حذف می کند.
rename(newName) void سند را تغییر نام می دهد.
rename Active Sheet(newName) void برگه فعال فعلی را به نام جدید داده شده تغییر نام می دهد.
reset Spreadsheet Theme() Spreadsheet Theme طرح زمینه اعمال شده را حذف می کند و موضوع پیش فرض را در صفحه گسترده تنظیم می کند.
set Active Range(range) Range محدوده مشخص شده را به عنوان active range در برگه فعال، با سلول بالا سمت چپ در محدوده به عنوان current cell تنظیم می کند.
set Active Range List(rangeList) Range List لیست مشخص شده محدوده ها را به عنوان active ranges در برگه فعال تنظیم می کند.
set Active Selection(range) Range منطقه انتخاب فعال را برای این برگه تنظیم می کند.
set Active Selection(a1Notation) Range انتخاب فعال را همانطور که در نماد A1 یا R1C1 مشخص شده است، تنظیم می کند.
set Active Sheet(sheet) Sheet صفحه داده شده را به عنوان برگه فعال در صفحه گسترده تنظیم می کند.
set Active Sheet(sheet, restoreSelection) Sheet برگه داده شده را به عنوان برگه فعال در صفحه گسترده تنظیم می کند، با گزینه ای برای بازیابی جدیدترین انتخاب در آن صفحه.
set Column Width(columnPosition, width) Sheet عرض ستون داده شده را بر حسب پیکسل تنظیم می کند.
set Current Cell(cell) Range سلول مشخص شده را به عنوان current cell تنظیم می کند.
set Frozen Columns(columns) void تعداد ستون ها را ثابت می کند.
set Frozen Rows(rows) void تعداد ردیف های داده شده را ثابت می کند.
set Iterative Calculation Convergence Threshold(minThreshold) Spreadsheet حداقل مقدار آستانه را برای محاسبه تکراری تنظیم می کند.
set Iterative Calculation Enabled(isEnabled) Spreadsheet تنظیم می کند که آیا محاسبه تکراری در این صفحه گسترده فعال شود یا خیر.
set Max Iterative Calculation Cycles(maxIterations) Spreadsheet حداکثر تعداد تکرارهای محاسباتی را که باید در حین محاسبه تکراری انجام شوند را تنظیم می کند.
set Named Range(name, range) void یک محدوده را نام می برد.
set Recalculation Interval(recalculationInterval) Spreadsheet تعیین می‌کند این صفحه‌گسترده چقدر باید دوباره محاسبه شود.
set Row Height(rowPosition, height) Sheet ارتفاع ردیف ردیف داده شده را بر حسب پیکسل تنظیم می کند.
set Spreadsheet Locale(locale) void محل صفحه گسترده را تنظیم می کند.
set Spreadsheet Theme(theme) Spreadsheet Theme یک موضوع را در صفحه گسترده تنظیم می کند.
set Spreadsheet Time Zone(timezone) void منطقه زمانی صفحه گسترده را تنظیم می کند.
show(userInterface) void یک جزء رابط کاربری سفارشی را در یک گفتگو در مرکز نمای مرورگر کاربر نمایش می دهد.
sort(columnPosition) Sheet یک ورق را بر اساس ستون، صعودی مرتب می کند.
sort(columnPosition, ascending) Sheet یک ورق را به ستون مرتب می کند.
toast(msg) void یک پنجره بازشو در گوشه سمت راست پایین صفحه گسترده با پیام داده شده نشان می دهد.
toast(msg, title) void یک پنجره بازشو در گوشه سمت راست پایین صفحه گسترده با پیام و عنوان داده شده نشان می دهد.
toast(msg, title, timeoutSeconds) void یک پنجره بازشو در گوشه سمت راست پایین صفحه گسترده با عنوان و پیام داده شده نشان می دهد که برای مدت زمان مشخصی قابل مشاهده می ماند.
unhide Column(column) void ستون را در محدوده داده شده باز می کند.
unhide Row(row) void ردیف را در محدوده داده شده نشان می دهد.
update Menu(name, subMenus) void منویی را که با add Menu(name, subMenus) اضافه شده است به روز می کند.
wait For All Data Executions Completion(timeoutInSeconds) void صبر می کند تا تمام اجرای فعلی در صفحه گسترده کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد.

مستندات دقیق

add Developer Metadata(key)

ابرداده برنامه‌نویس را با کلید مشخص شده به صفحه‌گسترده سطح بالا اضافه می‌کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

پارامترها

نام تایپ کنید توضیحات
key String کلید برای ابرداده های جدید توسعه دهنده.

بازگشت

Spreadsheet - این صفحه گسترده، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Developer Metadata(key, visibility)

ابرداده برنامه‌نویس را با کلید مشخص شده و قابلیت مشاهده به صفحه‌گسترده اضافه می‌کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

پارامترها

نام تایپ کنید توضیحات
key String کلید برای ابرداده های جدید توسعه دهنده.
visibility Developer Metadata Visibility قابلیت مشاهده ابرداده توسعه‌دهنده جدید.

بازگشت

Spreadsheet - این صفحه گسترده، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Developer Metadata(key, value)

ابرداده توسعه دهنده را با کلید و مقدار مشخص شده به صفحه گسترده اضافه می کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

پارامترها

نام تایپ کنید توضیحات
key String کلید برای ابرداده های جدید توسعه دهنده.
value String مقدار فراداده توسعه‌دهنده جدید.

بازگشت

Spreadsheet - این صفحه گسترده، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Developer Metadata(key, value, visibility)

ابرداده توسعه‌دهنده را با کلید، مقدار و قابلیت مشاهده به صفحه گسترده اضافه می‌کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

پارامترها

نام تایپ کنید توضیحات
key String کلید برای ابرداده های جدید توسعه دهنده.
value String مقدار فراداده توسعه‌دهنده جدید.
visibility Developer Metadata Visibility قابلیت مشاهده ابرداده توسعه‌دهنده جدید.

بازگشت

Spreadsheet - این صفحه گسترده، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Editor(emailAddress)

کاربر داده شده را به لیست ویرایشگرهای Spreadsheet اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای افزودن

بازگشت

Spreadsheet - این Spreadsheet ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Editor(user)

کاربر داده شده را به لیست ویرایشگرهای Spreadsheet اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای افزودن.

بازگشت

Spreadsheet - این Spreadsheet ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Editors(emailAddresses)

آرایه داده شده از کاربران را به لیست ویرایشگرهای Spreadsheet اضافه می کند. اگر هر یک از کاربران قبلاً در لیست بینندگان بودند، این روش آنها را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
email Addresses String[] مجموعه ای از آدرس های ایمیل کاربران برای افزودن.

بازگشت

Spreadsheet - این Spreadsheet ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Menu(name, subMenus)

یک منوی جدید در رابط کاربر صفحه گسترده ایجاد می کند.

هر ورودی منو یک تابع تعریف شده توسط کاربر را اجرا می کند. معمولاً می‌خواهید آن را از تابع on Open() فراخوانی کنید تا با بارگیری صفحه‌گسترده، منو به‌طور خودکار ایجاد شود. 

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

پارامترها

نام تایپ کنید توضیحات
name String نام منوی ایجاد شده
sub Menus Object[] آرایه ای از نقشه های جاوا اسکریپت با پارامترهای name و function Name . می توانید از توابع کتابخانه های موجود مانند Library.libFunction1 استفاده کنید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Viewer(emailAddress)

کاربر داده شده را به لیست بینندگان Spreadsheet اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای افزودن

بازگشت

Spreadsheet - این Spreadsheet ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Viewer(user)

کاربر داده شده را به لیست بینندگان Spreadsheet اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای افزودن.

بازگشت

Spreadsheet - این Spreadsheet ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

add Viewers(emailAddresses)

آرایه داده شده از کاربران را به لیست بینندگان Spreadsheet اضافه می کند. اگر هر یک از کاربران قبلاً در لیست ویرایشگرها بودند، این روش برای آنها تأثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
email Addresses String[] مجموعه ای از آدرس های ایمیل کاربران برای افزودن.

بازگشت

Spreadsheet - این Spreadsheet ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

append Row(rowContents)

یک ردیف به پایین منطقه داده فعلی در برگه اضافه می کند. اگر محتوای یک سلول با = شروع شود، به عنوان یک فرمول تفسیر می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

پارامترها

نام تایپ کنید توضیحات
row Contents Object[] آرایه ای از مقادیر برای درج بعد از آخرین ردیف در برگه.

بازگشت

Sheet - ورق، مفید برای زنجیره روش.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

auto Resize Column(columnPosition)

عرض ستون داده شده را متناسب با محتوای آن تنظیم می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

پارامترها

نام تایپ کنید توضیحات
column Position Integer موقعیت ستون داده شده برای تغییر اندازه.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

copy(name)

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

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

پارامترها

نام تایپ کنید توضیحات
name String نام کپی.

بازگشت

Spreadsheet - این صفحه گسترده، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

create Developer Metadata Finder()

برای یافتن فراداده توسعه‌دهنده در محدوده این صفحه‌گسترده، یک Developer Metadata Finder را برمی‌گرداند. به‌طور پیش‌فرض، تمام ابرداده‌های مرتبط با صفحه‌گسترده، برگه‌ها، ردیف‌ها و ستون‌ها را در نظر می‌گیرد. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

بازگشت

Developer Metadata Finder — یاب فراداده توسعه دهنده برای جستجوی فراداده در محدوده این صفحه گسترده.

create Text Finder(findText)

یک متن یاب برای صفحه گسترده ایجاد می کند که می تواند برای یافتن و جایگزینی متن در صفحه گسترده استفاده شود. جستجو از اولین صفحه صفحه گسترده شروع می شود. 

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
var textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

پارامترها

نام تایپ کنید توضیحات
find Text String متن مورد جستجو

بازگشت

Text Finder - Text Finder برای صفحه گسترده.

delete Active Sheet()

برگه فعال فعلی را حذف می کند. 

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

بازگشت

Sheet - برگه فعال جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

delete Column(columnPosition)

ستون را در موقعیت ستون داده شده حذف می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

پارامترها

نام تایپ کنید توضیحات
column Position Integer موقعیت ستون، از 1 برای ستون اول شروع می شود.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

delete Columns(columnPosition, howMany)

تعدادی از ستون هایی که از موقعیت ستون داده شده شروع می شوند را حذف می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

پارامترها

نام تایپ کنید توضیحات
column Position Integer موقعیت اولین ستون برای حذف.
how Many Integer تعداد ستون هایی که باید حذف شوند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

delete Row(rowPosition)

ردیف را در موقعیت ردیف داده شده حذف می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

پارامترها

نام تایپ کنید توضیحات
row Position Integer موقعیت ردیف، از 1 برای ردیف اول شروع می شود.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

delete Rows(rowPosition, howMany)

تعدادی از ردیف هایی که از موقعیت ردیف داده شده شروع می شوند را حذف می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

پارامترها

نام تایپ کنید توضیحات
row Position Integer موقعیت ردیف اول برای حذف.
how Many Integer تعداد ردیف هایی که باید حذف شوند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

delete Sheet(sheet)

برگه مشخص شده را حذف می کند. 

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

پارامترها

نام تایپ کنید توضیحات
sheet Sheet برگه ای برای حذف

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

duplicate Active Sheet()

برگه فعال را کپی می کند و آن را به برگه فعال تبدیل می کند. 

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

بازگشت

Sheet - ورق جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Active Cell()

سلول فعال در این برگه را برمی گرداند.

توجه: ترجیحاً از get Current Cell() استفاده کنید که سلول هایلایت شده فعلی را برمی گرداند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

بازگشت

Range - سلول فعال فعلی

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Active Range()

محدوده انتخاب شده را در برگه فعال برمی‌گرداند، یا اگر محدوده فعالی وجود نداشته باشد null . اگر چندین محدوده انتخاب شده باشد، این روش فقط آخرین محدوده انتخاب شده را برمی گرداند.

اصطلاح "محدوده فعال" به محدوده ای اطلاق می شود که کاربر در برگه فعال انتخاب کرده است، اما در یک تابع سفارشی به سلولی اشاره دارد که به طور فعال دوباره محاسبه می شود. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

بازگشت

Range - محدوده فعال

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

همچنین ببینید

get Active Range List()

لیست محدوده های فعال را در برگه فعال برمی گرداند یا اگر محدوده فعالی وجود نداشته باشد، null برمی گرداند.

اگر یک محدوده انتخاب شده باشد، به عنوان یک فراخوانی get Active Range() عمل می کند. 

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

بازگشت

Range List - فهرست محدوده های فعال

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

همچنین ببینید

get Active Sheet()

برگه فعال را در یک صفحه گسترده دریافت می کند.

صفحه فعال در یک صفحه گسترده، برگه ای است که در رابط کاربر صفحه گسترده نمایش داده می شود. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

بازگشت

Sheet - برگه فعال در صفحه گسترده.

get As(contentType)

داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید. این روش پسوند مناسب را به نام فایل اضافه می کند - به عنوان مثال، "myfile.pdf". با این حال، فرض می‌کند که بخشی از نام فایل که پس از آخرین نقطه (در صورت وجود) یک پسوند موجود است که باید جایگزین شود. در نتیجه، "ShoppingList.12.25.2014" به "ShoppingList.12.25.pdf" تبدیل می شود.

برای مشاهده سهمیه های روزانه برای تبدیل، به سهمیه خدمات Google مراجعه کنید. دامنه‌های جدید Google Workspace ممکن است به طور موقت مشمول سهمیه‌های سخت‌گیرانه‌تر شوند.

پارامترها

نام تایپ کنید توضیحات
content Type String نوع MIME برای تبدیل. برای اکثر حباب‌ها، 'application/pdf' تنها گزینه معتبر است. برای تصاویر با فرمت BMP، GIF، JPEG یا PNG، هر یک از 'image/bmp' ، 'image/gif' ، 'image/jpeg' یا 'image/png' نیز معتبر هستند. برای سند Google Docs، 'text/markdown' نیز معتبر است.

بازگشت

Blob - داده ها به عنوان یک لکه.

get Bandings()

همه باندهای موجود در این صفحه گسترده را برمی گرداند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

بازگشت

Banding[] - باندهای موجود در این صفحه گسترده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Blob()

داده های داخل این شی را به صورت حباب برگردانید.

بازگشت

Blob - داده ها به عنوان یک لکه.

get Column Width(columnPosition)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

پارامترها

نام تایپ کنید توضیحات
column Position Integer موقعیت ستون برای بررسی.

بازگشت

Integer - عرض ستون بر حسب پیکسل

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Current Cell()

سلول فعلی در برگه فعال را برمی‌گرداند یا اگر سلول فعلی وجود نداشته باشد، null برمی‌گرداند. سلول فعلی سلولی است که در رابط کاربری کاربرگ‌نگار Google فوکوس دارد و با یک حاشیه تیره برجسته می‌شود. هرگز بیش از یک سلول فعلی وجود ندارد. هنگامی که کاربر یک یا چند محدوده سلولی را انتخاب می کند، یکی از سلول های انتخابی سلول فعلی است. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.getCurrentCell();

بازگشت

Range - سلول فعلی

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Range()

یک Range مربوط به ابعادی که داده در آن وجود دارد را برمی‌گرداند.

این از نظر عملکردی معادل ایجاد یک محدوده محدود شده با A1 و (Sheet.getLastColumn()، Sheet.getLastRow()) است. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

بازگشت

Range - محدوده ای متشکل از تمام داده های صفحه گسترده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Source Formulas()

تمام فرمول های منبع داده را دریافت می کند. 

// Opens the spreadsheet by its ID. If you created your script from within a Google Sheets
// file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

بازگشت

Data Source Formula[] - فهرستی از فرمول های منبع داده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Source Pivot Tables()

تمام جداول محوری منبع داده را دریافت می کند. 

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

بازگشت

Data Source Pivot Table[] - فهرستی از جداول محوری منبع داده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Source Refresh Schedules()

برنامه‌های به‌روزرسانی این صفحه‌گسترده را دریافت می‌کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

بازگشت

Data Source Refresh Schedule[] - برنامه‌های به‌روزرسانی این صفحه‌گسترده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Source Sheets()

همه برگه های منبع داده را در صفحه گسترده برمی گرداند. 

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

بازگشت

Data Source Sheet[] - آرایه ای از همه برگه های منبع داده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Source Tables()

تمام جداول منبع داده را دریافت می کند. 

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

بازگشت

Data Source Table[] - فهرستی از جداول منبع داده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Sources()

همه منابع داده را در صفحه گسترده برمی گرداند. 

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

بازگشت

Data Source[] - آرایه ای از همه منابع داده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Developer Metadata()

فراداده برنامه‌نویس مرتبط با صفحه‌گسترده سطح بالا را دریافت می‌کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

بازگشت

Developer Metadata[] - فراداده توسعه‌دهنده مرتبط با این محدوده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Editors()

لیست ویرایشگران این Spreadsheet را دریافت می کند.

بازگشت

User[] - آرایه ای از کاربران با مجوز ویرایش.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Form Url()

نشانی اینترنتی فرمی را که پاسخ‌های خود را به این صفحه‌گسترده ارسال می‌کند، برمی‌گرداند، یا اگر این صفحه‌گسترده هیچ فرم مرتبطی نداشته باشد، null . اگر چندین فرم پاسخ‌ها را به این صفحه‌گسترده ارسال کنند، نشانی وب فرم بازگردانده شده نامشخص است. به عنوان جایگزین، پیوندهای URL فرم هر برگه را می توان از طریق متد Sheet.getFormUrl() بازیابی کرد. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

بازگشت

String - URL برای فرمی که پاسخ‌های خود را در این صفحه‌گسترده قرار می‌دهد، یا اگر این صفحه‌گسترده فرم مرتبطی نداشته باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Frozen Columns()

تعداد ستون های ثابت شده را برمی گرداند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

بازگشت

Integer - تعداد ستون های ثابت

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Frozen Rows()

تعداد ردیف‌های ثابت شده را برمی‌گرداند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

بازگشت

Integer - تعداد ردیف های ثابت

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Id()

یک شناسه منحصر به فرد برای این صفحه گسترده دریافت می کند. شناسه صفحه گسترده را می توان از URL آن استخراج کرد. به عنوان مثال، شناسه صفحه گسترده در URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 "abc1234567" است. 

// The code below logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

بازگشت

String - شناسه (یا کلید) منحصر به فرد برای صفحه گسترده.

get Images()

همه تصاویر خارج از شبکه را بر روی صفحه برمی گرداند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

بازگشت

Over Grid Image[] - آرایه ای از تصاویر خارج از شبکه.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Iterative Calculation Convergence Threshold()

مقدار آستانه استفاده شده در طول محاسبه تکراری را برمی‌گرداند. هنگامی که نتایج محاسبات متوالی کمتر از این مقدار متفاوت باشد، محاسبه تکراری متوقف می شود. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

بازگشت

Number - آستانه همگرایی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Last Column()

موقعیت آخرین ستونی که محتوا دارد را برمی‌گرداند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

بازگشت

Integer - آخرین ستون برگه که حاوی محتوا است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Last Row()

موقعیت آخرین ردیفی که محتوا دارد را برمی‌گرداند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

بازگشت

Integer - آخرین ردیف برگه که حاوی محتوا است

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Max Iterative Calculation Cycles()

حداکثر تعداد تکرارها را برای استفاده در حین محاسبه تکراری برمی‌گرداند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

بازگشت

Integer - حداکثر تعداد تکرارهای محاسباتی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Name()

نام سند را دریافت می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

بازگشت

String - نام صفحه گسترده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Named Ranges()

تمام محدوده های نامگذاری شده در این صفحه گسترده را دریافت می کند. 

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

بازگشت

Named Range[] - آرایه ای از تمام محدوده های نامگذاری شده در صفحه گسترده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Num Sheets()

تعداد برگه‌های این صفحه‌گسترده را برمی‌گرداند. 

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

بازگشت

Integer - تعداد صفحات در صفحه گسترده.

get Owner()

مالک سند را برمی‌گرداند، یا برای سندی در درایو مشترک، null . 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

بازگشت

User - مالک سند، یا اگر سند در یک درایو مشترک باشد، null .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Predefined Spreadsheet Themes()

لیست تم های از پیش تعریف شده را برمی گرداند. 

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

بازگشت

Spreadsheet Theme[] - فهرست تم های از پیش تعریف شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Protections(type)

آرایه ای از اشیاء را دریافت می کند که همه محدوده ها یا صفحات محافظت شده را در صفحه گسترده نشان می دهد. 

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

پارامترها

نام تایپ کنید توضیحات
type Protection Type نوع منطقه محافظت شده، یا Spreadsheet App.ProtectionType.RANGE یا Spreadsheet App.ProtectionType.SHEET .

بازگشت

Protection[] - آرایه ای از اشیاء که همه محدوده ها یا صفحات محافظت شده در صفحه گسترده را نشان می دهد.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Range(a1Notation)

محدوده مشخص شده در نماد A1 یا R1C1 را برمی‌گرداند. 

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

پارامترها

نام تایپ کنید توضیحات
a1Notation String محدوده ای که باید برگردانده شود، همانطور که در نماد A1 یا نماد R1C1 مشخص شده است.

بازگشت

Range - محدوده در مکان تعیین شده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Range By Name(name)

یک محدوده با نام را برمی‌گرداند، یا اگر محدوده‌ای با نام داده‌شده یافت نشد، null برمی‌گرداند. اگر چندین برگه صفحه گسترده از یک نام محدوده استفاده می کنند، نام برگه را بدون علامت نقل قول اضافی مشخص کنید - برای مثال، get Range By Name('TaxRates') یا get Range By Name('Sheet Name!TaxRates') ، اما get Range By Name('"Sheet Name"!TaxRates') نکنید. get Range By Name('"Sheet Name"!TaxRates') . 

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

پارامترها

نام تایپ کنید توضیحات
name String نام محدوده به دست آوردن.

بازگشت

Range - محدوده سلول هایی با نام داده شده.

get Range List(a1Notations)

مجموعه Range List را باز می گرداند که محدوده هایی را در همان برگه مشخص شده توسط یک لیست غیرخالی از نمادهای A1 یا نمادهای R1C1 نشان می دهد. 

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

پارامترها

نام تایپ کنید توضیحات
a1Notations String[] فهرست محدوده هایی که باید برگردانده شوند، همانطور که در نماد A1 یا R1C1 مشخص شده است.

بازگشت

Range List - فهرست محدوده در مکان تعیین شده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Recalculation Interval()

فاصله محاسبه را برای این صفحه‌گسترده برمی‌گرداند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

بازگشت

Recalculation Interval - فاصله محاسبه برای این صفحه گسترده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Row Height(rowPosition)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

پارامترها

نام تایپ کنید توضیحات
row Position Integer موقعیت ردیف برای بررسی.

بازگشت

Integer - ارتفاع ردیف بر حسب پیکسل

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Selection()

Selection فعلی را در صفحه گسترده برمی‌گرداند. 

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

بازگشت

Selection - انتخاب فعلی

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Sheet By Name(name)

برگه ای را با نام داده شده برمی گرداند.

اگر چندین برگه یک نام داشته باشند، سمت چپ ترین برگه برگردانده می شود. اگر برگه ای با نام داده شده وجود نداشته باشد، null برمی گرداند. 

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

پارامترها

نام تایپ کنید توضیحات
name String نام ورق برای دریافت.

بازگشت

Sheet - ورق با نام داده شده.

get Sheet Id()

شناسه برگه نشان داده شده توسط این شی را برمی گرداند.

این یک شناسه برای صفحه‌ای است که مختص صفحه‌گسترده است. شناسه یک عدد صحیح افزایش دهنده یکنواخت است که در زمان ایجاد برگه اختصاص داده می شود که مستقل از موقعیت ورق است. این در ارتباط با روش‌هایی مانند Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) مفید است که به‌جای یک نمونه Sheet ، پارامتر grid Id را می‌گیرند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

بازگشت

Integer - شناسه ای برای صفحه منحصر به فرد صفحه گسترده

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Sheet Name()

نام برگه را برمی گرداند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

بازگشت

String - نام ورق

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Sheet Values(startRow, startColumn, numRows, numColumns)

شبکه مستطیلی مقادیر را برای این محدوده که از مختصات داده شده شروع می شود، برمی گرداند. یک مقدار -1 که به عنوان موقعیت سطر یا ستون داده می شود، معادل به دست آوردن آخرین سطر یا ستونی است که داده ها را در برگه دارد. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

پارامترها

نام تایپ کنید توضیحات
start Row Integer موقعیت ردیف شروع.
start Column Integer موقعیت ستون شروع.
num Rows Integer تعداد سطرهایی که باید مقادیر را برگرداند.
num Columns Integer تعداد ستون‌هایی که باید مقادیر را برگرداند.

بازگشت

Object[][] - یک آرایه دو بعدی از مقادیر

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Sheets()

همه برگه های این صفحه گسترده را دریافت می کند. 

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

بازگشت

Sheet[] - آرایه ای از تمام صفحات در صفحه گسترده.

get Spreadsheet Locale()

محل صفحه گسترده را دریافت می کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

بازگشت

String - محل صفحه گسترده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Spreadsheet Theme()

موضوع فعلی صفحه‌گسترده را برمی‌گرداند، یا اگر طرح زمینه اعمال نشود، null است. 

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

بازگشت

Spreadsheet Theme - موضوع فعلی اعمال شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Spreadsheet Time Zone()

منطقه زمانی صفحه گسترده را دریافت می کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

بازگشت

String - منطقه زمانی، مشخص شده در قالب "طولانی" (به عنوان مثال، "America/New_York"، همانطور که توسط Joda.org فهرست شده است).

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Url()

URL صفحه گسترده داده شده را برمی گرداند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

بازگشت

String - URL برای صفحه گسترده داده شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Viewers()

لیست بینندگان و نظر دهندگان را برای این Spreadsheet دریافت می کند.

بازگشت

User[] - آرایه ای از کاربران با مجوز مشاهده یا نظر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

hide Column(column)

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

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

پارامترها

نام تایپ کنید توضیحات
column Range محدوده ستون برای پنهان کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

hide Row(row)

سطرها را در محدوده داده شده پنهان می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

پارامترها

نام تایپ کنید توضیحات
row Range محدوده ردیف برای پنهان کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Column After(afterPosition)

ستونی را بعد از موقعیت ستون داده شده درج می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

پارامترها

نام تایپ کنید توضیحات
after Position Integer ستونی که بعد از آن ستون جدید باید اضافه شود.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Column Before(beforePosition)

یک ستون را قبل از موقعیت ستون داده شده درج می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

پارامترها

نام تایپ کنید توضیحات
before Position Integer ستونی که ستون جدید باید قبل از آن اضافه شود.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Columns After(afterPosition, howMany)

تعداد مشخصی از ستون ها را بعد از موقعیت ستون داده شده درج می کند. 

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

پارامترها

نام تایپ کنید توضیحات
after Position Integer ستونی که بعد از آن ستون جدید باید اضافه شود.
how Many Integer تعداد ستون هایی که باید درج شود.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Columns Before(beforePosition, howMany)

تعدادی ستون را قبل از موقعیت ستون داده شده درج می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

پارامترها

نام تایپ کنید توضیحات
before Position Integer ستونی که ستون جدید باید قبل از آن اضافه شود.
how Many Integer تعداد ستون هایی که باید درج شود.

بازگشت

Sheet - ورق، مفید برای روش زنجیره ای

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Data Source Sheet(spec)

Data Source Sheet جدیدی را در صفحه گسترده درج می کند و اجرای داده ها را شروع می کند. به عنوان یک عارضه جانبی، این نیز برگه جدید را به برگه فعال تبدیل می کند.

در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای Spreadsheet App#enable...Execution() برای فعال کردن اجرای داده برای نوع منبع داده خاص استفاده کنید. 

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setTableProjectId('bigquery-public-data')
 .setDatasetId('ncaa_basketball')
 .setTableId('mbb_historical_teams_games')
 .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

پارامترها

نام تایپ کنید توضیحات
spec Data Source Spec مشخصات منبع داده برای درج با.

بازگشت

Data Source Sheet - برگه منبع داده جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Image(blobSource, column, row)

یک Spreadsheet به عنوان تصویر در یک سطر و ستون معین در سند درج می کند. اندازه تصویر از محتویات حباب بازیابی می شود. حداکثر اندازه حباب پشتیبانی شده 2 مگابایت است. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

پارامترها

نام تایپ کنید توضیحات
blob Source Blob Source حباب حاوی محتویات تصویر، نوع MIME و (به صورت اختیاری) نام.
column Integer موقعیت ستون.
row Integer موقعیت ردیف.

بازگشت

Over Grid Image - تصویر درج شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Image(blobSource, column, row, offsetX, offsetY)

یک Spreadsheet به عنوان یک تصویر در سند در یک ردیف و ستون معین ، با یک جبران پیکسل درج می کند. اندازه تصویر از محتوای حباب بازیابی می شود. حداکثر اندازه حباب پشتیبانی شده 2MB است. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

پارامترها

نام تایپ کنید توضیحات
blob Source Blob Source حباب حاوی محتویات تصویر ، نوع MIME و نام (اختیاری).
column Integer موقعیت ستون
row Integer موقعیت ردیف
offsetX Integer جبران افقی از گوشه سلول در پیکسل ها.
offsetY Integer جبران عمودی از گوشه سلول در پیکسل ها.

بازگشت

Over Grid Image - تصویر درج شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Image(url, column, row)

تصویری را در سند در یک ردیف و ستون معین وارد می کند.

URL ارائه شده باید در دسترس عموم باشد. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

پارامترها

نام تایپ کنید توضیحات
url String URL تصویر.
column Integer موقعیت ستون شبکه.
row Integer موقعیت ردیف شبکه.

بازگشت

Over Grid Image - تصویر درج شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Image(url, column, row, offsetX, offsetY)

یک تصویر را در یک سند در یک ردیف و ستون معین ، با جبران پیکسل وارد می کند.

URL ارائه شده باید در دسترس عموم باشد. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

پارامترها

نام تایپ کنید توضیحات
url String URL برای تصویر.
column Integer موقعیت ستون
row Integer موقعیت ردیف
offsetX Integer جبران افقی از گوشه سلول در پیکسل ها.
offsetY Integer جبران عمودی از گوشه سلول در پیکسل ها.

بازگشت

Over Grid Image - تصویر درج شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Row After(afterPosition)

یک ردیف را بعد از موقعیت ردیف داده شده وارد کنید. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

پارامترها

نام تایپ کنید توضیحات
after Position Integer ردیف پس از آن باید ردیف جدید اضافه شود.

بازگشت

Sheet - ورق ، برای زنجیر کردن روش مفید است

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Row Before(beforePosition)

یک ردیف را قبل از موقعیت ردیف داده شده وارد کنید. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

پارامترها

نام تایپ کنید توضیحات
before Position Integer ردیف قبل از آن باید ردیف جدید اضافه شود.

بازگشت

Sheet - ورق ، برای زنجیر کردن روش مفید است

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Rows After(afterPosition, howMany)

تعدادی ردیف را پس از موقعیت ردیف داده شده درج می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

پارامترها

نام تایپ کنید توضیحات
after Position Integer ردیف پس از آن باید ردیف های جدید اضافه شود.
how Many Integer تعداد ردیف ها برای درج.

بازگشت

Sheet - ورق ، برای زنجیر کردن روش مفید است

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Rows Before(beforePosition, howMany)

تعدادی از ردیف ها را قبل از موقعیت ردیف داده شده درج می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

پارامترها

نام تایپ کنید توضیحات
before Position Integer ردیف قبل از آن باید ردیف های جدید اضافه شود.
how Many Integer تعداد ردیف ها برای درج.

بازگشت

Sheet - ورق ، برای زنجیر کردن روش مفید است

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet()

با استفاده از نام ورق پیش فرض ، یک برگه جدید را در صفحه گسترده وارد می کند. برگه جدید به ورق فعال تبدیل می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet(sheetIndex)

یک برگه جدید را در صفحه گسترده در فهرست داده شده وارد کنید. برگه جدید به ورق فعال تبدیل می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

پارامترها

نام تایپ کنید توضیحات
sheet Index Integer شاخص برگه تازه ایجاد شده. برای درج یک ورق به عنوان اولین مورد در صفحه گسترده ، آن را روی 0 تنظیم کنید.

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet(sheetIndex, options)

یک برگه جدید را در صفحه گسترده در فهرست داده شده قرار می دهد و از آرگومان های پیشرفته اختیاری استفاده می کند. برگه جدید به ورق فعال تبدیل می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

پارامترها

نام تایپ کنید توضیحات
sheet Index Integer شاخص برگه تازه ایجاد شده. برای درج یک ورق به عنوان اولین مورد در صفحه گسترده ، آن را روی 0 تنظیم کنید.
options Object آرگومان های پیشرفته JavaScript اختیاری.

پارامترهای پیشرفته

نام تایپ کنید توضیحات
template Sheet تمام داده های موجود از شیء ورق الگو در برگه جدید کپی می شوند. الگوی ورق باید یکی از برگه های شیء صفحه گسترده باشد.

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet(options)

با استفاده از نام برگه پیش فرض و آرگومان های پیشرفته اختیاری ، یک برگه جدید را در صفحه گسترده وارد می کند. برگه جدید به ورق فعال تبدیل می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

پارامترها

نام تایپ کنید توضیحات
options Object آرگومان های پیشرفته JavaScript اختیاری ، که در زیر ذکر شده است.

پارامترهای پیشرفته

نام تایپ کنید توضیحات
template Sheet تمام داده های موجود از شیء ورق الگو در برگه جدید کپی می شوند. الگوی ورق باید یکی از برگه های این شیء صفحه گسترده باشد.

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet(sheetName)

یک برگه جدید را با نام داده شده در صفحه گسترده وارد می کند. برگه جدید به ورق فعال تبدیل می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

پارامترها

نام تایپ کنید توضیحات
sheet Name String نام برگه جدید.

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet(sheetName, sheetIndex)

یک برگه جدید را در صفحه گسترده با نام داده شده در فهرست داده شده وارد کنید. برگه جدید به ورق فعال تبدیل می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

پارامترها

نام تایپ کنید توضیحات
sheet Name String نام برگه جدید.
sheet Index Integer شاخص برگه تازه ایجاد شده. برای درج یک ورق به عنوان اولین مورد در صفحه گسترده ، آن را روی 0 تنظیم کنید.

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet(sheetName, sheetIndex, options)

یک برگه جدید را در صفحه گسترده با نام داده شده در فهرست داده شده درج می کند و از آرگومان های پیشرفته اختیاری استفاده می کند. برگه جدید به ورق فعال تبدیل می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

پارامترها

نام تایپ کنید توضیحات
sheet Name String نام برگه جدید.
sheet Index Integer شاخص برگه تازه درج شده. برای درج یک ورق به عنوان اولین مورد در صفحه گسترده ، آن را روی 0 تنظیم کنید.
options Object آرگومان های پیشرفته JavaScript اختیاری.

پارامترهای پیشرفته

نام تایپ کنید توضیحات
template Sheet تمام داده های موجود از شیء ورق الگو در برگه جدید کپی می شوند. الگوی ورق باید یکی از برگه های شیء صفحه گسترده باشد.

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet(sheetName, options)

یک برگه جدید را با نام داده شده در صفحه گسترده وارد می کند و از آرگومان های پیشرفته اختیاری استفاده می کند. برگه جدید به ورق فعال تبدیل می شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

پارامترها

نام تایپ کنید توضیحات
sheet Name String نام برگه جدید.
options Object آرگومان های پیشرفته JavaScript اختیاری.

پارامترهای پیشرفته

نام تایپ کنید توضیحات
template Sheet تمام داده های موجود از شیء ورق الگو در برگه جدید کپی می شوند. الگوی ورق باید یکی از برگه های شیء صفحه گسترده باشد.

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insert Sheet With Data Source Table(spec)

یک برگه جدید در صفحه گسترده درج می کند ، یک Data Source Table را ایجاد می کند که کل برگه را با مشخصات منبع داده داده شده قرار می دهد و اجرای داده ها را شروع می کند. به عنوان یک اثر جانبی ، ورق جدید را به برگه فعال تبدیل می کند.

اگر نوع منبع داده فعال نباشد ، یک استثنا را پرتاب می کند. برای فعال کردن اجرای داده ها برای نوع منبع داده خاص Spreadsheet App#enable...Execution() استفاده کنید. 

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

پارامترها

نام تایپ کنید توضیحات
spec Data Source Spec مشخصات منبع داده برای درج.

بازگشت

Sheet - برگه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

is Column Hidden By User(columnPosition)

باز می گردد که آیا ستون داده شده توسط کاربر پنهان است. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

پارامترها

نام تایپ کنید توضیحات
column Position Integer موقعیت ستون برای بررسی.

بازگشت

Boolean - اگر ستون پنهان باشد ، در غیر این صورت true false .

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

is Iterative Calculation Enabled()

باز می گردد که آیا محاسبه تکراری در این صفحه گسترده فعال شده است. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

بازگشت

Boolean - اگر محاسبه تکراری فعال شود ، در غیر این صورت true false .

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

is Row Hidden By Filter(rowPosition)

باز می گردد که آیا ردیف داده شده توسط یک فیلتر پنهان است (نه نمای فیلتر). 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

پارامترها

نام تایپ کنید توضیحات
row Position Integer موقعیت ردیف برای بررسی.

بازگشت

Boolean - اگر ردیف پنهان باشد ، در غیر این صورت true false .

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

is Row Hidden By User(rowPosition)

باز می گردد که آیا ردیف داده شده توسط کاربر پنهان است. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

پارامترها

نام تایپ کنید توضیحات
row Position Integer موقعیت ردیف برای بررسی.

بازگشت

Boolean - اگر ردیف پنهان باشد ، در غیر این صورت true false .

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

move Active Sheet(pos)

برگه فعال را به موقعیت داده شده در لیست برگه ها منتقل می کند. اگر موقعیت منفی یا بیشتر از تعداد ورق باشد ، استثنا می کند. 

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

پارامترها

نام تایپ کنید توضیحات
pos Integer موقعیت 1 شاخص برای انتقال برگه فعال در لیست برگه ها.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

move Chart To Object Sheet(chart)

یک برگه جدید Sheet Type.OBJECT جدید ایجاد می کند و نمودار ارائه شده را به آن منتقل می کند. اگر نمودار در حال حاضر روی برگه خود باشد ، آن ورق بدون ایجاد یک مورد جدید بازگردانده می شود. 

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

پارامترها

نام تایپ کنید توضیحات
chart Embedded Chart نمودار برای حرکت.

بازگشت

Sheet - برگه ای که نمودار روشن است.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refresh All Data Sources()

تمام منابع داده پشتیبانی شده و اشیاء منبع داده مرتبط با آنها را تازه می کند و از اشیاء منبع داده نامعتبر پرش می کند.

برای فعال کردن اجرای داده ها برای نوع منبع داده خاص Spreadsheet App#enable...Execution() استفاده کنید. 

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(`Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`);

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Editor(emailAddress)

کاربر داده شده را از لیست ویرایشگران برای Spreadsheet حذف می کند. این روش در صورت تعلق به یک کلاس از کاربران که دسترسی عمومی دارند ، کاربران را از دسترسی به Spreadsheet باز نمی کند - برای مثال ، اگر Spreadsheet با کل دامنه کاربر به اشتراک گذاشته شود ، یا اگر Spreadsheet در یک درایو مشترک باشد که کاربر می تواند دسترسی داشته باشد.

برای پرونده های درایو ، این همچنین کاربر را از لیست بینندگان حذف می کند.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای حذف.

بازگشت

Spreadsheet - این Spreadsheet ، برای زنجیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Editor(user)

کاربر داده شده را از لیست ویرایشگران برای Spreadsheet حذف می کند. این روش در صورت تعلق به یک کلاس از کاربران که دسترسی عمومی دارند ، کاربران را از دسترسی به Spreadsheet باز نمی کند - برای مثال ، اگر Spreadsheet با کل دامنه کاربر به اشتراک گذاشته شود ، یا اگر Spreadsheet در یک درایو مشترک باشد که کاربر می تواند دسترسی داشته باشد.

برای پرونده های درایو ، این همچنین کاربر را از لیست بینندگان حذف می کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایندگی کاربر برای حذف.

بازگشت

Spreadsheet - این Spreadsheet ، برای زنجیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Menu(name)

منویی را که با add Menu(name, subMenus) اضافه شده است ، حذف می کند. آرگومان name باید همان مقدار تماس مربوطه را برای add Menu(name, subMenus) داشته باشد. 

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

پارامترها

نام تایپ کنید توضیحات
name String نام منو برای حذف.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Named Range(name)

محدوده نامگذاری شده را با نام مشخص حذف می کند. اگر هیچ محدوده با نام داده شده در صفحه گسترده یافت نشود ، یک استثنا را پرتاب می کند. 

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

پارامترها

نام تایپ کنید توضیحات
name String نام دامنه

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Viewer(emailAddress)

کاربر داده شده را از لیست بینندگان و مفسران برای Spreadsheet حذف می کند. اگر کاربر ویرایشگر باشد ، نه بیننده یا مفسران ، این روش تاثیری ندارد. این روش همچنین اگر به یک کلاس از کاربرانی که دسترسی کلی دارند ، کاربران را از دسترسی به Spreadsheet جلوگیری نمی کند - برای مثال ، اگر Spreadsheet با کل دامنه کاربر به اشتراک گذاشته شود ، یا اگر Spreadsheet در یک درایو مشترک باشد کاربر می تواند دسترسی داشته باشد.

برای پرونده های درایو ، این همچنین کاربر را از لیست ویرایشگران حذف می کند.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای حذف.

بازگشت

Spreadsheet - این Spreadsheet برای زنجیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove Viewer(user)

کاربر داده شده را از لیست بینندگان و مفسران برای Spreadsheet حذف می کند. اگر کاربر ویرایشگر باشد ، نه بیننده ، این روش تاثیری ندارد. این روش همچنین اگر به یک کلاس از کاربرانی که دسترسی کلی دارند ، کاربران را از دسترسی به Spreadsheet جلوگیری نمی کند - برای مثال ، اگر Spreadsheet با کل دامنه کاربر به اشتراک گذاشته شود ، یا اگر Spreadsheet در یک درایو مشترک باشد کاربر می تواند دسترسی داشته باشد.

برای پرونده های درایو ، این همچنین کاربر را از لیست ویرایشگران حذف می کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایندگی کاربر برای حذف.

بازگشت

Spreadsheet - این Spreadsheet برای زنجیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

rename(newName)

تغییر نام سند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

پارامترها

نام تایپ کنید توضیحات
new Name String نام جدید این سند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

rename Active Sheet(newName)

برگه فعال فعلی را به نام جدید داده شده تغییر نام دهید. 

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

پارامترها

نام تایپ کنید توضیحات
new Name String نام جدید برگه فعال فعلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

reset Spreadsheet Theme()

موضوع کاربردی را حذف کرده و موضوع پیش فرض را در صفحه گسترده تنظیم می کند. 

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

بازگشت

Spreadsheet Theme - موضوع پیش فرض.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Active Range(range)

دامنه مشخص شده را به عنوان active range در ورق فعال تنظیم می کند ، با سلول بالا سمت چپ در محدوده به عنوان current cell . 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D4
var activeRange = selection.getActiveRange();

پارامترها

نام تایپ کنید توضیحات
range Range دامنه ای که به عنوان محدوده فعال تنظیم می شود.

بازگشت

Range - محدوده تازه فعال

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Active Range List(rangeList)

لیست مشخص شده دامنه ها را به عنوان active ranges در برگه فعال تنظیم می کند. آخرین محدوده در لیست به عنوان active range تنظیم شده است. 

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

پارامترها

نام تایپ کنید توضیحات
range List Range List لیست محدوده ها برای انتخاب.

بازگشت

Range List - لیست تازه انتخاب شده محدوده ها

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Active Selection(range)

منطقه انتخاب فعال را برای این برگه تنظیم می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

پارامترها

نام تایپ کنید توضیحات
range Range دامنه ای که به عنوان انتخاب فعال تنظیم می شود.

بازگشت

Range - محدوده تازه فعال

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Active Selection(a1Notation)

انتخاب فعال را تنظیم می کند ، همانطور که در نماد A1 یا نماد R1C1 مشخص شده است. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.setActiveSelection("A1:D4");

پارامترها

نام تایپ کنید توضیحات
a1Notation String دامنه تنظیم شده به عنوان فعال ، همانطور که در نماد A1 یا نماد R1C1 مشخص شده است.

بازگشت

Range - محدوده تازه فعال

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Active Sheet(sheet)

برگه داده شده را به عنوان ورق فعال در صفحه گسترده تنظیم می کند. UI برگه Google برگه انتخاب شده را نشان می دهد مگر اینکه این برگه متعلق به یک صفحه گسترده باشد. 

// The code below makes the first sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

پارامترها

نام تایپ کنید توضیحات
sheet Sheet ورق به عنوان ورق فعال تنظیم شده است.

بازگشت

Sheet - ورق فعال.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Active Sheet(sheet, restoreSelection)

برگه داده شده را به عنوان برگه فعال در صفحه گسترده تنظیم می کند ، با گزینه ای برای بازگرداندن جدیدترین انتخاب در آن برگ. UI برگه Google برگه انتخاب شده را نشان می دهد مگر اینکه این برگه متعلق به یک صفحه گسترده باشد. 

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

پارامترها

نام تایپ کنید توضیحات
sheet Sheet برگه فعال جدید.
restore Selection Boolean TF true ، با فعال شدن برگه جدید ، جدیدترین انتخاب برگه فعال جدید دوباره انتخاب می شود. اگر false ، برگه جدید بدون تغییر انتخاب فعلی فعال می شود.

بازگشت

Sheet - برگه فعال جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Column Width(columnPosition, width)

عرض ستون داده شده را در پیکسل ها تنظیم می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

پارامترها

نام تایپ کنید توضیحات
column Position Integer موقعیت ستون داده شده برای تنظیم.
width Integer عرض در پیکسل ها برای تنظیم آن.

بازگشت

Sheet - ورق ، برای زنجیر کردن روش مفید است

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Current Cell(cell)

سلول مشخص شده را به عنوان current cell تنظیم می کند.

اگر سلول مشخص شده در یک محدوده از قبل انتخاب شده موجود باشد ، آن دامنه به عنوان سلول فعلی با سلول به عنوان سلول فعال می شود.

اگر سلول مشخص شده در هیچ محدوده انتخابی موجود نباشد ، هر انتخاب موجود حذف می شود و سلول به سلول فعلی و دامنه فعال تبدیل می شود.

توجه: Range مشخص شده باید از یک سلول تشکیل شود ، در غیر این صورت یک استثنا را به وجود می آورد. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

پارامترها

نام تایپ کنید توضیحات
cell Range سلول به عنوان سلول فعلی تنظیم می شود.

بازگشت

Range - سلول فعلی جدید تنظیم شده

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Frozen Columns(columns)

تعداد ستون ها را یخ می زند. اگر صفر باشد ، هیچ ستون یخ زده نیست. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

پارامترها

نام تایپ کنید توضیحات
columns Integer تعداد ستون ها برای یخ زدن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Frozen Rows(rows)

تعداد مشخصی از ردیف ها را یخ می زند. اگر صفر باشد ، هیچ ردیف منجمد نمی شود. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

پارامترها

نام تایپ کنید توضیحات
rows Integer تعداد ردیف ها برای یخ زدن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Iterative Calculation Convergence Threshold(minThreshold)

حداقل مقدار آستانه را برای محاسبه تکراری تعیین می کند. هنگامی که نتایج محاسبه پی در پی با کمتر از این مقدار متفاوت است ، محاسبه تکراری متوقف می شود. این مقدار باید غیر منفی و پیش فرض 0.05 باشد. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

پارامترها

نام تایپ کنید توضیحات
min Threshold Number حداقل آستانه همگرایی (باید غیر منفی باشد).

بازگشت

Spreadsheet - این صفحه گسترده ، برای زنجیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Iterative Calculation Enabled(isEnabled)

تعیین می کند که آیا محاسبه تکراری در این صفحه گسترده فعال شده است. اگر حداکثر تعداد چرخه محاسبه و آستانه همگرایی قبلاً هنگام فعال شدن محاسبه تنظیم نشده باشد ، آنها به ترتیب به ترتیب به 50 و 0.05 پیش فرض می شوند. اگر قبلاً تنظیم شده باشد ، مقادیر قبلی خود را حفظ می کنند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

پارامترها

نام تایپ کنید توضیحات
is Enabled Boolean اگر محاسبه تکراری باید فعال شود ، true . false در غیر این صورت

بازگشت

Spreadsheet - این صفحه گسترده ، برای زنجیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Max Iterative Calculation Cycles(maxIterations)

حداکثر تعداد تکرارهای محاسبه را که باید در طول محاسبه تکراری انجام شود ، تعیین می کند. این مقدار باید بین 1 تا 10،000 (فراگیر) و پیش فرض تا 50 باشد. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

پارامترها

نام تایپ کنید توضیحات
max Iterations Integer حداکثر تعداد تکرارهای محاسبه (بین 1 تا 10،000).

بازگشت

Spreadsheet - این صفحه گسترده ، برای زنجیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Named Range(name, range)

دامنه ای را نامگذاری می کند. 

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

پارامترها

نام تایپ کنید توضیحات
name String نامی برای ارائه دامنه.
range Range مشخصات دامنه

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Recalculation Interval(recalculationInterval)

تنظیم می کند که چند بار این صفحه گسترده باید محاسبه شود. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

پارامترها

نام تایپ کنید توضیحات
recalculation Interval Recalculation Interval فاصله محاسبه مجدد جدید.

بازگشت

Spreadsheet - این صفحه گسترده ، برای زنجیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Row Height(rowPosition, height)

ارتفاع ردیف ردیف داده شده را در پیکسل ها تنظیم می کند. به طور پیش فرض ، ردیف ها رشد می کنند تا محتوای سلول متناسب باشند. اگر می خواهید ردیف ها را به یک ارتفاع مشخص مجبور کنید ، از Sheet.setRowHeightsForced(startRow, numRows, height) استفاده کنید. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

پارامترها

نام تایپ کنید توضیحات
row Position Integer موقعیت ردیف برای تغییر.
height Integer ارتفاع پیکسل ها برای تنظیم آن.

بازگشت

Sheet - ورق ، برای زنجیره روش مفید است.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Spreadsheet Locale(locale)

محل صفحه گسترده را تنظیم می کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

پارامترها

نام تایپ کنید توضیحات
locale String کد محلی برای استفاده (به عنوان مثال ، "en" ، "fr" یا "en_us").

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Spreadsheet Theme(theme)

یک موضوع را در صفحه گسترده تنظیم می کند. 

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

پارامترها

نام تایپ کنید توضیحات
theme Spreadsheet Theme موضوع برای اعمال

بازگشت

Spreadsheet Theme - موضوع جدید فعلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

set Spreadsheet Time Zone(timezone)

منطقه زمانی را برای صفحه گسترده تنظیم می کند. 

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

پارامترها

نام تایپ کنید توضیحات
timezone String منطقه زمانی ، که در قالب "طولانی" مشخص شده است (به عنوان مثال ، "آمریکا/new_york" ، همانطور که توسط joda.org ذکر شده است).

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

show(userInterface)

یک مؤلفه رابط کاربری سفارشی را در یک گفتگو با محوریت نمای مرورگر کاربر نشان می دهد. اجرای اسکریپت سمت سرور به حالت تعلیق در نمی آید. برای برقراری ارتباط با سمت سرور ، مؤلفه رابط کاربری باید پاسخ های ناهمزمان را به اسکریپت سمت سرور تبدیل کند.

اگر اسکریپت سمت سرور قبلاً دیالوگ را نمایش داده بود که هنوز رد نشده است ، گفتگوی موجود با رابط کاربری گفتگوی تازه درخواست شده جایگزین می شود.

قطعه کد زیر یک برنامه Html Service ساده را در یک گفتگو با عنوان ، ارتفاع و عرض مشخص شده نشان می دهد: 

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

پارامترها

نام تایپ کنید توضیحات
user Interface Object Html Output .

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/script.container.ui

sort(columnPosition)

یک ورق بر ستون ، صعودی را مرتب می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

پارامترها

نام تایپ کنید توضیحات
column Position Integer ستون برای مرتب کردن.

بازگشت

Sheet - ورق ، برای زنجیر کردن روش مفید است

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(columnPosition, ascending)

یک ورق بر ستون را مرتب می کند. پارامتر را برای مشخص کردن صعود یا نزولی می گیرد. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

پارامترها

نام تایپ کنید توضیحات
column Position Integer ستون برای مرتب کردن.
ascending Boolean برای انواع صعودی ، false برای نزولی true .

بازگشت

Sheet - ورق ، برای زنجیر کردن روش مفید است

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

toast(msg)

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

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

پارامترها

نام تایپ کنید توضیحات
msg String پیام نشان داده شده در نان تست.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

toast(msg, title)

یک پنجره بازشو را در گوشه پایین سمت راست صفحه گسترده با پیام و عنوان داده شده نشان می دهد. 

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

پارامترها

نام تایپ کنید توضیحات
msg String پیام نشان داده شده در نان تست.
title String عنوان اختیاری نان تست.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

toast(msg, title, timeoutSeconds)

یک پنجره بازشو را در گوشه سمت راست پایین صفحه گسترده با عنوان و پیام داده شده نشان می دهد که برای مدت زمان مشخصی قابل مشاهده است. 

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

پارامترها

نام تایپ کنید توضیحات
msg String پیام نشان داده شده در نان تست.
title String عنوان اختیاری نان تست.
timeout Seconds Number مدت زمان در ثانیه ؛ اگر null ، نان تست به 5 ثانیه پیش فرض می شود. اگر منفی باشد ، نان تست تا زمان برکناری باقی می ماند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

unhide Column(column)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

پارامترها

نام تایپ کنید توضیحات
column Range اگر پنهان باشد ، محدوده ای برای خنثی کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

unhide Row(row)

ردیف را در محدوده داده شده باز می کند. 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

پارامترها

نام تایپ کنید توضیحات
row Range اگر پنهان باشد ، محدوده ای برای خنثی کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

update Menu(name, subMenus)

منویی را که با add Menu(name, subMenus) اضافه شده است ، به روز می کند. دقیقاً مانند add Menu(name, subMenus) . 

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

پارامترها

نام تایپ کنید توضیحات
name String نام منو برای به روزرسانی.
sub Menus Object[] مجموعه ای از نقشه های JavaScript با پارامترهای name و function Name . شما می توانید از توابع کتابخانه های موجود ، مانند Library.libFunction1 استفاده کنید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

wait For All Data Executions Completion(timeoutInSeconds)

منتظر بمانید تا تمام اعدام های فعلی در صفحه گسترده کامل شود و بعد از تعداد ارائه شده از ثانیه زمان بندی شود. اگر اعدام ها هنگام پایان زمان به پایان نرسند ، استثنا می کند ، اما اعدام داده ها را لغو نمی کند.

پارامترها

نام تایپ کنید توضیحات
timeout In Seconds Integer زمان انتظار برای اعدام داده ها ، در ثانیه. حداکثر 300 ثانیه است.

مجوز

اسکریپت هایی که از این روش استفاده می کنند ، نیاز به مجوز با یک یا چند مورد زیر دارند:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

روشهای مستهلک