Class Spreadsheet

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

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

שיטות

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

תיעוד מפורט

addDeveloperMetadata(key)

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

פרמטרים

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

הלוך ושוב

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

הרשאה

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

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

addDeveloperMetadata(key, visibility)

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

פרמטרים

שםסוגתיאור
keyStringהמפתח למטא-נתונים החדשים של המפתח.
visibilityDeveloperMetadataVisibilityהחשיפה של המטא נתונים החדשים של המפתח.

הלוך ושוב

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

הרשאה

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

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

addDeveloperMetadata(key, value)

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

פרמטרים

שםסוגתיאור
keyStringהמפתח למטא-נתונים החדשים של המפתח.
valueStringהערך של המטא-נתונים של המפתח החדש.

הלוך ושוב

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

הרשאה

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

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

addDeveloperMetadata(key, value, visibility)

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

פרמטרים

שםסוגתיאור
keyStringהמפתח למטא-נתונים החדשים של המפתח.
valueStringהערך של המטא-נתונים של המפתח החדש.
visibilityDeveloperMetadataVisibilityהחשיפה של המטא נתונים החדשים של המפתח.

הלוך ושוב

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

הרשאה

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

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

addEditor(emailAddress)

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

פרמטרים

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

הלוך ושוב

SpreadsheetSpreadsheet זה, לשרשור.

הרשאה

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

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

addEditor(user)

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

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש להוספה.

הלוך ושוב

SpreadsheetSpreadsheet זה, לשרשור.

הרשאה

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

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

addEditors(emailAddresses)

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

פרמטרים

שםסוגתיאור
emailAddressesString[]מערך כתובות אימייל של המשתמשים להוספה.

הלוך ושוב

SpreadsheetSpreadsheet זה, לשרשור.

הרשאה

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

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

addMenu(name, subMenus)

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

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

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

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

פרמטרים

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

הרשאה

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

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

addViewer(emailAddress)

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

פרמטרים

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

הלוך ושוב

SpreadsheetSpreadsheet זה, לשרשור.

הרשאה

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

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

addViewer(user)

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

פרמטרים

שםסוגתיאור
userUserייצוג של המשתמש להוספה.

הלוך ושוב

SpreadsheetSpreadsheet זה, לשרשור.

הרשאה

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

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

addViewers(emailAddresses)

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

פרמטרים

שםסוגתיאור
emailAddressesString[]מערך כתובות אימייל של המשתמשים להוספה.

הלוך ושוב

SpreadsheetSpreadsheet זה, לשרשור.

הרשאה

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

  • 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"]);

פרמטרים

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

הלוך ושוב

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

פרמטרים

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

הלוך ושוב

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

פרמטרים

שםסוגתיאור
nameStringשם העותק.

הלוך ושוב

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

הרשאה

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

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

createDeveloperMetadataFinder()

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

הלוך ושוב

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

פרמטרים

שםסוגתיאור
findTextStringהטקסט שיש לחפש.

הלוך ושוב

TextFinderTextFinder לגיליון האלקטרוני.


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

פרמטרים

שםסוגתיאור
columnPositionIntegerמיקום העמודה, החל מ-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);

פרמטרים

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

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowPositionIntegerמיקום השורה, החל מ-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);

פרמטרים

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

הרשאה

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

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

פרמטרים

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

הרשאה

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

  • 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 הטווח" מתייחס לטווח שהמשתמש בחר בגיליון הפעיל, אך בפונקציה מותאמת אישית הוא מתייחס לתא שמחושב מחדש באופן פעיל.

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 עשויים להיות כפופים באופן זמני להגבלות מחמירות יותר.

פרמטרים

שםסוגתיאור
contentTypeStringסוג MIME לביצוע המרה. ברוב הערוצים, האפשרות 'application/pdf' היא האפשרות התקינה היחידה. תמונות בפורמט BMP, GIF, JPEG או PNG יכולות גם הן 'image/bmp', 'image/gif', 'image/jpeg' או 'image/png'.

הלוך ושוב

Blob — הנתונים הם blob.


getBandings()

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

הלוך ושוב

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

