דף זה תורגם על ידי Cloud Translation API.

Class Sheet

לגשת לגיליונות של גיליונות אלקטרוניים ולשנות אותם. פעולות נפוצות הן שינוי שם של גיליון וגישה לטווח מהגיליון.

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
`activate()`	`Sheet`	הפעלת הגיליון הזה.
`addDeveloperMetadata(key)`	`Sheet`	הוספת מטא-נתונים של מפתחים לגיליון עם המפתח שצוין.
`addDeveloperMetadata(key, visibility)`	`Sheet`	הוספת מטא-נתונים של המפתח עם המפתח שצוין וסטטוס החשיפה שלהם לגיליון.
`addDeveloperMetadata(key, value)`	`Sheet`	הוספת מטא-נתונים של מפתחים עם המפתח והערך שצוינו.
`addDeveloperMetadata(key, value, visibility)`	`Sheet`	הוספת מטא-נתונים של המפתח עם המפתח, הערך וסטטוס החשיפה שצוינו.
`appendRow(rowContents)`	`Sheet`	הפונקציה מוסיפה שורה לתחתית של אזור הנתונים הנוכחי בגיליון.
`asDataSourceSheet()`	`DataSourceSheet`	הפונקציה מחזירה את הגיליון בתור `DataSourceSheet` אם סוג הגיליון הוא `SheetType.DATASOURCE`. אחרת, `null`.
`autoResizeColumn(columnPosition)`	`Sheet`	מגדיר את הרוחב של עמודה נתונה כך שיתאים לתוכן שלה.
`autoResizeColumns(startColumn, numColumns)`	`Sheet`	מגדיר את הרוחב של כל העמודות, החל מהמיקום של העמודה, כך שיתאים לתוכן שלהן.
`autoResizeRows(startRow, numRows)`	`Sheet`	מגדיר את הגובה של כל השורות החל מהמיקום הנתון של השורה, כך שיתאים לתוכן שלהן.
`clear()`	`Sheet`	ניקוי גיליון התוכן והעיצוב.
`clear(options)`	`Sheet`	ניקוי גיליון התוכן ו/או הפורמט, כפי שצוין באפשרויות המתקדמות הנתונות.
`clearConditionalFormatRules()`	`void`	הסרה של כל הכללים של עיצוב מותנה מהגיליון.
`clearContents()`	`Sheet`	ניקוי גיליון התוכן תוך שמירה על פרטי העיצוב.
`clearFormats()`	`Sheet`	ניקוי גיליון העיצוב תוך שמירה על התוכן.
`clearNotes()`	`Sheet`	ניקוי הגיליון של כל ההערות.
`collapseAllColumnGroups()`	`Sheet`	כיווץ כל קבוצות העמודות בגיליון.
`collapseAllRowGroups()`	`Sheet`	כיווץ כל קבוצות השורות בגיליון.
`copyTo(spreadsheet)`	`Sheet`	מעתיק את הגיליון לגיליון אלקטרוני נתון, שיכול להיות אותו גיליון אלקטרוני כמו המקור.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	הפונקציה מחזירה את הערך `DeveloperMetadataFinder` לחיפוש מטא-נתונים של מפתח במסגרת הגיליון הזה.
`createTextFinder(findText)`	`TextFinder`	יוצר כלי לאיתור טקסט בגיליון, שיכול לחפש ולהחליף טקסט בתוך הגיליון.
`deleteColumn(columnPosition)`	`Sheet`	מוחק את העמודה במיקום הנתון של העמודה.
`deleteColumns(columnPosition, howMany)`	`void`	מוחקת מספר עמודות החל מהמיקום של העמודה הנתון.
`deleteRow(rowPosition)`	`Sheet`	מחיקת השורה במיקום הנתון של השורה.
`deleteRows(rowPosition, howMany)`	`void`	הפונקציה מוחקת מספר שורות החל מהמיקום הנתון של השורה.
`expandAllColumnGroups()`	`Sheet`	הרחבת כל קבוצות העמודות בגיליון.
`expandAllRowGroups()`	`Sheet`	הרחבת כל קבוצות השורות בגיליון.
`expandColumnGroupsUpToDepth(groupDepth)`	`Sheet`	מרחיב את כל קבוצות העמודות עד לעומק הנתון, ומכווץ את כל שאר הקבוצות.
`expandRowGroupsUpToDepth(groupDepth)`	`Sheet`	מרחיב את כל קבוצות השורות עד לעומק הנתון, ומכווץ את כל הקבוצות האחרות.
`getActiveCell()`	`Range`	מחזירה את התא הפעיל בגיליון.
`getActiveRange()`	`Range`	הפונקציה מחזירה את הטווח שנבחר בגיליון הפעיל, או `null` אם אין טווח פעיל.
`getActiveRangeList()`	`RangeList`	פונקציה זו מחזירה את רשימת הטווחים הפעילים בגיליון הפעיל או `null` אם אין פעילות פעילה טווחים.
`getBandings()`	`Banding[]`	מחזירה את כל הפסים בגיליון.
`getCharts()`	`EmbeddedChart[]`	מחזירה מערך של תרשימים בגיליון הזה.
`getColumnGroup(columnIndex, groupDepth)`	`Group`	מחזירה את קבוצת העמודות באינדקס ובעומק הקבוצה הנתונים.
`getColumnGroupControlPosition()`	`GroupControlTogglePosition`	הפונקציה מחזירה את הערך `GroupControlTogglePosition` בכל קבוצות העמודות בגיליון.
`getColumnGroupDepth(columnIndex)`	`Integer`	מחזירה את עומק הקבוצה של העמודה באינדקס הנתון.
`getColumnWidth(columnPosition)`	`Integer`	הפונקציה מקבלת את הרוחב בפיקסלים של העמודה הנתונה.
`getConditionalFormatRules()`	`ConditionalFormatRule[]`	כל הכללים של עיצוב מותנה בגיליון הזה.
`getCurrentCell()`	`Range`	הפונקציה מחזירה את התא הנוכחי בגיליון הפעיל או `null` אם אין תא נוכחי.
`getDataRange()`	`Range`	הפונקציה מחזירה ערך `Range` שתואם למאפיינים שבהם קיימים נתונים.
`getDataSourceFormulas()`	`DataSourceFormula[]`	קבלת כל הנוסחאות של מקורות הנתונים.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	קבלת כל טבלאות הצירים של מקור הנתונים.
`getDataSourceTables()`	`DataSourceTable[]`	מקבלת את כל הטבלאות של מקורות הנתונים.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	קבלת כל המטא-נתונים של המפתחים שמשויכים לגיליון הזה.
`getDrawings()`	`Drawing[]`	מחזירה מערך של שרטוטים בגיליון.
`getFilter()`	`Filter`	הפונקציה מחזירה את המסנן בגיליון הזה, או הפונקציה `null` אם אין מסנן.
`getFormUrl()`	`String`	פונקציה זו מחזירה את כתובת ה-URL של הטופס השולח את תגובותיו לגיליון זה, או `null` אם לגיליון הזה לא משויך טופס.
`getFrozenColumns()`	`Integer`	מחזירה את מספר העמודות שהוקפאו.
`getFrozenRows()`	`Integer`	מחזירה את מספר השורות שהוקפאו.
`getImages()`	`OverGridImage[]`	הצגת כל התמונות שמופיעות מעל הרשת בגיליון.
`getIndex()`	`Integer`	מקבל את מיקום הגיליון בגיליון האלקטרוני הראשי שלו.
`getLastColumn()`	`Integer`	מחזירה את המיקום של העמודה האחרונה שמכילה תוכן.
`getLastRow()`	`Integer`	מחזירה את המיקום של השורה האחרונה שמכילה תוכן.
`getMaxColumns()`	`Integer`	מחזירה את המספר הנוכחי של עמודות בגיליון, ללא קשר לתוכן.
`getMaxRows()`	`Integer`	מחזירה את מספר השורות הנוכחי בגיליון, ללא קשר לתוכן.
`getName()`	`String`	מחזירה את שם הגיליון.
`getNamedRanges()`	`NamedRange[]`	הפונקציה מקבלת את כל טווחי התאים בעלי השם בגיליון הזה.
`getParent()`	`Spreadsheet`	הפונקציה מחזירה את הערך `Spreadsheet` שמכיל את הגיליון הזה.
`getPivotTables()`	`PivotTable[]`	הפונקציה מחזירה את כל טבלאות הצירים בגיליון.
`getProtections(type)`	`Protection[]`	מקבלת מערך של אובייקטים שמייצגים את כל טווחי התאים המוגנים בגיליון, או רכיב יחיד שמייצג את ההגנה על הגיליון עצמו.
`getRange(row, column)`	`Range`	מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונות.
`getRange(row, column, numRows)`	`Range`	מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונים, ועם המספר הנתון שורות.
`getRange(row, column, numRows, numColumns)`	`Range`	מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונים מספר השורות הנתון ו-עמודות.
`getRange(a1Notation)`	`Range`	מחזירה את הטווח כפי שצוין בסימון A1 או בסימון R1C1.
`getRangeList(a1Notations)`	`RangeList`	הפונקציה מחזירה את האוסף `RangeList` שמייצג את הטווחים באותו הגיליון שצוין באמצעות רשימה לא ריקה של סימוני A1 או סימני R1C1.
`getRowGroup(rowIndex, groupDepth)`	`Group`	מחזירה את קבוצת השורות באינדקס ובעומק הקבוצה הנתונים.
`getRowGroupControlPosition()`	`GroupControlTogglePosition`	הפונקציה מחזירה את הערך `GroupControlTogglePosition` בכל קבוצות השורות בגיליון.
`getRowGroupDepth(rowIndex)`	`Integer`	מחזירה את עומק הקבוצה של השורה באינדקס הנתון.
`getRowHeight(rowPosition)`	`Integer`	הפונקציה מקבלת את הגובה בפיקסלים של השורה הנתונה.
`getSelection()`	`Selection`	הפונקציה מחזירה את הערך הנוכחי של `Selection` בגיליון האלקטרוני.
`getSheetId()`	`Integer`	מחזירה את המזהה של הגיליון שמיוצג על ידי האובייקט הזה.
`getSheetName()`	`String`	מחזירה את שם הגיליון.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	מחזירה את רשת הערכים המלבנית של הערכים עבור הטווח הזה החל מהקואורדינטות הנתונות.
`getSlicers()`	`Slicer[]`	מחזירה מערך של כלי סינון בגיליון.
`getTabColorObject()`	`Color`	הפונקציה מקבלת את הצבע של לשונית הגיליון. לחלופין, אם לשונית הגיליון לא מכילה צבע, הערך `null`.
`getType()`	`SheetType`	מחזירה את הסוג של הגיליון.
`hasHiddenGridlines()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם קווי הרשת בגיליון מוסתרים. אחרת, הפונקציה מחזירה `false`.
`hideColumn(column)`	`void`	הסתרת העמודה או העמודות בטווח הנתון.
`hideColumns(columnIndex)`	`void`	מסתירה עמודה אחת באינדקס הנתון.
`hideColumns(columnIndex, numColumns)`	`void`	מסתירה עמודה אחת או יותר ברצף, החל מהאינדקס הנתון.
`hideRow(row)`	`void`	הסתרת השורות בטווח הנתון.
`hideRows(rowIndex)`	`void`	הסתרת השורה באינדקס הנתון.
`hideRows(rowIndex, numRows)`	`void`	מסתירה שורה אחת או יותר ברצף, החל מהאינדקס הנתון.
`hideSheet()`	`Sheet`	הסתרת הגיליון הזה.
`insertChart(chart)`	`void`	הוספת תרשים חדש לגיליון הזה.
`insertColumnAfter(afterPosition)`	`Sheet`	מוסיפה עמודה אחרי המיקום הנתון של העמודה.
`insertColumnBefore(beforePosition)`	`Sheet`	מוסיפה עמודה לפני המיקום הנתון של העמודה.
`insertColumns(columnIndex)`	`void`	הוספת עמודה ריקה בגיליון במיקום שצוין.
`insertColumns(columnIndex, numColumns)`	`void`	מוסיפה עמודה ריקה אחת או יותר ברצף בגיליון החל מהמיקום שצוין.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	מוסיפה מספר נתון של עמודות אחרי מיקום העמודה הנתון.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	מוסיפה מספר עמודות לפני מיקום העמודה הנתון.
`insertImage(blobSource, column, row)`	`OverGridImage`	הוספת `BlobSource` כתמונה במסמך בשורה ובעמודה מסוימות.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	מוסיפה `BlobSource` כתמונה למסמך בשורה ועמודה נתונה, עם קיזוז פיקסלים.
`insertImage(url, column, row)`	`OverGridImage`	הוספת תמונה למסמך בשורה ועמודה נתונה.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	הוספת תמונה למסמך בשורה ועמודה נתונה, עם היסט פיקסלים.
`insertRowAfter(afterPosition)`	`Sheet`	מוסיפה שורה אחרי מיקום השורה הנתון.
`insertRowBefore(beforePosition)`	`Sheet`	הוספת שורה לפני מיקום השורה הנתון.
`insertRows(rowIndex)`	`void`	הוספת שורה ריקה בגיליון במיקום שצוין.
`insertRows(rowIndex, numRows)`	`void`	הוספת שורה ריקה אחת או יותר ברצף בגיליון, החל מהמיקום שצוין.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	מוסיפה מספר שורות אחרי מיקום השורה הנתון.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	מוסיפה מספר שורות לפני מיקום השורה הנתון.
`insertSlicer(range, anchorRowPos, anchorColPos)`	`Slicer`	הוספת כלי סינון חדש לגיליון הזה.
`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`	`Slicer`	הוספת כלי סינון חדש לגיליון הזה.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	הפונקציה מחזירה אם העמודה הנתונה מוסתרת על ידי המשתמש.
`isRightToLeft()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם פריסת הגיליון הזו היא מימין לשמאל.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	הפונקציה מחזירה אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת סינון).
`isRowHiddenByUser(rowPosition)`	`Boolean`	הפונקציה מחזירה אם השורה הנתונה מוסתרת על ידי המשתמש.
`isSheetHidden()`	`Boolean`	הפונקציה מחזירה את הערך `true` אם הגיליון מוסתר כרגע.
`moveColumns(columnSpec, destinationIndex)`	`void`	העברת העמודות שנבחרו בטווח הנתון למיקום שמצוין ב-`destinationIndex`.
`moveRows(rowSpec, destinationIndex)`	`void`	מעבירה את השורות שנבחרו בטווח הנתון למיקום שמצוין על ידי `destinationIndex`.
`newChart()`	`EmbeddedChartBuilder`	הפונקציה מחזירה Builder כדי ליצור תרשים חדש לגיליון הזה.
`protect()`	`Protection`	יצירת אובייקט שיכול להגן על הגיליון מפני עריכה, למעט על ידי משתמשים הרשאה.
`removeChart(chart)`	`void`	הסרת תרשים מהגיליון הראשי.
`setActiveRange(range)`	`Range`	מגדיר את הטווח שצוין כ-`active range` בגיליון הפעיל, עם התא הימני העליון בטווח, בתור `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	מגדיר את רשימת הטווחים שצוינה כ-`active ranges` בשדה גיליון פעיל.
`setActiveSelection(range)`	`Range`	הגדרת אזור הבחירה הפעיל בגיליון הזה.
`setActiveSelection(a1Notation)`	`Range`	מגדיר את הבחירה הפעילה, כפי שמצוין בסימון A1 או R1C1.
`setColumnGroupControlPosition(position)`	`Sheet`	הגדרת המיקום של מתג הבקרה על קבוצת העמודות בגיליון.
`setColumnWidth(columnPosition, width)`	`Sheet`	מגדיר את הרוחב של העמודה הנתונה בפיקסלים.
`setColumnWidths(startColumn, numColumns, width)`	`Sheet`	מגדיר את הרוחב של העמודות הנתונות בפיקסלים.
`setConditionalFormatRules(rules)`	`void`	הפונקציה מחליפה את כל הכללים הקיימים של עיצוב מותנים בגיליון בכללי הקלט.
`setCurrentCell(cell)`	`Range`	מגדיר את התא שצוין כ-`current cell`.
`setFrozenColumns(columns)`	`void`	הקפאה של מספר העמודות הנתון.
`setFrozenRows(rows)`	`void`	הקפאה של מספר השורות הנתון.
`setHiddenGridlines(hideGridlines)`	`Sheet`	הסתרה או חשיפה של קווי הרשת בגיליון.
`setName(name)`	`Sheet`	מגדיר את שם הגיליון.
`setRightToLeft(rightToLeft)`	`Sheet`	מגדיר או מבטל את ההגדרה של פריסת הגיליון מימין לשמאל.
`setRowGroupControlPosition(position)`	`Sheet`	המדיניות קובעת את המיקום של מתג הבקרה של קבוצת השורות בגיליון.
`setRowHeight(rowPosition, height)`	`Sheet`	מגדיר את גובה השורה של שורה נתונה בפיקסלים.
`setRowHeights(startRow, numRows, height)`	`Sheet`	מגדיר את הגובה של השורות הנתונות בפיקסלים.
`setRowHeightsForced(startRow, numRows, height)`	`Sheet`	מגדיר את הגובה של השורות הנתונות בפיקסלים.
`setTabColor(color)`	`Sheet`	הגדרת הצבע של לשונית בגיליון.
`setTabColorObject(color)`	`Sheet`	הגדרת הצבע של לשונית בגיליון.
`showColumns(columnIndex)`	`void`	מבטל את הסתרת העמודה באינדקס הנתון.
`showColumns(columnIndex, numColumns)`	`void`	ביטול ההסתרה של עמודה אחת או יותר ברצף החל מהאינדקס הנתון.
`showRows(rowIndex)`	`void`	מבטל את הסתרת השורה באינדקס הנתון.
`showRows(rowIndex, numRows)`	`void`	ביטול ההסתרה של שורה אחת או יותר ברצף, החל מהאינדקס הנתון.
`showSheet()`	`Sheet`	הופך את הגיליון לגלוי.
`sort(columnPosition)`	`Sheet`	ממיינת גיליון לפי עמודה, בסדר עולה.
`sort(columnPosition, ascending)`	`Sheet`	ממיינת גיליון לפי עמודה.
`unhideColumn(column)`	`void`	ביטול ההסתרה של העמודה בטווח הנתון.
`unhideRow(row)`	`void`	ביטול ההסתרה של השורה בטווח הנתון.
`updateChart(chart)`	`void`	עדכון התרשים בגיליון הזה.

שיטות שהוצאו משימוש

שיטה	סוג הערך המוחזר	תיאור קצר
`getSheetProtection()`	`PageProtection`	מחזירה מופע `PageProtection` שמתאר את ההרשאות לגיליון הנוכחי.
`getTabColor()`	`String`	הפונקציה מקבלת את הצבע של לשונית הגיליון. לחלופין, אם לשונית הגיליון לא מכילה צבע, הערך `null`.
`setSheetProtection(permissions)`	`void`	הגדרת ההרשאות לגיליון הנוכחי.

מסמכי תיעוד מפורטים

`activate()`

הפעלת הגיליון הזה. לא משנה את הגיליון עצמו, אלא רק את הרעיון של ההורה הפעיל גיליון.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.activate();

חזרה

Sheet – הגיליון הפעיל החדש.

`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');

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

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

