หน้านี้ได้รับการแปลโดย Cloud Translation API

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`	รอจนกว่าการดำเนินการปัจจุบันทั้งหมดในสเปรดชีตจะเสร็จสมบูรณ์ โดยระบบจะหมดเวลาหลังจากผ่านไปตามจำนวนวินาทีที่ระบุ

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

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
`getSheetProtection()`	`PageProtection`	แสดงผลอินสแตนซ์ `PageProtection` ที่อธิบายสิทธิ์สำหรับชีตปัจจุบัน
`isAnonymousView()`	`Boolean`	บ่งบอกว่าเอกสารอนุญาตให้ดูแบบไม่ระบุตัวตนหรือไม่
`isAnonymousWrite()`	`Boolean`	ระบุว่าเอกสารอนุญาตให้ผู้ใช้ที่ไม่ระบุชื่อแก้ไขได้หรือไม่
`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`	`void`	กำหนดนโยบายของเอกสารเกี่ยวกับการอ่านและการเขียนแบบไม่ระบุตัวตน
`setSheetProtection(permissions)`	`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())

พารามิเตอร์

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

รีเทิร์น

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()}`);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`key`	`String`	คีย์สำหรับข้อมูลเมตาของนักพัฒนาแอปใหม่
`visibility`	`DeveloperMetadataVisibility`	ระดับการแชร์ข้อมูลเมตาของนักพัฒนาแอปใหม่

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สําหรับการต่อเชื่อม

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

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()}`);

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สําหรับการต่อเชื่อม

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

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()}`);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`key`	`String`	คีย์สำหรับข้อมูลเมตาของนักพัฒนาแอปใหม่
`value`	`String`	ค่าสำหรับข้อมูลเมตาของนักพัฒนาแอปใหม่
`visibility`	`DeveloperMetadataVisibility`	ระดับการแชร์ข้อมูลเมตาของนักพัฒนาแอปใหม่

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สําหรับการต่อเชื่อม

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

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

`addEditor(emailAddress)`

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

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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

`addEditor(user)`

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`user`	`User`	การแสดงผู้ใช้ที่จะเพิ่ม

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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

`addEditors(emailAddresses)`

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

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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);
}

พารามิเตอร์

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

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

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

`addViewer(emailAddress)`

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

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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

`addViewer(user)`

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`user`	`User`	การแสดงผู้ใช้ที่จะเพิ่ม

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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

`addViewers(emailAddresses)`

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

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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"]);

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`name`	`String`	ชื่อสำเนา

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สําหรับการต่อเชื่อม

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

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');

พารามิเตอร์

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

รีเทิร์น

TextFinder — TextFinder ของสเปรดชีต

`deleteActiveSheet()`

ลบชีตที่ใช้งานอยู่ในปัจจุบัน

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

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`columnPosition`	`Integer`	ตำแหน่งของคอลัมน์ โดยเริ่มจาก 1 สำหรับคอลัมน์แรก

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`rowPosition`	`Integer`	ตำแหน่งของแถว โดยเริ่มจาก 1 สำหรับแถวแรก

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`sheet`	`Sheet`	แผ่นงานที่จะลบ

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

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 — ชีตใหม่

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

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 — เซลล์ที่ใช้งานอยู่ในปัจจุบัน

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

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 — ช่วงที่มีการใช้งาน

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

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

ดูเพิ่มเติม

setActiveRange(range)

`getActiveRangeList()`

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

หากเลือกช่วงเดียว การดำเนินการนี้จะทํางานแบบการเรียก getActiveRange()

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

รีเทิร์น

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

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

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

ดูเพิ่มเติม

setActiveRangeList(rangeList)

`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 ที่สร้างขึ้นใหม่อาจอยู่ภายใต้โควต้าที่เข้มงวดขึ้นชั่วคราว

พารามิเตอร์

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

รีเทิร์น

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[] — แถบในสเปรดชีตนี้

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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 — เซลล์ปัจจุบัน

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

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 — ช่วงที่มีข้อมูลทั้งหมดในสเปรดชีต

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

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[] — รายการสูตรแหล่งข้อมูล

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

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 ของแหล่งข้อมูล

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

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[] — กําหนดเวลารีเฟรชของสเปรดชีตนี้

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

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[] — อาร์เรย์ของชีตแหล่งข้อมูลทั้งหมด

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

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[] — รายการตารางแหล่งข้อมูล

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

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[] — อาร์เรย์ของแหล่งข้อมูลทั้งหมด

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

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[] — ข้อมูลเมตาของนักพัฒนาแอปที่เชื่อมโยงกับช่วงนี้

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

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

