דף זה תורגם על ידי Cloud Translation API.

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`	הפונקציה מחזירה את הרוחב של העמודה שצוינה.
`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().

חזרה

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

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

חזרה

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