פרמטרים

שם	סוג	תיאור
`key`	`String`	המפתח למטא-נתונים של המפתח החדש.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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');

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

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

פרמטרים

שם	סוג	תיאור
`key`	`String`	המפתח למטא-נתונים של המפתח החדש.
`visibility`	`DeveloperMetadataVisibility`	החשיפה של המטא-נתונים החדשים של המפתח.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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');

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

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

פרמטרים

שם	סוג	תיאור
`key`	`String`	המפתח למטא-נתונים של המפתח החדש.
`value`	`String`	הערך של המטא-נתונים של המפתח החדש.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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');

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

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and sets the
// visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
  'COMPANY',
  'TECH',
  SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

פרמטרים

שם	סוג	תיאור
`key`	`String`	המפתח למטא-נתונים של המפתח החדש.
`value`	`String`	הערך של המטא-נתונים של המפתח החדש.
`visibility`	`DeveloperMetadataVisibility`	החשיפה של המטא-נתונים החדשים של המפתח.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`asDataSourceSheet()`

הפונקציה מחזירה את הגיליון בתור DataSourceSheet אם סוג הגיליון הוא SheetType.DATASOURCE. אחרת, null.

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

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

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

חזרה

DataSourceSheet – גיליון של מקור נתונים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`autoResizeColumns(startColumn, numColumns)`

