Class DataSourceTable

טבלתמקורנתונים

גישה ושינוי של טבלה קיימת של מקור נתונים. כדי ליצור טבלה חדשה של מקור נתונים בגיליון חדש, משתמשים ב-Spreadsheet.insertSheetWithDataSourceTable(spec).

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

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

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActive();
const spec = SpreadsheetApp.newDataSourceSpec()
                 .asBigQuery()
                 .setProjectId('big_query_project')
                 .setRawQuery('select @FIELD from table limit @LIMIT')
                 .setParameterFromCell('FIELD', 'Sheet1!A1')
                 .setParameterFromCell('LIMIT', 'namedRangeCell')
                 .build();
// Starts data execution asynchronously.
const dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec);
const dataSourceTable = dataSheet.getDataSourceTables()[0];
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log(
    'Data execution state: %s.',
    dataSourceTable.getStatus().getExecutionState(),
);

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

SpreadsheetApp.enableBigQueryExecution();
const dataSheet = SpreadsheetApp.getActive().getSheetByName('Data Sheet 1');
const dataSourceTable = dataSheet.getDataSourceTables()[0];
const dataSource = dataSourceTable.getDataSource();
const newSpec = dataSource.getSpec()
                    .copy()
                    .asBigQuery()
                    .setRawQuery('select name from table limit 2')
                    .removeAllParameters()
                    .build();
// Updates data source specification and starts data execution asynchronously.
dataSource.updateSpec(newSpec);
// Check status during execution.
Logger.log(
    'Data execution state: %s.',
    dataSourceTable.getStatus().getExecutionState(),
);
// waitForCompletion() blocks script execution until data execution completes.
dataSourceTable.waitForCompletion(60);
// Check status after execution.
Logger.log(
    'Data execution state: %s.',
    dataSourceTable.getStatus().getExecutionState(),
);

Methods

שיטהסוג הערך המוחזרתיאור קצר
addColumns(columnNames)DataSourceTableהוספת עמודות לטבלה של מקור הנתונים.
addFilter(columnName, filterCriteria)DataSourceTableהוספת מסנן לטבלה של מקור הנתונים.
addSortSpec(columnName, ascending)DataSourceTableהוספת מפרט מיון לעמודה בטבלה של מקור הנתונים.
addSortSpec(columnName, sortOrder)DataSourceTableהוספת מפרט מיון לעמודה בטבלה של מקור הנתונים.
cancelDataRefresh()DataSourceTableביטול רענון הנתונים שמשויך לאובייקט הזה, אם הוא פועל כרגע.
forceRefreshData()DataSourceTableרענון הנתונים של האובייקט הזה, ללא קשר למצב הנוכחי.
getColumns()DataSourceTableColumn[]הפונקציה מקבלת את כל העמודות של מקור הנתונים שנוספו לטבלה של מקור הנתונים.
getDataSource()DataSourceהפונקציה מקבלת את מקור הנתונים שאליו האובייקט מקושר.
getFilters()DataSourceTableFilter[]הפונקציה מחזירה את כל המסננים שהוחלו על טבלת מקור הנתונים.
getRange()Rangeהפונקציה מקבלת את Range שבו הטבלה של מקור הנתונים הזו משתרעת.
getRowLimit()Integerהפונקציה מחזירה את מגבלת השורות של טבלת מקור הנתונים.
getSortSpecs()SortSpec[]הפונקציה מקבלת את כל מפרטי המיון בטבלה של מקור הנתונים.
getStatus()DataExecutionStatusהפונקציה מקבלת את סטטוס ביצוע הנתונים של האובייקט.
isSyncingAllColumns()Booleanהפונקציה מחזירה אם הטבלה של מקור הנתונים מסנכרנת את כל העמודות במקור הנתונים המשויך.
refreshData()DataSourceTableרענון הנתונים של האובייקט.
removeAllColumns()DataSourceTableהסרת כל העמודות בטבלה של מקור הנתונים.
removeAllSortSpecs()DataSourceTableהסרת כל מפרטי המיון בטבלה של מקור הנתונים.
setRowLimit(rowLimit)DataSourceTableעדכון מגבלת השורות בטבלה של מקור הנתונים.
syncAllColumns()DataSourceTableסנכרון של כל העמודות הנוכחיות והעתידיות במקור הנתונים המשויך לטבלת מקור הנתונים.
waitForCompletion(timeoutInSeconds)DataExecutionStatusהפונקציה ממתינה עד להשלמת ההרצה הנוכחית, ותוקף הזמן יפוג אחרי מספר השניות שצוין.