`getEditors()`

รับรายชื่อผู้แก้ไขสำหรับ Spreadsheet นี้

รีเทิร์น

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

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

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 หากสเปรดชีตนี้ไม่มีแบบฟอร์มที่เชื่อมโยง

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

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 — จํานวนคอลัมน์ที่ตรึง

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

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 — จํานวนแถวที่ตรึงไว้

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

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[] — อาร์เรย์ของรูปภาพที่วางทับบนตาราง

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

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 — เกณฑ์การบรรจบ

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

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 — คอลัมน์สุดท้ายของสเปรดชีตที่มีเนื้อหา

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

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 — แถวสุดท้ายของสเปรดชีตที่มีเนื้อหา

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

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 — จํานวนการวนซ้ำสูงสุดของคํานวณ

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

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

`getName()`

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

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

รีเทิร์น

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

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

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[] — อาร์เรย์ของช่วงที่มีชื่อทั้งหมดในสเปรดชีต

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

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 หากเอกสารอยู่ในไดรฟ์ที่แชร์

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

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[] — รายการธีมที่กําหนดไว้ล่วงหน้า

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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");

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`a1Notation`	`String`	ช่วงที่จะแสดงผลตามที่ระบุไว้ในรูปแบบ A1 หรือ R1C1

รีเทิร์น

Range — ช่วงของระดับที่สถานที่ที่ระบุ

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`name`	`String`	ชื่อของช่วงที่จะใช้

รีเทิร์น

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']);

พารามิเตอร์

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

รีเทิร์น

RangeList — รายการช่วงของตำแหน่งที่ระบุ

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

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 — ช่วงเวลาการคํานวณสําหรับสเปรดชีตนี้

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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 — รายการที่เลือกอยู่

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`name`	`String`	ชื่อชีตที่จะรับ

รีเทิร์น

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 — รหัสของชีตที่ไม่ซ้ำกันสำหรับสเปรดชีต

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

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 — ชื่อชีต

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`startRow`	`Integer`	ตำแหน่งของแถวเริ่มต้น
`startColumn`	`Integer`	ตำแหน่งของคอลัมน์เริ่มต้น
`numRows`	`Integer`	จำนวนแถวที่จะแสดงค่า
`numColumns`	`Integer`	จำนวนคอลัมน์ที่จะแสดงผลค่า

รีเทิร์น

Object[][] — อาร์เรย์ค่า 2 มิติ

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

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 — ภาษาของสเปรดชีต

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

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 — ธีมที่ใช้อยู่ในปัจจุบัน

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

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 — เขตเวลาซึ่งระบุในรูปแบบ "แบบยาว" (เช่น "อเมริกา/นิวยอร์ก" ตามที่ระบุโดย Joda.org)

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

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 ของสเปรดชีตที่ระบุ

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

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

`getViewers()`

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

รีเทิร์น

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

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

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

พารามิเตอร์

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

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

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

พารามิเตอร์

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`afterPosition`	`Integer`	คอลัมน์ที่ควรเพิ่มคอลัมน์ใหม่ต่อจากนี้

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`afterPosition`	`Integer`	คอลัมน์ที่ควรเพิ่มคอลัมน์ใหม่ต่อจากนี้
`howMany`	`Integer`	จํานวนคอลัมน์ที่จะแทรก

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`blobSource`	`BlobSource`	Blob ที่มีเนื้อหารูปภาพ ประเภท MIME และชื่อ (ไม่บังคับ)
`column`	`Integer`	ตำแหน่งคอลัมน์
`row`	`Integer`	ตำแหน่งแถว

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`blobSource`	`BlobSource`	Blob ที่มีเนื้อหารูปภาพ ประเภท MIME และชื่อ (ไม่บังคับ)
`column`	`Integer`	ตำแหน่งคอลัมน์
`row`	`Integer`	ตำแหน่งแถว
`offsetX`	`Integer`	การเลื่อนแนวนอนจากมุมเซลล์เป็นพิกเซล
`offsetY`	`Integer`	การเลื่อนแนวตั้งจากมุมเซลล์เป็นพิกเซล

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`url`	`String`	URL ของรูปภาพ
`column`	`Integer`	ตำแหน่งคอลัมน์ตารางกริด
`row`	`Integer`	ตำแหน่งแถวตารางกริด

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`url`	`String`	URL ของรูปภาพ
`column`	`Integer`	ตำแหน่งคอลัมน์
`row`	`Integer`	ตำแหน่งแถว
`offsetX`	`Integer`	การเลื่อนแนวนอนจากมุมเซลล์เป็นพิกเซล
`offsetY`	`Integer`	การเลื่อนแนวตั้งจากมุมเซลล์เป็นพิกเซล

