דף זה תורגם על ידי Cloud Translation API.

Class DataSourceFormula

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

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

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
`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)`

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

פרמטרים

שם	סוג	תיאור
`formula`	`String`	הנוסחה החדשה.

חזרה

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

אישור

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

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

`waitForCompletion(timeoutInSeconds)`

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

פרמטרים

שם	סוג	תיאור
`timeoutInSeconds`	`Integer`	זמן ההמתנה להפעלת נתונים, בשניות. האורך המקסימלי הוא 300 שניות.

חזרה

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

אישור

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

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