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

Class DataSource

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

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

שיטות

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

תיעוד מפורט

`cancelAllLinkedDataSourceObjectRefreshes()`

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

בדוגמה הזו מוסבר איך לבטל את כל העדכונים של מקור נתונים.

SpreadsheetApp.enableBigQueryExecution();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

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

אישור

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

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

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

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

אישור

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

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