Class DataSource

DataSource

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

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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
cancelAllLinkedDataSourceObjectRefreshes()voidמבטל את כל הרענונים שפועלים כרגע של אובייקטים במקור הנתונים שמקושרים למקור הנתונים הזה.
createCalculatedColumn(name, formula)DataSourceColumnיוצרת עמודה מחושבת.
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableיוצר טבלת צירים של מקור הנתונים הזה בתא הראשון של גיליון חדש.
createDataSourceTableOnNewSheet()DataSourceTableיוצר טבלת מקור נתונים ממקור הנתונים הזה בתא הראשון של גיליון חדש.
getCalculatedColumnByName(columnName)DataSourceColumn|nullהפונקציה מחזירה את העמודה המחושבת במקור הנתונים שתואמת לשם העמודה.
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.

פרמטרים

שםסוגתיאור
nameStringהשם של העמודה המחושבת.
formulaStringהנוסחה של העמודה המחושבת.

חזרה

‫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)

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

פרמטרים

שםסוגתיאור
columnNameStringהשם של העמודה המכילה חישוב שרוצים לאחזר.

חזרה

‫DataSourceColumn|null — העמודה המחושבת שתואמת לשם העמודה, או 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().

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

פרמטרים

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

חזרה

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

אישור

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

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

updateSpec(spec, refreshAllLinkedObjects)

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

פרמטרים

שםסוגתיאור
timeoutInSecondsIntegerהזמן להמתנה להפעלת הנתונים, בשניות. הערך המקסימלי הוא 300 שניות.

אישור

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

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