Class Spreadsheet

สเปรดชีต

เข้าถึงและแก้ไขไฟล์ Google ชีต การดำเนินการทั่วไปคือการเพิ่มชีตใหม่ ผู้ทำงานร่วมกัน

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
addDeveloperMetadata(key)Spreadsheetเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ที่ระบุลงในสเปรดชีตระดับบนสุด
addDeveloperMetadata(key, visibility)Spreadsheetเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ที่ระบุและระดับการเข้าถึงในสเปรดชีต
addDeveloperMetadata(key, value)Spreadsheetเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์และค่าที่ระบุลงในสเปรดชีต
addDeveloperMetadata(key, value, visibility)Spreadsheetเพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ ค่า และระดับการมองเห็นที่ระบุในสเปรดชีต
addEditor(emailAddress)Spreadsheetเพิ่มผู้ใช้ที่กำหนดไปยังรายชื่อเอดิเตอร์ของ Spreadsheet
addEditor(user)Spreadsheetเพิ่มผู้ใช้ที่กำหนดไปยังรายชื่อเอดิเตอร์ของ Spreadsheet
addEditors(emailAddresses)Spreadsheetเพิ่มอาร์เรย์ของผู้ใช้ที่ระบุลงในรายการเครื่องมือแก้ไขสำหรับ Spreadsheet
addMenu(name, subMenus)voidสร้างเมนูใหม่ใน UI ของสเปรดชีต
addViewer(emailAddress)Spreadsheetเพิ่มผู้ใช้ที่กำหนดลงในรายการผู้ดูสำหรับ Spreadsheet
addViewer(user)Spreadsheetเพิ่มผู้ใช้ที่กำหนดลงในรายการผู้ดูสำหรับ Spreadsheet
addViewers(emailAddresses)Spreadsheetเพิ่มอาร์เรย์ของผู้ใช้ที่ระบุลงในรายการผู้มีสิทธิ์อ่านสำหรับ Spreadsheet
appendRow(rowContents)Sheetเพิ่มแถวต่อท้ายเขตข้อมูลปัจจุบันในชีต
autoResizeColumn(columnPosition)Sheetตั้งค่าความกว้างของคอลัมน์เพื่อให้พอดีกับเนื้อหา
copy(name)Spreadsheetคัดลอกสเปรดชีตและส่งคืนสเปรดชีตใหม่
createDeveloperMetadataFinder()DeveloperMetadataFinderแสดง DeveloperMetadataFinder สำหรับการค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ภายในขอบเขตของ สเปรดชีตนี้
createTextFinder(findText)TextFinderสร้างเครื่องมือค้นหาข้อความสำหรับสเปรดชีต ซึ่งสามารถใช้ค้นหาและแทนที่ข้อความภายใน สเปรดชีต
deleteActiveSheet()Sheetลบชีตที่ใช้งานอยู่
deleteColumn(columnPosition)Sheetลบคอลัมน์ตรงตำแหน่งคอลัมน์ที่ระบุ
deleteColumns(columnPosition, howMany)voidลบคอลัมน์จำนวนหนึ่งโดยเริ่มจากตำแหน่งคอลัมน์ที่ระบุ
deleteRow(rowPosition)Sheetลบแถวในตำแหน่งแถวที่กำหนด
deleteRows(rowPosition, howMany)voidลบแถวจำนวนหนึ่งที่เริ่มจากตำแหน่งแถวที่ระบุ
deleteSheet(sheet)voidลบชีตที่ระบุ
duplicateActiveSheet()Sheetทำสำเนาชีตที่ใช้งานอยู่และทําให้เป็นชีตที่ใช้งานอยู่
getActiveCell()Rangeแสดงผลเซลล์ที่ใช้งานในชีตนี้
getActiveRange()Rangeแสดงผลช่วงที่เลือกในชีตที่ใช้งานอยู่ หรือ null หากไม่มีช่วงที่ใช้งานอยู่
getActiveRangeList()RangeListแสดงรายการช่วงที่มีการใช้งานอยู่ในชีตที่ใช้งานอยู่หรือ null ถ้าไม่มีการใช้งาน
getActiveSheet()Sheetรับชีตที่ใช้งานอยู่ในสเปรดชีต
getAs(contentType)Blobแสดงข้อมูลภายในออบเจ็กต์นี้เป็น BLOB ที่แปลงเป็นประเภทเนื้อหาที่ระบุ
getBandings()Banding[]แสดงแถบสีทั้งหมดในสเปรดชีตนี้
getBlob()Blobแสดงข้อมูลภายในออบเจ็กต์นี้เป็น BLOB
getColumnWidth(columnPosition)Integerหาความกว้างของคอลัมน์ที่ระบุเป็นพิกเซล
getCurrentCell()Rangeแสดงผลเซลล์ปัจจุบันในชีตที่ใช้งานอยู่หรือ null หากไม่มีเซลล์ปัจจุบัน
getDataRange()Rangeแสดงผล Range ที่สอดคล้องกับมิติข้อมูลที่มีข้อมูล
getDataSourceFormulas()DataSourceFormula[]รับสูตรแหล่งข้อมูลทั้งหมด
getDataSourcePivotTables()DataSourcePivotTable[]รับตาราง Pivot ของแหล่งข้อมูลทั้งหมด
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]รับกำหนดการรีเฟรชของสเปรดชีตนี้
getDataSourceSheets()DataSourceSheet[]แสดงแผ่นงานแหล่งข้อมูลทั้งหมดในสเปรดชีต
getDataSourceTables()DataSourceTable[]รับตารางแหล่งข้อมูลทั้งหมด
getDataSources()DataSource[]แสดงแหล่งข้อมูลทั้งหมดในสเปรดชีต
getDeveloperMetadata()DeveloperMetadata[]รับข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับสเปรดชีตระดับบนสุด
getEditors()User[]รับรายชื่อเอดิเตอร์ของ Spreadsheet นี้
getFormUrl()Stringแสดง URL สำหรับแบบฟอร์มที่ส่งคำตอบมาที่สเปรดชีตนี้ หรือ null ถ้า สเปรดชีตนี้ไม่มีแบบฟอร์มที่เกี่ยวข้อง
getFrozenColumns()Integerแสดงผลจำนวนคอลัมน์ที่ตรึงไว้
getFrozenRows()Integerแสดงผลจำนวนแถวที่ตรึงไว้
getId()Stringได้รับตัวระบุที่ไม่ซ้ำสำหรับสเปรดชีตนี้
getImages()OverGridImage[]แสดงผลรูปภาพแบบตารางกริดทั้งหมดในชีต
getIterativeCalculationConvergenceThreshold()Numberแสดงผลค่าเกณฑ์ที่ใช้ระหว่างการคำนวณซ้ำ
getLastColumn()Integerแสดงตำแหน่งของคอลัมน์สุดท้ายที่มีเนื้อหา
getLastRow()Integerแสดงตำแหน่งของแถวสุดท้ายที่มีเนื้อหา
getMaxIterativeCalculationCycles()Integerแสดงผลจำนวนสูงสุดของการทำซ้ำที่จะใช้ระหว่างการคำนวณซ้ำ
getName()Stringรับชื่อเอกสาร
getNamedRanges()NamedRange[]รับช่วงที่ตั้งชื่อแล้วทั้งหมดในสเปรดชีตนี้
getNumSheets()Integerแสดงจำนวนแผ่นงานในสเปรดชีตนี้
getOwner()Userแสดงผลเจ้าของเอกสารหรือ null สำหรับเอกสารในไดรฟ์ที่แชร์
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]แสดงรายการธีมที่กำหนดไว้ล่วงหน้า
getProtections(type)Protection[]รับอาร์เรย์ของออบเจ็กต์ที่แสดงช่วงหรือชีตทั้งหมดที่ป้องกันไว้ในสเปรดชีต
getRange(a1Notation)Rangeแสดงผลช่วงตามที่ระบุไว้ในรูปแบบ A1 หรือรูปแบบ R1C1
getRangeByName(name)Rangeแสดงผลช่วงที่ตั้งชื่อแล้ว หรือ null หากไม่พบช่วงที่มีชื่อที่ระบุ
getRangeList(a1Notations)RangeListแสดงผลคอลเล็กชัน RangeList ที่แสดงช่วงในชีตเดียวกันที่ระบุ โดยรายการที่ไม่ว่างเปล่าของเครื่องหมาย A1 หรือเครื่องหมาย R1C1
getRecalculationInterval()RecalculationIntervalแสดงช่วงเวลาการคำนวณสำหรับสเปรดชีตนี้
getRowHeight(rowPosition)Integerหาความสูงเป็นพิกเซลของแถวที่กำหนด
getSelection()Selectionแสดง Selection ปัจจุบันในสเปรดชีต
getSheetByName(name)Sheetแสดงชีตที่มีชื่อตัวตามที่ระบุ
getSheetId()Integerแสดงผลรหัสของชีตที่ออบเจ็กต์นี้แสดง
getSheetName()Stringแสดงผลชื่อชีต
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]แสดงผลตารางกริดสี่เหลี่ยมผืนผ้าของค่าสำหรับช่วงนี้โดยเริ่มต้นที่พิกัดที่ระบุ
getSheets()Sheet[]รับชีตทั้งหมดในสเปรดชีตนี้
getSpreadsheetLocale()Stringรับภาษาของสเปรดชีต
getSpreadsheetTheme()SpreadsheetThemeแสดงผลธีมปัจจุบันของสเปรดชีต หรือ null หากไม่มีการใช้ธีม
getSpreadsheetTimeZone()Stringรับเขตเวลาสำหรับสเปรดชีต
getUrl()Stringแสดง URL สำหรับสเปรดชีตที่ระบุ
getViewers()User[]ดูรายชื่อผู้มีสิทธิ์อ่านและผู้แสดงความคิดเห็นสำหรับ Spreadsheet นี้
hideColumn(column)voidซ่อนคอลัมน์ในช่วงที่กำหนด
hideRow(row)voidซ่อนแถวในช่วงที่กำหนด
insertColumnAfter(afterPosition)Sheetแทรกคอลัมน์หลังตำแหน่งคอลัมน์ที่ระบุ
insertColumnBefore(beforePosition)Sheetแทรกคอลัมน์ก่อนตำแหน่งคอลัมน์ที่ระบุ
insertColumnsAfter(afterPosition, howMany)Sheetแทรกจำนวนคอลัมน์ที่ระบุหลังตำแหน่งคอลัมน์ที่ระบุ
insertColumnsBefore(beforePosition, howMany)Sheetแทรกจำนวนคอลัมน์ก่อนตำแหน่งคอลัมน์ที่ระบุ
insertDataSourceSheet(spec)DataSourceSheetแทรก DataSourceSheet ใหม่ในสเปรดชีตและเริ่มการดำเนินการกับข้อมูล
insertImage(blobSource, column, row)OverGridImageแทรก Spreadsheet เป็นรูปภาพในเอกสารที่แถวและคอลัมน์ที่ระบุ
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageแทรก Spreadsheet เป็นรูปภาพในเอกสารที่แถวและคอลัมน์ที่ระบุ โดยมี ออฟเซ็ตพิกเซล
insertImage(url, column, row)OverGridImageแทรกรูปภาพในเอกสารที่แถวและคอลัมน์ที่ระบุ
insertImage(url, column, row, offsetX, offsetY)OverGridImageแทรกรูปภาพในเอกสารที่แถวและคอลัมน์ที่ระบุ โดยมีออฟเซ็ตพิกเซล
insertRowAfter(afterPosition)Sheetแทรกแถวหลังตำแหน่งแถวที่กำหนด
insertRowBefore(beforePosition)Sheetแทรกแถวก่อนตำแหน่งแถวที่ระบุ
insertRowsAfter(afterPosition, howMany)Sheetแทรกจำนวนแถวหลังตำแหน่งแถวที่ระบุ
insertRowsBefore(beforePosition, howMany)Sheetแทรกจำนวนแถวก่อนตำแหน่งแถวที่ระบุ
insertSheet()Sheetแทรกแผ่นงานใหม่ในสเปรดชีตโดยใช้ชื่อแผ่นงานเริ่มต้น
insertSheet(sheetIndex)Sheetแทรกชีตใหม่ในสเปรดชีตที่ดัชนีที่กำหนด
insertSheet(sheetIndex, options)Sheetแทรกชีตใหม่ในสเปรดชีตที่ดัชนีที่กำหนดและใช้ขั้นสูงที่ไม่บังคับ อาร์กิวเมนต์
insertSheet(options)Sheetแทรกแผ่นงานใหม่ในสเปรดชีต โดยใช้ชื่อแผ่นงานเริ่มต้นและขั้นสูงที่ไม่บังคับ อาร์กิวเมนต์
insertSheet(sheetName)Sheetแทรกชีตใหม่ในสเปรดชีตที่มีชื่อตัว
insertSheet(sheetName, sheetIndex)Sheetแทรกชีตใหม่ในสเปรดชีตที่มีชื่อตัวตามดัชนีที่ระบุ
insertSheet(sheetName, sheetIndex, options)Sheetแทรกชีตใหม่ในสเปรดชีตที่มีชื่อตัวตามดัชนีที่กำหนดและใช้ อาร์กิวเมนต์ขั้นสูงที่ไม่บังคับ
insertSheet(sheetName, options)Sheetแทรกชีตใหม่ในสเปรดชีตด้วยชื่อที่ระบุและใช้ขั้นสูงที่ไม่บังคับ อาร์กิวเมนต์
insertSheetWithDataSourceTable(spec)Sheetแทรกแผ่นงานใหม่ในสเปรดชีต สร้าง DataSourceTable ที่ครอบคลุมส่วน ทั้งชีตตามข้อกำหนดของแหล่งข้อมูลที่ระบุ และเริ่มการดำเนินการกับข้อมูล
isColumnHiddenByUser(columnPosition)Booleanแสดงผลว่าผู้ใช้ซ่อนคอลัมน์ที่ระบุหรือไม่
isIterativeCalculationEnabled()Booleanแสดงผลว่าเปิดใช้งานการคำนวณซ้ำในสเปรดชีตนี้หรือไม่
isRowHiddenByFilter(rowPosition)Booleanแสดงผลว่าแถวที่ระบุถูกซ่อนโดยตัวกรองหรือไม่ (ไม่ใช่มุมมองตัวกรอง)
isRowHiddenByUser(rowPosition)Booleanแสดงผลว่าผู้ใช้ซ่อนแถวที่ระบุหรือไม่
moveActiveSheet(pos)voidย้ายชีตที่ใช้งานอยู่ไปยังตำแหน่งที่ระบุในรายการชีต
moveChartToObjectSheet(chart)Sheetสร้างชีต SheetType.OBJECT ใหม่และย้ายแผนภูมิที่มีให้ไปยังชีตนั้น
refreshAllDataSources()voidรีเฟรชแหล่งข้อมูลที่รองรับทั้งหมดและออบเจ็กต์แหล่งข้อมูลที่ลิงก์ โดยข้ามรายการที่ไม่ถูกต้อง ออบเจ็กต์แหล่งข้อมูล
removeEditor(emailAddress)Spreadsheetนำผู้ใช้ที่ระบุออกจากรายชื่อเอดิเตอร์ของ Spreadsheet
removeEditor(user)Spreadsheetนำผู้ใช้ที่ระบุออกจากรายชื่อเอดิเตอร์ของ Spreadsheet
removeMenu(name)voidนำเมนูที่เพิ่มโดย addMenu(name, subMenus) ออก
removeNamedRange(name)voidลบช่วงที่ตั้งชื่อโดยใช้ชื่อที่ระบุ
removeViewer(emailAddress)Spreadsheetนำผู้ใช้ที่ระบุออกจากรายการผู้มีสิทธิ์อ่านและผู้แสดงความคิดเห็นสำหรับ Spreadsheet
removeViewer(user)Spreadsheetนำผู้ใช้ที่ระบุออกจากรายการผู้มีสิทธิ์อ่านและผู้แสดงความคิดเห็นสำหรับ Spreadsheet
rename(newName)voidเปลี่ยนชื่อเอกสาร
renameActiveSheet(newName)voidเปลี่ยนชื่อชีตที่ใช้งานอยู่ในปัจจุบันเป็นชื่อใหม่
resetSpreadsheetTheme()SpreadsheetThemeนำธีมที่ใช้ออกและตั้งค่าธีมเริ่มต้นในสเปรดชีต
setActiveRange(range)Rangeตั้งค่าช่วงที่ระบุเป็น active range ในชีตที่ใช้งานอยู่ด้วย เซลล์ซ้ายบนสุดในช่วงเป็น current cell
setActiveRangeList(rangeList)RangeListตั้งค่ารายการช่วงที่ระบุเป็น active ranges ใน ชีตที่ใช้งานอยู่
setActiveSelection(range)Rangeตั้งค่าภูมิภาคการเลือกที่ทำงานอยู่สำหรับชีตนี้
setActiveSelection(a1Notation)Rangeตั้งค่าการเลือกที่ใช้งานอยู่ ตามที่ระบุไว้ในรูปแบบ A1 หรือรูปแบบ R1C1
setActiveSheet(sheet)Sheetกำหนดให้ชีตที่ระบุเป็นชีตที่ใช้งานอยู่ในสเปรดชีต
setActiveSheet(sheet, restoreSelection)Sheetกำหนดให้ชีตใดเป็นชีตที่ใช้งานอยู่ในสเปรดชีต โดยมีตัวเลือกให้กู้คืน รายการล่าสุดที่เลือกไว้ในแผ่นงานนั้น
setColumnWidth(columnPosition, width)Sheetกำหนดความกว้างของคอลัมน์ที่ระบุเป็นพิกเซล
setCurrentCell(cell)Rangeตั้งค่าเซลล์ที่ระบุเป็น current cell
setFrozenColumns(columns)voidตรึงจำนวนคอลัมน์ที่ระบุ
setFrozenRows(rows)voidตรึงจำนวนแถวที่ระบุ
setIterativeCalculationConvergenceThreshold(minThreshold)Spreadsheetตั้งค่าเกณฑ์ขั้นต่ำสำหรับการคำนวณซ้ำ
setIterativeCalculationEnabled(isEnabled)Spreadsheetตั้งค่าว่าจะเปิดใช้งานการคำนวณซ้ำในสเปรดชีตนี้หรือไม่
setMaxIterativeCalculationCycles(maxIterations)Spreadsheetกำหนดจำนวนสูงสุดของการทำซ้ำการคำนวณที่ควรทำระหว่างการปรับปรุงซ้ำ การคํานวณ
setNamedRange(name, range)voidตั้งชื่อช่วง
setRecalculationInterval(recalculationInterval)Spreadsheetตั้งค่าความถี่ที่สเปรดชีตนี้ควรคำนวณใหม่
setRowHeight(rowPosition, height)Sheetกำหนดความสูงของแถวในแถวแนวนอนในหน่วยพิกเซล
setSpreadsheetLocale(locale)voidตั้งค่าภาษาของสเปรดชีต
setSpreadsheetTheme(theme)SpreadsheetThemeตั้งค่าธีมในสเปรดชีต
setSpreadsheetTimeZone(timezone)voidตั้งค่าเขตเวลาสำหรับสเปรดชีต
show(userInterface)voidแสดงคอมโพเนนต์อินเทอร์เฟซผู้ใช้ที่กำหนดเองในกล่องโต้ตอบที่อยู่ตรงกลางในเบราว์เซอร์ของผู้ใช้ วิวพอร์ต
sort(columnPosition)Sheetจัดเรียงชีตตามคอลัมน์จากน้อยไปมาก
sort(columnPosition, ascending)Sheetจัดเรียงชีตตามคอลัมน์
toast(msg)voidแสดงหน้าต่างป๊อปอัปที่มุมขวาล่างของสเปรดชีตพร้อมข้อความที่ระบุ
toast(msg, title)voidแสดงหน้าต่างป๊อปอัปที่มุมขวาล่างของสเปรดชีตพร้อมข้อความที่ระบุและ ชื่อ
toast(msg, title, timeoutSeconds)voidแสดงหน้าต่างป๊อปอัปที่มุมขวาล่างของสเปรดชีตพร้อมด้วยชื่อที่ระบุและ ซึ่งจะปรากฏอยู่เป็นระยะเวลาหนึ่ง
unhideColumn(column)voidเลิกซ่อนคอลัมน์ในช่วงที่กำหนด
unhideRow(row)voidเลิกซ่อนแถวในช่วงที่กำหนด
updateMenu(name, subMenus)voidอัปเดตเมนูที่เพิ่มโดย addMenu(name, subMenus)
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidรอจนกว่าการดำเนินการปัจจุบันทั้งหมดในสเปรดชีตจะเสร็จสมบูรณ์ และหมดเวลาหลังจาก จำนวนวินาทีที่ระบุ

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

