Class DataSourceSheet

ชีตแหล่งข้อมูล

เข้าถึงและแก้ไขชีตแหล่งข้อมูลที่มีอยู่ หากต้องการสร้างชีตแหล่งข้อมูลใหม่ ให้ใช้ 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)

เพิ่มตัวกรองที่ใช้กับชีตแหล่งข้อมูล

พารามิเตอร์

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

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูลสําหรับการต่อเชนเมธอด

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

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

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

asSheet()

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

รีเทิร์น

Sheet — ชีตปกติ

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

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

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

autoResizeColumn(columnName)

ปรับขนาดความกว้างของคอลัมน์ที่ระบุโดยอัตโนมัติ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูลนี้สําหรับการต่อเชื่อม

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

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

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

autoResizeColumns(columnNames)

ปรับขนาดความกว้างของคอลัมน์ที่ระบุโดยอัตโนมัติ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNamesString[]รายการชื่อคอลัมน์ที่จะอัปเดต

รีเทิร์น

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)

แสดงผลความกว้างของคอลัมน์ที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์

รีเทิร์น

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)

แสดงผลค่าทั้งหมดของชีตแหล่งข้อมูลสำหรับชื่อคอลัมน์ที่ระบุ

พารามิเตอร์

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

รีเทิร์น

Object[] — อาร์เรย์ค่าแบบ 1 มิติ

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

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

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

getSheetValues(columnName, startRow, numRows)

แสดงผลค่าทั้งหมดของชีตแหล่งข้อมูลสำหรับชื่อคอลัมน์ที่ระบุจากแถวเริ่มต้นที่ระบุ (อิงตาม 1) จนถึง numRows ที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์แหล่งข้อมูลที่จะดึงข้อมูลค่า
startRowIntegerตำแหน่งแถวที่จะเริ่มดึงข้อมูลค่า
numRowsIntegerจํานวนแถวที่จะดึงข้อมูล

รีเทิร์น

Object[] — อาร์เรย์ค่าแบบ 1 มิติ

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

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

นำตัวกรองทั้งหมดที่ใช้กับคอลัมน์ชีตแหล่งข้อมูลออก

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อของคอลัมน์ที่จะนำตัวกรองออก

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูลสําหรับการต่อเชนเมธอด

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

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

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

removeSortSpec(columnName)

นำข้อกำหนดการจัดเรียงในคอลัมน์ในชีตแหล่งข้อมูลออก

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อของคอลัมน์

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูลสําหรับการต่อเชื่อม

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

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

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

setColumnWidth(columnName, width)

กำหนดความกว้างของคอลัมน์ที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อคอลัมน์
widthIntegerความกว้างใหม่ของคอลัมน์

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูลนี้สําหรับการต่อเชื่อม

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

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

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

setColumnWidths(columnNames, width)

กำหนดความกว้างของคอลัมน์ที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNamesString[]รายการชื่อคอลัมน์ที่จะอัปเดต
widthIntegerความกว้างใหม่ของคอลัมน์

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูลนี้สําหรับการต่อเชื่อม

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

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

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

setSortSpec(columnName, ascending)

ตั้งค่าข้อกําหนดการจัดเรียงในคอลัมน์ในชีตแหล่งข้อมูล

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อของคอลัมน์ที่จะจัดเรียง
ascendingBooleanหากเป็น true ระบบจะจัดเรียงคอลัมน์จากน้อยไปมาก หากเป็น false ระบบจะจัดเรียงคอลัมน์จากมากไปน้อย

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูลสําหรับการต่อเชื่อม

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

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

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

setSortSpec(columnName, sortOrder)

ตั้งค่าข้อกําหนดการจัดเรียงในคอลัมน์ในชีตแหล่งข้อมูล

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnNameStringชื่อของคอลัมน์ที่จะจัดเรียง
sortOrderSortOrderลำดับการจัดเรียง

รีเทิร์น

DataSourceSheet — ชีตแหล่งข้อมูลสําหรับการต่อเชื่อม

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

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