รีเทิร์น

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

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`beforePosition`	`Integer`	แถวก่อนหน้าที่ควรเพิ่มแถวใหม่

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`afterPosition`	`Integer`	แถวที่ควรเพิ่มแถวใหม่ต่อจากนี้
`howMany`	`Integer`	จํานวนแถวที่จะแทรก

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`beforePosition`	`Integer`	แถวก่อนหน้าที่ควรเพิ่มแถวใหม่
`howMany`	`Integer`	จํานวนแถวที่จะแทรก

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

`insertSheet()`

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

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

รีเทิร์น

Sheet — ชีตใหม่

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

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

`insertSheet(sheetIndex)`

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตใหม่

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

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});

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`sheetIndex`	`Integer`	ดัชนีของชีตที่สร้างใหม่ หากต้องการแทรกชีตเป็นชีตแรกในสเปรดชีต ให้ตั้งค่าเป็น 0
`options`	`Object`	อาร์กิวเมนต์ขั้นสูงของ JavaScript (ไม่บังคับ)

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

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

รีเทิร์น

Sheet — ชีตใหม่

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

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});

พารามิเตอร์

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

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

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

รีเทิร์น

Sheet — ชีตใหม่

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

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

`insertSheet(sheetName)`

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`sheetName`	`String`	ชื่อชีตใหม่

รีเทิร์น

Sheet — ชีตใหม่

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตใหม่

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

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});

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`sheetName`	`String`	ชื่อชีตใหม่
`sheetIndex`	`Integer`	ดัชนีของชีตที่แทรกใหม่ หากต้องการแทรกชีตเป็นชีตแรกในสเปรดชีต ให้ตั้งค่าเป็น 0
`options`	`Object`	อาร์กิวเมนต์ขั้นสูงของ JavaScript (ไม่บังคับ)

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

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

รีเทิร์น

Sheet — ชีตใหม่

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

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});

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`sheetName`	`String`	ชื่อชีตใหม่
`options`	`Object`	อาร์กิวเมนต์ขั้นสูงของ JavaScript (ไม่บังคับ)

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

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

รีเทิร์น

Sheet — ชีตใหม่

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

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

`insertSheetWithDataSourceTable(spec)`

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

// 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');

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
  '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
 .asBigQuery()
 .setProjectId('project-id-1')
 .setRawQuery(query)
 .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
 .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตใหม่

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

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

พารามิเตอร์

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

รีเทิร์น

Boolean — true หากคอลัมน์ซ่อนอยู่ และ false ในกรณีอื่นๆ

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

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

`isIterativeCalculationEnabled()`

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

// 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');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

รีเทิร์น

Boolean — true หากเปิดใช้งานการคํานวณซ้ำ false ไม่เช่นนั้น

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

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

พารามิเตอร์

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

รีเทิร์น

Boolean — true หากแถวซ่อนอยู่ และ false ในกรณีอื่นๆ

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

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

พารามิเตอร์

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

รีเทิร์น

Boolean — true หากแถวซ่อนอยู่ และ false ในกรณีอื่นๆ

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

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

`moveActiveSheet(pos)`

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

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

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`pos`	`Integer`	ตำแหน่ง 1-index เพื่อย้ายชีตที่ใช้งานอยู่ในรายการชีต

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีแผนภูมิ

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

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

`refreshAllDataSources()`

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

ใช้เมธอด 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');

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

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(`Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`);

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

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

`removeEditor(emailAddress)`

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

สำหรับไฟล์ในไดรฟ์ ระบบจะนำผู้ใช้ออกจากรายชื่อผู้ดูด้วย

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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

`removeEditor(user)`

สำหรับไฟล์ในไดรฟ์ ระบบจะนำผู้ใช้ออกจากรายชื่อผู้ดูด้วย

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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
}

พารามิเตอร์

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

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

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");

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`name`	`String`	ชื่อของช่วง

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

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