addDeveloperMetadata(key)

เพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ที่ระบุลงในสเปรดชีตระดับบนสุด

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME')

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0]
console.log(developerMetaData.getKey())

พารามิเตอร์

ชื่อประเภทคำอธิบาย
keyStringคีย์สำหรับข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สำหรับการทำห่วงโซ่

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

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

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

addDeveloperMetadata(key, visibility)

เพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ที่ระบุและระดับการเข้าถึงในสเปรดชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility
// to the developer project that created the metadata.
ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the first developer metadata object and logs its key and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
keyStringคีย์สำหรับข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์
visibilityDeveloperMetadataVisibilityการเปิดเผยข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สำหรับการทำห่วงโซ่

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

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

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

addDeveloperMetadata(key, value)

เพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์และค่าที่ระบุลงในสเปรดชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the
// spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
keyStringคีย์สำหรับข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์
valueStringค่าสำหรับข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สำหรับการทำห่วงโซ่

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

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

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

addDeveloperMetadata(key, value, visibility)

เพิ่มข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ด้วยคีย์ ค่า และระดับการมองเห็นที่ระบุในสเปรดชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the first developer metadata object and logs its key, value, and visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
keyStringคีย์สำหรับข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์
valueStringค่าสำหรับข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์
visibilityDeveloperMetadataVisibilityการเปิดเผยข้อมูลเมตาใหม่ของนักพัฒนาซอฟต์แวร์

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สำหรับการทำห่วงโซ่

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

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

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

