Class DataSourceSheet

DataSourceSheet

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

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
addFilter(columnName, filterCriteria)	DataSourceSheet	הוספת מסנן שהוחל על הגיליון של מקור הנתונים.
asSheet()	Sheet	מחזירה את הגיליון של מקור הנתונים כאובייקט של גיליון רגיל.
autoResizeColumn(columnName)	DataSourceSheet	משנה באופן אוטומטי את רוחב העמודה שצוינה.
autoResizeColumns(columnNames)	DataSourceSheet	שינוי אוטומטי של רוחב העמודות שצוינו.
cancelDataRefresh()	DataSourceSheet	מבטל את רענון הנתונים המשויך לאובייקט הזה אם הוא פועל עכשיו.
forceRefreshData()	DataSourceSheet	רענון הנתונים של האובייקט הזה ללא קשר למצב הנוכחי.
getColumnWidth(columnName)	Integer	מחזירה את הרוחב של העמודה שצוינה.
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)

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

פרמטרים

שם	סוג	תיאור
columnName	String	שם העמודה שעליה יש להחיל את המסנן הזה.
filterCriteria	FilterCriteria	הקריטריונים לסינון.

החזרות

DataSourceSheet – הגיליון של מקור הנתונים, לשרשור שיטות (method).

אישור

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

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

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

פרמטרים

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

החזרות

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

אישור

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

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

---

autoResizeColumns(columnNames)

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

פרמטרים

שם	סוג	תיאור
columnNames	String[]	רשימת שמות העמודות שצריך לעדכן.

החזרות

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)

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

פרמטרים

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

החזרות

Integer — רוחב העמודה, או 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)

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

פרמטרים

שם	סוג	תיאור
columnName	String	שם העמודה של מקור הנתונים שצריך לאחזר את הערכים שלה.

החזרות

Object[] - מערך ערכים חד-ממדי.

אישור

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

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

---

getSheetValues(columnName, startRow, numRows)

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

פרמטרים

שם	סוג	תיאור
columnName	String	שם העמודה של מקור הנתונים שצריך לאחזר את הערכים שלה.
startRow	Integer	המיקום של השורה שממנו יש להתחיל לאחזר ערכים.
numRows	Integer	מספר השורות שיש לאחזר.

החזרות

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)

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

פרמטרים

שם	סוג	תיאור
columnName	String	שם העמודה שממנה מסירים מסננים.

החזרות

DataSourceSheet – הגיליון של מקור הנתונים, לשרשור שיטות (method).

אישור

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

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

---

removeSortSpec(columnName)

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

פרמטרים

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

החזרות

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

אישור

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

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

---

setColumnWidth(columnName, width)

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

פרמטרים

שם	סוג	תיאור
columnName	String	שם העמודה.
width	Integer	הרוחב החדש של העמודה.

החזרות

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

אישור

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

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

---

setColumnWidths(columnNames, width)

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

פרמטרים

שם	סוג	תיאור
columnNames	String[]	רשימת שמות העמודות שצריך לעדכן.
width	Integer	הרוחב החדש של העמודות.

החזרות

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

אישור

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

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

---

setSortSpec(columnName, ascending)

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

פרמטרים

שם	סוג	תיאור
columnName	String	שם העמודה שצריך למיין.
ascending	Boolean	אם העמודה true, למיין את העמודה בסדר עולה, ואם הערך הוא false, היא צריכה למיין בסדר יורד.

החזרות

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

אישור

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

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

---

setSortSpec(columnName, sortOrder)

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

פרמטרים

שם	סוג	תיאור
columnName	String	שם העמודה שצריך למיין.
sortOrder	SortOrder	סדר המיון.

החזרות

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

אישור

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

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

---

waitForCompletion(timeoutInSeconds)

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

פרמטרים

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

החזרות

DataExecutionStatus – סטטוס ביצוע הנתונים.

אישור

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

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