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

Class Spreadsheet

גישה לקובצי Google Sheets ושינוי שלהם. פעולות נפוצות הן הוספת גיליונות חדשים והוספת משתפי פעולה.

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
`addDeveloperMetadata(key)`	`Spreadsheet`	הפונקציה מוסיפה מטא נתונים למפתחים עם המפתח שצוין לגיליון האלקטרוני ברמה העליונה.
`addDeveloperMetadata(key, visibility)`	`Spreadsheet`	הפונקציה מוסיפה לגיליון האלקטרוני מטא-נתונים של מפתח עם סטטוס השיתוף שצוין.
`addDeveloperMetadata(key, value)`	`Spreadsheet`	הפונקציה מוסיפה לגיליון האלקטרוני מטא נתונים למפתחים עם המפתח והערך שצוינו.
`addDeveloperMetadata(key, value, visibility)`	`Spreadsheet`	הפונקציה מוסיפה לגיליון האלקטרוני מטא-נתונים למפתחים עם המפתח, הערך והסטטוס שצוינו.
`addEditor(emailAddress)`	`Spreadsheet`	הפונקציה מוסיפה את המשתמש שצוין לרשימת העורכים של `Spreadsheet`.
`addEditor(user)`	`Spreadsheet`	הפונקציה מוסיפה את המשתמש שצוין לרשימת העורכים של `Spreadsheet`.
`addEditors(emailAddresses)`	`Spreadsheet`	מוסיף את מערך המשתמשים שצוין לרשימת בעלי הרשאת העריכה של `Spreadsheet`.
`addMenu(name, subMenus)`	`void`	יצירת תפריט חדש בממשק המשתמש של הגיליון האלקטרוני.
`addViewer(emailAddress)`	`Spreadsheet`	הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של `Spreadsheet`.
`addViewer(user)`	`Spreadsheet`	הפונקציה מוסיפה את המשתמש שצוין לרשימת הצופים של `Spreadsheet`.
`addViewers(emailAddresses)`	`Spreadsheet`	הפונקציה מוסיפה את מערך המשתמשים שצוין לרשימת הצופים של `Spreadsheet`.
`appendRow(rowContents)`	`Sheet`	הוספת שורה לתחתית של אזור הנתונים הנוכחי בגיליון.
`autoResizeColumn(columnPosition)`	`Sheet`	ההגדרה קובעת את הרוחב של העמודה שצוינה כך שיתאים לתוכן שלה.
`copy(name)`	`Spreadsheet`	מעתיקה את הגיליון האלקטרוני ומחזירה את הגיליון החדש.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	מחזירה `DeveloperMetadataFinder` כדי למצוא מטא-נתונים למפתחים בטווח של הגיליון האלקטרוני הזה.
`createTextFinder(findText)`	`TextFinder`	יוצר כלי לחיפוש טקסט בגיליון האלקטרוני, שאפשר להשתמש בו כדי לחפש ולהחליף טקסט בגיליון האלקטרוני.
`deleteActiveSheet()`	`Sheet`	מחיקת הגיליון שפעיל כרגע.
`deleteColumn(columnPosition)`	`Sheet`	מוחקת את העמודה במיקום העמודה שצוין.
`deleteColumns(columnPosition, howMany)`	`void`	מוחקת מספר עמודות החל ממיקום העמודה שצוין.
`deleteRow(rowPosition)`	`Sheet`	מוחק את השורה במיקום השורה שצוין.
`deleteRows(rowPosition, howMany)`	`void`	מוחקת מספר שורות החל ממיקום השורה הנתון.
`deleteSheet(sheet)`	`void`	מחיקת הגיליון שצוין.
`duplicateActiveSheet()`	`Sheet`	יוצר עותק כפול של הגיליון הפעיל והופך אותו לגיליון הפעיל.
`getActiveCell()`	`Range`	הפונקציה מחזירה את התא הפעיל בגיליון הזה.
`getActiveRange()`	`Range`	הפונקציה מחזירה את הטווח שנבחר בגיליון הפעיל, או `null` אם אין טווח פעיל.
`getActiveRangeList()`	`RangeList`	הפונקציה מחזירה את רשימת הטווחים הפעילים בגיליון הפעיל, או `null` אם אין טווחים פעילים.
`getActiveSheet()`	`Sheet`	מחזירה את הגיליון הפעיל בגיליון אלקטרוני.
`getAs(contentType)`	`Blob`	החזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין.
`getBandings()`	`Banding[]`	הפונקציה מחזירה את כל ההצללות בגיליון האלקטרוני.
`getBlob()`	`Blob`	הפונקציה מחזירה את הנתונים בתוך האובייקט הזה כ-blob.
`getColumnWidth(columnPosition)`	`Integer`	מחזירה את הרוחב בפיקסלים של העמודה הנתונה.
`getCurrentCell()`	`Range`	הפונקציה מחזירה את התא הנוכחי בגיליון הפעיל או `null` אם אין תא נוכחי.
`getDataRange()`	`Range`	הפונקציה מחזירה `Range` שמתאים למאפיינים שבהם יש נתונים.
`getDataSourceFormulas()`	`DataSourceFormula[]`	מקבל את כל הנוסחאות של מקורות הנתונים.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	מחזירה את כל טבלאות הצירים של מקור הנתונים.
`getDataSourceRefreshSchedules()`	`DataSourceRefreshSchedule[]`	מקבל את לוחות הזמנים לרענון של הגיליון האלקטרוני הזה.
`getDataSourceSheets()`	`DataSourceSheet[]`	הפונקציה מחזירה את כל הגיליונות של מקור הנתונים בגיליון האלקטרוני.
`getDataSourceTables()`	`DataSourceTable[]`	מקבל את כל הטבלאות של מקורות הנתונים.
`getDataSources()`	`DataSource[]`	הפונקציה מחזירה את כל מקורות הנתונים בגיליון האלקטרוני.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	מקבל את המטא-נתונים של המפתח שמשויכים לגיליון האלקטרוני ברמה העליונה.
`getEditors()`	`User[]`	מקבל את רשימת העורכים של `Spreadsheet`.
`getFormUrl()`	`String`	הפונקציה מחזירה את כתובת ה-URL של הטופס ששולח את התשובות שלו לגיליון האלקטרוני הזה, או `null` אם אין טופס שמשויך לגיליון האלקטרוני הזה.
`getFrozenColumns()`	`Integer`	הפונקציה מחזירה את מספר העמודות הקפואות.
`getFrozenRows()`	`Integer`	הפונקציה מחזירה את מספר השורות הקפואות.
`getId()`	`String`	מחזירה מזהה ייחודי לגיליון האלקטרוני הזה.
`getImages()`	`OverGridImage[]`	הפונקציה מחזירה את כל התמונות שמוצבות מעל רשת התאים בגיליון.
`getIterativeCalculationConvergenceThreshold()`	`Number`	הפונקציה מחזירה את ערך הסף שמשמש במהלך חישוב איטרטיבי.
`getLastColumn()`	`Integer`	הפונקציה מחזירה את המיקום של העמודה האחרונה שמכילה תוכן.
`getLastRow()`	`Integer`	הפונקציה מחזירה את המיקום של השורה האחרונה שיש בה תוכן.
`getMaxIterativeCalculationCycles()`	`Integer`	הפונקציה מחזירה את המספר המקסימלי של איטרציות לשימוש במהלך חישוב איטרטיבי.
`getName()`	`String`	מחזירה את שם המסמך.
`getNamedRanges()`	`NamedRange[]`	מחזירה את כל טווחי התאים בעלי השם בגיליון האלקטרוני הזה.
`getNumSheets()`	`Integer`	הפונקציה מחזירה את מספר הגיליונות בגיליון האלקטרוני הזה.
`getOwner()`	`User`	מחזירה את הבעלים של המסמך, או `null` אם המסמך נמצא באחסון שיתופי.
`getPredefinedSpreadsheetThemes()`	`SpreadsheetTheme[]`	מחזירה את רשימת העיצובים המוגדרים מראש.
`getProtections(type)`	`Protection[]`	מחזירה מערך של אובייקטים שמייצגים את כל טווחי התאים המוגנים או הגיליונות המוגנים בגיליון האלקטרוני.
`getRange(a1Notation)`	`Range`	הפונקציה מחזירה את הטווח כפי שצוין בשיטת הסימון A1 או בשיטת הסימון R1C1.
`getRangeByName(name)`	`Range`	הפונקציה מחזירה טווח תאים עם שם, או `null` אם לא נמצא טווח עם השם שצוין.
`getRangeList(a1Notations)`	`RangeList`	הפונקציה מחזירה את האוסף `RangeList` שמייצג את הטווחים באותו גיליון שצוין על ידי רשימה לא ריקה של סימוני A1 או סימוני R1C1.
`getRecalculationInterval()`	`RecalculationInterval`	הפונקציה מחזירה את מרווח החישוב של הגיליון האלקטרוני הזה.
`getRowHeight(rowPosition)`	`Integer`	מחזירה את הגובה בפיקסלים של השורה הנתונה.
`getSelection()`	`Selection`	הפונקציה מחזירה את התאריך הנוכחי `Selection` בגיליון האלקטרוני.
`getSheetById(id)`	`Sheet`	הפונקציה מחזירה את הגיליון עם המזהה הנתון.
`getSheetByName(name)`	`Sheet`	הפונקציה מחזירה גיליון עם השם שצוין.
`getSheetId()`	`Integer`	מחזירה את המזהה של הגיליון שמיוצג על ידי האובייקט הזה.
`getSheetName()`	`String`	הפונקציה מחזירה את שם הגיליון.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	הפונקציה מחזירה את הרשת המלבנית של ערכים לטווח הזה, החל מהקואורדינטות שצוינו.
`getSheets()`	`Sheet[]`	מקבל את כל הגיליונות בגיליון האלקטרוני הזה.
`getSpreadsheetLocale()`	`String`	מחזירה את הלוקאל של הגיליון האלקטרוני.
`getSpreadsheetTheme()`	`SpreadsheetTheme`	הפונקציה מחזירה את העיצוב הנוכחי של הגיליון האלקטרוני, או `null` אם לא הוחל עיצוב.
`getSpreadsheetTimeZone()`	`String`	מחזירה את אזור הזמן של הגיליון האלקטרוני.
`getUrl()`	`String`	הפונקציה מחזירה את כתובת ה-URL של הגיליון האלקטרוני הנתון.
`getViewers()`	`User[]`	מחזירה את רשימת הצופים והמגיבים של `Spreadsheet`.
`hideColumn(column)`	`void`	הפונקציה מסתירה את העמודה או העמודות בטווח הנתון.
`hideRow(row)`	`void`	הפונקציה מסתירה את השורות בטווח הנתון.
`insertColumnAfter(afterPosition)`	`Sheet`	הפונקציה מוסיפה עמודה אחרי העמודה שצוין המיקום שלה.
`insertColumnBefore(beforePosition)`	`Sheet`	הפונקציה מוסיפה עמודה לפני המיקום של העמודה שצוין.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	הפונקציה הזו מוסיפה מספר מסוים של עמודות אחרי העמודה שצוינה.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	מוסיפה מספר עמודות לפני מיקום העמודה שצוין.
`insertDataSourceSheet(spec)`	`DataSourceSheet`	מוסיפים `DataSourceSheet` חדש לגיליון האלקטרוני ומתחילים את ביצוע הנתונים.
`insertImage(blobSource, column, row)`	`OverGridImage`	הפונקציה מוסיפה `Spreadsheet` כתמונה למסמך בשורה ובעמודה שצוינו.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	מוסיפה את `Spreadsheet` כתמונה למסמך בשורה ובעמודה נתונות, עם היסט של פיקסלים.
`insertImage(url, column, row)`	`OverGridImage`	הפונקציה מוסיפה תמונה למסמך בשורה ובעמודה שצוינו.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	הפונקציה מכניסה תמונה למסמך בשורה ובעמודה נתונות, עם היסט בפיקסלים.
`insertRowAfter(afterPosition)`	`Sheet`	הפונקציה מוסיפה שורה אחרי מיקום השורה שצוין.
`insertRowBefore(beforePosition)`	`Sheet`	מוסיף שורה לפני מיקום השורה שצוין.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	הפונקציה הזו מוסיפה מספר שורות אחרי מיקום השורה שצוין.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	מוסיפה מספר שורות לפני מיקום השורה הנתון.
`insertSheet()`	`Sheet`	הפונקציה מוסיפה גיליון חדש לגיליון האלקטרוני, עם שם ברירת מחדל לגיליון.
`insertSheet(sheetIndex)`	`Sheet`	מוסיפה גיליון חדש לגיליון האלקטרוני באינדקס הנתון.
`insertSheet(sheetIndex, options)`	`Sheet`	הפונקציה מוסיפה גיליון חדש לגיליון האלקטרוני באינדקס שצוין, ומשתמשת בארגומנטים אופציונליים מתקדמים.
`insertSheet(options)`	`Sheet`	הפונקציה מוסיפה גיליון חדש לגיליון האלקטרוני, עם שם גיליון שמוגדר כברירת מחדל וארגומנטים אופציונליים מתקדמים.
`insertSheet(sheetName)`	`Sheet`	מוסיף גיליון חדש לגיליון האלקטרוני עם השם שצוין.
`insertSheet(sheetName, sheetIndex)`	`Sheet`	הפונקציה מוסיפה גיליון חדש לגיליון האלקטרוני עם השם שצוין באינדקס שצוין.
`insertSheet(sheetName, sheetIndex, options)`	`Sheet`	מוסיפה גיליון חדש לגיליון האלקטרוני עם השם שצוין באינדקס שצוין, ומשתמשת בארגומנטים מתקדמים אופציונליים.
`insertSheet(sheetName, options)`	`Sheet`	מוסיפה גיליון חדש לגיליון האלקטרוני עם השם שצוין, ומשתמשת בארגומנטים אופציונליים מתקדמים.
`insertSheetWithDataSourceTable(spec)`	`Sheet`	הפונקציה מוסיפה גיליון חדש לגיליון האלקטרוני, יוצרת `DataSourceTable` שמשתרע על כל הגיליון עם המפרט של מקור הנתונים שצוין, ומתחילה את ביצוע הנתונים.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	הפונקציה מחזירה ערך בוליאני שמציין אם העמודה הנתונה מוסתרת על ידי המשתמש.
`isIterativeCalculationEnabled()`	`Boolean`	הפונקציה מחזירה את הערך TRUE אם החישוב האיטרטיבי מופעל בגיליון האלקטרוני הזה, ואת הערך FALSE אם הוא לא מופעל.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	הפונקציה מחזירה ערך בוליאני שקובע אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת מסנן).
`isRowHiddenByUser(rowPosition)`	`Boolean`	הפונקציה מחזירה אם השורה הנתונה מוסתרת על ידי המשתמש.
`moveActiveSheet(pos)`	`void`	מעבירה את הגיליון הפעיל למיקום שצוין ברשימת הגיליונות.
`moveChartToObjectSheet(chart)`	`Sheet`	יוצר גיליון `SheetType.OBJECT` חדש ומעביר אליו את התרשים שצוין.
`refreshAllDataSources()`	`void`	מבצע רענון של כל מקורות הנתונים הנתמכים ושל האובייקטים במקורות הנתונים המקושרים, ומדלג על אובייקטים לא תקינים במקורות הנתונים.
`removeEditor(emailAddress)`	`Spreadsheet`	מסיר את המשתמש שצוין מרשימת בעלי הרשאת העריכה של `Spreadsheet`.
`removeEditor(user)`	`Spreadsheet`	מסיר את המשתמש שצוין מרשימת בעלי הרשאת העריכה של `Spreadsheet`.
`removeMenu(name)`	`void`	הסרה של תפריט שנוסף על ידי `addMenu(name, subMenus)`.
`removeNamedRange(name)`	`void`	מוחק טווח תאים בעל שם עם השם שצוין.
`removeViewer(emailAddress)`	`Spreadsheet`	הפעולה מסירה את המשתמש שצוין מרשימת הצופים והמגיבים של `Spreadsheet`.
`removeViewer(user)`	`Spreadsheet`	הפעולה מסירה את המשתמש שצוין מרשימת הצופים והמגיבים של `Spreadsheet`.
`rename(newName)`	`void`	משנה את שם המסמך.
`renameActiveSheet(newName)`	`void`	משנה את השם של הגיליון הפעיל הנוכחי לשם החדש שצוין.
`resetSpreadsheetTheme()`	`SpreadsheetTheme`	הפעולה הזו מסירה את העיצוב שהוחל ומגדירה את עיצוב ברירת המחדל בגיליון האלקטרוני.
`setActiveRange(range)`	`Range`	מגדירה את הטווח שצוין כ-`active range` בגיליון הפעיל, כשהתא הימני העליון בטווח הוא `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	מגדיר את רשימת הטווחים שצוינה כ-`active ranges` בגיליון הפעיל.
`setActiveSelection(range)`	`Range`	מגדיר את אזור הבחירה הפעיל בגיליון הזה.
`setActiveSelection(a1Notation)`	`Range`	מגדיר את הבחירה הפעילה, כפי שמצוין בשיטת הסימון A1 או R1C1.
`setActiveSheet(sheet)`	`Sheet`	מגדיר את הגיליון שצוין כגיליון הפעיל בגיליון האלקטרוני.
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	הפעולה הזו מגדירה את הגיליון שצוין כגיליון הפעיל בגיליון האלקטרוני, עם אפשרות לשחזר את הבחירה האחרונה בגיליון הזה.
`setColumnWidth(columnPosition, width)`	`Sheet`	מגדירה את רוחב העמודה שצוינה בפיקסלים.
`setCurrentCell(cell)`	`Range`	הגדרת התא שצוין כ`current cell`.
`setFrozenColumns(columns)`	`void`	מקפיאה את מספר העמודות שצוין.
`setFrozenRows(rows)`	`void`	מקפיאה את מספר השורות שצוין.
`setIterativeCalculationConvergenceThreshold(minThreshold)`	`Spreadsheet`	הגדרת ערך הסף המינימלי לחישוב איטרטיבי.
`setIterativeCalculationEnabled(isEnabled)`	`Spreadsheet`	ההגדרה קובעת אם החישוב האיטרטיבי מופעל בגיליון האלקטרוני הזה.
`setMaxIterativeCalculationCycles(maxIterations)`	`Spreadsheet`	הגדרה של מספר החזרות המקסימלי של החישוב שצריך לבצע במהלך חישוב איטרטיבי.
`setNamedRange(name, range)`	`void`	נותן שם לטווח.
`setRecalculationInterval(recalculationInterval)`	`Spreadsheet`	הגדרה של התדירות שבה הגיליון האלקטרוני הזה צריך לבצע חישוב מחדש.
`setRowHeight(rowPosition, height)`	`Sheet`	מגדיר את גובה השורה של השורה הנתונה בפיקסלים.
`setSpreadsheetLocale(locale)`	`void`	הגדרת הלוקאל של הגיליון האלקטרוני.
`setSpreadsheetTheme(theme)`	`SpreadsheetTheme`	הגדרת עיצוב לגיליון האלקטרוני.
`setSpreadsheetTimeZone(timezone)`	`void`	הגדרת אזור הזמן של הגיליון האלקטרוני.
`show(userInterface)`	`void`	הצגת רכיב מותאם אישית של ממשק משתמש בתיבת דו-שיח שממוקמת במרכז אזור התצוגה של הדפדפן של המשתמש.
`sort(columnPosition)`	`Sheet`	מיון הגיליון לפי עמודה, בסדר עולה.
`sort(columnPosition, ascending)`	`Sheet`	ממיינת גיליון לפי עמודה.
`toast(msg)`	`void`	מציג חלון קופץ בפינה השמאלית התחתונה של הגיליון האלקטרוני עם ההודעה שצוינה.
`toast(msg, title)`	`void`	הפונקציה מציגה חלון קופץ בפינה השמאלית התחתונה של הגיליון האלקטרוני עם ההודעה והכותרת שצוינו.
`toast(msg, title, timeoutSeconds)`	`void`	מציג חלון קופץ בפינה השמאלית התחתונה של הגיליון האלקטרוני עם הכותרת וההודעה שצוינו, שנשאר גלוי למשך זמן מסוים.
`unhideColumn(column)`	`void`	הפונקציה מבטלת את ההסתרה של העמודה בטווח הנתון.
`unhideRow(row)`	`void`	הפונקציה מבטלת את ההסתרה של השורה בטווח הנתון.
`updateMenu(name, subMenus)`	`void`	עדכון של תפריט שנוסף על ידי `addMenu(name, subMenus)`.
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	הפונקציה ממתינה עד שכל ההרצות הנוכחיות בגיליון האלקטרוני יסתיימו, והיא מפסיקה לפעול אחרי מספר השניות שצוין.

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

שיטה	סוג הערך שמוחזר	תיאור קצר
`getSheetProtection()`	`PageProtection`	הפונקציה מחזירה מופע `PageProtection` שמתאר את ההרשאות של הגיליון הנוכחי.
`isAnonymousView()`	`Boolean`	מציין אם המסמך מאפשר צפייה אנונימית.
`isAnonymousWrite()`	`Boolean`	מציין אם במסמך מותרות עריכות של משתמשים אנונימיים.
`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`	`void`	הגדרת המדיניות של המסמך לגבי קריאה וכתיבה אנונימיות.
`setSheetProtection(permissions)`	`void`	הגדרת ההרשאות של הגיליון הנוכחי.

תיעוד מפורט

`addDeveloperMetadata(key)`

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

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

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

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

פרמטרים

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

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`addDeveloperMetadata(key, visibility)`

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

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

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

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

פרמטרים

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

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`addDeveloperMetadata(key, value)`

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

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

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

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

פרמטרים

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

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`addDeveloperMetadata(key, value, visibility)`

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

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

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

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

פרמטרים

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

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`addEditor(emailAddress)`

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

פרמטרים

שם	סוג	תיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שרוצים להוסיף.

חזרה

‫Spreadsheet — ‏Spreadsheet, לשרשור.

אישור

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

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

`addEditor(user)`

פרמטרים

שם	סוג	תיאור
`user`	`User`	ייצוג של המשתמש שרוצים להוסיף.

חזרה

‫Spreadsheet — ‏Spreadsheet, לשרשור.

אישור

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

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

`addEditors(emailAddresses)`

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

פרמטרים

שם	סוג	תיאור
`emailAddresses`	`String[]`	מערך של כתובות אימייל של המשתמשים שרוצים להוסיף.

חזרה

‫Spreadsheet — ‏Spreadsheet, לשרשור.

אישור

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

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

`addMenu(name, subMenus)`

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

כל פריט בתפריט מפעיל פונקציה בהגדרת המשתמש. בדרך כלל, כדאי להפעיל אותה מהפונקציה onOpen() כדי שהתפריט ייווצר באופן אוטומטי כשהגיליון האלקטרוני נטען.

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

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

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של התפריט שרוצים ליצור.
`subMenus`	`Object[]`	מערך של מפות JavaScript עם הפרמטרים `name` ו-`functionName`. אפשר להשתמש בפונקציות מספריות כלולות, כמו `Library.libFunction1`.

אישור

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

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

`addViewer(emailAddress)`

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

פרמטרים

שם	סוג	תיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שרוצים להוסיף.

חזרה

‫Spreadsheet — ‏Spreadsheet, לשרשור.

אישור

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

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

`addViewer(user)`

פרמטרים

שם	סוג	תיאור
`user`	`User`	ייצוג של המשתמש שרוצים להוסיף.

חזרה

‫Spreadsheet — ‏Spreadsheet, לשרשור.

אישור

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

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

`addViewers(emailAddresses)`

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

פרמטרים

שם	סוג	תיאור
`emailAddresses`	`String[]`	מערך של כתובות אימייל של המשתמשים שרוצים להוסיף.

חזרה

‫Spreadsheet — ‏Spreadsheet, לשרשור.

אישור

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

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

`appendRow(rowContents)`

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

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

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

פרמטרים

שם	סוג	תיאור
`rowContents`	`Object[]`	מערך של ערכים להוספה אחרי השורה האחרונה בגיליון.

חזרה

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

אישור

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

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

`autoResizeColumn(columnPosition)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`copy(name)`

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