addEditor(emailAddress)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressStringอีเมลของผู้ใช้ที่ต้องการเพิ่ม

รีเทิร์น

SpreadsheetSpreadsheet นี้สำหรับการทำเชน

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

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

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

addEditor(user)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userUserการนำเสนอของผู้ใช้ที่จะเพิ่ม

รีเทิร์น

SpreadsheetSpreadsheet นี้สำหรับการทำเชน

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

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

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

addEditors(emailAddresses)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressesString[]อาร์เรย์อีเมลของผู้ใช้ที่จะเพิ่ม

รีเทิร์น

SpreadsheetSpreadsheet นี้สำหรับการทำเชน

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

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

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

addMenu(name, subMenus)

สร้างเมนูใหม่ใน UI ของสเปรดชีต

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

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อเมนูที่จะสร้าง
subMenusObject[]อาร์เรย์ของการแมป JavaScript ที่มีพารามิเตอร์ name และ functionName คุณใช้ฟังก์ชันจากไลบรารีที่รวมไว้ เช่น Library.libFunction1 ได้

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

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

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

addViewer(emailAddress)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressStringอีเมลของผู้ใช้ที่ต้องการเพิ่ม

รีเทิร์น

SpreadsheetSpreadsheet นี้สำหรับการทำเชน

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

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

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

