Class DataSourceFormula

DataSourceFormula

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

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

שיטות

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

תיעוד מפורט

forceRefreshData()

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

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