`removeViewer(emailAddress)`

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

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

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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

`removeViewer(user)`

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

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

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — Spreadsheet นี้สําหรับการต่อเชื่อม

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

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");

พารามิเตอร์

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

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

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");

พารามิเตอร์

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

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

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 — ธีมเริ่มต้น

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`rangeList`	`RangeList`	รายการช่วงที่จะเลือก

รีเทิร์น

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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");

พารามิเตอร์

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

รีเทิร์น

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

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

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]);

พารามิเตอร์

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

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`sheet`	`Sheet`	ชีตใหม่ที่ใช้อยู่
`restoreSelection`	`Boolean`	หากเป็น `true` การเลือกล่าสุดของชีตใหม่ที่มีการใช้งานอยู่จะกลับมาเป็นการเลือกอีกครั้งเมื่อชีตใหม่เริ่มทำงาน หากเป็น `false` ชีตใหม่จะทำงานโดยไม่มีการเปลี่ยนแปลงการเลือกปัจจุบัน

รีเทิร์น

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

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

`setCurrentCell(cell)`

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

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

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

Range — เซลล์ปัจจุบันที่ตั้งค่าใหม่

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

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

พารามิเตอร์

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

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

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

พารามิเตอร์

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

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

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

`setIterativeCalculationConvergenceThreshold(minThreshold)`

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`minThreshold`	`Number`	เกณฑ์การบรรจบกันขั้นต่ำ (ต้องไม่เป็นค่าลบ)

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สําหรับการต่อเชื่อม

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

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

`setIterativeCalculationEnabled(isEnabled)`

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

// 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');

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`isEnabled`	`Boolean`	`true` หากควรเปิดใช้การคำนวณซ้ำ `false` ไม่เช่นนั้น

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สําหรับการต่อเชื่อม

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

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

`setMaxIterativeCalculationCycles(maxIterations)`

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

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

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สําหรับการต่อเชื่อม

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`name`	`String`	ชื่อที่จะตั้งให้กับช่วง
`range`	`Range`	ข้อกำหนดของช่วง

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

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

`setRecalculationInterval(recalculationInterval)`

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

// 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');

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(SpreadsheetApp.RecalculationInterval.ON_CHANGE);

// Logs the calculation interval to the console.
console.log(interval);

พารามิเตอร์

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

รีเทิร์น

Spreadsheet — สเปรดชีตนี้สําหรับการต่อเชื่อม

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

`setSpreadsheetLocale(locale)`

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

// 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 spreadsheet locale.
ss.setSpreadsheetLocale('fr');

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

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

