Class DataSourcePivotTable

DataSourcePivotTable

אפשר לגשת לטבלת צירים קיימת של מקור נתונים ולשנות אותה. כדי ליצור טבלת צירים חדשה של מקור נתונים, משתמשים ב-Range.createDataSourcePivotTable(dataSource).

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

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
addColumnGroup(columnName)	PivotGroup	הפונקציה מוסיפה קבוצה חדשה של עמודות ציר על סמך עמודת מקור הנתונים שצוינה.
addFilter(columnName, filterCriteria)	PivotFilter	הפונקציה מוסיפה מסנן חדש על סמך עמודה במקור הנתונים שצוין, עם קריטריוני הסינון שצוינו.
addPivotValue(columnName)	PivotValue	מוסיף ערך חדש בטבלת הצירים על סמך עמודת מקור הנתונים שצוינה, בלי פונקציית סיכום.
addPivotValue(columnName, summarizeFunction)	PivotValue	הפונקציה מוסיפה ערך חדש של PivotTable על סמך העמודה שצוינה במקור הנתונים, עם פונקציית הסיכום שצוינה.
addRowGroup(columnName)	PivotGroup	מוסיף קבוצה חדשה של שורות ציר על סמך העמודה שצוינה במקור הנתונים.
asPivotTable()	PivotTable	הפונקציה מחזירה את טבלת הצירים של מקור הנתונים כאובייקט רגיל של טבלת צירים.
cancelDataRefresh()	DataSourcePivotTable	מבטל את רענון הנתונים שמשויך לאובייקט הזה אם הוא פועל כרגע.
forceRefreshData()	DataSourcePivotTable	מרענן את הנתונים של האובייקט הזה בלי קשר למצב הנוכחי.
getDataSource()	DataSource	מחזירה את מקור הנתונים שאליו האובייקט מקושר.
getStatus()	DataExecutionStatus	מחזירה את סטטוס הפעלת הנתונים של האובייקט.
refreshData()	DataSourcePivotTable	רענון הנתונים של האובייקט.
waitForCompletion(timeoutInSeconds)	DataExecutionStatus	ממתין עד שההרצה הנוכחית מסתיימת, עם זמן קצוב לתפוגה לאחר מספר השניות שצוין.

תיעוד מפורט

addColumnGroup(columnName)

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

פרמטרים

שם	סוג	תיאור
columnName	String	השם של עמודת מקור הנתונים שעליה מבוססת קבוצת הצירים.

חזרה

‫PivotGroup — קבוצת הצירים החדשה.

אישור

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

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

---

addFilter(columnName, filterCriteria)

הפונקציה מוסיפה מסנן חדש על סמך עמודה במקור הנתונים שצוין, עם קריטריוני הסינון שצוינו.

פרמטרים

שם	סוג	תיאור
columnName	String	שם העמודה במקור הנתונים שהמסנן מבוסס עליה.
filterCriteria	FilterCriteria	הקריטריונים שבהם המסנן משתמש.

חזרה

‫PivotFilter – המסנן החדש.

אישור

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

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

---

addPivotValue(columnName)

מוסיף ערך חדש בטבלת הצירים על סמך עמודת מקור הנתונים שצוינה, בלי פונקציית סיכום. רק למדדים ב-Looker.

הקוד הבא מראה איך אפשר להוסיף מדד של Looker כערך ציר.

// TODO(developer): Replace with your spreadsheet ID which has a Looker data
// source.
const spreadsheet = SpreadsheetApp.openById('abcd1234');
const datasource = spreadsheet.getDataSources()[0];
const pivotTable = datasource.createDataSourcePivotTableOnNewSheet();

pivotTable.addPivotValue('columnName');

השיטה הזו זמינה רק למקורות נתונים של Looker.

פרמטרים

שם	סוג	תיאור
columnName	String	השם של עמודת מקור הנתונים שעליה מבוסס ערך הציר.

חזרה

‫PivotValue — ערך הציר החדש.

אישור

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

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

---

addPivotValue(columnName, summarizeFunction)

הפונקציה מוסיפה ערך חדש של PivotTable על סמך העמודה שצוינה במקור הנתונים, עם פונקציית הסיכום שצוינה.

כדי להוסיף ערכי ציר למדדים של Looker, משתמשים בפונקציה addPivotValue(columnName).

פרמטרים

שם	סוג	תיאור
columnName	String	השם של עמודת מקור הנתונים שעליה מבוסס ערך הציר.
summarizeFunction	PivotTableSummarizeFunction	פונקציית הסיכום שבה נעשה שימוש בערך הציר.

חזרה

‫PivotValue — ערך הציר החדש.

אישור

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

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

---

addRowGroup(columnName)

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

פרמטרים

שם	סוג	תיאור
columnName	String	השם של עמודת מקור הנתונים שעליה מבוססת קבוצת הצירים.

חזרה

‫PivotGroup — קבוצת הצירים החדשה.

אישור

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

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

---

asPivotTable()

הפונקציה מחזירה את טבלת הצירים של מקור הנתונים כאובייקט רגיל של טבלת צירים.

חזרה

‫PivotTable – טבלת הצירים.

אישור

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

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

---

cancelDataRefresh()

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

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

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

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

חזרה

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

אישור

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

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

---

forceRefreshData()

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

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

חזרה

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

אישור

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

• 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().

חזרה

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

אישור

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

• 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