addViewer(user)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userUserการนำเสนอของผู้ใช้ที่จะเพิ่ม

รีเทิร์น

SpreadsheetSpreadsheet นี้สำหรับการทำเชน

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

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

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

addViewers(emailAddresses)

เพิ่มอาร์เรย์ของผู้ใช้ที่ระบุลงในรายการผู้มีสิทธิ์อ่านสำหรับ Spreadsheet หากมี ผู้ใช้อยู่ในรายชื่อผู้แก้ไขอยู่แล้ว วิธีนี้ไม่มีผลต่อผู้ใช้

พารามิเตอร์

ชื่อประเภทคำอธิบาย
emailAddressesString[]อาร์เรย์อีเมลของผู้ใช้ที่จะเพิ่ม

รีเทิร์น

SpreadsheetSpreadsheet นี้สำหรับการทำเชน

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

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

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

appendRow(rowContents)

เพิ่มแถวต่อท้ายเขตข้อมูลปัจจุบันในชีต ถ้าเนื้อหาของเซลล์เริ่มต้น กับ = ระบบจะตีความว่าเป็นสูตร

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตมีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

autoResizeColumn(columnPosition)

ตั้งค่าความกว้างของคอลัมน์เพื่อให้พอดีกับเนื้อหา

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

copy(name)

คัดลอกสเปรดชีตและส่งคืนสเปรดชีตใหม่

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อของสำเนา

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สำหรับการทำห่วงโซ่

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

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

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

createDeveloperMetadataFinder()

แสดง DeveloperMetadataFinder สำหรับการค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ภายในขอบเขตของ สเปรดชีตนี้ การดำเนินการนี้จะพิจารณาข้อมูลเมตาทั้งหมด ที่เชื่อมโยงกับสเปรดชีตโดยค่าเริ่มต้น ชีต แถว และคอลัมน์

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet = developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

รีเทิร์น

DeveloperMetadataFinder — ตัวค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์เพื่อค้นหาข้อมูลเมตาในขอบเขตของสเปรดชีตนี้


createTextFinder(findText)

สร้างเครื่องมือค้นหาข้อความสำหรับสเปรดชีต ซึ่งสามารถใช้ค้นหาและแทนที่ข้อความภายใน สเปรดชีต การค้นหาจะเริ่มจากชีตแรกของสเปรดชีต

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
var textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
findTextStringข้อความที่จะค้นหา