מגדיר את הרוחב של כל העמודות, החל מהמיקום של העמודה, כך שיתאים לתוכן שלהן.

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

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

פרמטרים

שם	סוג	תיאור
`startColumn`	`Integer`	העמודה הראשונה שצריך לשנות את הגודל שלה באופן אוטומטי.
`numColumns`	`Integer`	מספר העמודות לשינוי אוטומטי של הגודל שלהן.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`autoResizeRows(startRow, numRows)`

מגדיר את הגובה של כל השורות החל מהמיקום הנתון של השורה, כך שיתאים לתוכן שלהן.

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

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

פרמטרים

שם	סוג	תיאור
`startRow`	`Integer`	השורה הראשונה שצריך לשנות את הגודל שלה באופן אוטומטי.
`numRows`	`Integer`	מספר השורות לשינוי אוטומטי של הגודל שלהן.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`clear()`

ניקוי גיליון התוכן והעיצוב.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clear();

חזרה

Sheet – הגיליון נוקה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`clear(options)`

ניקוי גיליון התוכן ו/או הפורמט, כפי שצוין באפשרויות המתקדמות הנתונות.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.clear({ formatOnly: true, contentsOnly: true });

פרמטרים

שם	סוג	תיאור
`options`	`Object`	מפת JavaScript הכוללת אפשרויות מתקדמות שמפורטות בהמשך.

