גישה לקובצי 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 | יצירת תפריט חדש בממשק המשתמש של Sheets. |
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 | הפעולה הזו ממתינה עד שכל הפעולות הנוכחיות בגיליון האלקטרוני יושלמו, והזמן הקצוב לתפוגה יחלוף אחרי מספר השניות שצוין. |
תיעוד מפורט
addDeveloperMetadata(key)
הוספת מטא-נתונים של מפתחים עם המפתח שצוין לגיליון האלקטרוני ברמה העליונה.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds the key 'NAME' in the developer metadata for the spreadsheet. ss.addDeveloperMetadata('NAME') // Gets the first developer metadata object and logs its key. const developerMetaData = ss.getDeveloperMetadata()[0] console.log(developerMetaData.getKey())
פרמטרים
שם | סוג | תיאור |
---|---|---|
key | String | המפתח למטא נתונים החדשים של המפתח. |
החזרות
Spreadsheet
- הגיליון האלקטרוני הזה, לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, visibility)
הוספת מטא-נתונים של מפתח לגיליון האלקטרוני עם המפתח וההרשאות שצוינו.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility // to the developer project that created the metadata. ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT); // Gets the first developer metadata object and logs its key and visibility setting. const developerMetaData = ss.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(`Key: ${developerMetaData.getKey()}, . Visibility: ${developerMetaData.getVisibility()}`);
פרמטרים
שם | סוג | תיאור |
---|---|---|
key | String | המפתח למטא נתונים החדשים של המפתח. |
visibility | DeveloperMetadataVisibility | סטטוס החשיפה של המטא-נתונים החדשים למפתחים. |
החזרות
Spreadsheet
- הגיליון האלקטרוני הזה, לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, value)
הוספת מטא-נתונים של מפתחים עם המפתח והערך שצוינו לגיליון האלקטרוני.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the // spreadsheet. ss.addDeveloperMetadata('NAME', 'GOOGLE'); // Gets the first developer metadata object and logs its key and value. const developerMetaData = ss.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);
פרמטרים
שם | סוג | תיאור |
---|---|---|
key | String | המפתח למטא נתונים החדשים של המפתח. |
value | String | הערך של המטא נתונים החדשים למפתחים. |
החזרות
Spreadsheet
- הגיליון האלקטרוני הזה, לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, value, visibility)
הוספת מטא-נתונים של מפתחים עם המפתח, הערך והחשיפה שצוינו לגיליון האלקטרוני.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility // to any developer project with document access. ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT); // Gets the first developer metadata object and logs its key, value, and visibility setting. const developerMetaData = ss.getDeveloperMetadata()[0]; console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}, Visibility: ${developerMetaData.getVisibility()}`);
פרמטרים
שם | סוג | תיאור |
---|---|---|
key | String | המפתח למטא נתונים החדשים של המפתח. |
value | String | הערך של המטא נתונים החדשים למפתחים. |
visibility | DeveloperMetadataVisibility | סטטוס החשיפה של המטא-נתונים החדשים למפתחים. |
החזרות
Spreadsheet
- הגיליון האלקטרוני הזה, לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditor(emailAddress)
מוסיף את המשתמש הנתון לרשימת העורכים של Spreadsheet
. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מקדמת את המשתמש מחוץ לרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש שיש להוסיף. |
החזרות
Spreadsheet
– Spreadsheet
, לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditor(user)
מוסיף את המשתמש הנתון לרשימת העורכים של Spreadsheet
. אם המשתמש כבר היה ברשימת הצופים, השיטה הזו מקדמת את המשתמש מחוץ לרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש להוספה. |
החזרות
Spreadsheet
– Spreadsheet
, לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditors(emailAddresses)
מוסיף את מערך המשתמשים הנתון לרשימת העורכים של Spreadsheet
. אם אחד מהמשתמשים כבר היה ברשימת הצופים, השיטה הזו מקדמת אותו מחוץ לרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddresses | String[] | מערך של כתובות אימייל של המשתמשים להוספה. |
החזרות
Spreadsheet
– Spreadsheet
, לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addMenu(name, subMenus)
יצירת תפריט חדש בממשק המשתמש של Sheets.
כל רשומה בתפריט מפעילה פונקציה בהגדרת המשתמש. בדרך כלל כדאי לקרוא לפונקציה 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
אם אין טווח פעיל. אם בוחרים כמה טווחים, השיטה מחזירה רק את הטווח האחרון שנבחר.
המונח Active range מתייחס לטווח שהמשתמש בחר בגיליון הפעיל, אבל בפונקציה מותאמת אישית הוא מתייחס לתא שחושב מחדש באופן פעיל.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var activeRange = sheet.getActiveRange();
החזרות
Range
– הטווח הפעיל
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
כדאי לעיין גם בפרטים הבאים
getActiveRangeList()
הפונקציה מחזירה את רשימת הטווחים הפעילים בגיליון הפעיל או ב-null
אם אין טווחים
פעילים.
אם נבחר טווח אחד, המערכת תפעל כמו קריאה ל-getActiveRange()
.
var sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. var activeRangeList = sheet.getActiveRangeList();
החזרות
RangeList
– הרשימה של הטווחים הפעילים
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
כדאי לעיין גם בפרטים הבאים
getActiveSheet()
הפונקציה מקבלת את הגיליון הפעיל בגיליון אלקטרוני.
הגיליון הפעיל של הגיליון האלקטרוני הוא הגיליון שמוצג בממשק המשתמש של הגיליון האלקטרוני.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
החזרות
Sheet
- הגיליון הפעיל בגיליון האלקטרוני.
getAs(contentType)
החזרת הנתונים שבתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין. השיטה הזו מוסיפה את הסיומת המתאימה לשם הקובץ, לדוגמה, 'myfile.pdf'. עם זאת, ההנחה היא שהחלק שמופיע בשם הקובץ אחרי הנקודה האחרונה (אם יש כזה) הוא תוסף קיים שצריך להחליף. בעקבות זאת, הערך "ShoppingList.12.25.2014" הופך ל-"ShoppingList.12.25.pdf".
במאמר מכסות לשירותי Google תוכלו לראות את המכסות היומיות להמרות. באופן זמני, דומיינים חדשים ב-Google Workspace עשויים להיות כפופים למכסות מחמירות יותר.
פרמטרים
שם | סוג | תיאור |
---|---|---|
contentType | String | סוג ה-MIME שאליו יש להמיר. ברוב ה-blobs, 'application/pdf' היא
האפשרות החוקית היחידה. עבור תמונות בפורמט BMP, GIF, JPEG או PNG, ניתן גם להשתמש בכל אחד מהערכים 'image/bmp' , 'image/gif' , 'image/jpeg' או 'image/png' . |
החזרות
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()
getColumnWidth(columnPosition)
הפונקציה מקבלת את הרוחב בפיקסלים של העמודה הנתונה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
פרמטרים
שם | סוג | תיאור |
---|---|---|
columnPosition | Integer | מיקום העמודה לבדיקה. |
החזרות
Integer
– רוחב העמודה בפיקסלים
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCurrentCell()
מחזירה את התא הנוכחי בגיליון הפעיל או null
אם אין תא נוכחי. התא הנוכחי הוא התא שהמיקוד שלו בממשק המשתמש של Google Sheets, והוא מודגש באמצעות גבול כהה. אף פעם אין יותר מתא נוכחי אחד. כשמשתמש בוחר טווח תאים אחד או יותר, אחד מהתאים ברשימה הוא התא הנוכחי.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. var currentCell = sheet.getCurrentCell();
החזרות
Range
– התא הנוכחי
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataRange()
מחזירה Range
שתואם למאפיינים שבהם קיימים נתונים.
הפונקציונליות שלו מקבילה מבחינה פונקציונלית ליצירת טווח שתחום על ידי A1 ו-(Sheet.getLastColumn(), Sheet.getLastRow()).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This represents ALL the data var range = sheet.getDataRange(); var values = range.getValues(); // This logs the spreadsheet in CSV format with a trailing comma for (var i = 0; i < values.length; i++) { var row = ""; for (var j = 0; j < values[i].length; j++) { if (values[i][j]) { row = row + values[i][j]; } row = row + ","; } Logger.log(row); }
החזרות
Range
– טווח שמכיל את כל הנתונים בגיליון האלקטרוני
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormulas()
הפונקציה מקבלת את כל הנוסחאות של מקור הנתונים.
// Opens the spreadsheet by its ID. If you created your script from within a Google Sheets // file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of the data source formulas on Sheet1. // To get an array of data source formulas for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceFormulas = sheet.getDataSourceFormulas(); // Logs the first data source formula in the array. console.log(dataSourceFormulas[0].getFormula());
החזרות
DataSourceFormula[]
– רשימת נוסחאות של מקורות נתונים.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourcePivotTables()
קבלת כל טבלאות הצירים של מקור הנתונים.
// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of the data source pivot tables on Sheet1. // To get an array of data source pivot tables for the entire // spreadsheet, replace 'sheet' with 'ss'. const dataSourcePivotTables = sheet.getDataSourcePivotTables(); // Logs the last time that the first pivot table in the array was refreshed. console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());
החזרות
DataSourcePivotTable[]
- רשימת טבלאות צירים של מקור נתונים.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceRefreshSchedules()
קבלת לוחות הזמנים לרענון של הגיליון האלקטרוני הזה.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Activates BigQuery operations for the connected spreadsheet. SpreadsheetApp.enableBigQueryExecution(); // Gets the frequency type of the first referesh schedule in the array. const frequencyType = ss.getDataSourceRefreshSchedules()[0] .getFrequency() .getFrequencyType() .toString(); // Logs the frequency type to the console. console.log(frequencyType);
החזרות
DataSourceRefreshSchedule[]
- לוחות הזמנים לרענון של הגיליון האלקטרוני הזה.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceSheets()
הפונקציה מחזירה את כל הגיליונות של מקור הנתונים בגיליון האלקטרוני.
// Turns data execution on for BigQuery data sources. SpreadsheetApp.enableBigQueryExecution(); // Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets the first data source sheet in the spreadsheet. const dataSource = ss.getDataSourceSheets()[0]; // Gets the name of the data source sheet. console.log(dataSource.asSheet().getName());
החזרות
DataSourceSheet[]
– מערך של כל הגיליונות של מקור הנתונים.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceTables()
קבלת כל הטבלאות של מקורות הנתונים.
// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of data source tables on Sheet1. // To get an array of data source tables for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceTables = sheet.getDataSourceTables(); // Logs the last completed data execution time on the first data source table. console.log(dataSourceTables[0].getStatus().getLastExecutionTime());
החזרות
DataSourceTable[]
– רשימת טבלאות של מקורות נתונים.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSources()
מחזירה את כל מקורות הנתונים בגיליון האלקטרוני.
// Turns data execution on for BigQuery data sources. SpreadsheetApp.enableBigQueryExecution(); // Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets the data sources on the spreadsheet. const dataSources = ss.getDataSources(); // Logs the name of the first column on the first data source. console.log(dataSources[0].getColumns()[0].getName());
החזרות
DataSource[]
– מערך של כל מקורות הנתונים.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDeveloperMetadata()
מאחזר את המטא-נתונים של המפתח המשויכים לגיליון האלקטרוני ברמה העליונה.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds 'Google' as a key to the spreadsheet metadata. ss.addDeveloperMetadata('Google'); // Gets the spreadsheet's metadata. const ssMetadata = ss.getDeveloperMetadata(); // Gets the first set of the spreadsheet's metadata and logs the key to the console. console.log(ssMetadata[0].getKey());
החזרות
DeveloperMetadata[]
– המטא-נתונים של המפתח שמשויכים לטווח הזה.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getEditors()
הפונקציה מקבלת את רשימת העורכים של Spreadsheet
.
החזרות
User[]
– מערך של משתמשים עם הרשאת עריכה.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormUrl()
הפונקציה מחזירה את כתובת ה-URL של הטופס ששולח את התגובות שלו לגיליון האלקטרוני הזה, או null
אם
לגיליון האלקטרוני הזה לא משויך טופס. אם מספר טפסים שולחים תגובות לגיליון האלקטרוני הזה, כתובת ה-URL של הטופס שמוחזרת אינה מוגדרת. לחלופין, ניתן לאחזר שיוכים של כתובות URL לכל גיליון באמצעות השיטה Sheet.getFormUrl()
.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets the form URL from the spreadsheet. const formUrl = ss.getFormUrl(); // Logs the form URL to the console. console.log(formUrl);
החזרות
String
- כתובת ה-URL של הטופס שמכיל את התגובות שלו בגיליון האלקטרוני הזה, או null
אם אין טופס משויך לגיליון האלקטרוני הזה.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFrozenColumns()
מחזירה את מספר העמודות שהוקפאו.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());
החזרות
Integer
– מספר העמודות שהוקפאו
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFrozenRows()
מחזירה את מספר השורות שהוקפאו.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());
החזרות
Integer
– מספר השורות שהוקפאו
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getId()
הפונקציה מקבלת מזהה ייחודי לגיליון האלקטרוני הזה. ניתן לחלץ מזהה של גיליון אלקטרוני מכתובת ה-URL שלו. לדוגמה, המזהה של הגיליון האלקטרוני בכתובת ה-URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 הוא "abc1234567".
// The code below logs the ID for the active spreadsheet. Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());
החזרות
String
- המזהה (או המפתח) הייחודי של הגיליון האלקטרוני.
getImages()
מחזירה את כל התמונות שממוקמות מעל הרשת בגיליון.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the over-the-grid images from Sheet1. // To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead. const images = sheet.getImages(); // For each image, logs the anchor cell in A1 notation. for (const image of images) { console.log(image.getAnchorCell().getA1Notation()); }
החזרות
OverGridImage[]
- מערך של תמונות שממוקמות מעל הרשת.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getIterativeCalculationConvergenceThreshold()
מחזירה את ערך הסף שנעשה בו שימוש במהלך חישוב חוזר. כשהתוצאות של החישובים הרציפים משתנות בשיעור נמוך מהערך הזה, החישוב החוזר מופסק.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Sets the iterative calculation convergence threshold for the spreadsheet. ss.setIterativeCalculationConvergenceThreshold(2); // Logs the threshold to the console. console.log(ss.getIterativeCalculationConvergenceThreshold());
החזרות
Number
- סף ההתכנסות.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastColumn()
מחזירה את המיקום של העמודה האחרונה שמכילה תוכן.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
החזרות
Integer
– העמודה האחרונה בגיליון שמכיל תוכן
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastRow()
מחזירה את המיקום של השורה האחרונה שמכילה תוכן.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
החזרות
Integer
– השורה האחרונה בגיליון שמכיל תוכן
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getMaxIterativeCalculationCycles()
מחזירה את מספר החזרות המקסימלי לשימוש במהלך חישוב איטרטיבי.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Sets the max iterative calculation cycles for the spreadsheet. ss.setMaxIterativeCalculationCycles(10); // Logs the max iterative calculation cycles to the console. console.log(ss.getMaxIterativeCalculationCycles());
החזרות
Integer
– המספר המקסימלי של איטרציות חישוב.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getName()
הפונקציה מקבלת את שם המסמך.
var ss = SpreadsheetApp.getActiveSpreadsheet(); Logger.log(ss.getName());
החזרות
String
- שם הגיליון האלקטרוני.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNamedRanges()
הפונקציה מקבלת את כל הטווחים בעלי השם בגיליון האלקטרוני הזה.
// The code below logs the name of the first named range. var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges(); for (var i = 0; i < namedRanges.length; i++) { Logger.log(namedRanges[i].getName()); }
החזרות
NamedRange[]
- מערך של כל הטווחים בעלי השם בגיליון האלקטרוני.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNumSheets()
מחזירה את מספר הגיליונות בגיליון האלקטרוני.
// The code below logs the number of sheets in the active spreadsheet. Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());
החזרות
Integer
- מספר הגיליונות בגיליון האלקטרוני.
getOwner()
הפונקציה מחזירה את הבעלים של המסמך, או null
עבור מסמך באחסון שיתופי.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var owner = ss.getOwner(); Logger.log(owner.getEmail());
החזרות
User
- הבעלים של המסמך, או null
אם המסמך נמצא באחסון שיתופי.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getPredefinedSpreadsheetThemes()
מחזירה את רשימת העיצובים שהוגדרו מראש.
// The code below returns the list of predefined themes. var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet() .getPredefinedSpreadsheetThemes();
החזרות
SpreadsheetTheme[]
– רשימה של עיצובים מוגדרים מראש.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getProtections(type)
הפונקציה מקבלת מערך של אובייקטים שמייצגים את כל הטווחים או הגיליונות המוגנים בגיליון האלקטרוני.
// Remove all range protections in the spreadsheet that the user has permission to edit. var ss = SpreadsheetApp.getActive(); var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE); for (var i = 0; i < protections.length; i++) { var protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
// Remove all sheet protections in the spreadsheet that the user has permission to edit. var ss = SpreadsheetApp.getActive(); var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET); for (var i = 0; i < protections.length; i++) { var protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
פרמטרים
שם | סוג | תיאור |
---|---|---|
type | ProtectionType | סוג האזור המוגן, SpreadsheetApp.ProtectionType.RANGE או SpreadsheetApp.ProtectionType.SHEET . |
החזרות
Protection[]
- מערך אובייקטים שמייצגים את כל הטווחים המוגנים או הגיליונות האלקטרוניים בגיליון האלקטרוני.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRange(a1Notation)
מחזירה את הטווח כפי שצוין בסימון A1 או בסימון R1C1.
// Get a range A1:D4 on sheet titled "Invoices" var ss = SpreadsheetApp.getActiveSpreadsheet(); var range = ss.getRange("Invoices!A1:D4"); // Get cell A1 on the first sheet var sheet = ss.getSheets()[0]; var cell = sheet.getRange("A1");
פרמטרים
שם | סוג | תיאור |
---|---|---|
a1Notation | String | הטווח שיש להחזיר, כפי שצוין בסימון A1 או בסימון R1C1. |
החזרות
Range
– הטווח במיקום שצוין
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRangeByName(name)
הפונקציה מחזירה טווח תאים בעל שם. לחלופין, הפונקציה מחזירה את הערך null
אם לא נמצא טווח בשם הנתון. אם למספר גיליונות בגיליון האלקטרוני יש אותו שם טווח, עליכם לציין את שם הגיליון בלי סימני מירכאות נוספים – לדוגמה getRangeByName('TaxRates')
או getRangeByName('Sheet Name!TaxRates')
, אבל לא getRangeByName('"Sheet
Name"!TaxRates')
.
// Log the number of columns for the range named 'TaxRates' in the active spreadsheet. var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates'); if (range != null) { Logger.log(range.getNumColumns()); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | שם הטווח שיש לקבל. |
החזרות
Range
- טווח התאים עם השם הנתון.
getRangeList(a1Notations)
מחזירה את האוסף RangeList
שמייצג את הטווחים באותו גיליון שצוין,
באמצעות רשימה לא ריקה של סימוןי A1 או של סימון R1C1.
// Get a list of ranges A1:D4, F1:H4. var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);
פרמטרים
שם | סוג | תיאור |
---|---|---|
a1Notations | String[] | רשימת הטווחים שיש להחזיר, כפי שצוין בסימון A1 או בסימון R1C1. |
החזרות
RangeList
- רשימת הטווחים במיקום המיועד
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRecalculationInterval()
מחזירה את מרווח החישוב של גיליון אלקטרוני זה.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Logs the calculation interval for the spreadsheet to the console. console.log(ss.getRecalculationInterval().toString());
החזרות
RecalculationInterval
- מרווח החישוב של הגיליון האלקטרוני הזה.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowHeight(rowPosition)
הפונקציה מקבלת את הגובה בפיקסלים של השורה הנתונה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
פרמטרים
שם | סוג | תיאור |
---|---|---|
rowPosition | Integer | מיקום השורה שיש לבדוק. |
החזרות
Integer
— גובה השורה בפיקסלים
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSelection()
מחזירה את הערך הנוכחי של Selection
בגיליון האלקטרוני.
var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection(); var currentCell = selection.getCurrentCell();
החזרות
Selection
– הבחירה הנוכחית
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetByName(name)
מחזירה גיליון בשם הנתון.
אם למספר גיליונות יש שם זהה, יוחזר הגיליון הימני ביותר. הפונקציה מחזירה את הערך null
אם אין גיליון עם השם הנתון.
// The code below logs the index of a sheet named "Expenses" var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses"); if (sheet != null) { Logger.log(sheet.getIndex()); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | שם הגיליון שמקבלים. |
החזרות
Sheet
- הגיליון עם השם הנתון.
getSheetId()
מחזירה את המזהה של הגיליון שמיוצג על ידי אובייקט זה.
זהו מזהה ייחודי לגיליון האלקטרוני. המזהה הוא מספר שלם שמוקצה באופן מונוטוני בזמן יצירת הגיליון, שלא תלוי במיקום הגיליון. האפשרות הזו שימושית בשילוב עם שיטות כמו Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
שמקבלות פרמטר gridId
במקום מופע של Sheet
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetId());
החזרות
Integer
– מזהה לגיליון הייחודי של הגיליון האלקטרוני
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetName()
מחזירה את שם הגיליון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetName());
החזרות
String
- שם הגיליון
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(startRow, startColumn, numRows, numColumns)
מחזירה את הרשת המלבנית של הערכים עבור הטווח הזה החל מהקואורדינטות הנתונות. ערך של 1- הנתון כמיקום של שורה או עמודה מקביל לערך של השורה או העמודה האחרונה שמכילה נתונים בגיליון.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The two samples below produce the same output var values = sheet.getSheetValues(1, 1, 3, 3); Logger.log(values); var range = sheet.getRange(1, 1, 3, 3); values = range.getValues(); Logger.log(values);
פרמטרים
שם | סוג | תיאור |
---|---|---|
startRow | Integer | המיקום של השורה הראשונה. |
startColumn | Integer | המיקום של העמודה הראשונה. |
numRows | Integer | מספר השורות שיש להחזיר עבורן ערכים. |
numColumns | Integer | מספר העמודות שעבורן יש להחזיר ערכים. |
החזרות
Object[][]
– מערך דו-ממדי של ערכים
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheets()
הפונקציה מקבלת את כל הגיליונות בגיליון האלקטרוני הזה.
// The code below logs the name of the second sheet var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets(); if (sheets.length > 1) { Logger.log(sheets[1].getName()); }
החזרות
Sheet[]
- מערך של כל הגיליונות בגיליון האלקטרוני.
getSpreadsheetLocale()
הפונקציה מקבלת את הלוקאל של הגיליון האלקטרוני.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets the spreadsheet locale. const ssLocale = ss.getSpreadsheetLocale(); // Logs the locale to the console. console.log(ssLocale);
החזרות
String
- הלוקאל של הגיליון האלקטרוני.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSpreadsheetTheme()
מחזירה את העיצוב הנוכחי של הגיליון האלקטרוני, או null
אם לא הוחל עיצוב.
// The code below returns the current theme of the spreadsheet. var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();
החזרות
SpreadsheetTheme
- העיצוב הנוכחי שהוחל.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSpreadsheetTimeZone()
הפונקציה מקבלת את אזור הזמן של הגיליון האלקטרוני.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Sets the time zone of the spreadsheet. ss.setSpreadsheetTimeZone('America/New_York'); // Gets the time zone of the spreadsheet. const ssTimeZone = ss.getSpreadsheetTimeZone(); // Logs the time zone to the console. console.log(ssTimeZone);
החזרות
String
- אזור הזמן, שמצוין בפורמט "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
שמקיף את כל הגיליון בהתאם למפרט הנתון של מקור הנתונים, והתחלת הפעלת הנתונים. כתוצאה מכך, הגיליון החדש הופך לגיליון הפעיל.
מציג חריגה אם סוג מקור הנתונים לא מופעל. שימוש בשיטות 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'); // 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)
מסיר את המשתמש הנתון מרשימת העורכים של Spreadsheet
. השיטה הזו לא חוסמת את הגישה של משתמשים ל-Spreadsheet
אם הם שייכים לקטגוריה של משתמשים שיש להם
גישה כללית, למשל אם Spreadsheet
משותף עם כל הדומיין של המשתמש, או אם Spreadsheet
נמצא באחסון שיתופי שהמשתמש יכול לגשת אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת הצופים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שיש להסיר. |
החזרות
Spreadsheet
– Spreadsheet
, לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeMenu(name)
מסירה תפריט שנוסף על ידי addMenu(name, subMenus)
. הארגומנט name
צריך להיות זהה לערך של הקריאה התואמת ל-addMenu(name, subMenus)
.
// The onOpen function is executed automatically every time a Spreadsheet is loaded function onOpen() { var ss = SpreadsheetApp.getActiveSpreadsheet(); ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"}, {name: "foo", functionName: "foo"}]); } function removeBadMenu() { var ss = SpreadsheetApp.getActiveSpreadsheet(); ss.removeMenu("badMenu"); // name must match the name used when added the menu } function foo(){ // Do nothing }
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | שם התפריט שיש להסיר. |
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeNamedRange(name)
מחיקת טווח תאים בעל שם בשם הנתון. הפונקציה מוסיפה חריגות אם לא נמצא בגיליון האלקטרוני טווח בשם הנתון.
// The code below creates a new named range "foo", and then remove it. var ss = SpreadsheetApp.getActiveSpreadsheet(); ss.setNamedRange("foo", ss.getActiveRange()); ss.removeNamedRange("foo");
פרמטרים
שם | סוג | תיאור |
---|---|---|
name | String | שם הטווח. |
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeViewer(emailAddress)
מסיר את המשתמש הנתון מרשימת הצופים והמגיבים בSpreadsheet
. לשיטה הזו אין השפעה אם המשתמש הוא עורך, ולא צופה או מגיב. השיטה הזו גם לא חוסמת את הגישה של משתמשים ל-Spreadsheet
אם הם שייכים לסוג של משתמשים שיש להם גישה כללית, למשל אם Spreadsheet
משותף עם כל הדומיין של המשתמש, או אם Spreadsheet
נמצא באחסון שיתופי שלמשתמש יש גישה אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
emailAddress | String | כתובת האימייל של המשתמש שיש להסיר. |
החזרות
Spreadsheet
– Spreadsheet
לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeViewer(user)
מסיר את המשתמש הנתון מרשימת הצופים והמגיבים בSpreadsheet
. לשיטה הזו אין השפעה אם המשתמש הוא עורך ולא צופה. השיטה הזו גם לא חוסמת
את הגישה של משתמשים ל-Spreadsheet
אם הם שייכים לקטגוריה של משתמשים שיש להם
גישה כללית, למשל אם Spreadsheet
משותף עם כל הדומיין של המשתמש, או אם ה-Spreadsheet
נמצא באחסון שיתופי שלמשתמש יש גישה אליו.
בקובצי Drive, המשתמש יוסר גם מרשימת העורכים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
user | User | ייצוג של המשתמש שיש להסיר. |
החזרות
Spreadsheet
– Spreadsheet
לשרשור.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
rename(newName)
משנה את שם המסמך.
var ss = SpreadsheetApp.getActiveSpreadsheet(); ss.rename("This is the new name");
פרמטרים
שם | סוג | תיאור |
---|---|---|
newName | String | השם החדש של המסמך. |
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
renameActiveSheet(newName)
משנה את השם של הגיליון הפעיל הנוכחי לשם החדש שניתן.
// The code below renames the active sheet to "Hello world" SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");
פרמטרים
שם | סוג | תיאור |
---|---|---|
newName | String | השם החדש של הגיליון הפעיל הנוכחי. |
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
resetSpreadsheetTheme()
מסיר את העיצוב שהוחל ומגדיר את עיצוב ברירת המחדל בגיליון האלקטרוני.
// The code below applies default theme on the spreadsheet. SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();
החזרות
SpreadsheetTheme
– עיצוב ברירת המחדל.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveRange(range)
הפונקציה מגדירה את הטווח שצוין כ-active range
בגיליון הפעיל, כשהתא הימני העליון בטווח הוא current cell
.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var range = sheet.getRange('A1:D4'); sheet.setActiveRange(range); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D4 var activeRange = selection.getActiveRange();
פרמטרים
שם | סוג | תיאור |
---|---|---|
range | Range | הטווח שיש להגדיר כטווח הפעיל. |
החזרות
Range
– הטווח הפעיל החדש
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveRangeList(rangeList)
מגדיר את רשימת הטווחים שצוינה כ-active ranges
בגיליון הפעיל. הטווח האחרון ברשימה מוגדר כ-active range
.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['D4', 'B2:C4']); sheet.setActiveRangeList(rangeList); var selection = sheet.getSelection(); // Current cell: B2 var currentCell = selection.getCurrentCell(); // Active range: B2:C4 var activeRange = selection.getActiveRange(); // Active range list: [D4, B2:C4] var activeRangeList = selection.getActiveRangeList();
פרמטרים
שם | סוג | תיאור |
---|---|---|
rangeList | RangeList | רשימת הטווחים לבחירה. |
החזרות
RangeList
– הרשימה החדשה של הטווחים שנבחרו
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveSelection(range)
מגדיר את אזור הבחירה הפעיל לגיליון זה.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D4"); sheet.setActiveSelection(range);
פרמטרים
שם | סוג | תיאור |
---|---|---|
range | Range | הטווח שיש להגדיר בתור הבחירה הפעילה. |
החזרות
Range
– הטווח הפעיל החדש
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveSelection(a1Notation)
מגדיר את הבחירה הפעילה כפי שצוין בסימון A1 או בסימון R1C1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.setActiveSelection("A1:D4");
פרמטרים
שם | סוג | תיאור |
---|---|---|
a1Notation | String | הטווח שיש להגדיר כפעיל, כפי שצוין בסימון A1 או בסימון R1C1. |
החזרות
Range
– הטווח הפעיל החדש
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveSheet(sheet)
מגדיר את הגיליון הנתון כגיליון הפעיל בגיליון האלקטרוני. הגיליון שנבחר יוצג בממשק המשתמש של Google Sheets, אלא אם הוא שייך לגיליון אלקטרוני אחר.
// The code below makes the first sheet active in the active spreadsheet. var spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);
פרמטרים
שם | סוג | תיאור |
---|---|---|
sheet | Sheet | הגיליון להגדרה כגיליון פעיל. |
החזרות
Sheet
- הגיליון הפעיל.
הרשאה
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setActiveSheet(sheet, restoreSelection)
מגדירה את הגיליון הנתון כגיליון הפעיל בגיליון האלקטרוני, עם אפשרות לשחזר את הבחירה העדכנית ביותר באותו גיליון. הגיליון שנבחר יוצג בממשק המשתמש של Google Sheets, אלא אם הוא שייך לגיליון אלקטרוני אחר.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); var firstSheet = spreadsheet.getSheets()[0]; var secondSheet = spreadsheet.getSheets()[1]; // Set the first sheet as the active sheet and select the range D4:F4. spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate(); // Switch to the second sheet to do some work. spreadsheet.setActiveSheet(secondSheet); // Switch back to first sheet, and restore its selection. spreadsheet.setActiveSheet(firstSheet, true); // The selection of first sheet is restored, and it logs D4:F4 var range = spreadsheet.getActiveSheet().getSelection().getActiveRange(); Logger.log(range.getA1Notation());
פרמטרים
שם | סוג | תיאור |
---|---|---|
sheet | Sheet | הגיליון הפעיל החדש. |
restoreSelection | Boolean | 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)
מציג רכיב מותאם אישית של ממשק משתמש בתיבת דו-שיח שמרכזת את אזור התצוגה של הדפדפן של המשתמש. ההפעלה של הסקריפט בצד השרת לא מושעה. כדי לתקשר עם צד השרת, הרכיב של ממשק המשתמש צריך לבצע קריאות חוזרות (callback) אסינכרוניות לסקריפט בצד השרת.
אם הסקריפט בצד השרת הציג בעבר תיבת דו-שיח שעדיין לא נסגרה, תיבת הדו-שיח הקיימת תוחלף בממשק המשתמש של תיבת הדו-שיח החדשה שהתבקשה.
קטע הקוד הבא מציג אפליקציה פשוטה של 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