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

Class DataSource

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

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

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
`createCalculatedColumn(name, formula)`	`DataSourceColumn`	יוצרת עמודה מחושבת.
`createDataSourcePivotTableOnNewSheet()`	`DataSourcePivotTable`	יצירת טבלת צירים של מקור נתונים ממקור הנתונים הזה בתא הראשון בגיליון חדש.
`createDataSourceTableOnNewSheet()`	`DataSourceTable`	יוצרת טבלה של מקור נתונים ממקור הנתונים הזה, בתא הראשון בגיליון חדש.
`getCalculatedColumnByName(columnName)`	`DataSourceColumn`	מחזירה את העמודה המחושבת במקור הנתונים שתואמת לשם העמודה.
`getCalculatedColumns()`	`DataSourceColumn[]`	מחזירה את כל העמודות המחושבות במקור הנתונים.
`getColumns()`	`DataSourceColumn[]`	מחזירה את כל העמודות במקור הנתונים.
`getDataSourceSheets()`	`DataSourceSheet[]`	הפונקציה מחזירה את הגיליונות של מקור הנתונים שמשויכים למקור הנתונים הזה.
`getSpec()`	`DataSourceSpec`	הפונקציה מקבלת את המפרט של מקור הנתונים.
`refreshAllLinkedDataSourceObjects()`	`void`	יתבצע רענון של כל האובייקטים של מקור הנתונים שמקושרים למקור הנתונים.
`updateSpec(spec)`	`DataSource`	עדכון המפרט של מקור הנתונים מתבצע רענון של האובייקטים של מקור הנתונים שמקושרים למקור הנתונים הזה בהתאם למפרט החדש.
`updateSpec(spec, refreshAllLinkedObjects)`	`DataSource`	עדכון המפרט של מקור הנתונים ירענן את `data source sheets` המקושר עם המפרט החדש.
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	בהמתנה עד שכל ההפעלות הנוכחיות של האובייקטים המקושרים של מקור הנתונים יושלמו, והזמן הזה יסתיים אחרי מספר השניות שצוין.

תיעוד מפורט

`createCalculatedColumn(name, formula)`

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

פרמטרים

שם	תיאור	התיאור
`name`	`String`	השם של העמודה המחושבת.
`formula`	`String`	הנוסחה של העמודה המחושבת.

החזרות

DataSourceColumn – העמודה המחושבת החדשה שנוצרה.

הרשאות

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

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

`createDataSourcePivotTableOnNewSheet()`

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

החזרות

DataSourcePivotTable - טבלת הצירים החדשה של מקור הנתונים.

הרשאות

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

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

`createDataSourceTableOnNewSheet()`

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

החזרות

DataSourceTable - הטבלה החדשה של מקור הנתונים שנוצרה.

הרשאות

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

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

`getCalculatedColumnByName(columnName)`

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

פרמטרים

שם	תיאור	התיאור
`columnName`	`String`	השם של העמודה המחושבת שרוצים לקבל.

החזרות

DataSourceColumn – העמודה המחושבת שתואמת לשם העמודה. אם אין עמודה מחושבת כזו, הערך null.

הרשאות

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

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

`getCalculatedColumns()`

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

החזרות

DataSourceColumn[] – מערך של כל העמודות המחושבות במקור הנתונים.

הרשאות

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

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

`getColumns()`

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

החזרות

DataSourceColumn[] – מערך של כל DataSourceColumn במקור הנתונים.

הרשאות

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

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

`getDataSourceSheets()`

הפונקציה מחזירה את הגיליונות של מקור הנתונים שמשויכים למקור הנתונים הזה.

החזרות

DataSourceSheet[] – מערך של גיליונות של מקור נתונים.

הרשאות

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

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

`getSpec()`

הפונקציה מקבלת את המפרט של מקור הנתונים.

החזרות

DataSourceSpec – המפרט של מקור הנתונים.

הרשאות

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

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

`refreshAllLinkedDataSourceObjects()`

יתבצע רענון של כל האובייקטים של מקור הנתונים שמקושרים למקור הנתונים.

מציג חריגה אם סוג מקור הנתונים לא מופעל. משתמשים בשיטות SpreadsheetApp#enable...Execution() כדי לאפשר ביצוע נתונים מהסוג הספציפי של מקור הנתונים.

הרשאות

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

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

`updateSpec(spec)`

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

פרמטרים

שם	תיאור	התיאור
`spec`	`DataSourceSpec`	מפרט מקור הנתונים לעדכון.

החזרות

DataSource – מקור הנתונים.

הרשאות

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

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

`updateSpec(spec, refreshAllLinkedObjects)`

עדכון המפרט של מקור הנתונים ירענן את data source sheets המקושר עם המפרט החדש.

פרמטרים

שם	תיאור	התיאור
`spec`	`DataSourceSpec`	מפרט מקור הנתונים לעדכון.
`refreshAllLinkedObjects`	`Boolean`	אם נבחר הערך `true`, יתבצע גם רענון של כל האובייקטים של מקור הנתונים שמקושרים למקור הנתונים הזה.

החזרות

DataSource – מקור הנתונים.

הרשאות

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

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

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

פרמטרים

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

הרשאות

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

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