// This code makes a copy of the current spreadsheet and names it appropriately
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy(`Copy of ${ss.getName()}`);

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של העותק.

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`createDeveloperMetadataFinder()`

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

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

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

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

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

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

חזרה

‫DeveloperMetadataFinder — כלי למציאת מטא נתונים למפתחים, לחיפוש מטא נתונים בהיקף של הגיליון האלקטרוני הזה.

`createTextFinder(findText)`

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

פרמטרים

שם	סוג	תיאור
`findText`	`String`	הטקסט שרוצים לחפש.

חזרה

‫TextFinder — ה-TextFinder של הגיליון האלקטרוני.

`deleteActiveSheet()`

מחיקת הגיליון שפעיל כרגע.

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

חזרה

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

אישור

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

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

`deleteColumn(columnPosition)`

מוחקת את העמודה במיקום העמודה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

מוחק את השורה במיקום השורה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

מוחקת מספר שורות החל ממיקום השורה הנתון.

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

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	המיקום של השורה הראשונה למחיקה.
`howMany`	`Integer`	מספר השורות למחיקה.

אישור

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

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

`deleteSheet(sheet)`

מחיקת הגיליון שצוין.

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

פרמטרים

שם	סוג	תיאור
`sheet`	`Sheet`	הגיליון שרוצים למחוק.