รีเทิร์น

TextFinderTextFinder สำหรับสเปรดชีต


deleteActiveSheet()

ลบชีตที่ใช้งานอยู่

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

รีเทิร์น

Sheet — แผ่นงานใหม่ที่ใช้งานอยู่

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

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

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

deleteColumn(columnPosition)

ลบคอลัมน์ตรงตำแหน่งคอลัมน์ที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerตำแหน่งของคอลัมน์ ซึ่งเริ่มต้นที่ 1 สำหรับคอลัมน์แรก

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

deleteColumns(columnPosition, howMany)

ลบคอลัมน์จำนวนหนึ่งโดยเริ่มจากตำแหน่งคอลัมน์ที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

พารามิเตอร์

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

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

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

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

deleteRow(rowPosition)

ลบแถวในตำแหน่งแถวที่กำหนด

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตำแหน่งของแถว เริ่มต้นที่ 1 สำหรับแถวแรก

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

deleteRows(rowPosition, howMany)

ลบแถวจำนวนหนึ่งที่เริ่มจากตำแหน่งแถวที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตำแหน่งของแถวแรกที่จะลบ
howManyIntegerจำนวนแถวที่จะลบ

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

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

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

deleteSheet(sheet)

ลบชีตที่ระบุ

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sheetSheetชีตที่จะลบ

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

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

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

duplicateActiveSheet()

ทำสำเนาชีตที่ใช้งานอยู่และทําให้เป็นชีตที่ใช้งานอยู่

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

รีเทิร์น

Sheet — แผ่นงานใหม่

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

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

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

getActiveCell()

แสดงผลเซลล์ที่ใช้งานในชีตนี้

หมายเหตุ: ควรใช้ getCurrentCell() ซึ่งแสดงผลเหตุการณ์ปัจจุบัน เซลล์ที่ไฮไลต์

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

รีเทิร์น

Range — เซลล์ปัจจุบันที่มีการใช้งานอยู่

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

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

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

getActiveRange()

แสดงผลช่วงที่เลือกในชีตที่ใช้งานอยู่ หรือ null หากไม่มีช่วงที่ใช้งานอยู่ ถ้า การเลือกหลายช่วงวิธีนี้จะแสดงเฉพาะช่วงที่เลือกล่าสุดเท่านั้น

คำว่า "ช่วงที่ใช้งานอยู่" หมายถึงช่วงที่ผู้ใช้เลือกในชีตที่ใช้งานอยู่ แต่ในฟังก์ชันที่กำหนดเอง ฟังก์ชันนี้จะหมายถึงเซลล์ที่กำลังคำนวณใหม่อยู่

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

รีเทิร์น

Range — ช่วงที่มีการใช้งานอยู่

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

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

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

ดูเพิ่มเติม


getActiveRangeList()

แสดงรายการช่วงที่มีการใช้งานอยู่ในชีตที่ใช้งานอยู่หรือ null ถ้าไม่มีการใช้งาน

หากเลือกช่วงเดียวไว้ การดำเนินการนี้จะทำงานเป็นการโทร getActiveRange()

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

รีเทิร์น

RangeList — รายการช่วงที่มีการใช้งานอยู่

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

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

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

ดูเพิ่มเติม


getActiveSheet()

รับชีตที่ใช้งานอยู่ในสเปรดชีต

แผ่นงานที่ใช้งานอยู่ในสเปรดชีตคือแผ่นงานที่แสดงอยู่ในสเปรดชีต UI

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

รีเทิร์น

Sheet — แผ่นงานที่ใช้งานอยู่ในสเปรดชีต


getAs(contentType)

แสดงข้อมูลภายในออบเจ็กต์นี้เป็น BLOB ที่แปลงเป็นประเภทเนื้อหาที่ระบุ ช่วงเวลานี้ จะเพิ่มนามสกุลที่เหมาะสมลงในชื่อไฟล์ เช่น "myfile.pdf" อย่างไรก็ตาม จะถือว่าส่วนของชื่อไฟล์ที่อยู่หลังเครื่องหมายจุดสุดท้าย (ถ้ามี) เป็นส่วนที่มีอยู่ ที่ควรแทนที่ ดังนั้น "ShoppingList.12.25.2014" กลายเป็น "ShoppingList.12.25.pdf"

หากต้องการดูโควต้ารายวันสำหรับ Conversion โปรดดูโควต้าสำหรับ Google บริการ โดเมน Google Workspace ที่สร้างใหม่อาจมีข้อกำหนดที่เข้มงวดขึ้นชั่วคราว โควต้า

พารามิเตอร์

ชื่อประเภทคำอธิบาย
contentTypeStringประเภท MIME ที่จะแปลง สำหรับ BLOB ส่วนใหญ่ 'application/pdf' คือ เป็นตัวเลือกเดียวที่ใช้ได้ สำหรับรูปภาพในรูปแบบ BMP, GIF, JPEG หรือ PNG ระบบจะใช้ 'image/bmp', 'image/gif', 'image/jpeg' หรือ 'image/png' ด้วย ใช้ได้ ใช้ 'text/markdown' สำหรับเอกสารของ Google เอกสารได้ด้วย

รีเทิร์น

Blob — ข้อมูลในรูปแบบ BLOB


getBandings()

แสดงแถบสีทั้งหมดในสเปรดชีตนี้

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

รีเทิร์น

Banding[] — แถบสีในสเปรดชีตนี้

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

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

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

getBlob()

แสดงข้อมูลภายในออบเจ็กต์นี้เป็น BLOB

รีเทิร์น

Blob — ข้อมูลในรูปแบบ BLOB


getColumnWidth(columnPosition)

หาความกว้างของคอลัมน์ที่ระบุเป็นพิกเซล

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

พารามิเตอร์

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

รีเทิร์น

Integer — ความกว้างของคอลัมน์เป็นพิกเซล

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

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

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

getCurrentCell()

แสดงผลเซลล์ปัจจุบันในชีตที่ใช้งานอยู่หรือ null หากไม่มีเซลล์ปัจจุบัน เซลล์ปัจจุบันคือเซลล์ที่มีโฟกัสใน UI ของ Google ชีตและถูกไฮไลต์ด้วยสีเข้ม เส้นขอบ ไม่มีเซลล์ปัจจุบันมากกว่า 1 เซลล์ เมื่อผู้ใช้เลือกช่วงเซลล์อย่างน้อย 1 ช่วง หนึ่งในเซลล์ที่เลือกคือเซลล์ปัจจุบัน

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.getCurrentCell();

