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

Class DataSourceSheet

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

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

שיטות

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

הרשאות

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

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

`forceRefreshData()`

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

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

החזרות

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

הרשאות

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

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

`removeFilters(columnName)`

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

פרמטרים

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

החזרות

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

הרשאות

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

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