פרמטרים מתקדמים

שם	סוג	תיאור
`contentsOnly`	`Boolean`	האם לנקות את התוכן.
`formatOnly`	`Boolean`	האם לנקות את הפורמט.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`clearConditionalFormatRules()`

הסרה של כל הכללים של עיצוב מותנה מהגיליון. זהה להפעלה של setConditionalFormatRules(rules) עם מערך ריק כקלט.

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

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`clearContents()`

ניקוי גיליון התוכן תוך שמירה על פרטי העיצוב.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearContents();

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`clearFormats()`

ניקוי גיליון העיצוב תוך שמירה על התוכן.

הפורמט מתייחס לאופן שבו הנתונים מופיעים בפורמט המותר לפי האפשרויות שבחרתם בקטע 'פורמט' תפריט (לדוגמה: מודגש, נטוי, עיצוב מותנה) ולא הרוחב או הגובה של התאים.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearFormats();

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`clearNotes()`

ניקוי הגיליון של כל ההערות.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.clearNotes();

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`collapseAllColumnGroups()`

כיווץ כל קבוצות העמודות בגיליון.

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

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`collapseAllRowGroups()`

כיווץ כל קבוצות השורות בגיליון.

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

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`copyTo(spreadsheet)`

מעתיק את הגיליון לגיליון אלקטרוני נתון, שיכול להיות אותו גיליון אלקטרוני כמו המקור. הגיליון שהועתק נקרא 'עותק של [השם המקורי]'.

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

var destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

פרמטרים

שם	סוג	תיאור
`spreadsheet`	`Spreadsheet`	הגיליון האלקטרוני שאליו צריך להעתיק את הגיליון, שיכול להיות אותו גיליון אלקטרוני כמו את המקור.

חזרה

Sheet – הגיליון החדש, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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');

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

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

חזרה

DeveloperMetadataFinder – כלי לאיתור מטא-נתונים למפתחים שמחפש מטא-נתונים ברמת הגיליון הזה.

`createTextFinder(findText)`

יוצר כלי לאיתור טקסט בגיליון, שיכול לחפש ולהחליף טקסט בתוך הגיליון.

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

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

// Returns the first occurrence of 'dog' in the sheet.
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 בגיליון.

`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

`expandAllColumnGroups()`

הרחבת כל קבוצות העמודות בגיליון. בשיטה הזו נדרשת לפחות קבוצת עמודות אחת.

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

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`expandAllRowGroups()`

הרחבת כל קבוצות השורות בגיליון. בשיטה הזו נדרשת לפחות קבוצת שורות אחת.

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

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`expandColumnGroupsUpToDepth(groupDepth)`

מרחיב את כל קבוצות העמודות עד לעומק הנתון, ומכווץ את כל שאר הקבוצות.

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

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

פרמטרים

שם	סוג	תיאור
`groupDepth`	`Integer`	עומק הקבוצה שאליו צריך להרחיב את קבוצות העמודות.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`expandRowGroupsUpToDepth(groupDepth)`

מרחיב את כל קבוצות השורות עד לעומק הנתון, ומכווץ את כל הקבוצות האחרות.

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

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

פרמטרים

שם	סוג	תיאור
`groupDepth`	`Integer`	עומק הקבוצה שאליו צריך להרחיב את קבוצות השורות.

חזרה

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

ראה גם

setActiveRange(range)

`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

ראה גם

setActiveRangeList(rangeList)

`getBandings()`

מחזירה את כל הפסים בגיליון.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the banding info for the sheet.
const bandings = sheet.getBandings();

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

חזרה

Banding[] — כל הפסים בגיליון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getCharts()`

מחזירה מערך של תרשימים בגיליון הזה.

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

for (var i in charts) {
  var chart = charts[i];
  // Do something with the chart
}

חזרה

EmbeddedChart[] – מערך תרשימים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getColumnGroup(columnIndex, groupDepth)`