אישור

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

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

`duplicateActiveSheet()`

יוצר עותק כפול של הגיליון הפעיל והופך אותו לגיליון הפעיל.

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

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`getActiveCell()`

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

הערה: עדיף להשתמש ב-getCurrentCell(), שמחזירה את התא הנוכחי שמודגש.

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

חזרה

‫Range – התא הפעיל הנוכחי.

אישור

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

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

`getActiveRange()`

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

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

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

חזרה

‫Range — הטווח הפעיל.

אישור

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

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

ראה גם

setActiveRange(range)

`getActiveRangeList()`

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

אם נבחר טווח יחיד, הפעולה תהיה כמו קריאה ל-getActiveRange().

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

חזרה

‫RangeList – רשימת הטווחים הפעילים.

אישור

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

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

ראה גם

setActiveRangeList(rangeList)

`getActiveSheet()`

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

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

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

חזרה

‫Sheet – הגיליון הפעיל בגיליון האלקטרוני.

`getAs(contentType)`

החזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין. בשיטה הזו, הסיומת המתאימה מתווספת לשם הקובץ – לדוגמה, 'myfile.pdf'. עם זאת, המערכת מניחה שחלק משם הקובץ שאחרי הנקודה האחרונה (אם יש כזו) הוא סיומת קיימת שצריך להחליף. לכן, השם "ShoppingList.12.25.2014" הופך ל-"ShoppingList.12.25.pdf".

