Class DataSourceFormula

DataSourceFormula

גישה לנוסחאות קיימות של מקורות נתונים ושינוי שלהן. כדי ליצור נוסחה חדשה של מקור נתונים, משתמשים ב-Range.setFormula(formula).

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

Methods

שיטהסוג הערך המוחזרתיאור קצר
cancelDataRefresh()DataSourceFormulaביטול רענון הנתונים שמשויך לאובייקט הזה, אם הוא פועל כרגע.
forceRefreshData()DataSourceFormulaרענון הנתונים של האובייקט הזה, ללא קשר למצב הנוכחי.
getAnchorCell()Rangeהפונקציה מחזירה את הערך Range שמייצג את התא שאליו הנוסחה של מקור הנתונים הוצמדה.
getDataSource()DataSourceהפונקציה מקבלת את מקור הנתונים שאליו האובייקט מקושר.
getDisplayValue()Stringהפונקציה מחזירה את ערך התצוגה של הנוסחה של מקור הנתונים.
getFormula()Stringהפונקציה מחזירה את הנוסחה של נוסחת מקור הנתונים.
getStatus()DataExecutionStatusהפונקציה מקבלת את סטטוס ביצוע הנתונים של האובייקט.
refreshData()DataSourceFormulaרענון הנתונים של האובייקט.
setFormula(formula)DataSourceFormulaעדכון הנוסחה.
waitForCompletion(timeoutInSeconds)DataExecutionStatusהפונקציה ממתינה עד להשלמת ההרצה הנוכחית, ותוקף הזמן יפוג אחרי מספר השניות שצוין.

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

cancelDataRefresh()

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

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

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

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

חזרה

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

אישור

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

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

forceRefreshData()

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

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

חזרה

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

אישור

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

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

getAnchorCell()

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

חזרה

Range – תא העוגן.

אישור

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

  • 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

getDisplayValue()

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

חזרה

String — הערך המוצג.

אישור

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

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

getFormula()

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

חזרה

String – הנוסחה.

אישור

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

  • 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

refreshData()

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

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

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

חזרה

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

אישור

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

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

setFormula(formula)

עדכון הנוסחה.

פרמטרים

שםסוגתיאור
formulaStringהנוסחה החדשה.

חזרה

DataSourceFormula – הנוסחה של מקור הנתונים, לצורך קישור.

אישור

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

  • 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