Class DataSourceSheet

נתוניםמקורגיליון

גישה לגיליון של מקור נתונים קיים ושינוי שלו. כדי ליצור גיליון חדש של מקור נתונים, משתמשים ב-Spreadsheet.insertDataSourceSheet(spec).

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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
addFilter(columnName, filterCriteria)DataSourceSheetמוסיף מסנן שמוחל על הגיליון של מקור הנתונים.
asSheet()Sheetהפונקציה מחזירה את הגיליון של מקור הנתונים כאובייקט גיליון רגיל.
autoResizeColumn(columnName)DataSourceSheetמשנה אוטומטית את רוחב העמודה שצוינה.
autoResizeColumns(columnNames)DataSourceSheetמשנה אוטומטית את רוחב העמודות שצוינו.
cancelDataRefresh()DataSourceSheetמבטל את רענון הנתונים שמשויך לאובייקט הזה אם הוא פועל כרגע.
forceRefreshData()DataSourceSheetרענון הנתונים של האובייקט הזה בלי קשר למצב הנוכחי.
getColumnWidth(columnName)Integer|nullהפונקציה מחזירה את הרוחב של העמודה שצוינה.
getDataSource()DataSourceמחזירה את מקור הנתונים שאליו האובייקט מקושר.
getFilters()DataSourceSheetFilter[]הפונקציה מחזירה את כל המסננים שהוחלו על הגיליון של מקור הנתונים.
getSheetValues(columnName)Object[]הפונקציה מחזירה את כל הערכים בגיליון של מקור הנתונים עבור שם העמודה שצוין.
getSheetValues(columnName, startRow, numRows)Object[]מחזירה את כל הערכים של גיליון מקור הנתונים עבור שם העמודה שצוין, החל משורת ההתחלה שצוינה (מבוסס-1) ועד numRows שצוין.
getSortSpecs()SortSpec[]מקבל את כל מפרטי המיון בגיליון מקור הנתונים.
getStatus()DataExecutionStatusמקבל את סטטוס הפעלת הנתונים של האובייקט.
refreshData()DataSourceSheetרענון הנתונים של האובייקט.
removeFilters(columnName)DataSourceSheetמסיר את כל המסננים שהוחלו על העמודה בגיליון של מקור הנתונים.
removeSortSpec(columnName)DataSourceSheetמסירה את הגדרת המיון בעמודה בגיליון של מקור הנתונים.
setColumnWidth(columnName, width)DataSourceSheetהגדרת הרוחב של העמודה שצוינה.
setColumnWidths(columnNames, width)DataSourceSheetהגדרת הרוחב של העמודות שצוינו.
setSortSpec(columnName, ascending)DataSourceSheetהגדרת מפרט המיון בעמודה בגיליון של מקור הנתונים.
setSortSpec(columnName, sortOrder)DataSourceSheetהגדרת מפרט המיון בעמודה בגיליון של מקור הנתונים.
waitForCompletion(timeoutInSeconds)DataExecutionStatusהפונקציה ממתינה עד שההרצה הנוכחית מסתיימת, ואז יוצאת אחרי מספר השניות שצוין.

תיעוד מפורט

addFilter(columnName, filterCriteria)

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

פרמטרים

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

חזרה

‫DataSourceSheet — הגיליון של מקור הנתונים, לשרשור שיטות.

אישור

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

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

asSheet()

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

חזרה

‫Sheet — הגיליון הרגיל.

אישור

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

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

autoResizeColumn(columnName)

משנה אוטומטית את רוחב העמודה שצוינה.

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה.

חזרה

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

אישור

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

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

autoResizeColumns(columnNames)

משנה אוטומטית את רוחב העמודות שצוינו.

פרמטרים

שםסוגתיאור
columnNamesString[]רשימת שמות העמודות לעדכון.

חזרה

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

אישור

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

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

cancelDataRefresh()

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

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

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

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

חזרה

‫DataSourceSheet – אובייקט הנתונים.

אישור

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

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

forceRefreshData()

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

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

חזרה

‫DataSourceSheet – אובייקט הנתונים.

אישור

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

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

getColumnWidth(columnName)

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

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה.

חזרה

‫Integer|null – רוחב העמודה, או null אם העמודה משתמשת ברוחב ברירת המחדל.

אישור

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

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

getDataSource()

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

חזרה

‫DataSource — מקור הנתונים.

אישור

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

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

getFilters()

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

חזרה

‫DataSourceSheetFilter[] — מערך של כל המסננים שהוחלו על גיליון מקור הנתונים.

אישור

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

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

getSheetValues(columnName)

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

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה במקור הנתונים שממנה יאוחזרו הערכים.

חזרה

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

אישור

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

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

getSheetValues(columnName, startRow, numRows)

מחזירה את כל הערכים של גיליון מקור הנתונים עבור שם העמודה שצוין, החל משורת ההתחלה שצוינה (מבוסס-1) ועד numRows שצוין.

פרמטרים

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

חזרה

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

אישור

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

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

getSortSpecs()

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

חזרה

‫SortSpec[] — רשימה של מפרטי מיון.

אישור

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

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

getStatus()

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

חזרה

‫DataExecutionStatus — הסטטוס של הפעלת הנתונים.

אישור

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

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

refreshData()

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

גורם לחריגה אם המצב הנוכחי הוא error. משתמשים ב-DataSource#updateSpec() כדי לעדכן את המפרט. השיטה הזו עדיפה על forceRefreshData() כדי למנוע עריכות לא צפויות במקור הנתונים.

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

חזרה

‫DataSourceSheet – אובייקט הנתונים.

אישור

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

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

removeFilters(columnName)

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

פרמטרים

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

חזרה

‫DataSourceSheet — הגיליון של מקור הנתונים, לשרשור שיטות.

אישור

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

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

removeSortSpec(columnName)

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

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה.

חזרה

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

אישור

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

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

setColumnWidth(columnName, width)

הגדרת הרוחב של העמודה שצוינה.

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה.
widthIntegerהרוחב החדש של העמודה.

חזרה

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

אישור

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

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

setColumnWidths(columnNames, width)

הגדרת הרוחב של העמודות שצוינו.

פרמטרים

שםסוגתיאור
columnNamesString[]רשימת שמות העמודות לעדכון.
widthIntegerהרוחב החדש של העמודות.

חזרה

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

אישור

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

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

setSortSpec(columnName, ascending)

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

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה שלפיה יתבצע המיון.
ascendingBooleanאם מופיע true, ממיינים את העמודה בסדר עולה. אם מופיע false, ממיינים את העמודה בסדר יורד.

חזרה

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

אישור

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

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

setSortSpec(columnName, sortOrder)

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

פרמטרים

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

חזרה

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

אישור

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

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

waitForCompletion(timeoutInSeconds)

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

פרמטרים

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

חזרה

‫DataExecutionStatus — הסטטוס של הפעלת הנתונים.

אישור

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

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