รีเทิร์น

Range — เซลล์ปัจจุบัน

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

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

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

getDataRange()

แสดงผล Range ที่สอดคล้องกับมิติข้อมูลที่มีข้อมูล

ฟังก์ชันนี้เทียบเท่ากับการสร้างช่วงที่ล้อมรอบด้วย A1 และ (Sheet.getLastColumn(), Sheet.getLastRow())

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

รีเทิร์น

Range — ช่วงที่ประกอบด้วยข้อมูลทั้งหมดในสเปรดชีต

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

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

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

getDataSourceFormulas()

รับสูตรแหล่งข้อมูลทั้งหมด

// Opens the spreadsheet by its ID. If you created your script from within a Google Sheets
// file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

รีเทิร์น

DataSourceFormula[] — รายการสูตรแหล่งข้อมูล

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

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

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

getDataSourcePivotTables()

รับตาราง Pivot ของแหล่งข้อมูลทั้งหมด

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

รีเทิร์น

DataSourcePivotTable[] — รายการตาราง Pivot ของแหล่งข้อมูล

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

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

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

getDataSourceRefreshSchedules()

รับกำหนดการรีเฟรชของสเปรดชีตนี้

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                        .getFrequency()
                        .getFrequencyType()
                        .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

รีเทิร์น

DataSourceRefreshSchedule[] — กำหนดการรีเฟรชของสเปรดชีตนี้

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

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

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

getDataSourceSheets()

แสดงแผ่นงานแหล่งข้อมูลทั้งหมดในสเปรดชีต

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

รีเทิร์น

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

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

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

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

getDataSourceTables()

รับตารางแหล่งข้อมูลทั้งหมด

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

รีเทิร์น

DataSourceTable[] — รายการตารางแหล่งข้อมูล

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

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

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

getDataSources()

แสดงแหล่งข้อมูลทั้งหมดในสเปรดชีต

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

รีเทิร์น

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

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

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

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

getDeveloperMetadata()

รับข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับสเปรดชีตระดับบนสุด

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the console.
console.log(ssMetadata[0].getKey());

รีเทิร์น

DeveloperMetadata[] — ข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ที่เชื่อมโยงกับช่วงนี้

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

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

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

getEditors()

รับรายชื่อเอดิเตอร์ของ Spreadsheet นี้

รีเทิร์น

User[] — อาร์เรย์ของผู้ใช้ที่มีสิทธิ์แก้ไข

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

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

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

getFormUrl()

แสดง URL สำหรับแบบฟอร์มที่ส่งคำตอบมาที่สเปรดชีตนี้ หรือ null ถ้า สเปรดชีตนี้ไม่มีแบบฟอร์มที่เกี่ยวข้อง หากมีหลายแบบฟอร์มส่งการตอบกลับมายังสเปรดชีตนี้ URL ของแบบฟอร์มที่แสดงผลนั้นไม่แน่นอน อีกวิธีหนึ่งคือการเชื่อมโยง URL ในแบบฟอร์มชีตแต่ละรายการ ผ่านเมธอด Sheet.getFormUrl()

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

รีเทิร์น

String — URL ของแบบฟอร์มที่ใส่คำตอบไว้ในสเปรดชีตนี้ หรือ null ถ้า สเปรดชีตนี้ไม่มีแบบฟอร์มที่เกี่ยวข้อง

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

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

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

getFrozenColumns()

แสดงผลจำนวนคอลัมน์ที่ตรึงไว้

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

รีเทิร์น

Integer — จำนวนคอลัมน์ที่ตรึง

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

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

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

getFrozenRows()

แสดงผลจำนวนแถวที่ตรึงไว้

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

รีเทิร์น

Integer — จำนวนแถวที่ตรึง

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

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

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

getId()

ได้รับตัวระบุที่ไม่ซ้ำสำหรับสเปรดชีตนี้ คุณดึงรหัสสเปรดชีตจาก URL ของสเปรดชีตได้ เช่น รหัสสเปรดชีตใน URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 คือ "abc1234567"

// The code below logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

รีเทิร์น

String — รหัสที่ไม่ซ้ำกัน (หรือคีย์) สำหรับสเปรดชีต


getImages()

แสดงผลรูปภาพแบบตารางกริดทั้งหมดในชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
 console.log(image.getAnchorCell().getA1Notation());
}

รีเทิร์น

OverGridImage[] — อาร์เรย์ของรูปภาพที่ครอบคลุมตาราง

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

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

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

getIterativeCalculationConvergenceThreshold()

แสดงผลค่าเกณฑ์ที่ใช้ระหว่างการคำนวณซ้ำ เมื่อผลลัพธ์ของการทำงานต่อเนื่อง การคํานวณจะแตกต่างไปน้อยกว่าค่านี้ การคำนวณซ้ำจะหยุดลง

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

รีเทิร์น

Number — เกณฑ์การบรรจบกัน

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

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

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

getLastColumn()

แสดงตำแหน่งของคอลัมน์สุดท้ายที่มีเนื้อหา

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

รีเทิร์น

Integer — คอลัมน์สุดท้ายของชีตที่มีเนื้อหา

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

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

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

getLastRow()

แสดงตำแหน่งของแถวสุดท้ายที่มีเนื้อหา

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

รีเทิร์น

Integer — แถวสุดท้ายของชีตที่มีเนื้อหา

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

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

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

getMaxIterativeCalculationCycles()

แสดงผลจำนวนสูงสุดของการทำซ้ำที่จะใช้ระหว่างการคำนวณซ้ำ

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

รีเทิร์น

Integer — จำนวนสูงสุดของการทำซ้ำการคำนวณ

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

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

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

getName()

รับชื่อเอกสาร

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

รีเทิร์น

String — ชื่อสเปรดชีต

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

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

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

getNamedRanges()

รับช่วงที่ตั้งชื่อแล้วทั้งหมดในสเปรดชีตนี้

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

รีเทิร์น

NamedRange[] — อาร์เรย์ของช่วงที่ตั้งชื่อแล้วทั้งหมดในสเปรดชีต

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

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

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

getNumSheets()

แสดงจำนวนแผ่นงานในสเปรดชีตนี้

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

รีเทิร์น

Integer — จำนวนแผ่นงานในสเปรดชีต


getOwner()

แสดงผลเจ้าของเอกสารหรือ null สำหรับเอกสารในไดรฟ์ที่แชร์

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

รีเทิร์น

User — เจ้าของเอกสาร หรือ null หากเอกสารอยู่ในไดรฟ์ที่แชร์

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

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

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

