Class DataSourceTable

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|nullהפונקציה מחזירה את מגבלת השורות של טבלת מקור הנתונים.
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 – מגבלת השורות בטבלה של מקור הנתונים, או 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