דף זה תורגם על ידי 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` בגיליון האלקטרוני.
`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`	הפונקציה מחזירה את הערך TRUE אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת מסנן).
`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() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

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

פרמטרים

שם	סוג	תיאור
`name`	`String`	השם של התפריט שייווצר.
`subMenus`	`Object[]`	מערך של מפות 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)`

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

פרמטרים

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

חזרה

Spreadsheet — השדה Spreadsheet, לצורך קישור.

אישור

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

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

`addViewers(emailAddresses)`

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

פרמטרים

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

חזרה

Spreadsheet — השדה Spreadsheet, לצורך קישור.

אישור

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

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

`appendRow(rowContents)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`autoResizeColumn(columnPosition)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`copy(name)`

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`createDeveloperMetadataFinder()`

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

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

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

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

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

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

חזרה

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

`createTextFinder(findText)`

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

פרמטרים

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

חזרה

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

`deleteActiveSheet()`

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

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

חזרה

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

אישור

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

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

`deleteColumn(columnPosition)`

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`deleteColumns(columnPosition, howMany)`

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

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

פרמטרים

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

אישור

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

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

`deleteRow(rowPosition)`

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

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

פרמטרים

שם	סוג	תיאור
`rowPosition`	`Integer`	המיקום של השורה, החל מ-1 בשורה הראשונה.

חזרה

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

אישור

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

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

`deleteRows(rowPosition, howMany)`

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

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

פרמטרים

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

אישור

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

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

`deleteSheet(sheet)`

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

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

פרמטרים

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

אישור

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

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

`duplicateActiveSheet()`

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

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

חזרה

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

אישור

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

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

`getActiveCell()`

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

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

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

חזרה

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

אישור

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

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

`getActiveRange()`

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

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

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

חזרה

Range – הטווח הפעיל

אישור

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

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

ראה גם

setActiveRange(range)

`getActiveRangeList()`

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

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

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

חזרה

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

אישור

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

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

ראה גם

setActiveRangeList(rangeList)

`getActiveSheet()`

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

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`getCurrentCell()`

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

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

חזרה

Range – התא הנוכחי

אישור

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

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

`getDataRange()`

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

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

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

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

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

חזרה

Range – טווח שכולל את כל הנתונים בגיליון האלקטרוני

אישור

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

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

`getDataSourceFormulas()`

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

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

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

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

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

חזרה

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

אישור

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

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

`getDataSourcePivotTables()`

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

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

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

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

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

חזרה

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

אישור

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

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

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

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

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

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

חזרה

Integer – מספר העמודות הקפואות

אישור

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

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

`getFrozenRows()`

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

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

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

חזרה

Integer – מספר השורות שהוקפאו

אישור

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

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

`getId()`

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

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

חזרה

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

`getImages()`

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

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

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

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

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

חזרה

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

אישור

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

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

`getIterativeCalculationConvergenceThreshold()`

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

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

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

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

חזרה

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

אישור

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

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

`getLastColumn()`

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

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

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

חזרה

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

אישור

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

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

`getLastRow()`

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

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

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

חזרה

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

אישור

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

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

`getMaxIterativeCalculationCycles()`

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

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

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

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

חזרה

Integer – המספר המקסימלי של חזרות החישוב.

אישור

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

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

`getName()`

הפונקציה מקבלת את שם המסמך.

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

חזרה

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

אישור

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

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

`getNamedRanges()`

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

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

חזרה

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

אישור

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

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

`getNumSheets()`

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

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

חזרה

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

`getOwner()`

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

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

חזרה

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

אישור

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

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

`getPredefinedSpreadsheetThemes()`

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

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

חזרה

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

אישור

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

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

`getProtections(type)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`getRange(a1Notation)`

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

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

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

פרמטרים

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

חזרה

Range – הטווח במיקום שצוין

אישור

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

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

`getRangeByName(name)`

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

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

פרמטרים

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

חזרה

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

`getRangeList(a1Notations)`

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

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

פרמטרים

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

חזרה

RangeList – רשימת הטווחים במיקום שצוין

אישור

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

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

`getRecalculationInterval()`

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

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

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

חזרה

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

אישור

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

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

`getRowHeight(rowPosition)`

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

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

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

פרמטרים

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

חזרה

Integer – גובה השורה בפיקסלים

אישור

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

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

`getSelection()`

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

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

