به فایلهای Google Sheets دسترسی داشته باشید و آنها را تغییر دهید. عملیات رایج اضافه کردن برگههای جدید و افزودن همکاران است.
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
addDeveloperMetadata(key) | Spreadsheet | ابرداده برنامهنویس را با کلید مشخص شده به صفحهگسترده سطح بالا اضافه میکند. |
addDeveloperMetadata(key, visibility) | Spreadsheet | ابرداده برنامهنویس را با کلید مشخص شده و قابلیت مشاهده به صفحهگسترده اضافه میکند. |
addDeveloperMetadata(key, value) | Spreadsheet | ابرداده توسعه دهنده را با کلید و مقدار مشخص شده به صفحه گسترده اضافه می کند. |
addDeveloperMetadata(key, value, visibility) | Spreadsheet | ابرداده توسعهدهنده را با کلید، مقدار و قابلیت مشاهده به صفحه گسترده اضافه میکند. |
addEditor(emailAddress) | Spreadsheet | کاربر داده شده را به لیست ویرایشگرهای Spreadsheet اضافه می کند. |
addEditor(user) | Spreadsheet | کاربر داده شده را به لیست ویرایشگرهای Spreadsheet اضافه می کند. |
addEditors(emailAddresses) | Spreadsheet | آرایه داده شده از کاربران را به لیست ویرایشگرهای Spreadsheet اضافه می کند. |
addMenu(name, subMenus) | void | یک منوی جدید در رابط کاربر صفحه گسترده ایجاد می کند. |
addViewer(emailAddress) | Spreadsheet | کاربر داده شده را به لیست بینندگان Spreadsheet اضافه می کند. |
addViewer(user) | Spreadsheet | کاربر داده شده را به لیست بینندگان Spreadsheet اضافه می کند. |
addViewers(emailAddresses) | Spreadsheet | آرایه داده شده از کاربران را به لیست بینندگان Spreadsheet اضافه می کند. |
appendRow(rowContents) | Sheet | یک ردیف به پایین منطقه داده فعلی در برگه اضافه می کند. |
autoResizeColumn(columnPosition) | Sheet | عرض ستون داده شده را متناسب با محتوای آن تنظیم می کند. |
copy(name) | Spreadsheet | صفحه گسترده را کپی می کند و صفحه جدید را برمی گرداند. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | یک DeveloperMetadataFinder را برای یافتن ابرداده توسعهدهنده در محدوده این صفحهگسترده برمیگرداند. |
createTextFinder(findText) | TextFinder | یک متن یاب برای صفحه گسترده ایجاد می کند که می تواند برای یافتن و جایگزینی متن در صفحه گسترده استفاده شود. |
deleteActiveSheet() | Sheet | برگه فعال فعلی را حذف می کند. |
deleteColumn(columnPosition) | Sheet | ستون را در موقعیت ستون داده شده حذف می کند. |
deleteColumns(columnPosition, howMany) | void | تعدادی از ستون هایی که از موقعیت ستون داده شده شروع می شوند را حذف می کند. |
deleteRow(rowPosition) | Sheet | ردیف را در موقعیت ردیف داده شده حذف می کند. |
deleteRows(rowPosition, howMany) | void | تعدادی از ردیف هایی که از موقعیت ردیف داده شده شروع می شوند را حذف می کند. |
deleteSheet(sheet) | void | برگه مشخص شده را حذف می کند. |
duplicateActiveSheet() | Sheet | برگه فعال را کپی می کند و آن را به برگه فعال تبدیل می کند. |
getActiveCell() | Range | سلول فعال در این برگه را برمی گرداند. |
getActiveRange() | Range | محدوده انتخاب شده را در برگه فعال برمیگرداند، یا اگر محدوده فعالی وجود نداشته باشد null . |
getActiveRangeList() | RangeList | لیست محدوده های فعال را در برگه فعال برمی گرداند یا اگر محدوده فعالی وجود نداشته باشد null برمی گرداند. |
getActiveSheet() | Sheet | برگه فعال را در یک صفحه گسترده دریافت می کند. |
getAs(contentType) | Blob | داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید. |
getBandings() | Banding[] | همه باندهای موجود در این صفحه گسترده را برمی گرداند. |
getBlob() | Blob | داده های داخل این شی را به صورت حباب برگردانید. |
getColumnWidth(columnPosition) | Integer | عرض ستون داده شده را بر حسب پیکسل دریافت می کند. |
getCurrentCell() | Range | سلول فعلی در برگه فعال را برمیگرداند یا اگر سلول فعلی وجود نداشته باشد، null برمیگرداند. |
getDataRange() | Range | یک Range مربوط به ابعادی که داده در آن وجود دارد را برمیگرداند. |
getDataSourceFormulas() | DataSourceFormula[] | تمام فرمول های منبع داده را دریافت می کند. |
getDataSourcePivotTables() | DataSourcePivotTable[] | تمام جداول محوری منبع داده را دریافت می کند. |
getDataSourceRefreshSchedules() | DataSourceRefreshSchedule[] | برنامههای بهروزرسانی این صفحهگسترده را دریافت میکند. |
getDataSourceSheets() | DataSourceSheet[] | همه برگه های منبع داده را در صفحه گسترده برمی گرداند. |
getDataSourceTables() | DataSourceTable[] | تمام جداول منبع داده را دریافت می کند. |
getDataSources() | DataSource[] | همه منابع داده را در صفحه گسترده برمی گرداند. |
getDeveloperMetadata() | DeveloperMetadata[] | فراداده برنامهنویس مرتبط با صفحهگسترده سطح بالا را دریافت میکند. |
getEditors() | User[] | لیست ویرایشگران این Spreadsheet را دریافت می کند. |
getFormUrl() | String | نشانی اینترنتی فرمی را که پاسخهای خود را به این صفحهگسترده ارسال میکند، برمیگرداند، یا اگر این صفحهگسترده هیچ فرم مرتبطی نداشته باشد، null . |
getFrozenColumns() | Integer | تعداد ستون های ثابت شده را برمی گرداند. |
getFrozenRows() | Integer | تعداد ردیفهای ثابت شده را برمیگرداند. |
getId() | String | یک شناسه منحصر به فرد برای این صفحه گسترده دریافت می کند. |
getImages() | OverGridImage[] | همه تصاویر خارج از شبکه را بر روی صفحه برمی گرداند. |
getIterativeCalculationConvergenceThreshold() | Number | مقدار آستانه استفاده شده در طول محاسبه تکراری را برمیگرداند. |
getLastColumn() | Integer | موقعیت آخرین ستونی که محتوا دارد را برمیگرداند. |
getLastRow() | Integer | موقعیت آخرین ردیفی که محتوا دارد را برمیگرداند. |
getMaxIterativeCalculationCycles() | Integer | حداکثر تعداد تکرارها را برای استفاده در حین محاسبه تکراری برمیگرداند. |
getName() | String | نام سند را دریافت می کند. |
getNamedRanges() | NamedRange[] | تمام محدوده های نامگذاری شده در این صفحه گسترده را دریافت می کند. |
getNumSheets() | Integer | تعداد برگههای این صفحهگسترده را برمیگرداند. |
getOwner() | User | مالک سند را برمیگرداند، یا برای سندی در درایو مشترک، null . |
getPredefinedSpreadsheetThemes() | SpreadsheetTheme[] | لیست تم های از پیش تعریف شده را برمی گرداند. |
getProtections(type) | Protection[] | آرایه ای از اشیاء را دریافت می کند که همه محدوده ها یا صفحات محافظت شده را در صفحه گسترده نشان می دهد. |
getRange(a1Notation) | Range | محدوده مشخص شده در نماد A1 یا R1C1 را برمیگرداند. |
getRangeByName(name) | Range | یک محدوده با نام را برمیگرداند، یا اگر محدودهای با نام دادهشده یافت نشد، null برمیگرداند. |
getRangeList(a1Notations) | RangeList | مجموعه RangeList را باز می گرداند که محدوده هایی را در همان برگه مشخص شده توسط یک لیست غیرخالی از نمادهای A1 یا نمادهای R1C1 نشان می دهد. |
getRecalculationInterval() | RecalculationInterval | فاصله محاسبه را برای این صفحهگسترده برمیگرداند. |
getRowHeight(rowPosition) | Integer | ارتفاع ردیف داده شده را بر حسب پیکسل دریافت می کند. |
getSelection() | Selection | Selection فعلی را در صفحه گسترده برمیگرداند. |
getSheetByName(name) | Sheet | برگه ای را با نام داده شده برمی گرداند. |
getSheetId() | Integer | شناسه برگه نشان داده شده توسط این شی را برمی گرداند. |
getSheetName() | String | نام برگه را برمی گرداند. |
getSheetValues(startRow, startColumn, numRows, numColumns) | Object[][] | شبکه مستطیلی مقادیر را برای این محدوده که از مختصات داده شده شروع می شود، برمی گرداند. |
getSheets() | Sheet[] | همه برگه های این صفحه گسترده را دریافت می کند. |
getSpreadsheetLocale() | String | محل صفحه گسترده را دریافت می کند. |
getSpreadsheetTheme() | SpreadsheetTheme | موضوع فعلی صفحهگسترده را برمیگرداند، یا اگر طرح زمینه اعمال نشود، null . |
getSpreadsheetTimeZone() | String | منطقه زمانی صفحه گسترده را دریافت می کند. |
getUrl() | String | URL صفحه گسترده داده شده را برمی گرداند. |
getViewers() | User[] | لیست بینندگان و نظر دهندگان را برای این Spreadsheet دریافت می کند. |
hideColumn(column) | void | ستون یا ستون ها را در محدوده داده شده پنهان می کند. |
hideRow(row) | void | سطرها را در محدوده داده شده پنهان می کند. |
insertColumnAfter(afterPosition) | Sheet | ستونی را بعد از موقعیت ستون داده شده درج می کند. |
insertColumnBefore(beforePosition) | Sheet | یک ستون را قبل از موقعیت ستون داده شده درج می کند. |
insertColumnsAfter(afterPosition, howMany) | Sheet | تعداد مشخصی از ستون ها را بعد از موقعیت ستون داده شده درج می کند. |
insertColumnsBefore(beforePosition, howMany) | Sheet | تعدادی ستون را قبل از موقعیت ستون داده شده درج می کند. |
insertDataSourceSheet(spec) | DataSourceSheet | یک DataSourceSheet جدید را در صفحه گسترده درج می کند و اجرای داده ها را شروع می کند. |
insertImage(blobSource, column, row) | OverGridImage | یک Spreadsheet به عنوان تصویر در یک سطر و ستون معین در سند درج می کند. |
insertImage(blobSource, column, row, offsetX, offsetY) | OverGridImage | یک Spreadsheet به عنوان تصویر در یک سطر و ستون معین، با فاصله پیکسلی در سند درج می کند. |
insertImage(url, column, row) | OverGridImage | یک تصویر را در یک ردیف و ستون معین در سند درج می کند. |
insertImage(url, column, row, offsetX, offsetY) | OverGridImage | یک تصویر را در یک ردیف و ستون معین، با فاصله پیکسلی در سند درج می کند. |
insertRowAfter(afterPosition) | Sheet | یک ردیف بعد از موقعیت ردیف داده شده درج می کند. |
insertRowBefore(beforePosition) | Sheet | یک ردیف قبل از موقعیت ردیف داده شده درج می کند. |
insertRowsAfter(afterPosition, howMany) | Sheet | تعدادی ردیف را بعد از موقعیت ردیف داده شده درج می کند. |
insertRowsBefore(beforePosition, howMany) | Sheet | تعدادی ردیف را قبل از موقعیت ردیف داده شده درج می کند. |
insertSheet() | Sheet | با استفاده از نام صفحه پیش فرض، یک صفحه جدید را در صفحه گسترده وارد می کند. |
insertSheet(sheetIndex) | Sheet | یک صفحه جدید را در فهرست داده شده در صفحه گسترده وارد می کند. |
insertSheet(sheetIndex, options) | Sheet | یک صفحه جدید را در صفحه گسترده در شاخص داده شده درج می کند و از آرگومان های پیشرفته اختیاری استفاده می کند. |
insertSheet(options) | Sheet | با استفاده از نام صفحه پیشفرض و آرگومانهای پیشرفته اختیاری، یک صفحه جدید را در صفحهگسترده درج میکند. |
insertSheet(sheetName) | Sheet | یک صفحه جدید با نام داده شده را در صفحه گسترده وارد می کند. |
insertSheet(sheetName, sheetIndex) | Sheet | یک صفحه جدید با نام داده شده در فهرست داده شده در صفحه گسترده وارد می کند. |
insertSheet(sheetName, sheetIndex, options) | Sheet | یک صفحه جدید با نام داده شده در فهرست داده شده در صفحه گسترده وارد می کند و از آرگومان های پیشرفته اختیاری استفاده می کند. |
insertSheet(sheetName, options) | Sheet | یک صفحه جدید با نام داده شده در صفحه گسترده وارد می کند و از آرگومان های پیشرفته اختیاری استفاده می کند. |
insertSheetWithDataSourceTable(spec) | Sheet | یک صفحه جدید را در صفحه گسترده وارد می کند، یک DataSourceTable ایجاد می کند که کل صفحه را با مشخصات منبع داده داده شده در بر می گیرد، و اجرای داده ها را شروع می کند. |
isColumnHiddenByUser(columnPosition) | Boolean | نشان می دهد که آیا ستون داده شده توسط کاربر پنهان شده است یا خیر. |
isIterativeCalculationEnabled() | Boolean | نشان می دهد که آیا محاسبه تکراری در این صفحه گسترده فعال شده است یا خیر. |
isRowHiddenByFilter(rowPosition) | Boolean | نشان می دهد که آیا ردیف داده شده توسط یک فیلتر (نه نمای فیلتر) پنهان شده است یا خیر. |
isRowHiddenByUser(rowPosition) | Boolean | نشان می دهد که آیا ردیف داده شده توسط کاربر پنهان شده است یا خیر. |
moveActiveSheet(pos) | void | برگه فعال را به موقعیت داده شده در لیست برگه ها منتقل می کند. |
moveChartToObjectSheet(chart) | Sheet | یک صفحه SheetType.OBJECT جدید ایجاد می کند و نمودار ارائه شده را به آن منتقل می کند. |
refreshAllDataSources() | void | همه منابع داده پشتیبانی شده و اشیاء منبع داده مرتبط آنها را بازخوانی می کند، از اشیاء منبع داده نامعتبر صرف نظر می کند. |
removeEditor(emailAddress) | Spreadsheet | کاربر داده شده را از لیست ویرایشگرهای Spreadsheet حذف می کند. |
removeEditor(user) | Spreadsheet | کاربر داده شده را از لیست ویرایشگرهای Spreadsheet حذف می کند. |
removeMenu(name) | void | منوی اضافه شده توسط addMenu(name, subMenus) را حذف می کند. |
removeNamedRange(name) | void | یک محدوده نامگذاری شده با نام داده شده را حذف می کند. |
removeViewer(emailAddress) | Spreadsheet | کاربر داده شده را از لیست بینندگان و نظر دهندگان Spreadsheet حذف می کند. |
removeViewer(user) | Spreadsheet | کاربر داده شده را از لیست بینندگان و نظر دهندگان Spreadsheet حذف می کند. |
rename(newName) | void | سند را تغییر نام می دهد. |
renameActiveSheet(newName) | void | برگه فعال فعلی را به نام جدید داده شده تغییر نام می دهد. |
resetSpreadsheetTheme() | SpreadsheetTheme | طرح زمینه اعمال شده را حذف می کند و موضوع پیش فرض را در صفحه گسترده تنظیم می کند. |
setActiveRange(range) | Range | محدوده مشخص شده را به عنوان active range در برگه فعال، با سلول بالا سمت چپ در محدوده به عنوان current cell تنظیم می کند. |
setActiveRangeList(rangeList) | RangeList | لیست مشخص شده محدوده ها را به عنوان active ranges در برگه فعال تنظیم می کند. |
setActiveSelection(range) | Range | منطقه انتخاب فعال را برای این برگه تنظیم می کند. |
setActiveSelection(a1Notation) | Range | انتخاب فعال را همانطور که در نماد A1 یا R1C1 مشخص شده است، تنظیم می کند. |
setActiveSheet(sheet) | Sheet | صفحه داده شده را به عنوان برگه فعال در صفحه گسترده تنظیم می کند. |
setActiveSheet(sheet, restoreSelection) | Sheet | برگه داده شده را به عنوان برگه فعال در صفحه گسترده تنظیم می کند، با گزینه ای برای بازیابی جدیدترین انتخاب در آن صفحه. |
setColumnWidth(columnPosition, width) | Sheet | عرض ستون داده شده را بر حسب پیکسل تنظیم می کند. |
setCurrentCell(cell) | Range | سلول مشخص شده را به عنوان current cell تنظیم می کند. |
setFrozenColumns(columns) | void | تعداد ستون ها را ثابت می کند. |
setFrozenRows(rows) | void | تعداد ردیف های داده شده را ثابت می کند. |
setIterativeCalculationConvergenceThreshold(minThreshold) | Spreadsheet | حداقل مقدار آستانه را برای محاسبه تکراری تنظیم می کند. |
setIterativeCalculationEnabled(isEnabled) | Spreadsheet | تنظیم می کند که آیا محاسبه تکراری در این صفحه گسترده فعال شود یا خیر. |
setMaxIterativeCalculationCycles(maxIterations) | Spreadsheet | حداکثر تعداد تکرارهای محاسباتی را که باید در حین محاسبه تکراری انجام شوند را تنظیم می کند. |
setNamedRange(name, range) | void | یک محدوده را نام می برد. |
setRecalculationInterval(recalculationInterval) | Spreadsheet | تعیین میکند این صفحهگسترده چقدر باید دوباره محاسبه شود. |
setRowHeight(rowPosition, height) | Sheet | ارتفاع ردیف ردیف داده شده را بر حسب پیکسل تنظیم می کند. |
setSpreadsheetLocale(locale) | void | محل صفحه گسترده را تنظیم می کند. |
setSpreadsheetTheme(theme) | SpreadsheetTheme | یک موضوع را در صفحه گسترده تنظیم می کند. |
setSpreadsheetTimeZone(timezone) | void | منطقه زمانی صفحه گسترده را تنظیم می کند. |
show(userInterface) | void | یک جزء رابط کاربری سفارشی را در یک گفتگو در مرکز نمای مرورگر کاربر نمایش می دهد. |
sort(columnPosition) | Sheet | یک ورق را بر اساس ستون، صعودی مرتب می کند. |
sort(columnPosition, ascending) | Sheet | یک ورق را به ستون مرتب می کند. |
toast(msg) | void | یک پنجره بازشو در گوشه سمت راست پایین صفحه گسترده با پیام داده شده نشان می دهد. |
toast(msg, title) | void | یک پنجره بازشو در گوشه سمت راست پایین صفحه گسترده با پیام و عنوان داده شده نشان می دهد. |
toast(msg, title, timeoutSeconds) | void | یک پنجره بازشو در گوشه سمت راست پایین صفحه گسترده با عنوان و پیام داده شده نشان می دهد که برای مدت زمان مشخصی قابل مشاهده می ماند. |
unhideColumn(column) | void | ستون را در محدوده داده شده باز می کند. |
unhideRow(row) | void | ردیف را در محدوده داده شده نشان می دهد. |
updateMenu(name, subMenus) | void | منویی را که توسط addMenu(name, subMenus) اضافه شده است به روز می کند. |
waitForAllDataExecutionsCompletion(timeoutInSeconds) | void | صبر می کند تا تمام اجرای فعلی در صفحه گسترده کامل شود و پس از تعداد ثانیه های ارائه شده به پایان می رسد. |
مستندات دقیق
addDeveloperMetadata(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
addDeveloperMetadata(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 | DeveloperMetadataVisibility | قابلیت مشاهده ابرداده توسعهدهنده جدید. |
بازگشت
Spreadsheet
- این صفحه گسترده، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(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
addDeveloperMetadata(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 | DeveloperMetadataVisibility | قابلیت مشاهده ابرداده توسعهدهنده جدید. |
بازگشت
Spreadsheet
- این صفحه گسترده، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditor(emailAddress)
کاربر داده شده را به لیست ویرایشگرهای Spreadsheet
اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای افزودن |
بازگشت
Spreadsheet
- این Spreadsheet
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditor(user)
کاربر داده شده را به لیست ویرایشگرهای Spreadsheet
اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایشی از کاربر برای افزودن. |
بازگشت
Spreadsheet
- این Spreadsheet
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditors(emailAddresses)
آرایه داده شده از کاربران را به لیست ویرایشگرهای Spreadsheet
اضافه می کند. اگر هر یک از کاربران قبلاً در لیست بینندگان بودند، این روش آنها را از لیست بینندگان خارج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddresses | String[] | مجموعه ای از آدرس های ایمیل کاربران برای اضافه کردن. |
بازگشت
Spreadsheet
- این Spreadsheet
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addMenu(name, subMenus)
یک منوی جدید در رابط کاربر صفحه گسترده ایجاد می کند.
هر ورودی منو یک تابع تعریف شده توسط کاربر را اجرا می کند. معمولاً میخواهید آن را از تابع onOpen()
فراخوانی کنید تا با بارگیری صفحهگسترده، منو بهطور خودکار ایجاد شود.
// 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 | نام منوی ایجاد شده |
subMenus | Object[] | آرایه ای از نقشه های جاوا اسکریپت با پارامترهای name و functionName . می توانید از توابع کتابخانه های موجود مانند Library.libFunction1 استفاده کنید. |
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addViewer(emailAddress)
کاربر داده شده را به لیست بینندگان Spreadsheet
اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای افزودن |
بازگشت
Spreadsheet
- این Spreadsheet
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addViewer(user)
کاربر داده شده را به لیست بینندگان Spreadsheet
اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایشی از کاربر برای افزودن. |
بازگشت
Spreadsheet
- این Spreadsheet
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addViewers(emailAddresses)
آرایه داده شده از کاربران را به لیست بینندگان Spreadsheet
اضافه می کند. اگر هر یک از کاربران قبلاً در لیست ویرایشگرها بودند، این روش برای آنها تأثیری ندارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddresses | String[] | مجموعه ای از آدرس های ایمیل کاربران برای افزودن. |
بازگشت
Spreadsheet
- این Spreadsheet
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
appendRow(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"]);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
rowContents | Object[] | آرایه ای از مقادیر برای درج بعد از آخرین ردیف در برگه. |
بازگشت
Sheet
- ورق، مفید برای زنجیره روش.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumn(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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
columnPosition | 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
createDeveloperMetadataFinder()
یک DeveloperMetadataFinder
را برای یافتن ابرداده توسعهدهنده در محدوده این صفحهگسترده برمیگرداند. بهطور پیشفرض، تمام ابردادههای مرتبط با صفحهگسترده، برگهها، ردیفها و ستونها را در نظر میگیرد.
// 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());
بازگشت
DeveloperMetadataFinder
- یاب فراداده توسعه دهنده برای جستجوی ابرداده در محدوده این صفحه گسترده.
createTextFinder(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');
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
findText | String | متن مورد جستجو |
بازگشت
TextFinder
- TextFinder
برای صفحه گسترده.
deleteActiveSheet()
برگه فعال فعلی را حذف می کند.
// 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
deleteColumn(columnPosition)
ستون را در موقعیت ستون داده شده حذف می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first column sheet.deleteColumn(1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
columnPosition | Integer | موقعیت ستون، از 1 برای ستون اول شروع می شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
deleteColumns(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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
columnPosition | Integer | موقعیت اولین ستون برای حذف. |
howMany | Integer | تعداد ستون هایی که باید حذف شوند. |
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
deleteRow(rowPosition)
ردیف را در موقعیت ردیف داده شده حذف می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first row sheet.deleteRow(1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
rowPosition | Integer | موقعیت ردیف، از 1 برای ردیف اول شروع می شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
deleteRows(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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
rowPosition | Integer | موقعیت ردیف اول برای حذف. |
howMany | Integer | تعداد ردیف هایی که باید حذف شوند. |
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
deleteSheet(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
duplicateActiveSheet()
برگه فعال را کپی می کند و آن را به برگه فعال تبدیل می کند.
// 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
getActiveCell()
سلول فعال در این برگه را برمی گرداند.
توجه: ترجیحاً از getCurrentCell()
استفاده کنید که سلول هایلایت شده فعلی را برمی گرداند.
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
getActiveRange()
محدوده انتخاب شده را در برگه فعال برمیگرداند، یا اگر محدوده فعالی وجود نداشته باشد null
. اگر چندین محدوده انتخاب شده باشد، این روش فقط آخرین محدوده انتخاب شده را برمی گرداند.
اصطلاح "محدوده فعال" به محدوده ای اطلاق می شود که کاربر در برگه فعال انتخاب کرده است، اما در یک تابع سفارشی به سلولی اشاره دارد که به طور فعال دوباره محاسبه می شود.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var activeRange = sheet.getActiveRange();
بازگشت
Range
- محدوده فعال
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
همچنین ببینید
getActiveRangeList()
لیست محدوده های فعال را در برگه فعال برمی گرداند یا اگر محدوده فعالی وجود نداشته باشد null
برمی گرداند.
اگر یک محدوده انتخاب شده باشد، به عنوان یک فراخوانی getActiveRange()
عمل می کند.
var sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. var activeRangeList = sheet.getActiveRangeList();
بازگشت
RangeList
- لیست محدوده های فعال
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
همچنین ببینید
getActiveSheet()
برگه فعال را در یک صفحه گسترده دریافت می کند.
صفحه فعال در یک صفحه گسترده، برگه ای است که در رابط کاربر صفحه گسترده نمایش داده می شود.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
بازگشت
Sheet
- صفحه فعال در صفحه گسترده.
getAs(contentType)
داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید. این روش پسوند مناسب را به نام فایل اضافه می کند - به عنوان مثال، "myfile.pdf". با این حال، فرض میکند که بخشی از نام فایل که پس از آخرین نقطه (در صورت وجود) یک پسوند موجود است که باید جایگزین شود. در نتیجه، "ShoppingList.12.25.2014" به "ShoppingList.12.25.pdf" تبدیل می شود.
برای مشاهده سهمیه های روزانه برای تبدیل، به سهمیه خدمات Google مراجعه کنید. دامنههای جدید Google Workspace ممکن است به طور موقت مشمول سهمیههای سختگیرانهتر شوند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
contentType | String | نوع MIME برای تبدیل. برای اکثر حبابها، 'application/pdf' تنها گزینه معتبر است. برای تصاویر با فرمت BMP، GIF، JPEG یا PNG، هر یک از 'image/bmp' ، 'image/gif' ، 'image/jpeg' یا 'image/png' نیز معتبر هستند. برای سند Google Docs، 'text/markdown' نیز معتبر است. |
بازگشت
Blob
- داده ها به عنوان یک لکه.
getBandings()
همه باندهای موجود در این صفحه گسترده را برمی گرداند.
// 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
getBlob()
getColumnWidth(columnPosition)
عرض ستون داده شده را بر حسب پیکسل دریافت می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
columnPosition | Integer | موقعیت ستون برای بررسی. |
بازگشت
Integer
- عرض ستون بر حسب پیکسل
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCurrentCell()
سلول فعلی در برگه فعال را برمیگرداند یا اگر سلول فعلی وجود نداشته باشد، 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
getDataRange()
یک 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
getDataSourceFormulas()
تمام فرمول های منبع داده را دریافت می کند.
// 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());
بازگشت
DataSourceFormula[]
- فهرستی از فرمول های منبع داده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourcePivotTables()
تمام جداول محوری منبع داده را دریافت می کند.
// 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());
بازگشت
DataSourcePivotTable[]
- فهرستی از جداول محوری منبع داده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceRefreshSchedules()
برنامههای بهروزرسانی این صفحهگسترده را دریافت میکند.
// 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);
بازگشت
DataSourceRefreshSchedule[]
- برنامه های به روز رسانی این صفحه گسترده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceSheets()
همه برگه های منبع داده را در صفحه گسترده برمی گرداند.
// 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());
بازگشت
DataSourceSheet[]
- آرایه ای از تمام برگه های منبع داده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceTables()
تمام جداول منبع داده را دریافت می کند.
// 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());
بازگشت
DataSourceTable[]
- فهرستی از جداول منبع داده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSources()
همه منابع داده را در صفحه گسترده برمی گرداند.
// 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());
بازگشت
DataSource[]
- آرایه ای از همه منابع داده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDeveloperMetadata()
فراداده برنامهنویس مرتبط با صفحهگسترده سطح بالا را دریافت میکند.
// 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());
بازگشت
DeveloperMetadata[]
- فراداده توسعه دهنده مرتبط با این محدوده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getEditors()
لیست ویرایشگران این Spreadsheet
را دریافت می کند.
بازگشت
User[]
- آرایه ای از کاربران با مجوز ویرایش.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormUrl()
نشانی اینترنتی فرمی را که پاسخهای خود را به این صفحهگسترده ارسال میکند، برمیگرداند، یا اگر این صفحهگسترده هیچ فرم مرتبطی نداشته باشد، 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
getFrozenColumns()
تعداد ستون های ثابت شده را برمی گرداند.
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
getFrozenRows()
تعداد ردیفهای ثابت شده را برمیگرداند.
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
getId()
یک شناسه منحصر به فرد برای این صفحه گسترده دریافت می کند. شناسه صفحه گسترده را می توان از 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
- شناسه (یا کلید) منحصر به فرد برای صفحه گسترده.
getImages()
همه تصاویر خارج از شبکه را بر روی صفحه برمی گرداند.
// 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()); }
بازگشت
OverGridImage[]
- آرایه ای از تصاویر بیش از شبکه.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getIterativeCalculationConvergenceThreshold()
مقدار آستانه استفاده شده در طول محاسبه تکراری را برمیگرداند. هنگامی که نتایج محاسبات متوالی کمتر از این مقدار متفاوت باشد، محاسبه تکراری متوقف می شود.
// 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
getLastColumn()
موقعیت آخرین ستونی که محتوا دارد را برمیگرداند.
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
getLastRow()
موقعیت آخرین ردیفی که محتوا دارد را برمیگرداند.
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
getMaxIterativeCalculationCycles()
حداکثر تعداد تکرارها را برای استفاده در حین محاسبه تکراری برمیگرداند.
// 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
getName()
نام سند را دریافت می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); Logger.log(ss.getName());
بازگشت
String
- نام صفحه گسترده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNamedRanges()
همه محدوده های نامگذاری شده در این صفحه گسترده را دریافت می کند.
// 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()); }
بازگشت
NamedRange[]
- آرایه ای از تمام محدوده های نامگذاری شده در صفحه گسترده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNumSheets()
تعداد برگههای این صفحهگسترده را برمیگرداند.
// The code below logs the number of sheets in the active spreadsheet. Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());
بازگشت
Integer
- تعداد صفحات در صفحه گسترده.
getOwner()
مالک سند را برمیگرداند، یا برای سندی در درایو مشترک، 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
getPredefinedSpreadsheetThemes()
لیست تم های از پیش تعریف شده را برمی گرداند.
// The code below returns the list of predefined themes. var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet() .getPredefinedSpreadsheetThemes();
بازگشت
SpreadsheetTheme[]
- فهرست تم های از پیش تعریف شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getProtections(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 | ProtectionType | نوع منطقه محافظت شده، SpreadsheetApp.ProtectionType.RANGE یا SpreadsheetApp.ProtectionType.SHEET . |
بازگشت
Protection[]
- آرایه ای از اشیاء که همه محدوده ها یا صفحات محافظت شده در صفحه گسترده را نشان می دهد.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(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
getRangeByName(name)
یک محدوده با نام را برمیگرداند، یا اگر محدودهای با نام دادهشده یافت نشد، null
برمیگرداند. اگر چندین برگه صفحهگسترده از یک نام محدوده استفاده میکنند، نام صفحه را بدون علامت نقل قول اضافی مشخص کنید - برای مثال getRangeByName('TaxRates')
یا getRangeByName('Sheet Name!TaxRates')
, اما نه getRangeByName('"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
- محدوده سلول هایی با نام داده شده.
getRangeList(a1Notations)
مجموعه RangeList
را باز می گرداند که محدوده هایی را در همان برگه مشخص شده توسط یک لیست غیرخالی از نمادهای 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 مشخص شده است. |
بازگشت
RangeList
- لیست محدوده در مکان تعیین شده
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRecalculationInterval()
فاصله محاسبه را برای این صفحهگسترده برمیگرداند.
// 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());
بازگشت
RecalculationInterval
- فاصله محاسبه برای این صفحه گسترده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowHeight(rowPosition)
ارتفاع ردیف داده شده را بر حسب پیکسل دریافت می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
rowPosition | Integer | موقعیت ردیف برای بررسی. |
بازگشت
Integer
- ارتفاع ردیف بر حسب پیکسل
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSelection()
Selection
فعلی را در صفحه گسترده برمیگرداند.
var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection(); var currentCell = selection.getCurrentCell();
بازگشت
Selection
- انتخاب فعلی
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetByName(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
- ورق با نام داده شده.
getSheetId()
شناسه برگه نشان داده شده توسط این شی را برمی گرداند.
این یک شناسه برای صفحهای است که مختص صفحهگسترده است. شناسه یک عدد صحیح افزایش دهنده یکنواخت است که در زمان ایجاد برگه اختصاص داده می شود که مستقل از موقعیت ورق است. این در ارتباط با روش هایی مانند Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
که یک پارامتر gridId
به جای یک نمونه Sheet
می گیرند، مفید است.
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
getSheetName()
نام برگه را برمی گرداند.
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
getSheetValues(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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
startRow | Integer | موقعیت ردیف شروع. |
startColumn | Integer | موقعیت ستون شروع. |
numRows | Integer | تعداد سطرهایی که باید مقادیر را برگرداند. |
numColumns | Integer | تعداد ستونهایی که باید مقادیر را برگرداند. |
بازگشت
Object[][]
- یک آرایه دو بعدی از مقادیر
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheets()
همه برگه های این صفحه گسترده را دریافت می کند.
// 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[]
- آرایه ای از تمام صفحات در صفحه گسترده.
getSpreadsheetLocale()
محل صفحه گسترده را دریافت می کند.
// 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
getSpreadsheetTheme()
موضوع فعلی صفحهگسترده را برمیگرداند، یا اگر طرح زمینه اعمال نشود، null
.
// The code below returns the current theme of the spreadsheet. var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();
بازگشت
SpreadsheetTheme
- موضوع فعلی اعمال شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSpreadsheetTimeZone()
منطقه زمانی صفحه گسترده را دریافت می کند.
// 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
getUrl()
URL صفحه گسترده داده شده را برمی گرداند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); Logger.log(ss.getUrl());
بازگشت
String
- URL برای صفحه گسترده داده شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getViewers()
لیست بینندگان و نظر دهندگان را برای این Spreadsheet
دریافت می کند.
بازگشت
User[]
- آرایه ای از کاربران با مجوز مشاهده یا نظر.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
hideColumn(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
hideRow(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
insertColumnAfter(afterPosition)
ستونی را بعد از موقعیت ستون داده شده درج می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column after the first column position sheet.insertColumnAfter(1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
afterPosition | Integer | ستونی که بعد از آن ستون جدید باید اضافه شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumnBefore(beforePosition)
یک ستون را قبل از موقعیت ستون داده شده درج می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column in the first column position sheet.insertColumnBefore(1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
beforePosition | Integer | ستونی که ستون جدید باید قبل از آن اضافه شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumnsAfter(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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
afterPosition | Integer | ستونی که بعد از آن ستون جدید باید اضافه شود. |
howMany | Integer | تعداد ستون هایی که باید درج شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertColumnsBefore(beforePosition, howMany)
تعدادی ستون را قبل از موقعیت ستون داده شده درج می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five columns before the first column sheet.insertColumnsBefore(1, 5);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
beforePosition | Integer | ستونی که ستون جدید باید قبل از آن اضافه شود. |
howMany | Integer | تعداد ستون هایی که باید درج شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertDataSourceSheet(spec)
یک DataSourceSheet
جدید را در صفحه گسترده درج می کند و اجرای داده ها را شروع می کند. به عنوان یک عارضه جانبی، این نیز برگه جدید را به برگه فعال تبدیل می کند.
در صورتی که نوع منبع داده فعال نباشد، یک استثنا ایجاد می کند. از متدهای SpreadsheetApp#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 | DataSourceSpec | مشخصات منبع داده برای درج با. |
بازگشت
DataSourceSheet
- صفحه منبع داده جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(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);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
blobSource | BlobSource | حباب حاوی محتویات تصویر، نوع MIME و (به صورت اختیاری) نام. |
column | Integer | موقعیت ستون. |
row | Integer | موقعیت ردیف. |
بازگشت
OverGridImage
- تصویر درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(blobSource, column, row, offsetX, offsetY)
یک Spreadsheet
به عنوان تصویر در یک سطر و ستون معین، با فاصله پیکسلی در سند درج می کند. اندازه تصویر از محتویات حباب بازیابی می شود. حداکثر اندازه حباب پشتیبانی شده 2 مگابایت است.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1, 10, 10);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
blobSource | BlobSource | حباب حاوی محتویات تصویر، نوع MIME و (به صورت اختیاری) نام. |
column | Integer | موقعیت ستون. |
row | Integer | موقعیت ردیف. |
offsetX | Integer | افست افقی از گوشه سلول در پیکسل. |
offsetY | Integer | افست عمودی از گوشه سلول در پیکسل. |
بازگشت
OverGridImage
- تصویر درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(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 | موقعیت ردیف شبکه. |
بازگشت
OverGridImage
- تصویر درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertImage(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 | افست عمودی از گوشه سلول در پیکسل. |
بازگشت
OverGridImage
- تصویر درج شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowAfter(afterPosition)
یک ردیف بعد از موقعیت ردیف داده شده درج می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a row after the first row position sheet.insertRowAfter(1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
afterPosition | Integer | ردیفی که بعد از آن سطر جدید باید اضافه شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowBefore(beforePosition)
یک ردیف قبل از موقعیت ردیف داده شده درج می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a row before the first row position sheet.insertRowBefore(1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
beforePosition | Integer | ردیفی که قبل از آن سطر جدید باید اضافه شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowsAfter(afterPosition, howMany)
تعدادی ردیف را بعد از موقعیت ردیف داده شده درج می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five rows after the first row sheet.insertRowsAfter(1, 5);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
afterPosition | Integer | ردیفی که پس از آن سطرهای جدید باید اضافه شوند. |
howMany | Integer | تعداد ردیف هایی که باید درج شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertRowsBefore(beforePosition, howMany)
تعدادی ردیف را قبل از موقعیت ردیف داده شده درج می کند.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five rows before the first row sheet.insertRowsBefore(1, 5);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
beforePosition | Integer | ردیفی که قبل از آن سطرهای جدید باید اضافه شوند. |
howMany | Integer | تعداد ردیف هایی که باید درج شود. |
بازگشت
Sheet
- ورق، مفید برای روش زنجیره ای
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSheet()
با استفاده از نام صفحه پیش فرض، یک صفحه جدید را در صفحه گسترده وارد می کند. برگه جدید به برگه فعال تبدیل می شود.
var ss = SpreadsheetApp.getActiveSpreadsheet(); ss.insertSheet();
بازگشت
Sheet
- ورق جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSheet(sheetIndex)
یک صفحه جدید را در فهرست داده شده در صفحه گسترده وارد می کند. برگه جدید به برگه فعال تبدیل می شود.
var ss = SpreadsheetApp.getActiveSpreadsheet(); ss.insertSheet(1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
sheetIndex | Integer | نمایه برگه تازه ایجاد شده. برای درج یک صفحه به عنوان اولین صفحه در صفحه گسترده، آن را روی 0 تنظیم کنید. |
بازگشت
Sheet
- ورق جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSheet(sheetIndex, options)
یک صفحه جدید را در صفحه گسترده در شاخص داده شده درج می کند و از آرگومان های پیشرفته اختیاری استفاده می کند. برگه جدید به برگه فعال تبدیل می شود.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var templateSheet = ss.getSheetByName('Sales'); ss.insertSheet(1, {template: templateSheet});
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
sheetIndex | Integer | نمایه برگه تازه ایجاد شده. برای درج یک صفحه به عنوان اولین صفحه در صفحه گسترده، آن را روی 0 تنظیم کنید. |
options | Object | آرگومان های پیشرفته جاوا اسکریپت اختیاری. |
پارامترهای پیشرفته
نام | تایپ کنید | توضیحات |
---|---|---|
template | Sheet | تمام داده ها از شی برگه الگو در صفحه جدید کپی می شوند. الگوی برگه باید یکی از برگه های شیء صفحه گسترده باشد. |
بازگشت
Sheet
- ورق جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSheet(options)
با استفاده از نام صفحه پیشفرض و آرگومانهای پیشرفته اختیاری، یک صفحه جدید را در صفحهگسترده درج میکند. برگه جدید به برگه فعال تبدیل می شود.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var templateSheet = ss.getSheetByName('Sales'); ss.insertSheet({template: templateSheet});
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
options | Object | آرگومانهای پیشرفته جاوا اسکریپت اختیاری، که در زیر فهرست شدهاند. |
پارامترهای پیشرفته
نام | تایپ کنید | توضیحات |
---|---|---|
template | Sheet | تمام داده ها از شی برگه الگو در صفحه جدید کپی می شوند. الگوی برگه باید یکی از برگه های این شیء صفحه گسترده باشد. |
بازگشت
Sheet
- ورق جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSheet(sheetName)
یک صفحه جدید با نام داده شده را در صفحه گسترده وارد می کند. برگه جدید به برگه فعال تبدیل می شود.
var ss = SpreadsheetApp.getActiveSpreadsheet(); ss.insertSheet('My New Sheet');
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
sheetName | String | نام برگه جدید. |
بازگشت
Sheet
- ورق جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSheet(sheetName, sheetIndex)
یک صفحه جدید با نام داده شده در فهرست داده شده در صفحه گسترده وارد می کند. برگه جدید به برگه فعال تبدیل می شود.
var ss = SpreadsheetApp.getActiveSpreadsheet(); ss.insertSheet('My New Sheet', 1);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
sheetName | String | نام برگه جدید. |
sheetIndex | Integer | نمایه برگه تازه ایجاد شده. برای درج یک صفحه به عنوان اولین صفحه در صفحه گسترده، آن را روی 0 تنظیم کنید. |
بازگشت
Sheet
- ورق جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSheet(sheetName, sheetIndex, options)
یک صفحه جدید با نام داده شده در فهرست داده شده در صفحه گسترده وارد می کند و از آرگومان های پیشرفته اختیاری استفاده می کند. برگه جدید به برگه فعال تبدیل می شود.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var templateSheet = ss.getSheetByName('Sales'); ss.insertSheet('My New Sheet', 1, {template: templateSheet});
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
sheetName | String | نام برگه جدید. |
sheetIndex | Integer | نمایه ورق تازه درج شده. برای درج یک صفحه به عنوان اولین صفحه در یک صفحه گسترده، آن را روی 0 تنظیم کنید. |
options | Object | آرگومان های پیشرفته جاوا اسکریپت اختیاری. |
پارامترهای پیشرفته
نام | تایپ کنید | توضیحات |
---|---|---|
template | Sheet | تمام داده ها از شی برگه الگو در صفحه جدید کپی می شوند. الگوی برگه باید یکی از برگه های شیء صفحه گسترده باشد. |
بازگشت
Sheet
- ورق جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertSheet(sheetName, options)
یک صفحه جدید با نام داده شده در صفحه گسترده وارد می کند و از آرگومان های پیشرفته اختیاری استفاده می کند. برگه جدید به برگه فعال تبدیل می شود.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var templateSheet = ss.getSheetByName('Sales'); ss.insertSheet('My New Sheet', {template: templateSheet});