הרשאה

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

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

getBlob()

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

הלוך ושוב

Blob — הנתונים הם blob.


getColumnWidth(columnPosition)

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

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

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

פרמטרים

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

הלוך ושוב

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

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

הלוך ושוב

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

הרשאה

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

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

getDataSourcePivotTables()

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

הלוך ושוב

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

הרשאה

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

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

getDataSourceRefreshSchedules()

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

הלוך ושוב

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

הרשאה

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

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

getDataSourceSheets()

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

הלוך ושוב

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

הרשאה

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

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

getDataSourceTables()

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

הלוך ושוב

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

הרשאה

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

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

getDataSources()

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

הלוך ושוב

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

הרשאה

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

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

getDeveloperMetadata()

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

הלוך ושוב

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

הלוך ושוב

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/sheets/d/abc1234567/edit#gid=0 הוא "abc1234567".

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

הלוך ושוב

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


getImages()

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

הלוך ושוב

OverGridImage[] — מערך של תמונות ברשת.

הרשאה

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

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

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

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

הלוך ושוב

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();
  }
}

פרמטרים

שםסוגתיאור
typeProtectionTypeסוג האזור המוגן, 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");

פרמטרים

שםסוגתיאור
a1NotationStringהטווח להחזרה, כפי שצוין בסימון 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());
}

פרמטרים

שםסוגתיאור
nameStringשם הטווח שיש לקבל.

הלוך ושוב

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

פרמטרים

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

הלוך ושוב

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

הרשאה

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

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

getRecalculationInterval()

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

הלוך ושוב

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

פרמטרים

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

הלוך ושוב

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());
}

פרמטרים

שםסוגתיאור
nameStringשם הגיליון שיש לקבל.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
startRowIntegerהמיקום של השורה הראשונה.
startColumnIntegerהמיקום של עמודת ההתחלה.
numRowsIntegerמספר השורות שיש להחזיר את הערכים שלהן.
numColumnsIntegerמספר העמודות שיש להחזיר את הערכים שלהן.

הלוך ושוב

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

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

הלוך ושוב

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

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

הלוך ושוב

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

פרמטרים

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

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowRangeטווח השורות להסתרה.

הרשאה

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

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

פרמטרים

שםסוגתיאור
afterPositionIntegerהעמודה שאחריה מוסיפים את העמודה החדשה.

הלוך ושוב

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

פרמטרים

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

הלוך ושוב

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

הרשאה

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

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

insertColumnsAfter(afterPosition, howMany)

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

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

פרמטרים

שםסוגתיאור
afterPositionIntegerהעמודה שאחריה מוסיפים את העמודה החדשה.
howManyIntegerמספר העמודות להוספה.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
beforePositionIntegerהעמודה שלפניה יש להוסיף את העמודה החדשה.
howManyIntegerמספר העמודות להוספה.

הלוך ושוב

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

הרשאה

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

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

insertDataSourceSheet(spec)

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

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

פרמטרים

שםסוגתיאור
specDataSourceSpecהמפרט של מקור הנתונים שצריך להוסיף אליו.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
blobSourceBlobSourceה-blob שמכיל את תוכן התמונה, סוג MIME והשם (אופציונלי).
columnIntegerמיקום העמודה.
rowIntegerמיקום השורה.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
blobSourceBlobSourceה-blob שמכיל את תוכן התמונה, סוג MIME והשם (אופציונלי).
columnIntegerמיקום העמודה.
rowIntegerמיקום השורה.
offsetXIntegerההיסט האופקי מהפינה התאית בפיקסלים.
offsetYIntegerההיסט האנכי מהפינה התאית בפיקסלים.

הלוך ושוב

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

הרשאה

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

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

insertImage(url, column, row)

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

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

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

פרמטרים

שםסוגתיאור
urlStringכתובת האתר של התמונה.
columnIntegerמיקום העמודה ברשת.
rowIntegerהמיקום של רשת השורות.

הלוך ושוב

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

הרשאה

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

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

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

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

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

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

פרמטרים