חזרה

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

אישור

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

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

`getSheetByName(name)`

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

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

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

פרמטרים

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

חזרה

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

`getSheetId()`

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

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

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

Logger.log(sheet.getSheetId());

חזרה

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

אישור

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

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

`getSheetName()`

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

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

Logger.log(sheet.getSheetName());

חזרה

String – שם הגיליון

אישור

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

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

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`getSheets()`

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

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

חזרה

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

`getSpreadsheetLocale()`

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

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

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

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

חזרה

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

אישור

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

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

`getSpreadsheetTheme()`

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

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

חזרה

SpreadsheetTheme — העיצוב שהוחל כרגע.

אישור

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

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

`getSpreadsheetTimeZone()`

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

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

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

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

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

חזרה

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

אישור

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

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

`getUrl()`

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

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

חזרה

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

אישור

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

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

`getViewers()`

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

חזרה

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

אישור

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

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

`hideColumn(column)`

הסתרת העמודה או העמודות בטווח הנתון.

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

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

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

פרמטרים

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

אישור

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

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

`hideRow(row)`

הסתרת השורות בטווח שצוין.

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

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

פרמטרים

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

אישור

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

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

`insertColumnAfter(afterPosition)`

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

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

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

פרמטרים

שם	סוג	תיאור
`afterPosition`	`Integer`	העמודה שאחרי שהעמודה החדשה צריכה להתווסף.

חזרה

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

אישור

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

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

`insertColumnBefore(beforePosition)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertColumnsAfter(afterPosition, howMany)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertColumnsBefore(beforePosition, howMany)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertDataSourceSheet(spec)`

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

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertImage(blobSource, column, row)`

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

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

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

פרמטרים

שם	סוג	תיאור
`blobSource`	`BlobSource`	ה-blob שמכיל את תוכן התמונה, סוג ה-MIME והשם (אופציונלי).
`column`	`Integer`	מיקום העמודה.
`row`	`Integer`	מיקום השורה.

חזרה

OverGridImage — התמונה שהוכנסה.

אישור

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

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

`insertImage(blobSource, column, row, offsetX, offsetY)`

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

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

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

פרמטרים

שם	סוג	תיאור
`blobSource`	`BlobSource`	ה-blob שמכיל את תוכן התמונה, סוג ה-MIME והשם (אופציונלי).
`column`	`Integer`	מיקום העמודה.
`row`	`Integer`	מיקום השורה.
`offsetX`	`Integer`	הסטייה האופקית מפינה של תא, בפיקסלים.
`offsetY`	`Integer`	הסטייה האנכית מפינה של התא, בפיקסלים.

חזרה

OverGridImage — התמונה שהוכנסה.

אישור

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

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

`insertImage(url, column, row)`

הוספת תמונה למסמך בשורה ובעמודה נתונות.

כתובת ה-URL שצוינה צריכה להיות נגישה לכולם.

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

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

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת האתר של התמונה.
`column`	`Integer`	המיקום של העמודה ברשת.
`row`	`Integer`	המיקום של שורת התצוגה.

חזרה

OverGridImage — התמונה שהוכנסה.

אישור

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

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

`insertImage(url, column, row, offsetX, offsetY)`

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

כתובת ה-URL שצוינה צריכה להיות נגישה לכולם.

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

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

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL של התמונה.
`column`	`Integer`	מיקום העמודה.
`row`	`Integer`	מיקום השורה.
`offsetX`	`Integer`	הסטייה האופקית מפינה של תא, בפיקסלים.
`offsetY`	`Integer`	הסטייה האנכית מפינה של התא, בפיקסלים.

חזרה

OverGridImage — התמונה שהוכנסה.

אישור

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

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

`insertRowAfter(afterPosition)`

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

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

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

פרמטרים

שם	סוג	תיאור
`afterPosition`	`Integer`	השורה שאחרי שרוצים להוסיף את השורה החדשה.

חזרה

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

אישור

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

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

`insertRowBefore(beforePosition)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertRowsAfter(afterPosition, howMany)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertRowsBefore(beforePosition, howMany)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertSheet()`

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

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

חזרה

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

אישור

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

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

`insertSheet(sheetIndex)`

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertSheet(sheetIndex, options)`

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

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

פרמטרים

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

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

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

חזרה

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

אישור

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

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

