เข้าถึงและแก้ไขแผนภูมิแหล่งข้อมูลที่มีอยู่
ใช้คลาสนี้กับข้อมูลที่เชื่อมต่อกับฐานข้อมูล 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 — ออบเจ็กต์ข้อมูล
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
รีเฟรชข้อมูลของออบเจ็กต์นี้โดยไม่คำนึงถึงสถานะปัจจุบัน ดู refreshData() สำหรับ
รายละเอียดเพิ่มเติม หากต้องการยกเลิกการรีเฟรชออบเจ็กต์นี้ที่กำลังทำงานอยู่ โปรดดู cancelDataRefresh()
มีข้อยกเว้นหากไม่ได้เปิดใช้ประเภทแหล่งข้อมูล ใช้เมธอด SpreadsheetApp#enable...Execution() เพื่อเปิดการเรียกใช้ข้อมูลจากแหล่งข้อมูลที่เฉพาะเจาะจง
ประเภท
รีเทิร์น
DataSourceChart — ออบเจ็กต์ข้อมูล
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 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() เพื่อป้องกันการแก้ไขแหล่งข้อมูลที่ไม่คาดคิด
แสดงข้อยกเว้นหากไม่ได้เปิดใช้ประเภทแหล่งข้อมูล ใช้เมธอด SpreadsheetApp#enable...Execution() เพื่อเปิดการเรียกใช้ข้อมูลจากแหล่งข้อมูลประเภทที่เฉพาะเจาะจง
รีเทิร์น
DataSourceChart — ออบเจ็กต์ข้อมูล
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับอนุญาตด้วยขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
รอจนกว่าการดำเนินการปัจจุบันจะเสร็จสมบูรณ์ โดยระบบจะหมดเวลาหลังจากผ่านไปตามจำนวนวินาทีที่ระบุ จะมีข้อยกเว้นหากการดำเนินการไม่เสร็จสมบูรณ์เมื่อหมดเวลา แต่จะไม่ยกเลิก การดำเนินการกับข้อมูล
พารามิเตอร์
| ชื่อ | ประเภท | คำอธิบาย |
|---|---|---|
timeoutInSeconds | Integer | เวลาที่รอการเรียกใช้ข้อมูลเป็นวินาที สูงสุด 300 วินาที |
รีเทิร์น
DataExecutionStatus — สถานะการดำเนินการกับข้อมูล
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets