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แสดงคอมโพเนนต์อินเทอร์เฟซที่กําหนดเองของผู้ใช้ในกล่องโต้ตอบที่อยู่ตรงกลางในมุมมองของเบราว์เซอร์ของเบราว์เซอร์ #39
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)

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

พารามิเตอร์

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

ไปกลับ

Spreadsheet — สเปรดชีตนี้สําหรับเชนธุรกิจ

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

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

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

addDeveloperMetadata(key, visibility)

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

พารามิเตอร์

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

ไปกลับ

Spreadsheet — สเปรดชีตนี้สําหรับเชนธุรกิจ

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

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

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

addDeveloperMetadata(key, value)

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

พารามิเตอร์

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

ไปกลับ

Spreadsheet — สเปรดชีตนี้สําหรับเชนธุรกิจ

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

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

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

addDeveloperMetadata(key, value, visibility)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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 สําหรับค้นหาข้อมูลเมตาของนักพัฒนาซอฟต์แวร์ภายในขอบเขตของสเปรดชีตนี้ โดยค่าเริ่มต้น ระบบจะพิจารณาข้อมูลเมตาทั้งหมดที่เชื่อมโยงกับสเปรดชีต ชีต แถว และคอลัมน์

ไปกลับ

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 หากไม่มีช่วงที่ใช้งานอยู่ หากเลือกหลายช่วง วิธีนี้จะแสดงเฉพาะช่วงสุดท้ายที่เลือกไว้เท่านั้น

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

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' ได้เช่นกัน

ไปกลับ

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


getBandings()

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

ไปกลับ

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

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

ไปกลับ

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

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

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

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

getDataSourcePivotTables()

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

ไปกลับ

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

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

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

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

getDataSourceRefreshSchedules()

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

ไปกลับ

DataSourceRefreshSchedule[] — กําหนดการรีเฟรชสเปรดชีตนี้

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

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

getDataSourceTables()

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

ไปกลับ

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

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

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

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

getDataSources()

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

ไปกลับ

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

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

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

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

getDeveloperMetadata()

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

ไปกลับ

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() ได้

ไปกลับ

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

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

ไปกลับ

OverGridImage[] — อาร์เรย์ของรูปภาพแบบตารางกริด

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

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

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

getIterativeCalculationConvergenceThreshold()

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

ไปกลับ

Number — เกณฑ์ Conversion

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

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

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

ไปกลับ

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

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

ไปกลับ

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[][] — อาร์เรย์ค่า 2 มิติ

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

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

ดาวน์โหลดภาษาของสเปรดชีต

ไปกลับ

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

แสดงเขตเวลาสําหรับสเปรดชีต

ไปกลับ

String — เขตเวลาที่ระบุไว้ในรูปแบบ "long" (เช่น "America/New_York" ตามที่ระบุไว้โดย 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)

แทรกคอลัมน์จํานวนหนึ่งหลังตําแหน่งคอลัมน์ที่กําหนด

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

พารามิเตอร์

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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)

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

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)

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

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 = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

พารามิเตอร์

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

พารามิเตอร์ขั้นสูง

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

ไปกลับ

Sheet — ชีตใหม่

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

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

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