מסמכים מפורטים

addColumns(columnNames)

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

פרמטרים

שםסוגתיאור
columnNamesString[]רשימת השמות של העמודות שרוצים להוסיף.

חזרה

DataSourceTable – טבלת מקור הנתונים, לצורך קישור.

אישור

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

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

addFilter(columnName, filterCriteria)

הוספת מסנן לטבלה של מקור הנתונים.

פרמטרים

שםסוגתיאור
columnNameStringהשם של העמודה שעליו יחול המסנן הזה.
filterCriteriaFilterCriteriaקריטריוני הסינון שיחולו.

חזרה

DataSourceTable – טבלת מקור הנתונים, לצורך קישור.

אישור

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

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

addSortSpec(columnName, ascending)

הוספת מפרט מיון לעמודה בטבלה של מקור הנתונים.

פרמטרים

שםסוגתיאור
columnNameStringהשם של העמודה למיון.
ascendingBooleanאם הערך הוא true, העמודה ממוינת בסדר עולה. אם הערך הוא false, העמודה ממוינת בסדר יורד.

חזרה

DataSourceTable – הגיליון של מקור הנתונים, לצורך קישור.

אישור

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

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

addSortSpec(columnName, sortOrder)

הוספת מפרט מיון לעמודה בטבלה של מקור הנתונים.

פרמטרים

שםסוגתיאור
columnNameStringהשם של העמודה למיון.
sortOrderSortOrderסדר המיון.

חזרה

DataSourceTable – הגיליון של מקור הנתונים, לצורך קישור.

אישור

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

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

cancelDataRefresh()

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

בדוגמה הזו מוסבר איך לבטל רענון של נוסחה. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

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

חזרה

DataSourceTable – אובייקט הנתונים.

אישור

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

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

forceRefreshData()

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

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

חזרה

DataSourceTable – אובייקט הנתונים.

אישור

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

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

getColumns()

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

חזרה

DataSourceTableColumn[] – רשימה של עמודות בטבלה של מקור הנתונים.

אישור

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

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

getDataSource()

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

חזרה

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

אישור

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

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

getFilters()

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

חזרה

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

אישור

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

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

getRange()

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

חזרה

Range — הטווח.

אישור

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

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

getRowLimit()

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

חזרה

Integer – מגבלת השורות בטבלה של מקור הנתונים, או null אם לא הוגדרה מגבלה והטבלה משתמשת במגבלת ברירת המחדל כמו בממשק המשתמש של Google Sheets.

אישור

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

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

getSortSpecs()

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

חזרה

SortSpec[] – רשימה של מפרטי מיון.

אישור

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

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

getStatus()

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

חזרה

DataExecutionStatus – סטטוס הפעלת הנתונים.

אישור

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

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

isSyncingAllColumns()

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

חזרה

Boolean — True אם טבלת מקור הנתונים מסנכרנת את כל העמודות במקור הנתונים המשויך, או false במקרה אחר.

אישור

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

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

refreshData()

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

גורמת להשלכת חריגה אם המצב הנוכחי הוא error. משתמשים ב-DataSource#updateSpec() כדי לעדכן את המפרט. מומלץ להשתמש בשיטה הזו במקום ב-forceRefreshData() כדי למנוע עריכות לא צפויות במקור הנתונים.

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

חזרה

DataSourceTable – אובייקט הנתונים.

אישור

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

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

removeAllColumns()

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

חזרה

DataSourceTable – טבלת מקור הנתונים, לצורך קישור.

אישור

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

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

removeAllSortSpecs()

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

חזרה

DataSourceTable – הגיליון של מקור הנתונים, לצורך קישור.

אישור

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

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

setRowLimit(rowLimit)

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

פרמטרים

שםסוגתיאור
rowLimitIntegerמגבלת השורות החדשה של טבלת הנתונים. אם הערך הוא null, הטבלה תתעדכן כך שתשתמש במגבלת השורות שמוגדרת כברירת מחדל.

חזרה

DataSourceTable – טבלת מקור הנתונים, לצורך קישור.

אישור

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

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

syncAllColumns()

סנכרון של כל העמודות הנוכחיות והעתידיות במקור הנתונים המשויך לטבלת מקור הנתונים.

חזרה

DataSourceTable – טבלת מקור הנתונים, לצורך קישור.

אישור

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

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

waitForCompletion(timeoutInSeconds)

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

פרמטרים

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

חזרה

DataExecutionStatus – סטטוס הפעלת הנתונים.

אישור

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

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