כדי לראות את המכסות היומיות להמרות, אפשר לעיין במאמר בנושא מכסות לשירותי Google. יכול להיות שדומיינים חדשים ב-Google Workspace יהיו כפופים באופן זמני למכסות מחמירות יותר.

פרמטרים

שם	סוג	תיאור
`contentType`	`String`	סוג ה-MIME שאליו רוצים להמיר. ברוב ה-blobs, האפשרות `'application/pdf'` היא האפשרות התקפה היחידה. אם התמונות בפורמט BMP,‏ GIF,‏ JPEG או PNG, אפשר להשתמש גם באחד מהערכים `'image/bmp'`,‏ `'image/gif'`,‏ `'image/jpeg'` או `'image/png'`. במסמך Google Docs, הערך `'text/markdown'` תקף גם כן.

חזרה

‫Blob — הנתונים כ-blob.

`getBandings()`

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

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

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

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

חזרה

‫Banding[] — הדירוגים בגיליון האלקטרוני הזה.

אישור

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

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

`getBlob()`

הפונקציה מחזירה את הנתונים בתוך האובייקט הזה כ-blob.

חזרה

‫Blob — הנתונים כ-blob.

`getColumnWidth(columnPosition)`

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

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

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

פרמטרים

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

חזרה

‫Integer – רוחב העמודה בפיקסלים.

אישור

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

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

`getCurrentCell()`

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

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

חזרה

‫Range – התא הנוכחי.

אישור

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

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

`getDataRange()`

הפונקציה מחזירה Range שמתאים למאפיינים שבהם יש נתונים.

הפעולה הזו שוות ערך מבחינה פונקציונלית ליצירת טווח שמוגבל על ידי A1 ו-(Sheet.getLastColumn(), Sheet.getLastRow()).

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

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

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

חזרה

‫Range — טווח שמורכב מכל הנתונים בגיליון האלקטרוני.

אישור

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

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

`getDataSourceFormulas()`

מקבל את כל הנוסחאות של מקורות הנתונים.

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

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

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

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

חזרה

‫DataSourceFormula[] — רשימה של נוסחאות של מקורות נתונים.

אישור

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

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

`getDataSourcePivotTables()`

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

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

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

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

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

חזרה

‫DataSourcePivotTable[] – רשימה של טבלאות צירים של מקורות נתונים.

אישור

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

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

`getDataSourceRefreshSchedules()`

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

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

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

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

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

חזרה

‫DataSourceRefreshSchedule[] – לוחות הזמנים לרענון של הגיליון האלקטרוני הזה.

אישור

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

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

`getDataSourceSheets()`

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

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

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

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

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

חזרה

‫DataSourceSheet[] – מערך של כל הגיליונות של מקורות הנתונים.

אישור

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

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

`getDataSourceTables()`

מקבל את כל הטבלאות של מקורות הנתונים.

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

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

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

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

חזרה

‫DataSourceTable[] — רשימה של טבלאות של מקורות נתונים.

אישור

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

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

`getDataSources()`

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

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

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

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

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

חזרה

‫DataSource[] – מערך של כל מקורות הנתונים.

