Class DataSourceSheet

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)

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

פרמטרים

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

חזרה

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

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

פרמטרים

שם	סוג	תיאור
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 – רוחב העמודה, או 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 — הגיליון של מקור הנתונים, לשרשור שיטות.

אישור

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

• 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