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[]	הפונקציה מחזירה את כל הערכים של גיליון מקור הנתונים עבור שם העמודה שצוין, החל משורת ההתחלה שצוינה (based-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 אם העמודה משתמשת ברוחב ברירת המחדל.

אישור

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

• 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