אישור

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

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

`getDeveloperMetadata()`

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

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

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

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

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

חזרה

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

אישור

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

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

`getEditors()`

מקבל את רשימת העורכים של Spreadsheet.

חזרה

‫User[] — מערך של משתמשים עם הרשאת עריכה.

אישור

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

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

`getFormUrl()`

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

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

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

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

חזרה

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

אישור

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

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

`getFrozenColumns()`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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()`

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

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

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

חזרה

‫Integer — מספר השורות שהוקפאו.

אישור

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

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

`getId()`

מחזירה מזהה ייחודי לגיליון האלקטרוני הזה. אפשר לחלץ את המזהה של הגיליון האלקטרוני מכתובת ה-URL שלו. לדוגמה, המזהה של הגיליון האלקטרוני בכתובת ה-URL‏ https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 הוא abc1234567.

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

חזרה

‫String — המזהה הייחודי (או המפתח) של הגיליון האלקטרוני.

`getImages()`

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

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

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

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

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

חזרה

‫OverGridImage[] – מערך של תמונות מעל הרשת.

אישור

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

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

`getIterativeCalculationConvergenceThreshold()`

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

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

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

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

חזרה

‫Number – סף ההתכנסות.

אישור

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

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

`getLastColumn()`

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

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

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

חזרה

‫Integer — העמודה האחרונה בגיליון שמכילה תוכן.

אישור

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

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

`getLastRow()`

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

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

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

חזרה

‫Integer — השורה האחרונה בגיליון שמכילה תוכן.

אישור

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

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

`getMaxIterativeCalculationCycles()`

הפונקציה מחזירה את המספר המקסימלי של איטרציות לשימוש במהלך חישוב איטרטיבי.

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

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

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

חזרה

‫Integer – המספר המקסימלי של איטרציות החישוב.

אישור

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

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

`getName()`

מחזירה את שם המסמך.

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

חזרה

‫String – שם הגיליון האלקטרוני.

אישור

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

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

`getNamedRanges()`

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

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

חזרה

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

אישור

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

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

`getNumSheets()`

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

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

חזרה

‫Integer — מספר הגיליונות בגיליון האלקטרוני.

`getOwner()`

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

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

חזרה

‫User – הבעלים של המסמך, או null אם המסמך נמצא באחסון שיתופי.

אישור

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

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

`getPredefinedSpreadsheetThemes()`

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

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

חזרה

‫SpreadsheetTheme[] — רשימה של עיצובים מוגדרים מראש.

אישור

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

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

`getProtections(type)`

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

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

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

פרמטרים

שם	סוג	תיאור
`type`	`ProtectionType`	סוג האזור המוגן, `SpreadsheetApp.ProtectionType.RANGE` או `SpreadsheetApp.ProtectionType.SHEET`.

חזרה

‫Protection[] — מערך של אובייקטים שמייצגים את כל הטווחים או הגיליונות המוגנים בגיליון האלקטרוני.

אישור

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

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

`getRange(a1Notation)`

הפונקציה מחזירה את הטווח כפי שצוין בשיטת הסימון A1 או בשיטת הסימון R1C1.

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

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

פרמטרים

שם	סוג	תיאור
`a1Notation`	`String`	הטווח שיוחזר, כפי שצוין בשיטת הסימון A1 או R1C1.

חזרה

‫Range — הטווח במיקום שצוין.

אישור

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

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

`getRangeByName(name)`

הפונקציה מחזירה טווח תאים עם שם, או null אם לא נמצא טווח עם השם שצוין. אם כמה גיליונות בגיליון האלקטרוני משתמשים באותו שם טווח, צריך לציין את שם הגיליון בלי גרשיים נוספים – לדוגמה, getRangeByName('TaxRates') או getRangeByName('Sheet Name!TaxRates'), אבל לא getRangeByName('"Sheet Name"!TaxRates').

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

פרמטרים

שם	סוג	תיאור
`name`	`String`	שם הטווח שרוצים לאחזר.

חזרה

‫Range — טווח התאים עם השם שצוין.

`getRangeList(a1Notations)`

הפונקציה מחזירה את האוסף RangeList שמייצג את הטווחים באותו גיליון שצוין על ידי רשימה לא ריקה של סימוני A1 או סימוני R1C1.

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

פרמטרים

שם	סוג	תיאור
`a1Notations`	`String[]`	רשימת הטווחים להחזרה, כפי שצוין בסימון A1 או בסימון R1C1.

חזרה

‫RangeList — רשימת הטווחים במיקום שצוין.

אישור

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

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

`getRecalculationInterval()`

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

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

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

חזרה

‫RecalculationInterval — מרווח החישובים של הגיליון האלקטרוני הזה.

אישור

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

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

`getRowHeight(rowPosition)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 בגיליון האלקטרוני.

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

חזרה

‫Selection – הבחירה הנוכחית.

אישור

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

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

`getSheetById(id)`

הפונקציה מחזירה את הגיליון עם המזהה הנתון. שימוש בכתובת Sheet.getSheetId().

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetById(12345);

פרמטרים

שם	סוג	תיאור
`id`	`Integer`	המזהה של הגיליון האלקטרוני שרוצים לקבל.

חזרה

‫Sheet – הגיליון עם המזהה שצוין או null אם לא נמצא גיליון.

`getSheetByName(name)`

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

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

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

פרמטרים

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

חזרה

‫Sheet – הגיליון עם השם שצוין.

`getSheetId()`

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

זהו מזהה של הגיליון שייחודי לגיליון האלקטרוני. המזהה הוא מספר שלם שגדל באופן מונוטוני, שמוקצה בזמן יצירת הגיליון ולא תלוי במיקום הגיליון. השימוש בפרמטר הזה שימושי בשילוב עם שיטות כמו Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd), שמקבלות פרמטר gridId ולא מופע Sheet.

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

Logger.log(sheet.getSheetId());

חזרה

‫Integer – מזהה של הגיליון שייחודי לגיליון האלקטרוני.

אישור

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

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

`getSheetName()`

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

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

Logger.log(sheet.getSheetName());

חזרה

‫String – שם הגיליון.

אישור

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

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

הפונקציה מחזירה את הרשת המלבנית של ערכים לטווח הזה, החל מהקואורדינטות שצוינו. ערך של ‎-1 שמוגדר כמיקום השורה או העמודה שווה לשורה או לעמודה האחרונות שמכילות נתונים בגיליון.

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

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

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

פרמטרים

שם	סוג	תיאור
`startRow`	`Integer`	המיקום של שורת ההתחלה.
`startColumn`	`Integer`	המיקום של עמודת ההתחלה.
`numRows`	`Integer`	מספר השורות שרוצים להחזיר עבורן ערכים.
`numColumns`	`Integer`	מספר העמודות שצריך להחזיר עבורן ערכים.

חזרה

‫Object[][] – מערך דו-ממדי של ערכים.

אישור

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

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

`getSheets()`

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

// The code below logs the name of the second sheet
const sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
// Iterates through the sheets and logs the name and ID of each sheet.
for (const sheet of sheets) {
  Logger.log(`name: ${sheet.getName()}, ID: ${sheet.getSheetId()}`);
}

חזרה

‫Sheet[] — מערך של כל הגיליונות בגיליון האלקטרוני.

`getSpreadsheetLocale()`

מחזירה את הלוקאל של הגיליון האלקטרוני.

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

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

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

חזרה

‫String — הלוקאל של הגיליון האלקטרוני.

אישור

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

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

`getSpreadsheetTheme()`

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

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

חזרה

‫SpreadsheetTheme – העיצוב הנוכחי שמוחל.

