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