insertSheet(options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

พารามิเตอร์

ชื่อประเภทคำอธิบาย
optionsObjectอาร์กิวเมนต์ JavaScript ขั้นสูงที่ไม่บังคับ แสดงอยู่ด้านล่าง

พารามิเตอร์ขั้นสูง

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

ไปกลับ

Sheet — ชีตใหม่

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

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

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

insertSheet(sheetName)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sheetNameStringชื่อของชีตใหม่

ไปกลับ

Sheet — ชีตใหม่

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

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

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

insertSheet(sheetName, sheetIndex)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

พารามิเตอร์

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

ไปกลับ

Sheet — ชีตใหม่

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

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

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

insertSheet(sheetName, sheetIndex, options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sheetNameStringชื่อของชีตใหม่
sheetIndexIntegerดัชนีของชีตที่แทรกใหม่ หากต้องการแทรกชีตเป็นรายการแรกในสเปรดชีต ให้ตั้งค่าเป็น 0
optionsObjectอาร์กิวเมนต์ขั้นสูงของ JavaScript ที่ไม่บังคับ

พารามิเตอร์ขั้นสูง

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

ไปกลับ

Sheet — ชีตใหม่

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

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

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

insertSheet(sheetName, options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sheetNameStringชื่อของชีตใหม่
optionsObjectอาร์กิวเมนต์ขั้นสูงของ JavaScript ที่ไม่บังคับ

พารามิเตอร์ขั้นสูง

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

ไปกลับ

Sheet — ชีตใหม่

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

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

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

insertSheetWithDataSourceTable(spec)

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

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

พารามิเตอร์

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

ไปกลับ

Sheet — ชีตใหม่

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

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

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

isColumnHiddenByUser(columnPosition)

แสดงผลว่าผู้ใช้ซ่อนคอลัมน์หนึ่งๆ หรือไม่

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

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

พารามิเตอร์

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

ไปกลับ

Booleantrue หากซ่อนคอลัมน์ไว้ false ในกรณีอื่นๆ

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

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

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

isIterativeCalculationEnabled()

แสดงผลว่ามีการเปิดใช้การคํานวณซ้ําในสเปรดชีตนี้หรือไม่

ไปกลับ

Booleantrue หากเปิดใช้การคํานวณแบบทําซ้ํา false ในกรณีอื่นๆ

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

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

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

isRowHiddenByFilter(rowPosition)

แสดงผลว่าตัวกรองจะซ่อนแถวที่ระบุหรือไม่ (ไม่ใช่มุมมองตัวกรอง)

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

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

พารามิเตอร์

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

ไปกลับ

Booleantrue หากแถวซ่อนไว้ false ในกรณีอื่นๆ

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

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

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

isRowHiddenByUser(rowPosition)

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

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

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

พารามิเตอร์

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

ไปกลับ

Booleantrue หากแถวซ่อนไว้ false ในกรณีอื่นๆ

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

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

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

moveActiveSheet(pos)

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

// This example assumes there are two sheets in the current
// active spreadsheet: one named "first", and another named "second",
// and that the current active sheet (first) is in position 1
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var sheet = spreadsheet.getSheetByName("first");

// This should output 'Current index of sheet: 1'
Logger.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// This should output 'New index of sheet: 2'
Logger.log("New index of sheet: %s", sheet.getIndex());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
posIntegerตําแหน่งเพื่อย้ายชีตที่ใช้งานอยู่ไปยังรายชื่อชีต

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

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

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

moveChartToObjectSheet(chart)

สร้างชีต SheetType.OBJECT ใหม่และย้ายแผนภูมิที่ระบุไปยังชีตดังกล่าว หากแผนภูมิอยู่ในชีตของตัวเองอยู่แล้ว ระบบจะส่งแผ่นงานนั้นกลับมาโดยไม่สร้างชีตใหม่

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
chartEmbeddedChartแผนภูมิที่จะย้าย

ไปกลับ

Sheet — แผ่นงานที่แผนภูมิเปิดอยู่

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

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

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

refreshAllDataSources()

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

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

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

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

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

removeEditor(emailAddress)

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

สําหรับไฟล์ในไดรฟ์ การดําเนินการนี้จะนําผู้ใช้ออกจากรายชื่อผู้มีสิทธิ์อ่านด้วย

พารามิเตอร์

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

ไปกลับ

SpreadsheetSpreadsheet นี้สําหรับเชนธุรกิจ

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

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

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

removeEditor(user)

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

สําหรับไฟล์ในไดรฟ์ การดําเนินการนี้จะนําผู้ใช้ออกจากรายชื่อผู้มีสิทธิ์อ่านด้วย

พารามิเตอร์

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

ไปกลับ

SpreadsheetSpreadsheet นี้สําหรับเชนธุรกิจ

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

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

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

removeMenu(name)

นําเมนูที่เพิ่มโดย addMenu(name, subMenus) ออก อาร์กิวเมนต์ name ควรมีค่าเดียวกับการเรียกที่เกี่ยวข้องไปยัง addMenu(name, subMenus)

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อของเมนูที่จะนําออก

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

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

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

removeNamedRange(name)

ลบช่วงที่ตั้งชื่อแล้วโดยใช้ชื่อที่ระบุ ส่งข้อยกเว้นหากไม่พบช่วงที่มีชื่อที่ระบุในสเปรดชีต

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

พารามิเตอร์

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

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

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

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

removeViewer(emailAddress)

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

สําหรับไฟล์ในไดรฟ์ การดําเนินการนี้จะนําผู้ใช้ออกจากรายชื่อผู้แก้ไขด้วย

พารามิเตอร์

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

ไปกลับ

SpreadsheetSpreadsheet นี้สําหรับเชนธุรกิจ

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

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

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

removeViewer(user)

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

สําหรับไฟล์ในไดรฟ์ การดําเนินการนี้จะนําผู้ใช้ออกจากรายชื่อผู้แก้ไขด้วย

พารามิเตอร์

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

ไปกลับ

SpreadsheetSpreadsheet นี้สําหรับเชนธุรกิจ

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

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

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

rename(newName)

เปลี่ยนชื่อเอกสาร

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

พารามิเตอร์

ชื่อประเภทคำอธิบาย
newNameStringชื่อใหม่ของเอกสาร

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

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

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

renameActiveSheet(newName)

เปลี่ยนชื่อชีตที่ใช้งานอยู่ในปัจจุบันเป็นชื่อใหม่ที่ระบุ

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

พารามิเตอร์

ชื่อประเภทคำอธิบาย
newNameStringชื่อใหม่ของชีตที่ใช้งานอยู่ในปัจจุบัน

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

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

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

resetSpreadsheetTheme()

นําธีมที่ใช้อยู่ออกและตั้งค่าธีมเริ่มต้นในสเปรดชีต

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

ไปกลับ

SpreadsheetTheme — ธีมเริ่มต้น

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

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

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

setActiveRange(range)

ตั้งค่าช่วงที่ระบุเป็น active range ในชีตที่ใช้งานอยู่ โดยเซลล์ซ้ายบนสุดในช่วงคือ current cell

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D4
var activeRange = selection.getActiveRange();

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeRangeช่วงที่จะตั้งค่าเป็นช่วงที่ใช้งานอยู่

ไปกลับ

Range — ช่วงที่เพิ่งเปิดใช้

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

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

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

setActiveRangeList(rangeList)

ตั้งค่ารายการช่วงที่ระบุเป็น active ranges ในชีตที่ใช้งานอยู่ ช่วงสุดท้ายในรายการจะตั้งค่าเป็น active range

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeListRangeListรายการช่วงให้เลือก

ไปกลับ

RangeList — รายการช่วงที่เลือกไว้ใหม่

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

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

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

setActiveSelection(range)

ตั้งค่าเขตการเลือกที่ใช้งานอยู่สําหรับชีตนี้

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

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rangeRangeช่วงที่จะตั้งค่าเป็นตัวเลือกที่ใช้งานอยู่

ไปกลับ

Range — ช่วงที่เพิ่งเปิดใช้

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

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

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

setActiveSelection(a1Notation)

ตั้งค่าการเลือกที่ทํางานอยู่ ตามที่ระบุไว้ในรูปแบบ A1 หรือ R1C1

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

sheet.setActiveSelection("A1:D4");

พารามิเตอร์

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

ไปกลับ

Range — ช่วงที่เพิ่งเปิดใช้

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

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

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

setActiveSheet(sheet)

ตั้งค่าแผ่นงานที่ระบุเป็นแผ่นงานที่ใช้งานอยู่ในสเปรดชีต UI ของ Google ชีตจะแสดงชีตที่เลือกไว้ เว้นแต่ชีตจะอยู่ในสเปรดชีตอื่น

// The code below makes the first sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sheetSheetชีตที่ตั้งค่าเป็นชีตที่ใช้งานอยู่

ไปกลับ

Sheet — ชีตที่ใช้งานอยู่

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

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

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

setActiveSheet(sheet, restoreSelection)

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
sheetSheetชีตใหม่ที่ใช้งานอยู่
restoreSelectionBooleanถึง true ระบบจะเลือกแผ่นงานใหม่ที่มีการใช้งานล่าสุดอีกครั้งเมื่อชีตใหม่เริ่มทํางาน หาก false แผ่นงานใหม่จะทํางานโดยไม่เปลี่ยนการเลือกปัจจุบัน

ไปกลับ

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

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

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

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

setColumnWidth(columnPosition, width)

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

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

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

พารามิเตอร์

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

ไปกลับ

Sheet — ชีตซึ่งเหมาะสําหรับการเชื่อมโยงวิธีการ

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

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

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

setCurrentCell(cell)

ตั้งค่าเซลล์ที่ระบุเป็น current cell

หากมีเซลล์ที่ระบุอยู่ในช่วงที่เลือกแล้ว ช่วงนั้นจะเป็นช่วงที่มีการใช้งานกับเซลล์เป็นเซลล์ปัจจุบัน

หากไม่พบเซลล์ที่ระบุในช่วงที่เลือก ระบบจะนําการเลือกที่มีอยู่ออกและเซลล์จะกลายเป็นเซลล์ปัจจุบันและช่วงที่มีการใช้งาน

หมายเหตุ:Range ที่ระบุต้องประกอบด้วยเซลล์เดียว มิฉะนั้นจะแสดงข้อยกเว้น

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

พารามิเตอร์

ชื่อประเภทคำอธิบาย
cellRangeเซลล์ที่จะตั้งค่าเป็นเซลล์ปัจจุบัน

ไปกลับ

Range — เซลล์ปัจจุบันที่กําหนดใหม่

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

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

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

setFrozenColumns(columns)

ตรึงจํานวนคอลัมน์ที่ระบุ หากเป็น 0 ระบบจะไม่ตรึงคอลัมน์

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

// Freezes the first column
sheet.setFrozenColumns(1);

พารามิเตอร์

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

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

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

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

setFrozenRows(rows)

ตรึงจํานวนแถวที่ระบุ หากเป็น 0 ระบบจะไม่ตรึงแถว

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

// Freezes the first row
sheet.setFrozenRows(1);

พารามิเตอร์

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

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

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

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

setIterativeCalculationConvergenceThreshold(minThreshold)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
minThresholdNumberเกณฑ์ Conversion ต่ําสุด (ต้องไม่ติดลบ)

ไปกลับ

Spreadsheet — สเปรดชีตนี้สําหรับเชนธุรกิจ

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

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

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

setIterativeCalculationEnabled(isEnabled)

ตั้งค่าว่าจะเปิดใช้การคํานวณซ้ําในสเปรดชีตนี้หรือไม่ หากก่อนหน้านี้ไม่ได้กําหนดจํานวนรอบการคํานวณและเกณฑ์ Conver สูงสุดไว้ตอนที่เปิดใช้การคํานวณ ระบบจะกําหนดค่าเริ่มต้นเป็น 50 และ 0.05 ตามลําดับ หากกําหนดค่าไว้ก่อนหน้านี้ ก็จะยังเก็บค่าก่อนหน้าไว้

พารามิเตอร์

ชื่อประเภทคำอธิบาย
isEnabledBooleantrue หากควรเปิดใช้การคํานวณแบบทําซ้ํา false มิฉะนั้นหากเปิดใช้

ไปกลับ

Spreadsheet — สเปรดชีตนี้สําหรับเชนธุรกิจ

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

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

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

setMaxIterativeCalculationCycles(maxIterations)

กําหนดจํานวนการทําซ้ําการคํานวณที่ควรดําเนินการในระหว่างการคํานวณซ้ํา ค่านี้ต้องอยู่ระหว่าง 1 ถึง 10,000 (รวม) และค่าเริ่มต้นคือ 50

พารามิเตอร์

ชื่อประเภทคำอธิบาย
maxIterationsIntegerจํานวนสูงสุดของการคํานวณซ้ํา (ระหว่าง 1 ถึง 10,000)

ไปกลับ

Spreadsheet — สเปรดชีตนี้สําหรับเชนธุรกิจ

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

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

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

setNamedRange(name, range)

ตั้งชื่อช่วง

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

พารามิเตอร์

ชื่อประเภทคำอธิบาย
nameStringชื่อที่จะตั้งช่วง
rangeRangeข้อกําหนดของช่วง

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

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

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

setRecalculationInterval(recalculationInterval)

ตั้งค่าความถี่ในการคํานวณสเปรดชีตนี้ใหม่

พารามิเตอร์

ชื่อประเภทคำอธิบาย
recalculationIntervalRecalculationIntervalช่วงการคํานวณใหม่

ไปกลับ

Spreadsheet — สเปรดชีตนี้สําหรับเชนธุรกิจ

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

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

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

setRowHeight(rowPosition, height)

ตั้งค่าความสูงของแถวของแถวที่ระบุเป็นพิกเซล โดยค่าเริ่มต้น แถวจะขยายออกให้พอดีกับเนื้อหาของเซลล์ หากต้องการบังคับให้แถวมีความสูงตามที่ตั้งไว้ ให้ใช้ Sheet.setRowHeightsForced(startRow, numRows, height)

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowPositionIntegerตําแหน่งแถวที่จะเปลี่ยน
heightIntegerความสูงเป็นพิกเซลที่จะตั้งค่า

ไปกลับ

Sheet — ชีตที่เป็นประโยชน์สําหรับการเชื่อมโยงวิธีการ

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

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

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

setSpreadsheetLocale(locale)

ตั้งค่าภาษาของสเปรดชีต

พารามิเตอร์

ชื่อประเภทคำอธิบาย
localeStringรหัสภาษาที่จะใช้ (เช่น 'en', 'fr' หรือ 'en_US')

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

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

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

setSpreadsheetTheme(theme)

ตั้งค่าธีมในสเปรดชีต

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
themeSpreadsheetThemeธีมที่จะใช้

ไปกลับ

SpreadsheetTheme — ธีมใหม่ในปัจจุบัน

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

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

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

setSpreadsheetTimeZone(timezone)

ตั้งค่าเขตเวลาสําหรับสเปรดชีต

พารามิเตอร์

ชื่อประเภทคำอธิบาย
timezoneStringเขตเวลา ซึ่งระบุในรูปแบบ "long" (เช่น "America/New_York" ตามที่แสดงใน Joda.org)

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

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

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

show(userInterface)

แสดงคอมโพเนนต์อินเทอร์เฟซที่กําหนดเองของผู้ใช้ในกล่องโต้ตอบที่อยู่ตรงกลางในมุมมองของเบราว์เซอร์ของเบราว์เซอร์ #39 สคริปต์ฝั่งเซิร์ฟเวอร์ไม่ถูกระงับ หากต้องการสื่อสารกับฝั่งเซิร์ฟเวอร์ คอมโพเนนต์อินเทอร์เฟซผู้ใช้ต้องทําการเรียกกลับแบบไม่พร้อมกันไปยังสคริปต์ฝั่งเซิร์ฟเวอร์

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

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

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

พารามิเตอร์

ชื่อประเภทคำอธิบาย
userInterfaceObjectHtmlOutput

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

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

  • https://www.googleapis.com/auth/script.container.ui

sort(columnPosition)

จัดเรียงแผ่นงานตามคอลัมน์จากน้อยไปหามาก

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

พารามิเตอร์

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

ไปกลับ

Sheet — ชีตซึ่งเหมาะสําหรับการเชื่อมโยงวิธีการ

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

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

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

sort(columnPosition, ascending)

จัดเรียงแผ่นงานตามคอลัมน์ ใช้พารามิเตอร์เพื่อระบุจากน้อยไปมากหรือมากไปน้อย

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnPositionIntegerคอลัมน์ที่จะจัดเรียง
ascendingBooleantrue สําหรับจัดเรียงจากน้อยไปมาก false จากมากไปน้อย

ไปกลับ

Sheet — ชีตซึ่งเหมาะสําหรับการเชื่อมโยงวิธีการ

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

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

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

toast(msg)

แสดงหน้าต่างป๊อปอัปที่มุมล่างขวาของสเปรดชีตพร้อมข้อความที่ระบุ

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
msgStringข้อความที่จะแสดงในข้อความโทสต์

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

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

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

toast(msg, title)

แสดงหน้าต่างป๊อปอัปที่มุมล่างขวาของสเปรดชีตพร้อมระบุข้อความและชื่อ

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

พารามิเตอร์

ชื่อประเภทคำอธิบาย
msgStringข้อความที่จะแสดงในข้อความโทสต์
titleStringชื่อของข้อความโทสต์

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

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

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

toast(msg, title, timeoutSeconds)

แสดงหน้าต่างป๊อปอัปที่มุมล่างขวาของสเปรดชีตที่มีชื่อและข้อความนั้น ซึ่งจะปรากฏอยู่เรื่อยๆ เป็นระยะเวลาหนึ่ง

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
msgStringข้อความที่จะแสดงในข้อความโทสต์
titleStringชื่อของข้อความโทสต์
timeoutSecondsNumberระยะหมดเวลาเป็นวินาที หาก null ข้อความโทสต์จะอยู่ที่ 5 วินาที หากเป็นลบ ข้อความโทสต์จะยังคงอยู่จนกว่าจะปิด

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

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

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

unhideColumn(column)

เลิกซ่อนคอลัมน์ในช่วงที่กําหนด

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

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
columnRangeช่วงสําหรับเลิกซ่อน หากซ่อนไว้

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

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

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

unhideRow(row)

เลิกซ่อนแถวในช่วงที่กําหนด

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

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
rowRangeช่วงสําหรับเลิกซ่อน หากซ่อนไว้

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

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

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

updateMenu(name, subMenus)

อัปเดตเมนูที่เพิ่มโดย addMenu(name, subMenus) ทํางานเหมือนกับ addMenu(name, subMenus)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

พารามิเตอร์

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

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

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

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

waitForAllDataExecutionsCompletion(timeoutInSeconds)

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

พารามิเตอร์

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

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

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

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

วิธีการเลิกใช้งาน