Class DataSourceFormula

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

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

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

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

forceRefreshData()

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

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

รีเทิร์น

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

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

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

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

getAnchorCell()

แสดงผล Range ที่แสดงเซลล์ที่ยึดสูตรแหล่งข้อมูลนี้ไว้

รีเทิร์น

Range — เซลล์หลัก

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

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 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

getDisplayValue()

แสดงผลค่าที่แสดงของสูตรแหล่งข้อมูล

รีเทิร์น

String — ค่าที่แสดง

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

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

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

getFormula()

แสดงผลสูตรสำหรับสูตรแหล่งข้อมูลนี้

รีเทิร์น

String — สูตร

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

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 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() เพื่อเปิดใช้การเรียกใช้ข้อมูลสำหรับแหล่งข้อมูลประเภทใดประเภทหนึ่ง

รีเทิร์น

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

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

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

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

setFormula(formula)

อัปเดตสูตร

พารามิเตอร์

ชื่อประเภทคำอธิบาย
formulaStringสูตรใหม่

รีเทิร์น

DataSourceFormula - สูตรแหล่งข้อมูลสำหรับการเชื่อมโยง

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

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 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