Class DataSourcePivotTable

טבלתציריםשלמקורנתונים

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

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

Methods

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

מסמכים מפורטים

addColumnGroup(columnName)

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

פרמטרים

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

חזרה

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

אישור

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

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

addFilter(columnName, filterCriteria)

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

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה של מקור הנתונים שעליו מבוסס המסנן.
filterCriteriaFilterCriteriaהקריטריונים שבהם נעשה שימוש במסנן.

חזרה

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.

פרמטרים

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

חזרה

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

אישור

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

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

addPivotValue(columnName, summarizeFunction)

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

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

פרמטרים

שםסוגתיאור
columnNameStringשם העמודה של מקור הנתונים שעליו מבוסס ערך הציר.
summarizeFunctionPivotTableSummarizeFunctionפונקציית הסיכום שבה נעשה שימוש בערך הציר.

חזרה

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

אישור

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

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

addRowGroup(columnName)

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

פרמטרים

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

חזרה

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)

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

פרמטרים

שםסוגתיאור
timeoutInSecondsIntegerמשך ההמתנה להפעלת הנתונים, בשניות. האורך המקסימלי הוא 300 שניות.

חזרה

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

אישור

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

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