אישור

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

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

`getSpreadsheetTimeZone()`

מחזירה את אזור הזמן של הגיליון האלקטרוני.

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

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

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

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

חזרה

‫String – אזור הזמן, שצוין בפורמט 'ארוך' (לדוגמה, America/New_York, כמו שמופיע ב-Joda.org).

אישור

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

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

`getUrl()`

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

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

חזרה

‫String — כתובת ה-URL של הגיליון האלקטרוני הנתון.

אישור

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

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

`getViewers()`

מחזירה את רשימת הצופים והמגיבים של Spreadsheet.

חזרה

‫User[] — מערך של משתמשים עם הרשאת צפייה או תגובה.

אישור

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

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

`hideColumn(column)`

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

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

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

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

פרמטרים

שם	סוג	תיאור
`column`	`Range`	טווח העמודות להסתרה.

אישור

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

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

`hideRow(row)`

הפונקציה מסתירה את השורות בטווח הנתון.

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

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

פרמטרים

שם	סוג	תיאור
`row`	`Range`	טווח השורות להסתרה.

אישור

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

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

`insertColumnAfter(afterPosition)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

הפונקציה מוסיפה עמודה לפני המיקום של העמודה שצוין.

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

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

פרמטרים

שם	סוג	תיאור
`beforePosition`	`Integer`	העמודה שלפניה צריך להוסיף את העמודה החדשה.

חזרה

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

אישור

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

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

`insertColumnsAfter(afterPosition, howMany)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

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

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

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

פרמטרים

שם	סוג	תיאור
`beforePosition`	`Integer`	העמודה שלפניה צריך להוסיף את העמודה החדשה.
`howMany`	`Integer`	מספר העמודות להוספה.

חזרה

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

אישור

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

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

`insertDataSourceSheet(spec)`

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

מוחזרת חריגה אם הסוג של מקור הנתונים לא מופעל. כדי להפעיל הפעלות של נתונים בסוג מסוים של מקור נתונים, צריך להשתמש בשיטות SpreadsheetApp#enable...Execution().

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

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

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

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

פרמטרים

שם	סוג	תיאור
`spec`	`DataSourceSpec`	המפרט של מקור הנתונים שרוצים להוסיף.

חזרה

‫DataSourceSheet – הגיליון של מקור הנתונים החדש.

אישור

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

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

`insertImage(blobSource, column, row)`

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

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const 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)`

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

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const 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 שסיפקתם צריכה להיות נגישה לכולם.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 שסיפקתם צריכה להיות נגישה לכולם.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

הפונקציה מוסיפה שורה אחרי מיקום השורה שצוין.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

מוסיף שורה לפני מיקום השורה שצוין.

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

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

פרמטרים

שם	סוג	תיאור
`beforePosition`	`Integer`	השורה שלפניה צריך להוסיף את השורה החדשה.

חזרה

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

אישור

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

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

`insertRowsAfter(afterPosition, howMany)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

מוסיפה מספר שורות לפני מיקום השורה הנתון.

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

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

פרמטרים

שם	סוג	תיאור
`beforePosition`	`Integer`	השורה שלפניה צריך להוסיף את השורות החדשות.
`howMany`	`Integer`	מספר השורות להוספה.

חזרה

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

אישור

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

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

`insertSheet()`

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

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

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`insertSheet(sheetIndex)`

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

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

פרמטרים

שם	סוג	תיאור
`sheetIndex`	`Integer`	האינדקס של הגיליון שנוצר. כדי להוסיף גיליון כגיליון הראשון בגיליון האלקטרוני, מגדירים את הערך שלו ל-0.

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`insertSheet(sheetIndex, options)`

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

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

פרמטרים

שם	סוג	תיאור
`sheetIndex`	`Integer`	האינדקס של הגיליון שנוצר. כדי להוסיף גיליון כגיליון הראשון בגיליון האלקטרוני, מגדירים את הערך שלו ל-0.
`options`	`Object`	ארגומנטים מתקדמים אופציונליים של JavaScript.

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

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

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`insertSheet(options)`

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

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

פרמטרים

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

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

שם	סוג	תיאור
`template`	`Sheet`	כל הנתונים מאובייקט הגיליון של התבנית מועתקים לגיליון החדש. תבנית הגיליון חייבת להיות אחת מהגיליונות של אובייקט הגיליון האלקטרוני הזה.

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`insertSheet(sheetName)`

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

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

פרמטרים

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

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`insertSheet(sheetName, sheetIndex)`

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

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

פרמטרים

שם	סוג	תיאור
`sheetName`	`String`	השם של הגיליון החדש.
`sheetIndex`	`Integer`	האינדקס של הגיליון שנוצר. כדי להוסיף גיליון כגיליון הראשון בגיליון האלקטרוני, מגדירים את הערך שלו ל-0.

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`insertSheet(sheetName, sheetIndex, options)`

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

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

פרמטרים

שם	סוג	תיאור
`sheetName`	`String`	השם של הגיליון החדש.
`sheetIndex`	`Integer`	האינדקס של הגיליון החדש שנוסף. כדי להוסיף גיליון כגיליון הראשון בגיליון אלקטרוני, מגדירים את הערך שלו ל-0.
`options`	`Object`	ארגומנטים מתקדמים אופציונליים של JavaScript.

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

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

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`insertSheet(sheetName, options)`

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

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

פרמטרים

שם	סוג	תיאור
`sheetName`	`String`	השם של הגיליון החדש.
`options`	`Object`	ארגומנטים מתקדמים אופציונליים של JavaScript.

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

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

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`insertSheetWithDataSourceTable(spec)`

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

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

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

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

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

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

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

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

פרמטרים

שם	סוג	תיאור
`spec`	`DataSourceSpec`	המפרט של מקור הנתונים שרוצים להוסיף.

חזרה

‫Sheet — הגיליון החדש.

אישור

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

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

`isColumnHiddenByUser(columnPosition)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

`isIterativeCalculationEnabled()`

הפונקציה מחזירה את הערך TRUE אם החישוב האיטרטיבי מופעל בגיליון האלקטרוני הזה, ואת הערך FALSE אם הוא לא מופעל.

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

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

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

חזרה

‫Boolean – true אם החישוב האיטרטיבי מופעל, false אחרת.

אישור

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

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

`isRowHiddenByFilter(rowPosition)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

`moveActiveSheet(pos)`

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

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

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

spreadsheet.moveActiveSheet(2);

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

פרמטרים

שם	סוג	תיאור
`pos`	`Integer`	המיקום באינדקס (החל מ-1) שאליו רוצים להעביר את הגיליון הפעיל ברשימת הגיליונות.

אישור

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

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

`moveChartToObjectSheet(chart)`

יוצר גיליון SheetType.OBJECT חדש ומעביר אליו את התרשים שצוין. אם התרשים כבר נמצא בגיליון משלו, הגיליון הזה יוחזר בלי ליצור גיליון חדש.

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

פרמטרים

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

חזרה

‫Sheet — הגיליון שבו נמצא התרשים.

אישור

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

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

`refreshAllDataSources()`

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

כדי להפעיל הפעלות של נתונים בסוג מסוים של מקור נתונים, צריך להשתמש בשיטות SpreadsheetApp#enable...Execution().

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

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

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

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

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

אישור

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

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

`removeEditor(emailAddress)`

מסיר את המשתמש שצוין מרשימת בעלי הרשאת העריכה של Spreadsheet. השיטה הזו לא חוסמת את הגישה של משתמשים אל Spreadsheet אם הם שייכים לסוג משתמשים שיש להם גישה כללית – לדוגמה, אם Spreadsheet משותף עם כל הדומיין של המשתמש, או אם Spreadsheet נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

