Class DataSourcePivotTable

DataSourcePivotTable

เข้าถึงและแก้ไขตาราง Pivot ของแหล่งข้อมูลที่มีอยู่ หากต้องการสร้างตาราง Pivot ของแหล่งข้อมูลใหม่ ให้ใช้ Range.createDataSourcePivotTable(dataSource)

ใช้คลาสนี้กับข้อมูลที่เชื่อมต่อกับฐานข้อมูลเท่านั้น

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
addColumnGroup(columnName)PivotGroupเพิ่มกลุ่มคอลัมน์ Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุ
addFilter(columnName, filterCriteria)PivotFilterเพิ่มตัวกรองใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุพร้อมกับเกณฑ์ตัวกรองที่ระบุ
addPivotValue(columnName)PivotValueเพิ่มค่า Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุโดยไม่มีฟังก์ชันสรุป
addPivotValue(columnName, summarizeFunction)PivotValueเพิ่มค่า Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุด้วยฟังก์ชันสรุปที่ระบุ
addRowGroup(columnName)PivotGroupเพิ่มกลุ่มแถว Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุ
asPivotTable()PivotTableแสดงผลตาราง Pivot ของแหล่งข้อมูลเป็นออบเจ็กต์ตาราง Pivot ปกติ
cancelDataRefresh()DataSourcePivotTableยกเลิกการรีเฟรชข้อมูลที่เชื่อมโยงกับออบเจ็กต์นี้หากกำลังทำงานอยู่
forceRefreshData()DataSourcePivotTableรีเฟรชข้อมูลของออบเจ็กต์นี้โดยไม่คำนึงถึงสถานะปัจจุบัน
getDataSource()DataSourceรับแหล่งข้อมูลที่ออบเจ็กต์ลิงก์อยู่
getStatus()DataExecutionStatusรับสถานะการดำเนินการข้อมูลของออบเจ็กต์
refreshData()DataSourcePivotTableรีเฟรชข้อมูลของออบเจ็กต์
waitForCompletion(timeoutInSeconds)DataExecutionStatusรอจนกว่าการดำเนินการปัจจุบันจะเสร็จสมบูรณ์ โดยจะหมดเวลาหลังจากผ่านไปตามจำนวนวินาทีที่ระบุ

เอกสารโดยละเอียด

addColumnGroup(columnName)

เพิ่มกลุ่มคอลัมน์ Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งข้อมูลที่กลุ่ม Pivot อิงตาม

รีเทิร์น

PivotGroup - กลุ่ม Pivot ใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

addFilter(columnName, filterCriteria)

เพิ่มตัวกรองใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุพร้อมกับเกณฑ์ตัวกรองที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งข้อมูลที่ใช้เป็นพื้นฐานของตัวกรอง
filterCriteriaFilterCriteriaเกณฑ์ที่ตัวกรองใช้

รีเทิร์น

PivotFilter — ตัวกรองใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

addPivotValue(columnName)

เพิ่มค่า Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุโดยไม่มีฟังก์ชันสรุป สำหรับมาตรวัด Looker เท่านั้น

โค้ดต่อไปนี้แสดงวิธีเพิ่มเมตริก Looker เป็นค่า Pivot 

// 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ชื่อคอลัมน์แหล่งข้อมูลที่ค่า Pivot อิงตาม

รีเทิร์น

PivotValue — ค่า Pivot ใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

addPivotValue(columnName, summarizeFunction)

เพิ่มค่า Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุด้วยฟังก์ชันสรุปที่ระบุ

หากต้องการเพิ่มค่า Pivot สำหรับเมตริก Looker ให้ใช้ addPivotValue(columnName)

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งข้อมูลที่ค่า Pivot อิงตาม
summarizeFunctionPivotTableSummarizeFunctionฟังก์ชันสรุปที่ค่า Pivot ใช้

รีเทิร์น

PivotValue — ค่า Pivot ใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

addRowGroup(columnName)

เพิ่มกลุ่มแถว Pivot ใหม่ตามคอลัมน์แหล่งข้อมูลที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งข้อมูลที่กลุ่ม Pivot อิงตาม

รีเทิร์น

PivotGroup - กลุ่ม Pivot ใหม่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

asPivotTable()

แสดงผลตาราง Pivot ของแหล่งข้อมูลเป็นออบเจ็กต์ตาราง Pivot ปกติ

รีเทิร์น

PivotTable — ตาราง Pivot

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

  • 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 — ออบเจ็กต์ข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

forceRefreshData()

รีเฟรชข้อมูลของออบเจ็กต์นี้โดยไม่คำนึงถึงสถานะปัจจุบัน ดูรายละเอียดเพิ่มเติมได้ที่ refreshData() หากต้องการยกเลิกการรีเฟรชออบเจ็กต์นี้ที่กำลังดำเนินการอยู่ โปรดดูcancelDataRefresh()

แสดงข้อยกเว้นหากไม่ได้เปิดใช้ประเภทแหล่งข้อมูล ใช้วิธีการ SpreadsheetApp#enable...Execution() เพื่อเปิดใช้การเรียกใช้ข้อมูลสำหรับแหล่งข้อมูลประเภทใดประเภทหนึ่ง

รีเทิร์น

DataSourcePivotTable — ออบเจ็กต์ข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getDataSource()

รับแหล่งข้อมูลที่ออบเจ็กต์ลิงก์อยู่

รีเทิร์น

DataSource — แหล่งข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getStatus()

รับสถานะการดำเนินการข้อมูลของออบเจ็กต์

รีเทิร์น

DataExecutionStatus — สถานะการเรียกใช้ข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

refreshData()

รีเฟรชข้อมูลของออบเจ็กต์

แสดงข้อยกเว้นหากอยู่ในสถานะ error ใช้ DataSource#updateSpec() เพื่ออัปเดตข้อกำหนด วิธีนี้forceRefreshData()ดีกว่าforceRefreshData()เพื่อป้องกันการแก้ไขแหล่งข้อมูลโดยไม่คาดคิด

แสดงข้อยกเว้นหากไม่ได้เปิดใช้ประเภทแหล่งข้อมูล ใช้วิธีการ SpreadsheetApp#enable...Execution() เพื่อเปิดใช้การเรียกใช้ข้อมูลสำหรับแหล่งข้อมูลประเภทใดประเภทหนึ่ง

รีเทิร์น

DataSourcePivotTable — ออบเจ็กต์ข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

waitForCompletion(timeoutInSeconds)

รอจนกว่าการดำเนินการปัจจุบันจะเสร็จสมบูรณ์ โดยจะหมดเวลาหลังจากผ่านไปตามจำนวนวินาทีที่ระบุ โยนข้อยกเว้นหากการดำเนินการไม่เสร็จสมบูรณ์เมื่อหมดเวลา แต่จะไม่ยกเลิกการดำเนินการข้อมูล

พารามิเตอร์

ชื่อประเภทคำอธิบาย
timeoutInSecondsIntegerเวลาที่รอการดำเนินการข้อมูลเป็นวินาที สูงสุดคือ 300 วินาที

รีเทิร์น

DataExecutionStatus — สถานะการเรียกใช้ข้อมูล

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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