getPredefinedSpreadsheetThemes()

แสดงรายการธีมที่กำหนดไว้ล่วงหน้า

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

รีเทิร์น

SpreadsheetTheme[] — รายการธีมที่กำหนดไว้ล่วงหน้า

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

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

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

getProtections(type)

รับอาร์เรย์ของออบเจ็กต์ที่แสดงช่วงหรือชีตทั้งหมดที่ป้องกันไว้ในสเปรดชีต

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
typeProtectionTypeประเภทของพื้นที่คุ้มครอง SpreadsheetApp.ProtectionType.RANGE หรือ SpreadsheetApp.ProtectionType.SHEET

รีเทิร์น

Protection[] — อาร์เรย์ของออบเจ็กต์ที่แสดงช่วงหรือแผ่นงานที่มีการป้องกันทั้งหมดในสเปรดชีต

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

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

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

getRange(a1Notation)

แสดงผลช่วงตามที่ระบุไว้ในรูปแบบ A1 หรือรูปแบบ R1C1

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

พารามิเตอร์

ชื่อประเภทคำอธิบาย
a1NotationStringช่วงที่จะส่งคืน ตามที่ระบุไว้ในรูปแบบ A1 หรือสัญลักษณ์ R1C1

รีเทิร์น

Range — ช่วง ณ ตำแหน่งที่กำหนด

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

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

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

getRangeByName(name)

แสดงผลช่วงที่ตั้งชื่อแล้ว หรือ null หากไม่พบช่วงที่มีชื่อที่ระบุ หากหลาย ชีตของสเปรดชีตใช้ชื่อช่วงเดียวกัน ระบุชื่อชีตโดยไม่เพิ่ม เครื่องหมายอัญประกาศ เช่น getRangeByName('TaxRates') หรือ getRangeByName('Sheet Name!TaxRates') แต่ไม่ใช่ getRangeByName('"Sheet Name"!TaxRates')

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อของช่วงที่จะรับ

รีเทิร์น

Range — ช่วงของเซลล์ที่มีชื่อตัวที่ระบุ


getRangeList(a1Notations)

แสดงผลคอลเล็กชัน RangeList ที่แสดงช่วงในชีตเดียวกันที่ระบุ โดยรายการที่ไม่ว่างเปล่าของเครื่องหมาย A1 หรือเครื่องหมาย R1C1

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
a1NotationsString[]รายการช่วงที่จะแสดงผล ตามที่ระบุไว้ในรูปแบบ A1 หรือสัญลักษณ์ R1C1

รีเทิร์น

RangeList — รายการช่วงในตำแหน่งที่กำหนด

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

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

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

getRecalculationInterval()

แสดงช่วงเวลาการคำนวณสำหรับสเปรดชีตนี้

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

รีเทิร์น

RecalculationInterval — ช่วงเวลาการคำนวณสำหรับสเปรดชีตนี้

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

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

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

getRowHeight(rowPosition)

หาความสูงเป็นพิกเซลของแถวที่กำหนด

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตำแหน่งของแถวที่จะตรวจสอบ

รีเทิร์น

Integer — ความสูงของแถวเป็นพิกเซล

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

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

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

getSelection()

แสดง Selection ปัจจุบันในสเปรดชีต

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

รีเทิร์น

Selection — การเลือกปัจจุบัน

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

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

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

getSheetByName(name)

แสดงชีตที่มีชื่อตัวตามที่ระบุ

หากชีตหลายแผ่นมีชื่อเหมือนกัน ระบบจะแสดงผลชีตที่อยู่ซ้ายสุด แสดงผล null หาก ไม่มีชีตที่ใช้ชื่อดังกล่าว

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อของชีตที่จะรับ

รีเทิร์น

Sheet — แผ่นงานที่มีชื่อตัวหนึ่ง


getSheetId()

แสดงผลรหัสของชีตที่ออบเจ็กต์นี้แสดง

นี่คือรหัสของชีตที่ไม่ซ้ำกันสําหรับสเปรดชีต รหัสเป็นรหัสในทางเดียว จํานวนเต็มที่เพิ่มขึ้นซึ่งได้รับการกำหนด ณ เวลาที่สร้างชีต ซึ่งไม่เกี่ยวข้องกับตําแหน่งของชีต ช่วงเวลานี้ มีประโยชน์เมื่อใช้ร่วมกับเมธอด เช่น Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) ที่รับพารามิเตอร์ gridId แทนที่จะเป็นอินสแตนซ์ Sheet

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

รีเทิร์น

Integer — รหัสของแผ่นงานเฉพาะสำหรับสเปรดชีต

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

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

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

getSheetName()

แสดงผลชื่อชีต

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

รีเทิร์น

String — ชื่อชีต

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

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

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

getSheetValues(startRow, startColumn, numRows, numColumns)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

พารามิเตอร์

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

รีเทิร์น

Object[][] — อาร์เรย์สองมิติของค่า

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

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

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

getSheets()

รับชีตทั้งหมดในสเปรดชีตนี้

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

รีเทิร์น

Sheet[] — อาร์เรย์ของแผ่นงานทั้งหมดในสเปรดชีต


getSpreadsheetLocale()

รับภาษาของสเปรดชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

รีเทิร์น

String — ภาษาของสเปรดชีต

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

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

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

getSpreadsheetTheme()

แสดงผลธีมปัจจุบันของสเปรดชีต หรือ null หากไม่มีการใช้ธีม

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

รีเทิร์น

SpreadsheetTheme — ธีมที่ใช้อยู่ปัจจุบัน

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

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

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

getSpreadsheetTimeZone()

รับเขตเวลาสำหรับสเปรดชีต

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets spreadsheet, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

รีเทิร์น

String — เขตเวลา ระบุเป็น "long" รูปแบบ (เช่น "อเมริกา/กรุงเทพฯ" ตามที่ระบุไว้ โดย Joda.org)

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

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

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

getUrl()

แสดง URL สำหรับสเปรดชีตที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

รีเทิร์น

String — URL สำหรับสเปรดชีตที่ระบุ

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

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

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

getViewers()

ดูรายชื่อผู้มีสิทธิ์อ่านและผู้แสดงความคิดเห็นสำหรับ Spreadsheet นี้

รีเทิร์น

User[] — อาร์เรย์ของผู้ใช้ที่มีสิทธิ์ดูหรือแสดงความคิดเห็น

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

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

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

hideColumn(column)

ซ่อนคอลัมน์ในช่วงที่กำหนด

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

พารามิเตอร์

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

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

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

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

