Class DataSource

DataSource

เข้าถึงและแก้ไขแหล่งข้อมูลที่มีอยู่ หากต้องการสร้างตารางแหล่งข้อมูลด้วยแหล่งข้อมูลใหม่ ให้ดู DataSourceTable

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

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
createCalculatedColumn(name, formula)DataSourceColumnสร้างคอลัมน์ที่คำนวณ
createDataSourcePivotTableOnNewSheet()DataSourcePivotTableสร้างตาราง Pivot ของแหล่งข้อมูลจากแหล่งข้อมูลนี้ในเซลล์แรกของชีตใหม่
createDataSourceTableOnNewSheet()DataSourceTableสร้างตารางแหล่งข้อมูลจากแหล่งข้อมูลนี้ในเซลล์แรกของชีตใหม่
getCalculatedColumnByName(columnName)DataSourceColumnแสดงผลคอลัมน์ที่คำนวณในแหล่งข้อมูลที่ตรงกับชื่อคอลัมน์
getCalculatedColumns()DataSourceColumn[]แสดงคอลัมน์ที่คำนวณแล้วทั้งหมดในแหล่งข้อมูล
getColumns()DataSourceColumn[]แสดงผลคอลัมน์ทั้งหมดในแหล่งข้อมูล
getDataSourceSheets()DataSourceSheet[]แสดงผลชีตแหล่งข้อมูลที่เชื่อมโยงกับแหล่งข้อมูลนี้
getSpec()DataSourceSpecรับข้อกำหนดของแหล่งข้อมูล
refreshAllLinkedDataSourceObjects()voidรีเฟรชออบเจ็กต์แหล่งข้อมูลทั้งหมดที่ลิงก์กับแหล่งข้อมูล
updateSpec(spec)DataSourceอัปเดตข้อกำหนดของแหล่งข้อมูลและรีเฟรชออบเจ็กต์แหล่งข้อมูลที่ลิงก์กับแหล่งข้อมูลนี้ด้วยข้อกำหนดใหม่
updateSpec(spec, refreshAllLinkedObjects)DataSourceอัปเดตข้อกำหนดของแหล่งข้อมูลและรีเฟรช data source sheets ที่ลิงก์ด้วยข้อกำหนดใหม่
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidรอจนกระทั่งการดำเนินการปัจจุบันของออบเจ็กต์แหล่งข้อมูลที่ลิงก์เสร็จสมบูรณ์ แล้วหมดเวลาหลังจากครบจำนวนวินาทีที่ระบุ

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

createCalculatedColumn(name, formula)

สร้างคอลัมน์ที่คำนวณ

พารามิเตอร์

ชื่อTypeคำอธิบาย
nameStringชื่อของคอลัมน์ที่คำนวณ
formulaStringสูตรคอลัมน์ที่คำนวณ

รีเทิร์น

DataSourceColumn — คอลัมน์ที่คำนวณแล้วที่สร้างขึ้นใหม่

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

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

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

createDataSourcePivotTableOnNewSheet()

สร้างตาราง Pivot ของแหล่งข้อมูลจากแหล่งข้อมูลนี้ในเซลล์แรกของชีตใหม่ ผลข้างเคียงคือทำให้ชีตใหม่เป็นชีตที่ใช้งานอยู่

รีเทิร์น

DataSourcePivotTable — ตาราง Pivot ของแหล่งข้อมูลที่สร้างขึ้นใหม่

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

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

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

createDataSourceTableOnNewSheet()

สร้างตารางแหล่งข้อมูลจากแหล่งข้อมูลนี้ในเซลล์แรกของชีตใหม่ ผลข้างเคียงคือทำให้ชีตใหม่เป็นชีตที่ใช้งานอยู่

รีเทิร์น

DataSourceTable — ตารางแหล่งข้อมูลที่สร้างขึ้นใหม่

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

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

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

getCalculatedColumnByName(columnName)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
columnNameStringชื่อของคอลัมน์ที่คำนวณที่จะรับ

รีเทิร์น

DataSourceColumn — คอลัมน์ที่คำนวณแล้วซึ่งตรงกับชื่อคอลัมน์ หรือ null หากไม่มีคอลัมน์ที่คำนวณดังกล่าว

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

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

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

getCalculatedColumns()

แสดงคอลัมน์ที่คำนวณแล้วทั้งหมดในแหล่งข้อมูล

รีเทิร์น

DataSourceColumn[] — อาร์เรย์ของคอลัมน์ที่คำนวณแล้วทั้งหมดในแหล่งข้อมูล

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

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

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

getColumns()

แสดงผลคอลัมน์ทั้งหมดในแหล่งข้อมูล

รีเทิร์น

DataSourceColumn[] — อาร์เรย์ของ DataSourceColumn ทั้งหมดในแหล่งข้อมูล

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

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

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

getDataSourceSheets()

แสดงผลชีตแหล่งข้อมูลที่เชื่อมโยงกับแหล่งข้อมูลนี้

รีเทิร์น

DataSourceSheet[] — อาร์เรย์ของชีตแหล่งข้อมูล

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

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

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

getSpec()

รับข้อกำหนดของแหล่งข้อมูล

รีเทิร์น

DataSourceSpec — ข้อกำหนดของแหล่งข้อมูล

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

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

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

refreshAllLinkedDataSourceObjects()

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

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

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

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

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

updateSpec(spec)

อัปเดตข้อกำหนดของแหล่งข้อมูลและรีเฟรชออบเจ็กต์แหล่งข้อมูลที่ลิงก์กับแหล่งข้อมูลนี้ด้วยข้อกำหนดใหม่

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
specDataSourceSpecข้อกำหนดของแหล่งข้อมูลที่จะใช้อัปเดต

รีเทิร์น

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

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

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

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

updateSpec(spec, refreshAllLinkedObjects)

อัปเดตข้อกำหนดของแหล่งข้อมูลและรีเฟรช data source sheets ที่ลิงก์ด้วยข้อกำหนดใหม่

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
specDataSourceSpecข้อกำหนดของแหล่งข้อมูลที่จะใช้อัปเดต
refreshAllLinkedObjectsBooleanหากเป็น true ให้รีเฟรชออบเจ็กต์แหล่งข้อมูลทั้งหมดที่ลิงก์กับแหล่งข้อมูลนี้ด้วย

รีเทิร์น

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

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

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

พารามิเตอร์

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

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

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

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