שםסוגתיאור
urlStringכתובת ה-URL של התמונה.
columnIntegerמיקום העמודה.
rowIntegerמיקום השורה.
offsetXIntegerההיסט האופקי מהפינה התאית בפיקסלים.
offsetYIntegerההיסט האנכי מהפינה התאית בפיקסלים.

הלוך ושוב

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

פרמטרים

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

הלוך ושוב

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

פרמטרים

שםסוגתיאור
beforePositionIntegerהשורה שלפניה יש להוסיף את השורה החדשה.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
afterPositionIntegerהשורה שאחריה יש להוסיף את השורות החדשות.
howManyIntegerמספר השורות להוספה.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
beforePositionIntegerהשורה שלפניה יש להוסיף את השורות החדשות.
howManyIntegerמספר השורות להוספה.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
sheetIndexIntegerהאינדקס של הגיליון החדש שנוצר. כדי להוסיף גיליון לגיליון הראשון בגיליון האלקטרוני, יש להגדיר אותו כ-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});

פרמטרים

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

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

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

הלוך ושוב

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

פרמטרים

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

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

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

הלוך ושוב

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

פרמטרים

שםסוגתיאור
sheetNameStringשם הגיליון החדש.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
sheetNameStringשם הגיליון החדש.
sheetIndexIntegerהאינדקס של הגיליון החדש שנוצר. כדי להוסיף גיליון לגיליון הראשון בגיליון האלקטרוני, יש להגדיר אותו כ-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});

פרמטרים

שםסוגתיאור
sheetNameStringשם הגיליון החדש.
sheetIndexIntegerהאינדקס של הגיליון החדש שנוסף. כדי להוסיף גיליון לגיליון הראשון בגיליון אלקטרוני, צריך להגדיר אותו כ-0.
optionsObjectארגומנטים מתקדמים של JavaScript.

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

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

הלוך ושוב

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

פרמטרים

שםסוגתיאור
sheetNameStringשם הגיליון החדש.
optionsObjectארגומנטים מתקדמים של JavaScript.

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

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

הלוך ושוב

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

הרשאה

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

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

insertSheetWithDataSourceTable(spec)

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

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

פרמטרים

שםסוגתיאור
specDataSourceSpecהמפרט של מקור הנתונים שצריך להוסיף אליו.

הלוך ושוב

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

פרמטרים

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

הלוך ושוב

Booleantrue אם העמודה מוסתרת, false אם לא.

הרשאה

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

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

isIterativeCalculationEnabled()

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

הלוך ושוב

Booleantrue אם החישוב החוזר מופעל, 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));

פרמטרים

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

הלוך ושוב

Booleantrue אם השורה מוסתרת, 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));

פרמטרים

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

הלוך ושוב

Booleantrue אם השורה מוסתרת, false אם לא.

הרשאה

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

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

moveActiveSheet(pos)

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

// This example assumes there are two sheets in the current
// active spreadsheet: one named "first", and another named "second",
// and that the current active sheet (first) is in position 1
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var sheet = spreadsheet.getSheetByName("first");

// This should output 'Current index of sheet: 1'
Logger.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// This should output 'New index of sheet: 2'
Logger.log("New index of sheet: %s", sheet.getIndex());

פרמטרים

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

הרשאה

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

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

פרמטרים

שםסוגתיאור
chartEmbeddedChartהתרשים להעברה.

הלוך ושוב

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

הרשאה

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

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

refreshAllDataSources()

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

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

הרשאה

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

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

removeEditor(emailAddress)

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

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

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש להסרה.

הלוך ושוב

SpreadsheetSpreadsheet זה, לשרשור.

הרשאה

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

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

removeEditor(user)

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

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

פרמטרים

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

הלוך ושוב

SpreadsheetSpreadsheet זה, לשרשור.

הרשאה

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

  • 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
}

פרמטרים

שםסוגתיאור
nameStringשם התפריט להסרה.

הרשאה

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

  • 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");

פרמטרים

שםסוגתיאור
nameStringשם הטווח.

הרשאה

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

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

removeViewer(emailAddress)

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

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

פרמטרים

שםסוגתיאור
emailAddressStringכתובת האימייל של המשתמש להסרה.

