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

Class Spreadsheet

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

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
`addDeveloperMetadata(key)`	`Spreadsheet`	הוספת מטא-נתונים של מפתחים עם המפתח שצוין לגיליון האלקטרוני ברמה העליונה.
`addDeveloperMetadata(key, visibility)`	`Spreadsheet`	הוספת מטא-נתונים של המפתח עם המפתח והרשאות הגישה שצוינו לגיליון האלקטרוני.
`addDeveloperMetadata(key, value)`	`Spreadsheet`	הוספת מטא-נתונים של מפתחים עם המפתח והערך שצוינו לגיליון האלקטרוני.
`addDeveloperMetadata(key, value, visibility)`	`Spreadsheet`	הוספת מטא-נתונים של המפתח עם המפתח, הערך וסטטוס החשיפה שצוינו לגיליון האלקטרוני.
`addEditor(emailAddress)`	`Spreadsheet`	הוספה של המשתמש הנתון לרשימת העורכים של `Spreadsheet`.
`addEditor(user)`	`Spreadsheet`	הוספה של המשתמש הנתון לרשימת העורכים של `Spreadsheet`.
`addEditors(emailAddresses)`	`Spreadsheet`	הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת העורכים של `Spreadsheet`.
`addMenu(name, subMenus)`	`void`	יצירת תפריט חדש בממשק המשתמש של הגיליון האלקטרוני.
`addViewer(emailAddress)`	`Spreadsheet`	הוספה של המשתמש הנתון לרשימת הצופים ב-`Spreadsheet`.
`addViewer(user)`	`Spreadsheet`	הוספה של המשתמש הנתון לרשימת הצופים ב-`Spreadsheet`.
`addViewers(emailAddresses)`	`Spreadsheet`	הפונקציה מוסיפה את מערך המשתמשים הנתון לרשימת הצופים של `Spreadsheet`.
`appendRow(rowContents)`	`Sheet`	הפונקציה מוסיפה שורה לתחתית של אזור הנתונים הנוכחי בגיליון.
`autoResizeColumn(columnPosition)`	`Sheet`	מגדיר את הרוחב של עמודה נתונה כך שיתאים לתוכן שלה.
`copy(name)`	`Spreadsheet`	מעתיק את הגיליון האלקטרוני ומחזיר את הגיליון החדש.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	הפונקציה מחזירה את הערך `DeveloperMetadataFinder` עבור מציאת מטא-נתונים של מפתח במסגרת הגיליון האלקטרוני הזה.
`createTextFinder(findText)`	`TextFinder`	יוצר כלי לחיפוש טקסט עבור הגיליון האלקטרוני, שיכול לשמש לחיפוש והחלפה של טקסט בתוך הגיליון האלקטרוני בגיליון האלקטרוני.
`deleteActiveSheet()`	`Sheet`	מחיקת הגיליון הפעיל הנוכחי.
`deleteColumn(columnPosition)`	`Sheet`	מוחק את העמודה במיקום הנתון של העמודה.
`deleteColumns(columnPosition, howMany)`	`void`	הפונקציה מוחקת מספר עמודות החל מהמיקום של העמודה הנתון.
`deleteRow(rowPosition)`	`Sheet`	מחיקת השורה במיקום הנתון של השורה.
`deleteRows(rowPosition, howMany)`	`void`	הפונקציה מוחקת מספר שורות החל מהמיקום הנתון של השורה.
`deleteSheet(sheet)`	`void`	מחיקת הגיליון שצוין.
`duplicateActiveSheet()`	`Sheet`	משכפל את הגיליון הפעיל והופך אותו לגיליון פעיל.
`getActiveCell()`	`Range`	מחזירה את התא הפעיל בגיליון.
`getActiveRange()`	`Range`	הפונקציה מחזירה את הטווח שנבחר בגיליון הפעיל, או `null` אם אין טווח פעיל.
`getActiveRangeList()`	`RangeList`	פונקציה זו מחזירה את רשימת הטווחים הפעילים בגיליון הפעיל או `null` אם אין פעילות פעילה טווחים.
`getActiveSheet()`	`Sheet`	מקבל את הגיליון הפעיל בגיליון אלקטרוני.
`getAs(contentType)`	`Blob`	החזרת הנתונים שבתוך האובייקט הזה כ-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`	הפונקציה מחזירה אם החישוב החוזר מופעל בגיליון האלקטרוני הזה.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	הפונקציה מחזירה אם השורה הנתונה מוסתרת על ידי מסנן (לא תצוגת סינון).
`isRowHiddenByUser(rowPosition)`	`Boolean`	הפונקציה מחזירה אם השורה הנתונה מוסתרת על ידי המשתמש.
`moveActiveSheet(pos)`	`void`	מעביר את הגיליון הפעיל למיקום הנתון ברשימת הגיליונות.
`moveChartToObjectSheet(chart)`	`Sheet`	יצירת גיליון `SheetType.OBJECT` חדש והעברת התרשים שסופק אליו.
`refreshAllDataSources()`	`void`	רענון של כל מקורות הנתונים הנתמכים והאובייקטים של מקור הנתונים המקושרים שלהם, תוך דילוג על ערכים לא חוקיים האובייקטים של מקור הנתונים.
`removeEditor(emailAddress)`	`Spreadsheet`	הסרה של המשתמש הנתון מרשימת העורכים של `Spreadsheet`.
`removeEditor(user)`	`Spreadsheet`	הסרה של המשתמש הנתון מרשימת העורכים של `Spreadsheet`.
`removeMenu(name)`	`void`	הסרה של תפריט שנוסף על ידי `addMenu(name, subMenus)`.
`removeNamedRange(name)`	`void`	מחיקה של טווח תאים בעל שם עם השם הנתון.
`removeViewer(emailAddress)`	`Spreadsheet`	הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של `Spreadsheet`.
`removeViewer(user)`	`Spreadsheet`	הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של `Spreadsheet`.
`rename(newName)`	`void`	משנה את שם המסמך.
`renameActiveSheet(newName)`	`void`	משנה את השם של הגיליון הפעיל הנוכחי לשם החדש הנתון.
`resetSpreadsheetTheme()`	`SpreadsheetTheme`	מסירה את העיצוב שהוחל ומגדירה את עיצוב ברירת המחדל בגיליון האלקטרוני.
`setActiveRange(range)`	`Range`	מגדיר את הטווח שצוין כ-`active range` בגיליון הפעיל, עם התא הימני העליון בטווח, בתור `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	מגדיר את רשימת הטווחים שצוינה כ-`active ranges` בשדה גיליון פעיל.
`setActiveSelection(range)`	`Range`	הגדרת אזור הבחירה הפעיל בגיליון הזה.
`setActiveSelection(a1Notation)`	`Range`	מגדיר את הבחירה הפעילה, כפי שמצוין בסימון A1 או R1C1.
`setActiveSheet(sheet)`	`Sheet`	מגדיר את הגיליון הנתון כגיליון הפעיל בגיליון האלקטרוני.
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	מגדיר את הגיליון הנתון כגיליון פעיל בגיליון האלקטרוני, עם אפשרות לשחזר את הבחירה האחרונה באותו גיליון.
`setColumnWidth(columnPosition, width)`	`Sheet`	מגדיר את הרוחב של העמודה הנתונה בפיקסלים.
`setCurrentCell(cell)`	`Range`	מגדיר את התא שצוין כ-`current cell`.
`setFrozenColumns(columns)`	`void`	הקפאה של מספר העמודות הנתון.
`setFrozenRows(rows)`	`void`	הקפאה של מספר השורות הנתון.
`setIterativeCalculationConvergenceThreshold(minThreshold)`	`Spreadsheet`	מגדיר את ערך הסף המינימלי לחישוב חוזר.
`setIterativeCalculationEnabled(isEnabled)`	`Spreadsheet`	המדיניות הזו מגדירה אם חישוב איטרטיבי מופעל בגיליון האלקטרוני הזה.
`setMaxIterativeCalculationCycles(maxIterations)`	`Spreadsheet`	הגדרת המספר המקסימלי של איטרציות חישוב שיש לבצע במהלך האיטרציה של הסבירות.
`setNamedRange(name, range)`	`void`	נותנים שם לטווח.
`setRecalculationInterval(recalculationInterval)`	`Spreadsheet`	המדיניות הזו מגדירה את התדירות שבה צריך לבצע חישוב מחדש בגיליון האלקטרוני.
`setRowHeight(rowPosition, height)`	`Sheet`	מגדיר את גובה השורה של שורה נתונה בפיקסלים.
`setSpreadsheetLocale(locale)`	`void`	הגדרת הלוקאל של הגיליון האלקטרוני.
`setSpreadsheetTheme(theme)`	`SpreadsheetTheme`	מגדיר עיצוב לגיליון האלקטרוני.
`setSpreadsheetTimeZone(timezone)`	`void`	מגדיר את אזור הזמן של הגיליון האלקטרוני.
`show(userInterface)`	`void`	הצגת רכיב של ממשק משתמש בהתאמה אישית בתיבת דו-שיח שבמרכזה בדפדפן של המשתמש אזור התצוגה.
`sort(columnPosition)`	`Sheet`	ממיינת גיליון לפי עמודה, בסדר עולה.
`sort(columnPosition, ascending)`	`Sheet`	ממיינת גיליון לפי עמודה.
`toast(msg)`	`void`	מציג חלון קופץ בפינה השמאלית התחתונה של הגיליון האלקטרוני עם ההודעה הנתונה.
`toast(msg, title)`	`void`	מציג חלון קופץ בפינה השמאלית התחתונה של הגיליון האלקטרוני עם ההודעה הנתונה כותרת.
`toast(msg, title, timeoutSeconds)`	`void`	מציג חלון קופץ בפינה השמאלית התחתונה של הגיליון האלקטרוני עם הכותרת הנתונה שנשארת גלויה למשך פרק זמן מסוים.
`unhideColumn(column)`	`void`	ביטול ההסתרה של העמודה בטווח הנתון.
`unhideRow(row)`	`void`	ביטול ההסתרה של השורה בטווח הנתון.
`updateMenu(name, subMenus)`	`void`	מעדכן תפריט שנוסף על ידי `addMenu(name, subMenus)`.
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	בהמתנה להשלמת כל ההפעלות הנוכחיות בגיליון האלקטרוני, והזמן הקצוב יסתיים לאחר מספר השניות שצוין.

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

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

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