พารามิเตอร์

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

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

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]);

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setSpreadsheetTimeZone(timezone)`

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

// 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);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`timezone`	`String`	เขตเวลาซึ่งระบุในรูปแบบ "แบบยาว" (เช่น "อเมริกา/นิวยอร์ก" ตามที่ระบุโดย Joda.org)

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

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

`show(userInterface)`

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

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

ข้อมูลโค้ดต่อไปนี้แสดงแอปพลิเคชัน 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.

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`userInterface`	`Object`	`HtmlOutput`

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

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

พารามิเตอร์

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

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`columnPosition`	`Integer`	คอลัมน์ที่จะจัดเรียง
`ascending`	`Boolean`	`true` สำหรับการจัดเรียงจากน้อยไปมาก และ `false` สำหรับการจัดเรียงจากมากไปน้อย

รีเทิร์น

Sheet — ชีตที่มีประโยชน์สำหรับการต่อเชนเมธอด

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

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');

พารามิเตอร์

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

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

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');

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`msg`	`String`	ข้อความที่จะแสดงในข้อความแจ้ง
`title`	`String`	ชื่อของข้อความแจ้งแบบไม่บังคับ

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`msg`	`String`	ข้อความที่จะแสดงในข้อความแจ้ง
`title`	`String`	ชื่อของข้อความแจ้งแบบไม่บังคับ
`timeoutSeconds`	`Number`	ระยะหมดเวลาเป็นวินาที หากเป็น `null` ระบบจะตั้งค่าเริ่มต้นของข้อความแจ้งเป็น 5 วินาที หากเป็นค่าลบ ข้อความแจ้งจะยังคงแสดงอยู่จนกว่าจะปิด

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`column`	`Range`	ช่วงที่จะเลิกซ่อน หากซ่อนอยู่

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`row`	`Range`	ช่วงที่จะเลิกซ่อน หากซ่อนอยู่

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

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

พารามิเตอร์

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

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

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

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

พารามิเตอร์

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

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

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

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

`getSheetProtection()`

เลิกใช้งานแล้ว สำหรับสเปรดชีตที่สร้างใน Google ชีตเวอร์ชันใหม่ ให้ใช้ Sheet.getProtections(type) ซึ่งจะแสดงผลคลาส Protection ที่มีประสิทธิภาพมากกว่า แม้ว่าเราจะเลิกใช้งานวิธีการนี้แล้ว แต่ก็ยังใช้ได้อยู่เพื่อให้ชีตเวอร์ชันเก่าใช้งานร่วมกันได้

แสดงผลอินสแตนซ์ PageProtection ที่อธิบายสิทธิ์สำหรับชีตปัจจุบัน

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

var permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser("user@example.com");

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
var users = permissions.getUsers();
Logger.log(users);

รีเทิร์น

PageProtection — ออบเจ็กต์ที่อธิบายสิทธิ์การเข้าถึงชีต

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

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

`isAnonymousView()`

เลิกใช้งานแล้ว ตั้งแต่เดือนมกราคม 2014 เราได้เลิกใช้งานฟังก์ชันนี้และฟังก์ชันดังกล่าวไม่พร้อมใช้งานใน Google ชีตเวอร์ชันใหม่

บ่งบอกว่าเอกสารอนุญาตให้ดูแบบไม่ระบุตัวตนหรือไม่ เนื่องจากGoogle ชีตเวอร์ชันใหม่ไม่รองรับการดำเนินการนี้อีกต่อไป ให้ใช้ File.getSharingAccess() และ File.getSharingPermission() แทน

// Determine if the document allows anonymous viewing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission != DriveApp.Permission.NONE;

รีเทิร์น

Boolean — true หากเอกสารอนุญาตให้ดูแบบไม่ระบุตัวตน หรือไม่เช่นนั้นให้ใช้ false

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

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

ดูเพิ่มเติม

บริการไดรฟ์

`isAnonymousWrite()`

ระบุว่าเอกสารอนุญาตให้ผู้ใช้ที่ไม่ระบุชื่อแก้ไขได้หรือไม่ เนื่องจากGoogle ชีตเวอร์ชันใหม่ไม่รองรับรูปแบบนี้อีกต่อไป ให้ใช้ File.getSharingAccess() และ File.getSharingPermission() แทน

// Determine if the document allow anonymous edits via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission == DriveApp.Permission.EDIT;

รีเทิร์น

Boolean — true หากเอกสารอนุญาตให้แก้ไขแบบไม่ระบุตัวตน false ไม่เช่นนั้น

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

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

ดูเพิ่มเติม

บริการไดรฟ์

`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`

กำหนดนโยบายของเอกสารเกี่ยวกับการอ่านและการเขียนแบบไม่ระบุตัวตน เนื่องจากGoogle ชีตเวอร์ชันใหม่ไม่รองรับการดำเนินการนี้แล้ว ให้ใช้ File.setSharing(accessType, permissionType) แทน

// Set the document's policy on anonymous reading and writing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApi.Access.PRIVATE, file.getSharingPermission());

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`anonymousReadAllowed`	`Boolean`	`true` เพื่ออนุญาตการอ่านแบบไม่ระบุตัวตน หรือ `false` หากไม่อนุญาต
`anonymousWriteAllowed`	`Boolean`	`true` เพื่ออนุญาตการอ่านแบบไม่ระบุตัวตน หรือ `false` หากไม่อนุญาต

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

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

ดูเพิ่มเติม

`setSheetProtection(permissions)`

เลิกใช้งานแล้ว สำหรับสเปรดชีตที่สร้างใน Google ชีตเวอร์ชันใหม่ ให้ใช้ Sheet.protect() ซึ่งจะแสดงผลคลาส Protection ที่มีประสิทธิภาพมากกว่า แม้ว่าเราจะเลิกใช้งานวิธีการนี้แล้ว แต่ก็ยังใช้ได้เพื่อให้ชีตเวอร์ชันเก่าใช้งานร่วมกันได้

ตั้งค่าสิทธิ์สำหรับชีตปัจจุบัน

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

var permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
var sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`permissions`	`PageProtection`	ออบเจ็กต์สิทธิ์การเข้าถึงที่จะตั้งค่าในชีตนี้

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

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