hideRow(row)

ซ่อนแถวในช่วงที่กำหนด

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowRangeช่วงแถวที่จะซ่อน

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

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

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

insertColumnAfter(afterPosition)

แทรกคอลัมน์หลังตำแหน่งคอลัมน์ที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
afterPositionIntegerคอลัมน์ที่ควรเพิ่มคอลัมน์ใหม่ในภายหลัง

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

insertColumnBefore(beforePosition)

แทรกคอลัมน์ก่อนตำแหน่งคอลัมน์ที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
beforePositionIntegerคอลัมน์ที่ควรเพิ่มคอลัมน์ใหม่

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

insertColumnsAfter(afterPosition, howMany)

แทรกจำนวนคอลัมน์ที่ระบุหลังตำแหน่งคอลัมน์ที่ระบุ

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the spreadsheet.
sheet.insertColumnsAfter(1,2);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
afterPositionIntegerคอลัมน์ที่ควรเพิ่มคอลัมน์ใหม่ในภายหลัง
howManyIntegerจำนวนคอลัมน์ที่จะแทรก

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

insertColumnsBefore(beforePosition, howMany)

แทรกจำนวนคอลัมน์ก่อนตำแหน่งคอลัมน์ที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
beforePositionIntegerคอลัมน์ที่ควรเพิ่มคอลัมน์ใหม่
howManyIntegerจำนวนคอลัมน์ที่จะแทรก

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

insertDataSourceSheet(spec)

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

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setTableProjectId('bigquery-public-data')
 .setDatasetId('ncaa_basketball')
 .setTableId('mbb_historical_teams_games')
 .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

พารามิเตอร์

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

รีเทิร์น

DataSourceSheet — แผ่นงานแหล่งข้อมูลใหม่

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

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

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

insertImage(blobSource, column, row)

แทรก Spreadsheet เป็นรูปภาพในเอกสารที่แถวและคอลัมน์ที่ระบุ รูปภาพ ขนาดที่ดึงมาจากเนื้อหา BLOB ขนาดของ BLOB ที่รองรับต้องไม่เกิน 2 MB

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
blobSourceBlobSourceBLOB ที่มีเนื้อหารูปภาพ ประเภท MIME และชื่อ (ไม่บังคับ)
columnIntegerตำแหน่งคอลัมน์
rowIntegerตำแหน่งของแถว

รีเทิร์น

OverGridImage — รูปภาพที่แทรก

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

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

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

insertImage(blobSource, column, row, offsetX, offsetY)

แทรก Spreadsheet เป็นรูปภาพในเอกสารที่แถวและคอลัมน์ที่ระบุ โดยมี ออฟเซ็ตพิกเซล ขนาดของรูปภาพจะดึงมาจากเนื้อหา BLOB BLOB สูงสุดที่รองรับ ขนาด 2 MB

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
blobSourceBlobSourceBLOB ที่มีเนื้อหารูปภาพ ประเภท MIME และชื่อ (ไม่บังคับ)
columnIntegerตำแหน่งคอลัมน์
rowIntegerตำแหน่งของแถว
offsetXIntegerออฟเซ็ตแนวนอนจากมุมของเซลล์ในหน่วยพิกเซล
offsetYIntegerค่าออฟเซ็ตแนวตั้งจากมุมของเซลล์ในหน่วยพิกเซล

รีเทิร์น

OverGridImage — รูปภาพที่แทรก

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

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

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

insertImage(url, column, row)

แทรกรูปภาพในเอกสารที่แถวและคอลัมน์ที่ระบุ

URL ที่ระบุต้องเข้าถึงได้แบบสาธารณะ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
urlStringURL ของรูปภาพ
columnIntegerตำแหน่งคอลัมน์ตารางกริด
rowIntegerตำแหน่งแถวของตาราง

รีเทิร์น

OverGridImage — รูปภาพที่แทรก

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

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

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

insertImage(url, column, row, offsetX, offsetY)

แทรกรูปภาพในเอกสารที่แถวและคอลัมน์ที่ระบุ โดยมีออฟเซ็ตพิกเซล

URL ที่ระบุต้องเข้าถึงได้แบบสาธารณะ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
urlStringURL ของรูปภาพ
columnIntegerตำแหน่งคอลัมน์
rowIntegerตำแหน่งของแถว
offsetXIntegerออฟเซ็ตแนวนอนจากมุมของเซลล์ในหน่วยพิกเซล
offsetYIntegerค่าออฟเซ็ตแนวตั้งจากมุมของเซลล์ในหน่วยพิกเซล

รีเทิร์น

OverGridImage — รูปภาพที่แทรก

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

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

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

insertRowAfter(afterPosition)

แทรกแถวหลังตำแหน่งแถวที่กำหนด

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
afterPositionIntegerแถวที่ควรเพิ่มแถวใหม่หลังจากนั้น

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

insertRowBefore(beforePosition)

แทรกแถวก่อนตำแหน่งแถวที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
beforePositionIntegerแถวที่ควรเพิ่มแถวใหม่

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

insertRowsAfter(afterPosition, howMany)

แทรกจำนวนแถวหลังตำแหน่งแถวที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
afterPositionIntegerแถวที่ควรเพิ่มแถวใหม่หลังจากนั้น
howManyIntegerจำนวนแถวที่จะแทรก

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

insertRowsBefore(beforePosition, howMany)

แทรกจำนวนแถวก่อนตำแหน่งแถวที่ระบุ

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
beforePositionIntegerแถวที่ควรเพิ่มแถวใหม่
howManyIntegerจำนวนแถวที่จะแทรก

รีเทิร์น

Sheet — ชีต มีประโยชน์สำหรับห่วงโซ่เมธอด

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

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

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

insertSheet()

แทรกแผ่นงานใหม่ในสเปรดชีตโดยใช้ชื่อแผ่นงานเริ่มต้น ชีตใหม่จะกลายเป็น ชีตที่ใช้งานอยู่

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

รีเทิร์น

Sheet — แผ่นงานใหม่

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

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

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

insertSheet(sheetIndex)

แทรกชีตใหม่ในสเปรดชีตที่ดัชนีที่กำหนด ชีตใหม่จะเปลี่ยนเป็น ชีต

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sheetIndexIntegerดัชนีของชีตที่สร้างขึ้นใหม่ หากต้องการแทรกแผ่นงานเป็นรายการแรกใน ตั้งค่าสเปรดชีตเป็น 0

รีเทิร์น

Sheet — แผ่นงานใหม่

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

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

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

insertSheet(sheetIndex, options)

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

var ss