דף זה תורגם על ידי 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();

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

אישור

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

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

`createCalculatedColumn(name, formula)`

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

פרמטרים

שם	סוג	תיאור
`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()`

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

השיטה הזו זמינה רק למקורות נתונים של BigQuery.

חזרה

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

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

מפרטי מקורות נתונים מסוג DataSourceType.LOOKER מחזירים מערך ריק.

חזרה

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

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

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