เข้าถึงและแก้ไขชีตแหล่งข้อมูลที่มีอยู่ หากต้องการสร้างชีตแหล่งข้อมูลใหม่ ให้ใช้ Spreadsheet.insertDataSourceSheet(spec)
ใช้คลาสนี้กับข้อมูลที่เชื่อมต่อกับฐานข้อมูลเท่านั้น
วิธีการ
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | เพิ่มตัวกรองที่ใช้กับชีตแหล่งข้อมูล |
asSheet() | Sheet | แสดงผลชีตแหล่งข้อมูลเป็นออบเจ็กต์ชีตปกติ |
autoResizeColumn(columnName) | DataSourceSheet | ปรับขนาดความกว้างของคอลัมน์ที่ระบุโดยอัตโนมัติ |
autoResizeColumns(columnNames) | DataSourceSheet | ปรับขนาดความกว้างของคอลัมน์ที่ระบุโดยอัตโนมัติ |
cancelDataRefresh() | DataSourceSheet | ยกเลิกการรีเฟรชข้อมูลที่เชื่อมโยงกับออบเจ็กต์นี้หากยังทำงานอยู่ |
forceRefreshData() | DataSourceSheet | รีเฟรชข้อมูลของออบเจ็กต์นี้โดยไม่คำนึงถึงสถานะปัจจุบันของ |
getColumnWidth(columnName) | Integer | แสดงผลความกว้างของคอลัมน์ที่ระบุ |
getDataSource() | DataSource | รับแหล่งข้อมูลที่ออบเจ็กต์ลิงก์อยู่ |
getFilters() | DataSourceSheetFilter[] | แสดงผลตัวกรองทั้งหมดที่ใช้กับชีตแหล่งข้อมูล |
getSheetValues(columnName) | Object[] | แสดงค่าทั้งหมดของชีตแหล่งข้อมูลสําหรับชื่อคอลัมน์ที่ระบุ |
getSheetValues(columnName, startRow, numRows) | Object[] | แสดงค่าทั้งหมดของชีตแหล่งข้อมูลสำหรับชื่อคอลัมน์ที่ระบุจากแถวเริ่มต้นที่ระบุ (อิงตาม 1) จนถึง numRows ที่ระบุ |
getSortSpecs() | SortSpec[] | รับข้อกำหนดในการจัดเรียงทั้งหมดในชีตแหล่งข้อมูล |
getStatus() | DataExecutionStatus | รับสถานะการเรียกใช้ข้อมูลของออบเจ็กต์ |
refreshData() | DataSourceSheet | รีเฟรชข้อมูลของออบเจ็กต์ |
removeFilters(columnName) | DataSourceSheet | นำตัวกรองทั้งหมดที่ใช้กับคอลัมน์ชีตแหล่งข้อมูลออก |
removeSortSpec(columnName) | DataSourceSheet | นำข้อกำหนดในการจัดเรียงออกจากคอลัมน์ในชีตแหล่งข้อมูล |
setColumnWidth(columnName, width) | DataSourceSheet | ตั้งค่าความกว้างของคอลัมน์ที่ระบุ |
setColumnWidths(columnNames, width) | DataSourceSheet | ตั้งค่าความกว้างของคอลัมน์ที่ระบุ |
setSortSpec(columnName, ascending) | DataSourceSheet | ตั้งค่าข้อกำหนดในการจัดเรียงในคอลัมน์ในชีตแหล่งข้อมูล |
setSortSpec(columnName, sortOrder) | DataSourceSheet | ตั้งค่าข้อกำหนดในการจัดเรียงในคอลัมน์ในชีตแหล่งข้อมูล |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | รอจนกว่าการดำเนินการปัจจุบันจะเสร็จสมบูรณ์ แล้วหมดเวลาหลังจากใช้งานไปตามจำนวนวินาทีที่ระบุ |
เอกสารโดยละเอียด
addFilter(columnName, filterCriteria)
เพิ่มตัวกรองที่ใช้กับชีตแหล่งข้อมูล
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อของคอลัมน์ที่จะใช้ตัวกรองนี้ |
filterCriteria | FilterCriteria | เกณฑ์ตัวกรองที่จะใช้ |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลสำหรับการเชื่อมโยงเมธอด
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asSheet()
autoResizeColumn(columnName)
ปรับขนาดความกว้างของคอลัมน์ที่ระบุโดยอัตโนมัติ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อคอลัมน์ |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลนี้สำหรับทำการเชื่อมโยง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(columnNames)
ปรับขนาดความกว้างของคอลัมน์ที่ระบุโดยอัตโนมัติ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnNames | String[] | รายการชื่อคอลัมน์ที่จะอัปเดต |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลนี้สำหรับทำการเชื่อมโยง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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()
เพื่อเปิดใช้การดำเนินการกับข้อมูลสําหรับประเภทแหล่งข้อมูลที่เฉพาะเจาะจง
รีเทิร์น
DataSourceSheet
— ออบเจ็กต์ข้อมูล
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
รีเฟรชข้อมูลของออบเจ็กต์นี้โดยไม่คำนึงถึงสถานะปัจจุบันของ ดูรายละเอียดเพิ่มเติมได้ที่ refreshData()
หากต้องการยกเลิกการรีเฟรชออบเจ็กต์นี้ที่ดำเนินการอยู่ในปัจจุบัน โปรดดู cancelDataRefresh()
มีข้อยกเว้นหากไม่ได้เปิดใช้ประเภทแหล่งข้อมูล ใช้เมธอด SpreadsheetApp#enable...Execution()
เพื่อเปิดใช้การดำเนินการกับข้อมูลสําหรับประเภทแหล่งข้อมูลที่เฉพาะเจาะจง
รีเทิร์น
DataSourceSheet
— ออบเจ็กต์ข้อมูล
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnName)
แสดงผลความกว้างของคอลัมน์ที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อคอลัมน์ |
รีเทิร์น
Integer
— ความกว้างของคอลัมน์ หรือ null
หากคอลัมน์ใช้ความกว้างเริ่มต้น
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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
getFilters()
แสดงผลตัวกรองทั้งหมดที่ใช้กับชีตแหล่งข้อมูล
รีเทิร์น
DataSourceSheetFilter[]
— อาร์เรย์ของตัวกรองทั้งหมดที่ใช้กับชีตแหล่งข้อมูล
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName)
แสดงค่าทั้งหมดของชีตแหล่งข้อมูลสําหรับชื่อคอลัมน์ที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อคอลัมน์แหล่งข้อมูลที่จะดึงค่า |
รีเทิร์น
Object[]
— อาร์เรย์ของค่าแบบหนึ่งมิติ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName, startRow, numRows)
แสดงค่าทั้งหมดของชีตแหล่งข้อมูลสำหรับชื่อคอลัมน์ที่ระบุจากแถวเริ่มต้นที่ระบุ (อิงตาม 1) จนถึง numRows
ที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อคอลัมน์แหล่งข้อมูลที่จะดึงค่า |
startRow | Integer | ตําแหน่งแถวที่จะเริ่มดึงข้อมูลค่า |
numRows | Integer | จำนวนแถวที่จะดึงข้อมูล |
รีเทิร์น
Object[]
— อาร์เรย์ของค่าแบบหนึ่งมิติ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSortSpecs()
รับข้อกำหนดในการจัดเรียงทั้งหมดในชีตแหล่งข้อมูล
รีเทิร์น
SortSpec[]
— รายการข้อมูลจำเพาะของการจัดเรียง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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()
เพื่อเปิดใช้การดำเนินการกับข้อมูลสําหรับประเภทแหล่งข้อมูลที่เฉพาะเจาะจง
รีเทิร์น
DataSourceSheet
— ออบเจ็กต์ข้อมูล
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeFilters(columnName)
นำตัวกรองทั้งหมดที่ใช้กับคอลัมน์ชีตแหล่งข้อมูลออก
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อของคอลัมน์ที่จะนําตัวกรองออก |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลสำหรับการเชื่อมโยงเมธอด
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeSortSpec(columnName)
นำข้อกำหนดในการจัดเรียงออกจากคอลัมน์ในชีตแหล่งข้อมูล
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อคอลัมน์ |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลสำหรับการเชื่อมโยง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidth(columnName, width)
ตั้งค่าความกว้างของคอลัมน์ที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อคอลัมน์ |
width | Integer | ความกว้างใหม่สำหรับคอลัมน์ |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลนี้สำหรับทำการเชื่อมโยง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidths(columnNames, width)
ตั้งค่าความกว้างของคอลัมน์ที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnNames | String[] | รายการชื่อคอลัมน์ที่จะอัปเดต |
width | Integer | ความกว้างใหม่สำหรับคอลัมน์ |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลนี้สำหรับทำการเชื่อมโยง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, ascending)
ตั้งค่าข้อกำหนดในการจัดเรียงในคอลัมน์ในชีตแหล่งข้อมูล
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อคอลัมน์ที่จะจัดเรียง |
ascending | Boolean | หากเป็น true ให้จัดเรียงคอลัมน์ตามลําดับจากน้อยไปมาก หากเป็น false ให้จัดเรียงคอลัมน์ตามลําดับจากมากไปน้อย |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลสำหรับการเชื่อมโยง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, sortOrder)
ตั้งค่าข้อกำหนดในการจัดเรียงในคอลัมน์ในชีตแหล่งข้อมูล
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnName | String | ชื่อคอลัมน์ที่จะจัดเรียง |
sortOrder | SortOrder | ลำดับการจัดเรียง |
รีเทิร์น
DataSourceSheet
— ชีตแหล่งข้อมูลสำหรับการเชื่อมโยง
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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