Class DataSource

מקורנתונים

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

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

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
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 spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
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)

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

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

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

אישור

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

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

---

updateSpec(spec)

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

---

updateSpec(spec, refreshAllLinkedObjects)

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

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

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

פרמטרים

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