`addDeveloperMetadata(key)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`addDeveloperMetadata(key, visibility)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`addDeveloperMetadata(key, value)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`addDeveloperMetadata(key, value, visibility)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`addEditor(emailAddress)`

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

פרמטרים

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

חזרה

Spreadsheet – Spreadsheet, לשרשור.

אישור

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

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

`addEditor(user)`

פרמטרים

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

חזרה

Spreadsheet – Spreadsheet, לשרשור.

אישור

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

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

`addEditors(emailAddresses)`

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

פרמטרים

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

חזרה

Spreadsheet – Spreadsheet, לשרשור.

אישור

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

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

`addMenu(name, subMenus)`

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

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

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  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 שהומר לסוג התוכן שצוין. הזה method מוסיפה את הסיומת המתאימה לשם הקובץ, לדוגמה, "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 is 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)`

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

`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 – אזור הזמן, מצוין בשדה 'long' פורמט (לדוגמה, '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()`

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

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

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

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

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

שימוש ב-methods 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. הזה ל-method אין השפעה אם המשתמש הוא עורך, לא צופה או מגיב. השיטה הזאת גם לא חוסמת את הגישה של משתמשים אל Spreadsheet אם הם שייכים לקטגוריה של משתמשים יש גישה כללית – לדוגמה, אם ה-Spreadsheet משותף עם המשתמש בכל הדומיין, או אם הקובץ Spreadsheet נמצא באחסון שיתופי שלמשתמש יש גישה אליו.

בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.

פרמטרים

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

חזרה

Spreadsheet – ה-Spreadsheet הזה לשרשור.

אישור

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

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

`removeViewer(user)`

הסרה של המשתמש הנתון מרשימת הצופים והמגיבים של Spreadsheet. הזה ל-method אין השפעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא חוסמת למשתמשים לגשת אל 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`	Tf `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`	אזור הזמן, מצוין ב-'long' (לדוגמה, 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`	ההודעה שתוצג בחלון קופץ.

אישור

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

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

`toast(msg, title)`

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

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

פרמטרים

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

אישור

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

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

`toast(msg, title, timeoutSeconds)`

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

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

פרמטרים

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

אישור

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

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

`unhideColumn(column)`

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

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 העוצמתית יותר. למרות שיטה זו הוצאה משימוש, היא עדיין זמינה לצורך תאימות עם הגרסה הישנה יותר של גיליונות

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

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