הלוך ושוב

SpreadsheetSpreadsheet לשרשור.

הרשאה

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

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

removeViewer(user)

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

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

פרמטרים

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

הלוך ושוב

SpreadsheetSpreadsheet לשרשור.

הרשאה

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

  • 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");

פרמטרים

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

הרשאה

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

  • 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");

פרמטרים

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

הרשאה

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

  • 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();

פרמטרים

שםסוגתיאור
rangeRangeהטווח שיש להגדיר כטווח הפעיל.

הלוך ושוב

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

פרמטרים

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

הלוך ושוב

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

פרמטרים

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

הלוך ושוב

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

פרמטרים

שםסוגתיאור
a1NotationStringהטווח שיש להגדיר כפעיל, כפי שצוין בסימון 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]);

פרמטרים

שםסוגתיאור
sheetSheetהגיליון שמוגדר כגיליון הפעיל.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
sheetSheetהגיליון הפעיל החדש.
restoreSelectionBooleanבעמודה '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);

פרמטרים

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

הלוך ושוב

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

פרמטרים

שםסוגתיאור
cellRangeהתא שיוגדר בתא הנוכחי.

הלוך ושוב

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

פרמטרים

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

הרשאה

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

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

פרמטרים

שםסוגתיאור
rowsIntegerמספר השורות שהוקפאו.

הרשאה

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

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

setIterativeCalculationConvergenceThreshold(minThreshold)

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

פרמטרים

שםסוגתיאור
minThresholdNumberסף ההמרה המינימלי (חייב להיות לא שלילי).

הלוך ושוב

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

הרשאה

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

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

setIterativeCalculationEnabled(isEnabled)

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

פרמטרים

שםסוגתיאור
isEnabledBooleantrue אם צריך להפעיל חישוב חוזר; false אחרת.

הלוך ושוב

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

הרשאה

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

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

setMaxIterativeCalculationCycles(maxIterations)

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

פרמטרים

שםסוגתיאור
maxIterationsIntegerהמספר המקסימלי של חזרות חישוב (בין 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());

פרמטרים

שםסוגתיאור
nameStringהשם שנותן את הטווח.
rangeRangeמפרט הטווחים.

הרשאה

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

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

setRecalculationInterval(recalculationInterval)

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

פרמטרים

שםסוגתיאור
recalculationIntervalRecalculationIntervalמרווח החישוב מחדש.

הלוך ושוב

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

פרמטרים

שםסוגתיאור
rowPositionIntegerמיקום השורה לשינוי.
heightIntegerהגובה בפיקסלים כדי להגדיר אותו.

הלוך ושוב

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

הרשאה

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

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

setSpreadsheetLocale(locale)

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

פרמטרים

שםסוגתיאור
localeStringקוד הלוקאל שבו צריך להשתמש (לדוגמה, '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]);

פרמטרים

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

הלוך ושוב

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

הרשאה

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

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

setSpreadsheetTimeZone(timezone)

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

פרמטרים

שםסוגתיאור
timezoneStringאזור הזמן, שצוין בפורמט "long" (לדוגמה, "America/New_York", כפי שמצוין בכתובת Joda.org).

הרשאה

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

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

show(userInterface)

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

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

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

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

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

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

פרמטרים

שםסוגתיאור
userInterfaceObjectHtmlOutput.

הרשאה

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

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

פרמטרים

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

הלוך ושוב

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

פרמטרים

שםסוגתיאור
columnPositionIntegerהעמודה שלפיה יבוצע מיון.
ascendingBooleantrue למיון עולה, 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');

פרמטרים

שםסוגתיאור
msgStringההודעה שתוצג בחלון ההודעה.

הרשאה

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

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

פרמטרים

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

הרשאה

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

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

פרמטרים

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

פרמטרים

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

הרשאה

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

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

פרמטרים

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

הרשאה

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

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

פרמטרים

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

הרשאה

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

פרמטרים

שםסוגתיאור
timeoutInSecondsIntegerזמן ההמתנה לביצוע נתונים, בשניות. האורך המקסימלי הוא 300 שניות.

הרשאה

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

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

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