שם	סוג	תיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שרוצים להסיר.

חזרה

‫Spreadsheet — ‏Spreadsheet, לשרשור.

אישור

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

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

`removeEditor(user)`

בקבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת הצופים.

פרמטרים

שם	סוג	תיאור
`user`	`User`	ייצוג של המשתמש שרוצים להסיר.

חזרה

‫Spreadsheet — ‏Spreadsheet, לשרשור.

אישור

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

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

`removeMenu(name)`

הסרה של תפריט שנוסף על ידי addMenu(name, subMenus). הערך של הארגומנט name צריך להיות זהה לערך של הקריאה המתאימה ל-addMenu(name, subMenus).

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

פרמטרים

שם	סוג	תיאור
`name`	`String`	שם התפריט שרוצים להסיר.

אישור

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

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

`removeNamedRange(name)`

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

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

פרמטרים

שם	סוג	תיאור
`name`	`String`	שם הטווח.

אישור

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

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

`removeViewer(emailAddress)`

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

במקרה של קבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת העורכים.

פרמטרים

שם	סוג	תיאור
`emailAddress`	`String`	כתובת האימייל של המשתמש שרוצים להסיר.

חזרה

‫Spreadsheet — This Spreadsheet for chaining.

אישור

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

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

`removeViewer(user)`

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

במקרה של קבצים ב-Drive, הפעולה הזו מסירה את המשתמש גם מרשימת העורכים.

פרמטרים

שם	סוג	תיאור
`user`	`User`	ייצוג של המשתמש שרוצים להסיר.

חזרה

‫Spreadsheet — This Spreadsheet for chaining.

אישור

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

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

`rename(newName)`

משנה את שם המסמך.

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename('This is the new name');

פרמטרים

שם	סוג	תיאור
`newName`	`String`	השם החדש של המסמך.

אישור

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

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

`renameActiveSheet(newName)`

משנה את השם של הגיליון הפעיל הנוכחי לשם החדש שצוין.

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

פרמטרים

שם	סוג	תיאור
`newName`	`String`	השם החדש של הגיליון הפעיל הנוכחי.

אישור

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

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

`resetSpreadsheetTheme()`

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

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

חזרה

‫SpreadsheetTheme – עיצוב ברירת המחדל.

אישור

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

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

`setActiveRange(range)`

מגדירה את הטווח שצוין כ-active range בגיליון הפעיל, כשהתא הימני העליון בטווח הוא current cell.

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

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D4
const 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.

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`setActiveSelection(range)`

מגדיר את אזור הבחירה הפעיל בגיליון הזה.

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

const 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.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

`setActiveSheet(sheet)`

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

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

פרמטרים

שם	סוג	תיאור
`sheet`	`Sheet`	הגיליון שרוצים להגדיר כגיליון הפעיל.

חזרה

‫Sheet – הגיליון הפעיל.

אישור

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

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

`setActiveSheet(sheet, restoreSelection)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`setColumnWidth(columnPosition, width)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

`setCurrentCell(cell)`

הגדרת התא שצוין כcurrent cell.

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

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

הערה: הערך של Range חייב להיות תא אחד, אחרת תתקבל חריגה.

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

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

פרמטרים

שם	סוג	תיאור
`cell`	`Range`	התא שרוצים להגדיר כתא הנוכחי.

חזרה

‫Range – התא הנוכחי החדש שהוגדר.

אישור

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

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

`setFrozenColumns(columns)`

מקפיאה את מספר העמודות שצוין. אם הערך הוא אפס, לא יוקפאו עמודות.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

מקפיאה את מספר השורות שצוין. אם הערך הוא אפס, לא יוקפאו שורות.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

`setIterativeCalculationConvergenceThreshold(minThreshold)`

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

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

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

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

פרמטרים

שם	סוג	תיאור
`minThreshold`	`Number`	סף ההתכנסות המינימלי (חייב להיות לא שלילי).

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`setIterativeCalculationEnabled(isEnabled)`

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

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

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

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

פרמטרים

שם	סוג	תיאור
`isEnabled`	`Boolean`	‫`true` אם צריך להפעיל חישוב איטרטיבי; `false` אחרת.

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`setMaxIterativeCalculationCycles(maxIterations)`

הגדרה של מספר החזרות המקסימלי של החישוב שצריך לבצע במהלך חישוב איטרטיבי. הערך צריך להיות בין 1 ל-10,000 (כולל), וערך ברירת המחדל הוא 50.

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

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

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

פרמטרים

שם	סוג	תיאור
`maxIterations`	`Integer`	מספר החזרות המקסימלי של החישוב (בין 1 ל-10,000).

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`setNamedRange(name, range)`

נותן שם לטווח.

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

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם שרוצים לתת לטווח.
`range`	`Range`	מפרט הטווח.

אישור

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

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

`setRecalculationInterval(recalculationInterval)`

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

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

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(
    SpreadsheetApp.RecalculationInterval.ON_CHANGE,
);

// Logs the calculation interval to the console.
console.log(interval);

פרמטרים

שם	סוג	תיאור
`recalculationInterval`	`RecalculationInterval`	מרווח החישוב מחדש החדש.

חזרה

‫Spreadsheet — הגיליון האלקטרוני הזה, לשרשור.

אישור

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

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

`setRowHeight(rowPosition, height)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

`setSpreadsheetLocale(locale)`

הגדרת הלוקאל של הגיליון האלקטרוני.

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

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

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

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

פרמטרים

שם	סוג	תיאור
`locale`	`String`	קוד הלוקאל לשימוש (לדוגמה, 'en', ‏'fr' או 'en_US').

אישור

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

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

`setSpreadsheetTheme(theme)`

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the
// spreadsheet.
const predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

פרמטרים

שם	סוג	תיאור
`theme`	`SpreadsheetTheme`	העיצוב להחלה.

חזרה

‫SpreadsheetTheme — העיצוב הנוכחי החדש.

אישור

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

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

`setSpreadsheetTimeZone(timezone)`

הגדרת אזור הזמן של הגיליון האלקטרוני.

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

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

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

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

פרמטרים

שם	סוג	תיאור
`timezone`	`String`	אזור הזמן, שצוין בפורמט 'long' (לדוגמה, America/New_York, כמו שמופיע ב-Joda.org).

אישור

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

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

`show(userInterface)`

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

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

קטע הקוד הבא מציג אפליקציית HtmlService פשוטה בתיבת דו-שיח עם הכותרת, הגובה והרוחב שצוינו:

const htmlApp = HtmlService
                    .createHtmlOutput(
                        '<p>A change of speed, a change of style...</p>',
                        )
                    .setTitle('My HtmlService Application')
                    .setWidth(250)
                    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

פרמטרים

שם	סוג	תיאור
`userInterface`	`Object`	`HtmlOutput`.

אישור

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

https://www.googleapis.com/auth/script.container.ui

`sort(columnPosition)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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

`toast(msg)`

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

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

פרמטרים

שם	סוג	תיאור
`msg`	`String`	ההודעה שתוצג בהודעה הקופצת.

אישור

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

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

`toast(msg, title)`

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

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

פרמטרים

שם	סוג	תיאור
`msg`	`String`	ההודעה שתוצג בהודעה הקופצת.
`title`	`String`	הכותרת האופציונלית של ההודעה הקופצת.

אישור

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

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

`toast(msg, title, timeoutSeconds)`

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

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

פרמטרים

