לגשת לתרשים קיים של מקור נתונים ולשנות אותו.
יש להשתמש בכיתה הזו רק עם נתונים שמקושרים למסד נתונים של BigQuery.
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
cancelDataRefresh() | DataSourceChart | ביטול רענון הנתונים שמשויך לאובייקט הזה, אם הוא פועל כרגע. |
forceRefreshData() | DataSourceChart | רענון הנתונים של האובייקט הזה, ללא קשר למצב הנוכחי. |
getDataSource() | DataSource | הפונקציה מקבלת את מקור הנתונים שאליו האובייקט מקושר. |
getStatus() | DataExecutionStatus | הפונקציה מקבלת את סטטוס ביצוע הנתונים של האובייקט. |
refreshData() | DataSourceChart | רענון של נתוני האובייקט. |
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()
.
חזרה
DataSourceChart
– אובייקט הנתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
רענון הנתונים של האובייקט הזה, ללא קשר למצב הנוכחי. הצגת refreshData()
ל-
פרטים נוספים. כדי לבטל את הרענון של האובייקט הזה, עיינו במאמר cancelDataRefresh()
.
מחריגה חריג אם הסוג של מקור הנתונים לא מופעל. כדי להפעיל נתונים במקור נתונים ספציפי, צריך להשתמש ב-methods SpreadsheetApp#enable...Execution()
מהסוג הזה.
חזרה
DataSourceChart
– אובייקט הנתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
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
getStatus()
הפונקציה מקבלת את סטטוס ביצוע הנתונים של האובייקט.
חזרה
DataExecutionStatus
– סטטוס הפעלת הנתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו צריכים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
רענון של נתוני האובייקט.
גורמת להשלכת חריגה אם המצב הנוכחי הוא error
. משתמשים ב-DataSource#updateSpec()
כדי לעדכן את המפרט. השיטה היא
העדפה על forceRefreshData()
כדי למנוע עריכות לא צפויות במקור הנתונים.
מחריגה חריג אם הסוג של מקור הנתונים לא מופעל. כדי להפעיל נתונים במקור נתונים ספציפי, צריך להשתמש בשיטות SpreadsheetApp#enable...Execution()
מהסוג הזה.
חזרה
DataSourceChart
– אובייקט הנתונים.
אישור
סקריפטים שמשתמשים בשיטה הזו צריכים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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