מחזירה את קבוצת העמודות באינדקס ובעומק הקבוצה הנתונים.

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

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
var columnGroup = sheet.getColumnGroup(2, 1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	אינדקס העמודה של מתג הבקרה על הקבוצה או אינדקס בתוך הקבוצה.
`groupDepth`	`Integer`	עומק הקבוצה.

חזרה

Group – קבוצת העמודות באינדקס ובעומק הבקרה, או מקפיצה הודעת שגיאה אם הקבוצה לא קיים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getColumnGroupControlPosition()`

הפונקציה מחזירה את הערך GroupControlTogglePosition בכל קבוצות העמודות בגיליון.

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

// GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the
// group.
var columnGroupControlPosition = sheet.getColumnGroupControlPosition();

חזרה

GroupControlTogglePosition – true אם המתג של אמצעי הבקרה לקיבוץ עמודות מוצג אחרי הקבוצה גיליון אלקטרוני. אחרת, false.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getColumnGroupDepth(columnIndex)`

מחזירה את עומק הקבוצה של העמודה באינדקס הנתון.

עומק הקבוצה מציין כמה קבוצות חופפות לעמודה. הטווח הזה יכול לנוע בין אפס ושמונה.

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

// 1 if there is a group over columns 1 through 3
var groupDepth = sheet.getColumnGroupDepth(1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס של העמודה.

חזרה

Integer – עומק הקבוצה של העמודה באינדקס הנתון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`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

`getConditionalFormatRules()`

כל הכללים של עיצוב מותנה בגיליון הזה.

// Logs the conditional format rules in a sheet.
var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (var i = 0; i < rules.length; i++) {
  var rule = rules[i];
  Logger.log(rule);
}

חזרה

ConditionalFormatRule[] – מערך של כל הכללים בגיליון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getCurrentCell()`

הפונקציה מחזירה את התא הנוכחי בגיליון הפעיל או null אם אין תא נוכחי. התא הנוכחי הוא התא שמתמקד בממשק המשתמש של Google Sheets, והוא מודגש באמצעות גבול. אף פעם אין יותר מתא נוכחי אחד. כשמשתמש בוחר טווח תאים אחד או יותר, אחד מהתאים בבחירה הוא התא הנוכחי.

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

`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

`getDeveloperMetadata()`

קבלת כל המטא-נתונים של המפתחים שמשויכים לגיליון הזה.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

חזרה

DeveloperMetadata[] – המטא-נתונים של המפתח שמשויכים לגיליון הזה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getDrawings()`

מחזירה מערך של שרטוטים בגיליון.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

 // Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

חזרה

Drawing[] – רשימת השרטוטים בגיליון הזה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getFilter()`

הפונקציה מחזירה את המסנן בגיליון הזה, או הפונקציה null אם אין מסנן.

// Gets the filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();

חזרה

Filter – המסנן.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getFormUrl()`

פונקציה זו מחזירה את כתובת ה-URL של הטופס השולח את תגובותיו לגיליון זה, או null אם לגיליון הזה לא משויך טופס.

var sheet = SpreadsheetApp.getActiveSheet();
var url = sheet.getFormUrl();

חזרה

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

`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

`getIndex()`

מקבל את מיקום הגיליון בגיליון האלקטרוני הראשי שלו. מתחיל ב-1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
var sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

חזרה

Integer – המיקום של הגיליון בגיליון האלקטרוני הראשי שלו.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getMaxColumns()`

מחזירה את המספר הנוכחי של עמודות בגיליון, ללא קשר לתוכן.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxColumns());

חזרה

Integer – הרוחב המקסימלי של הגיליון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getMaxRows()`

מחזירה את מספר השורות הנוכחי בגיליון, ללא קשר לתוכן.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxRows());

חזרה

Integer – הגובה המקסימלי של הגיליון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getName()`

מחזירה את שם הגיליון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
Logger.log(sheet.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.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

חזרה

NamedRange[] – מערך של כל טווחי התאים בעלי השם בגיליון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getParent()`

הפונקציה מחזירה את הערך Spreadsheet שמכיל את הגיליון הזה.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// parent is identical to ss
var parent = sheet.getParent();

חזרה

Spreadsheet – הגיליון האלקטרוני שמוגדר כהורה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getPivotTables()`

הפונקציה מחזירה את כל טבלאות הצירים בגיליון.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

חזרה

PivotTable[] – טבלאות הצירים בגיליון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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 sheet = SpreadsheetApp.getActiveSheet();
var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove sheet protection from the active sheet, if the user has permission to edit it.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection && 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(row, column)`

מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונות.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
var range = sheet.getRange(1, 1);
var values = range.getValues();
Logger.log(values[0][0]);

פרמטרים

שם	סוג	תיאור
`row`	`Integer`	אינדקס השורה של התא שיש להחזיר; הוספת השורות לאינדקס מתחילה ב-1.
`column`	`Integer`	אינדקס העמודה של התא שצריך להחזיר; ההוספה של עמודות לאינדקס מתחילה ב-1.

חזרה

Range – טווח שמכיל רק את התא הזה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getRange(row, column, numRows)`

מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונים, ועם המספר הנתון שורות.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is returned.
var range = sheet.getRange(1, 1, 3);
var values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

פרמטרים

שם	סוג	תיאור
`row`	`Integer`	אינדקס השורה הראשונה של הטווח; הוספת השורות לאינדקס מתחילה ב-1.
`column`	`Integer`	אינדקס העמודה של הטווח; ההוספה של עמודות לאינדקס מתחילה ב-1.
`numRows`	`Integer`	מספר השורות שיש להחזיר.

חזרה

Range – טווח שמכיל עמודה אחת של נתונים עם מספר השורות שצוינו.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getRange(row, column, numRows, numColumns)`

מחזירה את הטווח עם התא השמאלי העליון בקואורדינטות הנתונים מספר השורות הנתון ו-עמודות.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 3, 3);
var values = range.getValues();

// Print values from a 3x3 box.
for (var row in values) {
  for (var col in values[row]) {
    Logger.log(values[row][col]);
  }
}

פרמטרים

שם	סוג	תיאור
`row`	`Integer`	אינדקס השורה הראשונה של הטווח; הוספת השורות לאינדקס מתחילה ב-1.
`column`	`Integer`	אינדקס העמודה ההתחלתי של הטווח; ההוספה של עמודות לאינדקס מתחילה ב-1.
`numRows`	`Integer`	מספר השורות שיש להחזיר.
`numColumns`	`Integer`	מספר העמודות שיש להחזיר.

חזרה

Range – טווח שתואם לאזור שצוין.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`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

`getRowGroup(rowIndex, groupDepth)`

מחזירה את קבוצת השורות באינדקס ובעומק הקבוצה הנתונים.

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

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
var rowGroup = sheet.getRowGroup(2, 1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	אינדקס השורות של מתג הבקרה של הקבוצה או אינדקס בתוך הקבוצה.
`groupDepth`	`Integer`	עומק הקבוצה.

חזרה

Group – קבוצת השורות באינדקס ובעומק הבקרה, או מקפיצה הודעת שגיאה אם הקבוצה לא קיים.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getRowGroupControlPosition()`

הפונקציה מחזירה את הערך GroupControlTogglePosition בכל קבוצות השורות בגיליון.

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

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the
// group.
var rowGroupControlPosition = sheet.getRowGroupControlPosition();

חזרה

GroupControlTogglePosition – true אם מתג הבקרה לקיבוץ שורות מוצג אחרי הקבוצה בגיליון האלקטרוני ו-false, אחרת.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getRowGroupDepth(rowIndex)`

מחזירה את עומק הקבוצה של השורה באינדקס הנתון.

עומק הקבוצה מציין כמה קבוצות חופפות לשורה. הערך יכול לנוע בין אפס ושמונה.

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

// 1 if there is a group over rows 1 through 3
var groupDepth = sheet.getRowGroupDepth(1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס של השורה.

חזרה

Integer – עומק הקבוצה של השורה באינדקס הנתון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`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)`

מחזירה את רשת הערכים המלבנית של הערכים עבור הטווח הזה החל מהקואורדינטות הנתונות. A -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

`getSlicers()`

מחזירה מערך של כלי סינון בגיליון.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

חזרה

Slicer[] – רשימת כלי הסינון בגיליון הזה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getTabColorObject()`

הפונקציה מקבלת את הצבע של לשונית הגיליון. לחלופין, אם לשונית הגיליון לא מכילה צבע, הערך null.

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = first.getTabColorObject();

חזרה

Color – הצבע של לשונית הגיליון או null אם אין צבע בלשונית הגיליון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getType()`

מחזירה את הסוג של הגיליון.

סוג ברירת המחדל של הגיליון הוא SheetType.GRID. גיליון שמכיל רכיב מוטמע אחד אובייקט כמו EmbeddedChart הוא גיליון SheetType.OBJECT.

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

חזרה

SheetType – סוג הגיליון.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`hasHiddenGridlines()`

הפונקציה מחזירה את הערך true אם קווי הרשת בגיליון מוסתרים. אחרת, הפונקציה מחזירה false. כברירת מחדל, קווי הרשת מוצגים.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if the spreadsheet has hidden gridelines and logs the result to the console.
console.log(sheet.hasHiddenGridlines());

חזרה

Boolean — true אם קווי הרשת מוסתרים; false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`hideColumns(columnIndex)`

מסתירה עמודה אחת באינדקס הנתון. בשיטה הזו צריך להשתמש במדד 1.

כדי להסתיר יותר מעמודה אחת באמצעות אינדקס, יש להשתמש ב-hideColumns(columnIndex, numColumns).

כדי להסתיר יותר מעמודה אחת באמצעות טווח, יש להשתמש ב-hideColumn().

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס של העמודה להסתרה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`hideColumns(columnIndex, numColumns)`

מסתירה עמודה אחת או יותר ברצף, החל מהאינדקס הנתון. בשיטה הזו צריך להשתמש במדד 1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס ההתחלתי של העמודות להסתרה.
`numColumns`	`Integer`	מספר העמודות להסתרה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`hideRows(rowIndex)`

הסתרת השורה באינדקס הנתון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס של השורה להסתרה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`hideRows(rowIndex, numRows)`

מסתירה שורה אחת או יותר ברצף, החל מהאינדקס הנתון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס ההתחלתי של השורות להסתרה.
`numRows`	`Integer`	מספר השורות להסתרה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`hideSheet()`

הסתרת הגיליון הזה. אין לכך השפעה אם הגיליון כבר מוסתר. אם קוראים לשיטה הזו רק הגיליון הגלוי, הוא גורם לחריגה.

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

חזרה

Sheet – הגיליון הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`insertChart(chart)`

הוספת תרשים חדש לגיליון הזה.

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B4"))
    .setPosition(5, 5, 0, 0)
    .setOption("title", "Dynamic Chart")
    .build();
sheet.insertChart(chart);

פרמטרים

שם	סוג	תיאור
`chart`	`EmbeddedChart`	התרשים להוספה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`insertColumns(columnIndex)`

הוספת עמודה ריקה בגיליון במיקום שצוין.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס שמציין איפה להוסיף עמודה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`insertColumns(columnIndex, numColumns)`

מוסיפה עמודה ריקה אחת או יותר ברצף בגיליון החל מהמיקום שצוין.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס שמציין איפה להוסיף עמודה.
`numColumns`	`Integer`	מספר העמודות להוספה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`insertImage(blobSource, column, row)`

הוספת BlobSource כתמונה במסמך בשורה ובעמודה מסוימות. התמונה הגודל מאוחזר מתוכן ה-blob. גודל ה-blob המקסימלי הנתמך הוא 2MB.

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

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

פרמטרים

שם	סוג	תיאור
`blobSource`	`BlobSource`	ה-blob שמכיל את תוכן התמונה, סוג 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)`

מוסיפה BlobSource כתמונה למסמך בשורה ועמודה נתונה, עם קיזוז פיקסלים. גודל התמונה מאוחזר מתוכן ה-blob. מספר ה-blob הנתמך המקסימלי הגודל הוא 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);

פרמטרים

שם	סוג	תיאור
`blobSource`	`BlobSource`	ה-blob שמכיל את תוכן התמונה, סוג 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`	כתובת האתר של התמונה.
`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

`insertRows(rowIndex)`

הוספת שורה ריקה בגיליון במיקום שצוין.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס שמציין איפה להוסיף שורה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`insertRows(rowIndex, numRows)`

הוספת שורה ריקה אחת או יותר ברצף בגיליון, החל מהמיקום שצוין.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס שמציין איפה להוסיף שורה.
`numRows`	`Integer`	מספר השורות להוספה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`insertSlicer(range, anchorRowPos, anchorColPos)`

הוספת כלי סינון חדש לגיליון הזה.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range of the sheet.
const range = sheet.getRange('A1:D10');

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

פרמטרים

שם	סוג	תיאור
`range`	`Range`	הטווח שבו נוצר כלי הסינון.
`anchorRowPos`	`Integer`	הצד העליון של כלי הסינון מקושר לשורה הזו.
`anchorColPos`	`Integer`	הצד העליון של כלי הסינון מחובר לעמודה הזו.

חזרה

Slicer – כלי הסינון החדש שנוסף.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`

הוספת כלי סינון חדש לגיליון הזה.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range.
const range = sheet.getRange('A1:D10');

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

פרמטרים

שם	סוג	תיאור
`range`	`Range`	הטווח שבו נוצר כלי הסינון.
`anchorRowPos`	`Integer`	הצד העליון של כלי הסינון מקושר לשורה הזו.
`anchorColPos`	`Integer`	הצד העליון של כלי הסינון מחובר לעמודה הזו.
`offsetX`	`Integer`	ההיסט האופקי מפינת התא בפיקסלים.
`offsetY`	`Integer`	ההיסט האנכי מפינת התא בפיקסלים.

חזרה

Slicer – כלי הסינון החדש שנוסף.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`isColumnHiddenByUser(columnPosition)`

הפונקציה מחזירה אם העמודה הנתונה מוסתרת על ידי המשתמש.

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

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

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	מיקום העמודה לבדיקה.

חזרה

Boolean – true אם העמודה מוסתרת, אחרת false.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`isRightToLeft()`

הפונקציה מחזירה את הערך true אם פריסת הגיליון הזו היא מימין לשמאל. הפונקציה מחזירה את הערך false אם הגיליון משתמש בפריסת ברירת המחדל משמאל לימין.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to the console.
console.log(sheet.isRightToLeft());

חזרה

Boolean — true אם הוא מימין לשמאל; false אם לא.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`isRowHiddenByFilter(rowPosition)`

הפונקציה מחזירה אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת סינון).

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

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

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	מיקום השורה לבדיקה.

חזרה

Boolean – true אם השורה מוסתרת, אחרת false.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`isRowHiddenByUser(rowPosition)`

הפונקציה מחזירה אם השורה הנתונה מוסתרת על ידי המשתמש.

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

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

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	מיקום השורה לבדיקה.

חזרה

Boolean – true אם השורה מוסתרת, אחרת false.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`isSheetHidden()`

הפונקציה מחזירה את הערך true אם הגיליון מוסתר כרגע.

var sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

חזרה

Boolean — true אם הגיליון מוסתר, אחרת false.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`moveColumns(columnSpec, destinationIndex)`

העברת העמודות שנבחרו בטווח הנתון למיקום שמצוין ב-destinationIndex. ה-columnSpec עצמו לא חייב לייצג בדיוק שלם עמודה או קבוצת עמודות להעברה — היא בוחרת את כל העמודות שהטווח מתפרס עליהן.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
var columnSpec = sheet.getRange("A1:B1");
sheet.moveColumns(columnSpec, 5);

פרמטרים

שם	סוג	תיאור
`columnSpec`	`Range`	טווח שכולל את העמודות שצריך להעביר.
`destinationIndex`	`Integer`	האינדקס שאליו צריך להעביר את העמודות. שימו לב שהאינדקס הזה על סמך הקואורדינטות לפני שהעמודות יועברו. הנתונים הקיימים מועברים ימינה אל לפנות מקום לעמודות שהועברו בזמן שעמודות המקור מוסרות מהרשת. לכן, ייתכן שהנתונים יופיעו באינדקס שונה מזה שצוין במקור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`moveRows(rowSpec, destinationIndex)`

מעבירה את השורות שנבחרו בטווח הנתון למיקום שמצוין על ידי destinationIndex. השדה rowSpec עצמו לא חייב לייצג שורה שלמה בדיוק או קבוצה של שורות להעברה — היא בוחרת את כל השורות שהטווח מתפרס עליהן.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
var sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
var rowSpec = sheet.getRange("A1:A2");
sheet.moveRows(rowSpec, 5);

פרמטרים

שם	סוג	תיאור
`rowSpec`	`Range`	טווח שמתפרס על השורות שצריך להעביר.
`destinationIndex`	`Integer`	האינדקס שאליו צריך להעביר את השורות. שימו לב שהאינדקס הזה בהתאם לקואורדינטות לפני שהשורות מועברות. הנתונים הקיימים מוקטנים כדי ליצור מקום לשורות שהועברו בזמן ששורות המקור מוסרות מהרשת. לכן, הנתונים עשויים להגיע לאינדקס שונה מזה שצוין במקור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`newChart()`

הפונקציה מחזירה Builder כדי ליצור תרשים חדש לגיליון הזה.

בדוגמה הזו אפשר לראות איך יוצרים תרשים חדש:

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

חזרה

EmbeddedChartBuilder – כלי ליצירת תרשים חדש.

`protect()`

יצירת אובייקט שיכול להגן על הגיליון מפני עריכה, למעט על ידי משתמשים הרשאה. עד שהסקריפט משנה בפועל את רשימת העורכים של הגיליון (על ידי שליחת קריאה Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses), או הגדרה של עבור Protection.setDomainEdit(editable)), ההרשאות משקפות את הגיליון האלקטרוני עצמו, כלומר, הגיליון יישאר לא מוגן. אם הגיליון השיטה הזו כבר מוגנת, והיא מחזירה אובייקט שמייצג את הגדרות ההגנה הקיימות שלו. גיליון מוגן יכול לכלול אזורים לא מוגנים.

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if the user's edit
// permission comes from a group, the script throws an exception upon removing the group.
var me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

חזרה

Protection – אובייקט שמייצג את הגדרות ההגנה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`removeChart(chart)`

הסרת תרשים מהגיליון הראשי.

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

// This removes all the embedded charts from the spreadsheet
var charts = sheet.getCharts();
for (var i in charts) {
  sheet.removeChart(charts[i]);
}

פרמטרים

שם	סוג	תיאור
`chart`	`EmbeddedChart`	התרשים להסרה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setActiveRange(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

`setActiveRangeList(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();

פרמטרים

שם	סוג	תיאור
`rangeList`	`RangeList`	רשימת הטווחים לבחירה.

חזרה

RangeList – רשימת הטווחים החדשה שנבחרה

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setActiveSelection(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

`setActiveSelection(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

`setColumnGroupControlPosition(position)`

הגדרת המיקום של מתג הבקרה על קבוצת העמודות בגיליון.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);

פרמטרים

שם	סוג	תיאור
`position`	`GroupControlTogglePosition`	המיקום של מתג הבקרה על קבוצת העמודות.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setColumnWidth(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);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	המיקום של העמודה הנתונה.
`width`	`Integer`	הרוחב בפיקסלים שיש להגדיר אותו.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setColumnWidths(startColumn, numColumns, width)`

מגדיר את הרוחב של העמודות הנתונות בפיקסלים.

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

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

פרמטרים

שם	סוג	תיאור
`startColumn`	`Integer`	מיקום העמודה ההתחלתי שיש לשנות.
`numColumns`	`Integer`	מספר העמודות לשינוי.
`width`	`Integer`	הרוחב בפיקסלים שיש להגדיר אותו.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setConditionalFormatRules(rules)`

הפונקציה מחליפה את כל הכללים הקיימים של עיצוב מותנים בגיליון בכללי הקלט. הכללים נבדקים לפי סדר הקלט שלהם.

// Remove one of the existing conditional format rules.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
rules.splice(1, 1); // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

פרמטרים

שם	סוג	תיאור
`rules`	`ConditionalFormatRule[]`	הכללים החדשים של עיצוב מותנה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setCurrentCell(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

`setFrozenColumns(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

`setFrozenRows(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

`setHiddenGridlines(hideGridlines)`

הסתרה או חשיפה של קווי הרשת בגיליון.

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

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

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

פרמטרים

שם	סוג	תיאור
`hideGridlines`	`Boolean`	אם הערך שלו הוא `true`, קווי הרשת בגיליון הזה יוסתרו. אחרת תראו את בקווי רשת.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setName(name)`

מגדיר את שם הגיליון.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setName("not first anymore");

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם החדש של הגיליון.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setRightToLeft(rightToLeft)`

מגדיר או מבטל את ההגדרה של פריסת הגיליון מימין לשמאל.

// 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 a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

פרמטרים

שם	סוג	תיאור
`rightToLeft`	`Boolean`	אם הערך שלו הוא `true`, פריסת הגיליון מוגדרת מימין לשמאל, כאשר תא A1 מוגדר מימין לשמאל בפינה הימנית העליונה. אם הערך שלו הוא `false`, פריסת הגיליון מוגדרת לברירת המחדל משמאל לימין, כאשר תא A1 בפינה השמאלית העליונה.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setRowGroupControlPosition(position)`

המדיניות קובעת את המיקום של מתג הבקרה של קבוצת השורות בגיליון.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);

פרמטרים

שם	סוג	תיאור
`position`	`GroupControlTogglePosition`	המיקום של מתג הבקרה על קבוצת השורות.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setRowHeight(rowPosition, height)`

מגדיר את גובה השורה של שורה נתונה בפיקסלים. כברירת מחדל, השורות מתפתחות בהתאם לתוכן של התא. אם המיקום שרוצים לאלץ שורות לגובה מסוים, צריך להשתמש בפונקציה 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);

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	מיקום השורה שצריך לשנות.
`height`	`Integer`	הגובה בפיקסלים שיש להגדיר אותו.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setRowHeights(startRow, numRows, height)`

מגדיר את הגובה של השורות הנתונות בפיקסלים. כברירת מחדל, השורות מתפתחות בהתאם לתוכן של התא. אם אם רוצים לאלץ שורות לגובה מסוים, צריך להשתמש בפונקציה setRowHeightsForced(startRow, numRows, height).

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

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

פרמטרים

שם	סוג	תיאור
`startRow`	`Integer`	מיקום השורה הראשונה שיש לשנות.
`numRows`	`Integer`	מספר השורות שרוצים לשנות.
`height`	`Integer`	הגובה בפיקסלים שיש להגדיר אותו.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setRowHeightsForced(startRow, numRows, height)`

מגדיר את הגובה של השורות הנתונות בפיקסלים. כברירת מחדל, השורות מתפתחות בהתאם לתוכן של התא. מתי נעשה שימוש ב-setRowHeightsForced, השורות מאולצות לגובה שצוין גם אם תוכן התא גבוה מגובה השורה.

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

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

פרמטרים

שם	סוג	תיאור
`startRow`	`Integer`	מיקום השורה הראשונה שיש לשנות.
`numRows`	`Integer`	מספר השורות שרוצים לשנות.
`height`	`Integer`	הגובה בפיקסלים שיש להגדיר אותו.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setTabColor(color)`

הגדרת הצבע של לשונית בגיליון.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
first.setTabColor("ff0000"); // Set the color to red.
first.setTabColor(null); // Unset the color.

פרמטרים

שם	סוג	תיאור
`color`	`String`	קוד צבע בסימון CSS (כמו `'#ffffff'` או `'white'`), או `null` כדי לאפס את צבע הכרטיסייה.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setTabColorObject(color)`

הגדרת הצבע של לשונית בגיליון.

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
first.setTabColorObject(color); // Set the color to theme accent 1.
first.setTabColorObject(null); // Unset the color.

פרמטרים

שם	סוג	תיאור
`color`	`Color`	הצבע של לשונית הגיליון שיש להגדיר.

חזרה

Sheet – הגיליון הזה, לשרשור.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`showColumns(columnIndex)`

מבטל את הסתרת העמודה באינדקס הנתון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס של העמודה שצריך לבטל את ההסתרה שלה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`showColumns(columnIndex, numColumns)`

ביטול ההסתרה של עמודה אחת או יותר ברצף החל מהאינדקס הנתון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

פרמטרים

שם	סוג	תיאור
`columnIndex`	`Integer`	האינדקס ההתחלתי של העמודות לביטול הסתרה.
`numColumns`	`Integer`	מספר העמודות לביטול ההסתרה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`showRows(rowIndex)`

מבטל את הסתרת השורה באינדקס הנתון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס של השורה שצריך לבטל את ההסתרה שלה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`showRows(rowIndex, numRows)`

ביטול ההסתרה של שורה אחת או יותר ברצף, החל מהאינדקס הנתון.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

פרמטרים

שם	סוג	תיאור
`rowIndex`	`Integer`	האינדקס ההתחלתי של השורות לביטול הסתרה.
`numRows`	`Integer`	מספר השורות לביטול ההסתרה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`showSheet()`

הופך את הגיליון לגלוי. אין לכך השפעה אם הגיליון כבר גלוי.

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

חזרה

Sheet – הגיליון הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`sort(columnPosition)`

ממיינת גיליון לפי עמודה, בסדר עולה.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`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);

פרמטרים

שם	סוג	תיאור
`columnPosition`	`Integer`	העמודה שלפיה יתבצע מיון.
`ascending`	`Boolean`	`true` למיון בסדר עולה, `false` למיון בסדר יורד.

חזרה

Sheet – הגיליון, שימושי לשרשור שיטות

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`unhideColumn(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

`unhideRow(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

`updateChart(chart)`

עדכון התרשים בגיליון הזה.

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

// This code is going to loop through all the charts and change them to
// column charts
var charts = sheet.getCharts();
for (var i in charts) {
  var chart = charts[i];
  var newChart = chart
      .modify()
      .setChartType(Charts.ChartType.COLUMN)
      .build();
  sheet.updateChart(newChart);
}

פרמטרים

שם	סוג	תיאור
`chart`	`EmbeddedChart`	התרשים שצריך לעדכן.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

שיטות שהוצאו משימוש

`getSheetProtection()`

הוצא משימוש. לגיליונות אלקטרוניים שנוצרו בגרסה החדשה יותר של Google Sheets, צריך להשתמש בפונקציה getProtections(type), שמחזירה את המחלקה Protection העוצמתית יותר. השיטה הזו הוצאה משימוש, אבל היא עדיין זמינה עבור תאימות לגרסה הקודמת של Sheets

מחזירה מופע PageProtection שמתאר את ההרשאות לגיליון הנוכחי.

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

var permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser("user@example.com");

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
var users = permissions.getUsers();
Logger.log(users);

חזרה

PageProtection – אובייקט שמתאר הרשאות גישה לגיליון

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`getTabColor()`

הוצא משימוש. הוחלף על ידי getTabColorObject()

הפונקציה מקבלת את הצבע של לשונית הגיליון. לחלופין, אם לשונית הגיליון לא מכילה צבע, הערך null.

// This example assumes there is a sheet named "first"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
var color = first.getTabColor();

חזרה

String — קוד צבע בסימון CSS (למשל '#ffffff').

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

`setSheetProtection(permissions)`

הוצא משימוש. לגיליונות אלקטרוניים שנוצרו בגרסה החדשה יותר של Google Sheets, צריך להשתמש בפונקציה protect(), שמחזירה את המחלקה Protection העוצמתית יותר. למרות שיטה זו הוצאה משימוש, היא עדיין זמינה לצורך תאימות עם הגרסה הישנה יותר של גיליונות

הגדרת ההרשאות לגיליון הנוכחי.

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

var permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
var sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

פרמטרים

שם	סוג	תיאור
`permissions`	`PageProtection`	האובייקט של הרשאות הגישה שצריך להגדיר בגיליון הזה.

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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