שם	סוג	תיאור
`msg`	`String`	ההודעה שתוצג בהודעה הקופצת.
`title`	`String`	הכותרת האופציונלית של ההודעה הקופצת.
`timeoutSeconds`	`Number`	זמן ההמתנה בשניות. אם הערך הוא `null`, ההודעה הקופצת נשארת למשך 5 שניות כברירת מחדל. אם הערך שלילי, ההודעה הקופצת נשארת עד שמסלקים אותה.

אישור

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

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

`unhideColumn(column)`

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

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

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

פרמטרים

שם	סוג	תיאור
`column`	`Range`	הטווח לביטול ההסתרה, אם הוא מוסתר.

אישור

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

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

`unhideRow(row)`

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

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

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

פרמטרים

שם	סוג	תיאור
`row`	`Range`	הטווח לביטול ההסתרה, אם הוא מוסתר.

אישור

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

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

`updateMenu(name, subMenus)`

עדכון של תפריט שנוסף על ידי addMenu(name, subMenus). פועל בדיוק כמו addMenu(name, subMenus).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const menuEntries = [];
menuEntries.push({name: 'Lone Menu Entry', functionName: 'function1'});
ss.updateMenu('addMenuExample', menuEntries);

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של התפריט לעדכון.
`subMenus`	`Object[]`	מערך של מפות JavaScript עם הפרמטרים `name` ו-`functionName`. אפשר להשתמש בפונקציות מספריות כלולות, כמו `Library.libFunction1`.

אישור

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

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

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

פרמטרים

שם	סוג	תיאור
`timeoutInSeconds`	`Integer`	זמן ההמתנה להפעלת הנתונים, בשניות. הערך המקסימלי הוא 300 שניות.

אישור

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

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

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

`getSheetProtection()`

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

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

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

const 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.
const users = permissions.getUsers();
Logger.log(users);

חזרה

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

אישור

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

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

`isAnonymousView()`

הוצא משימוש. החל מינואר 2014, הפונקציה הזו הוצאה משימוש ולא זמינה בגרסה החדשה של Google Sheets.

מציין אם המסמך מאפשר צפייה אנונימית. הפונקציה הזו לא נתמכת יותר בגרסה החדשה של Google Sheets, ולכן צריך להשתמש במקומה בפונקציות File.getSharingAccess() ו-File.getSharingPermission().

// Determine if the document allows anonymous viewing via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());
const access = file.getSharingAccess();
const permission = file.getSharingPermission();
const isAnonymousAccess = access === DriveApp.Access.ANYONE ||
    access === DriveApp.Access.ANYONE_WITH_LINK;
const isAnonymousEdit =
    isAnonymousAccess && permission !== DriveApp.Permission.NONE;

חזרה

‫Boolean — true אם המסמך מאפשר צפייה אנונימית, false אחרת.

אישור

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

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

ראה גם

שירות Drive

`isAnonymousWrite()`

הוצא משימוש. החל מינואר 2014, הפונקציה הזו הוצאה משימוש ולא זמינה בגרסה החדשה של Google Sheets.

מציין אם במסמך מותרות עריכות של משתמשים אנונימיים. הפונקציה הזו לא נתמכת יותר בגרסה החדשה של Google Sheets, לכן צריך להשתמש במקומה בפונקציות File.getSharingAccess() ו-File.getSharingPermission().

// Determine if the document allow anonymous edits via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());
const access = file.getSharingAccess();
const permission = file.getSharingPermission();
const isAnonymousAccess = access === DriveApp.Access.ANYONE ||
    access === DriveApp.Access.ANYONE_WITH_LINK;
const isAnonymousEdit =
    isAnonymousAccess && permission === DriveApp.Permission.EDIT;

חזרה

‫Boolean — true אם המסמך מאפשר עריכה אנונימית, false אחרת.

אישור

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

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

ראה גם

שירות Drive

`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`

הוצא משימוש. החל מינואר 2014, הפונקציה הזו הוצאה משימוש ולא זמינה בגרסה החדשה של Google Sheets.

הגדרת המדיניות של המסמך לגבי קריאה וכתיבה אנונימיות. התכונה הזו לא נתמכת יותר בגרסה החדשה של Google Sheets, ולכן אפשר להשתמש ב-File.setSharing(accessType, permissionType) כחלופה.

// Set the document's policy on anonymous reading and writing via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApp.Access.PRIVATE, file.getSharingPermission());

פרמטרים

שם	סוג	תיאור
`anonymousReadAllowed`	`Boolean`	‫`true` כדי לאפשר קריאה אנונימית; `false` אחרת.
`anonymousWriteAllowed`	`Boolean`	‫`true` כדי לאפשר קריאה אנונימית; `false` אחרת.

אישור

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

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

ראה גם

isAnonymousView()
isAnonymousWrite()
שירות Drive

`setSheetProtection(permissions)`

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

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

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

const permissions = sheet.getSheetProtection();

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

פרמטרים

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

אישור

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

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

Class Spreadsheet קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

Methods

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

תיעוד מפורט

addDeveloperMetadata(key)

פרמטרים

חזרה

אישור

addDeveloperMetadata(key, visibility)

פרמטרים

חזרה

אישור

addDeveloperMetadata(key, value)

פרמטרים

חזרה

אישור

addDeveloperMetadata(key, value, visibility)

פרמטרים

חזרה

אישור

addEditor(emailAddress)

פרמטרים

חזרה

אישור

addEditor(user)

פרמטרים

חזרה

אישור

addEditors(emailAddresses)

פרמטרים

חזרה

אישור

addMenu(name, subMenus)

פרמטרים

אישור

addViewer(emailAddress)

פרמטרים

חזרה

אישור

addViewer(user)

פרמטרים

חזרה

אישור

addViewers(emailAddresses)

פרמטרים

חזרה

אישור

appendRow(rowContents)

פרמטרים

חזרה

אישור

autoResizeColumn(columnPosition)

פרמטרים

חזרה

אישור

copy(name)

פרמטרים

חזרה

אישור

createDeveloperMetadataFinder()

חזרה

createTextFinder(findText)

פרמטרים

חזרה

deleteActiveSheet()

חזרה

אישור

deleteColumn(columnPosition)

פרמטרים

חזרה

אישור

deleteColumns(columnPosition, howMany)

פרמטרים

אישור

deleteRow(rowPosition)

פרמטרים

חזרה

אישור

deleteRows(rowPosition, howMany)

פרמטרים

Class Spreadsheet

`addDeveloperMetadata(key)`

`addDeveloperMetadata(key, visibility)`

`addDeveloperMetadata(key, value)`

`addDeveloperMetadata(key, value, visibility)`

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addMenu(name, subMenus)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`appendRow(rowContents)`

`autoResizeColumn(columnPosition)`

`copy(name)`

`createDeveloperMetadataFinder()`

`createTextFinder(findText)`

`deleteActiveSheet()`

`deleteColumn(columnPosition)`

`deleteColumns(columnPosition, howMany)`

`deleteRow(rowPosition)`

`deleteRows(rowPosition, howMany)`

`deleteSheet(sheet)`

`duplicateActiveSheet()`

`getActiveCell()`

`getActiveRange()`

`getActiveRangeList()`

`getActiveSheet()`

`getAs(contentType)`

`getBandings()`

`getBlob()`

`getColumnWidth(columnPosition)`

`getCurrentCell()`

`getDataRange()`

`getDataSourceFormulas()`

`getDataSourcePivotTables()`

`getDataSourceRefreshSchedules()`

`getDataSourceSheets()`

`getDataSourceTables()`

`getDataSources()`

`getDeveloperMetadata()`

`getEditors()`

`getFormUrl()`

`getFrozenColumns()`

`getFrozenRows()`