Class DataSource

แหล่งข้อมูล

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

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

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
cancelAllLinkedDataSourceObjectRefreshes()	void	ยกเลิกการรีเฟรชออบเจ็กต์แหล่งข้อมูลที่ลิงก์กับแหล่งข้อมูลนี้ซึ่งกำลังทำงานอยู่ทั้งหมด
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	รอจนกว่าการดำเนินการปัจจุบันทั้งหมดของออบเจ็กต์แหล่งข้อมูลที่ลิงก์จะเสร็จสมบูรณ์ โดยระบบจะหมดเวลาหลังจากผ่านไปตามจำนวนวินาทีที่ระบุ

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

cancelAllLinkedDataSourceObjectRefreshes()

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

ตัวอย่างนี้แสดงวิธียกเลิกการรีเฟรชแหล่งข้อมูลทั้งหมด

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

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

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

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

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

---

createCalculatedColumn(name, formula)

สร้างคอลัมน์ที่คำนวณ วิธีนี้ใช้ได้กับแหล่งข้อมูล BigQuery เท่านั้น

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
name	String	ชื่อของคอลัมน์ที่คำนวณ
formula	String	สูตรของคอลัมน์ที่คำนวณ

รีเทิร์น

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()

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

วิธีนี้ใช้ได้กับแหล่งข้อมูล BigQuery เท่านั้น

รีเทิร์น

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

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

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

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

---

getCalculatedColumnByName(columnName)

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
columnName	String	ชื่อของคอลัมน์ที่คำนวณเพื่อรับ

รีเทิร์น

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

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

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

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

---

getCalculatedColumns()

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

ข้อกําหนดของแหล่งข้อมูลประเภท DataSourceType.LOOKER แสดงผลอาร์เรย์ว่าง

รีเทิร์น

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() เพื่อเปิดใช้การเรียกใช้ข้อมูลสําหรับแหล่งข้อมูลประเภทที่เฉพาะเจาะจง

แสดงข้อยกเว้นหากประเภทข้อกําหนดของแหล่งข้อมูลไม่ใช่ประเภทเดียวกับประเภทแหล่งข้อมูลปัจจุบัน

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
spec	DataSourceSpec	ข้อกําหนดของแหล่งข้อมูลที่จะอัปเดต

รีเทิร์น

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

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

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

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

---

updateSpec(spec, refreshAllLinkedObjects)

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

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

แสดงข้อยกเว้นหากประเภทข้อกําหนดของแหล่งข้อมูลไม่ใช่ประเภทเดียวกับประเภทแหล่งข้อมูลปัจจุบัน

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
spec	DataSourceSpec	ข้อกําหนดของแหล่งข้อมูลที่จะอัปเดต
refreshAllLinkedObjects	Boolean	หากเป็น true ระบบจะรีเฟรชออบเจ็กต์แหล่งข้อมูลทั้งหมดที่ลิงก์กับแหล่งข้อมูลนี้ด้วย

รีเทิร์น

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

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

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

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

---

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
timeoutInSeconds	Integer	เวลาที่รอการเรียกใช้ข้อมูลเป็นวินาที สูงสุด 300 วินาที

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

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

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