`insertSheet(options)`

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

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

פרמטרים

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

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

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

חזרה

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

אישור

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

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

`insertSheet(sheetName)`

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertSheet(sheetName, sheetIndex)`

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`insertSheet(sheetName, sheetIndex, options)`

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

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

פרמטרים

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

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

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

חזרה

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

אישור

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

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

`insertSheet(sheetName, options)`

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

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

פרמטרים

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`isRowHiddenByUser(rowPosition)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`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.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

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

spreadsheet.moveActiveSheet(2);

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

פרמטרים

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

אישור

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

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

`moveChartToObjectSheet(chart)`

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

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

פרמטרים

שם	סוג	תיאור
`chart`	`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() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

פרמטרים

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

אישור

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

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

`removeNamedRange(name)`

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

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

פרמטרים

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

אישור

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

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

`removeViewer(emailAddress)`

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

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

פרמטרים

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

חזרה

Spreadsheet — Spreadsheet לשרשור.

אישור

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

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

`removeViewer(user)`

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

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

פרמטרים

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

חזרה

Spreadsheet — Spreadsheet לשרשור.

אישור

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

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

`rename(newName)`

שינוי שם המסמך.

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

פרמטרים

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

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

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

פרמטרים

שם	סוג	תיאור
`range`	`Range`	הטווח שרוצים להגדיר כטווח הפעיל.

חזרה

Range – הטווח הפעיל החדש

אישור

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

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

`setActiveRangeList(rangeList)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`setActiveSelection(range)`

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

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

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

פרמטרים

שם	סוג	תיאור
`range`	`Range`	הטווח להגדרה כבחירה הפעילה.

חזרה

Range – הטווח הפעיל החדש

אישור

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

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

`setActiveSelection(a1Notation)`

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

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

sheet.setActiveSelection("A1:D4");

פרמטרים

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

חזרה

Range – הטווח הפעיל החדש

אישור

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

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

`setActiveSheet(sheet)`

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

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

פרמטרים

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

חזרה

Sheet — הגיליון הפעיל.

אישור

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

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

`setActiveSheet(sheet, restoreSelection)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`setColumnWidth(columnPosition, width)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`setCurrentCell(cell)`

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

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`setFrozenColumns(columns)`

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

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

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

פרמטרים

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

אישור

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

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

`setFrozenRows(rows)`

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

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

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

פרמטרים

שם	סוג	תיאור
`rows`	`Integer`	מספר השורות שרוצים להקפיא.

אישור

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

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

`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
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

פרמטרים

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

אישור

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

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

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

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

פרמטרים

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

חזרה

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

אישור

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

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

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

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

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

פרמטרים

שם	סוג	תיאור
`theme`	`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`	אזור הזמן, שמצוין בפורמט 'ארוך' (לדוגמה, 'America/New_York', כפי שמופיע ב-Joda.org).

אישור

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

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

`show(userInterface)`

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

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

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

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

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

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

פרמטרים

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

אישור

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

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

`sort(columnPosition)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`sort(columnPosition, ascending)`

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`toast(msg)`

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

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

פרמטרים

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

אישור

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

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`	ההודעה שתוצג בהודעת ה-Toast.
`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`	ההודעה שתוצג בהודעת ה-Toast.
`title`	`String`	הכותרת האופציונלית של ההודעה הקופצת.
`timeoutSeconds`	`Number`	זמן הקצאת הזמן לתפוגה בשניות. אם הערך הוא `null`, ברירת המחדל של זמן הקצאת הזמן לתפוגה היא 5 שניות. אם הערך הוא שלילי, ההודעה תישאר עד שהמשתמש יסיר אותה.

אישור

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

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

`unhideColumn(column)`

הסרת ההסתרה של העמודה בטווח הנתון.

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

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

פרמטרים

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

אישור

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

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

`unhideRow(row)`

הסרת ההסתרה של השורה בטווח הנתון.

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

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

פרמטרים

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

אישור

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

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

`updateMenu(name, subMenus)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 שמתאר את ההרשאות בגיליון הנוכחי.

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

var permissions = sheet.getSheetProtection();

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

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

חזרה

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

אישור

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

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

`isAnonymousView()`

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

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

// Determine if the document allows anonymous viewing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApi.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

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

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

var permissions = sheet.getSheetProtection();

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

פרמטרים

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

אישור

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

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