Class SpreadsheetApp

SpreadsheetApp

Mengakses dan membuat file Google Spreadsheet. Class ini adalah class induk untuk Layanan Spreadsheet.

Properti

PropertiJenisDeskripsi
AutoFillSeriesAutoFillSeriesEnumerasi jenis deret yang digunakan untuk menghitung nilai yang terisi otomatis.
BandingThemeBandingThemeEnumerasi kemungkinan tema garis berwarna.
BooleanCriteriaBooleanCriteriaEnumerasi kriteria boolean pemformatan bersyarat.
BorderStyleBorderStyleEnumerasi gaya yang valid untuk menyetel batas pada Range.
ColorTypeColorTypeEnumerasi kemungkinan jenis warna.
CopyPasteTypeCopyPasteTypeEnumerasi kemungkinan jenis tempel.
DataExecutionErrorCodeDataExecutionErrorCodeEnumerasi kemungkinan kode error eksekusi data.
DataExecutionStateDataExecutionStateEnumerasi kemungkinan status eksekusi data.
DataSourceParameterTypeDataSourceParameterTypeEnumerasi kemungkinan jenis parameter sumber data.
DataSourceRefreshScopeDataSourceRefreshScopeEnumerasi kemungkinan cakupan pembaruan sumber data.
DataSourceTypeDataSourceTypeEnumerasi kemungkinan jenis sumber data.
DataValidationCriteriaDataValidationCriteriaEnumerasi yang mewakili kriteria validasi data yang dapat ditetapkan pada rentang.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeEnumerasi aturan pengelompokan tanggal dan waktu.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeEnumerasi kemungkinan jenis lokasi metadata developer.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityEnumerasi kemungkinan visibilitas metadata developer.
DimensionDimensionEnumerasi kemungkinan dimensi {i>spreadsheet<i}.
DirectionDirectionEnumerasi kemungkinan arah yang dapat digerakkan dalam {i>spreadsheet<i} menggunakan tanda panah tombol.
FrequencyTypeFrequencyTypeEnumerasi kemungkinan jenis frekuensi.
GroupControlTogglePositionGroupControlTogglePositionEnumerasi posisi tombol kontrol grup.
InterpolationTypeInterpolationTypeEnumerasi jenis interpolasi gradien format bersyarat.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionEnumerasi fungsi yang dapat digunakan untuk meringkas nilai dalam tabel pivot.
PivotValueDisplayTypePivotValueDisplayTypeEnumerasi cara nilai pivot dapat ditampilkan.
ProtectionTypeProtectionTypeEnumerasi yang mewakili bagian-bagian {i>spreadsheet<i} yang dapat dilindungi dari pengeditan.
RecalculationIntervalRecalculationIntervalEnumerasi kemungkinan interval yang dapat digunakan dalam penghitungan ulang spreadsheet.
RelativeDateRelativeDateEnumerasi opsi tanggal relatif untuk menghitung nilai yang akan digunakan di BooleanCriteria berbasis tanggal.
SheetTypeSheetTypeEnumerasi berbagai jenis sheet yang bisa ada di spreadsheet.
SortOrderSortOrderEnumerasi tata urutan.
TextDirectionTextDirectionEnumerasi rute teks yang valid.
TextToColumnsDelimiterTextToColumnsDelimiterEnumerasi pemisah preset untuk memisahkan teks ke kolom.
ThemeColorTypeThemeColorTypeEnumerasi kemungkinan jenis warna tema.
ValueTypeValueTypeEnumerasi jenis nilai yang ditampilkan oleh Range.getValue() dan Range.getValues() dari class Range layanan Spreadsheet. Nilai enumerasi yang tercantum di bawah adalah selain Number, Boolean, Date, atau String.
WrapStrategyWrapStrategyEnumerasi strategi yang digunakan untuk menggabungkan sel.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
create(name)SpreadsheetMembuat spreadsheet baru dengan nama tertentu.
create(name, rows, columns)SpreadsheetMembuat {i>spreadsheet<i} baru dengan nama tertentu, jumlah baris dan kolom yang ditentukan.
enableAllDataSourcesExecution()voidMengaktifkan eksekusi data untuk semua jenis sumber data.
enableBigQueryExecution()voidMengaktifkan eksekusi data untuk sumber data BigQuery.
enableLookerExecution()voidMengaktifkan eksekusi data untuk sumber data Looker.
flush()voidMenerapkan semua perubahan Spreadsheet yang tertunda.
getActive()SpreadsheetMenampilkan spreadsheet yang sedang aktif, atau null jika tidak ada.
getActiveRange()RangeMenampilkan rentang yang dipilih dalam sheet aktif, atau null jika tidak ada rentang yang aktif.
getActiveRangeList()RangeListMenampilkan daftar rentang aktif dalam sheet aktif atau null jika tidak ada rentang dipilih.
getActiveSheet()SheetMendapatkan sheet aktif dalam spreadsheet.
getActiveSpreadsheet()SpreadsheetMenampilkan spreadsheet yang sedang aktif, atau null jika tidak ada.
getCurrentCell()RangeMengembalikan sel saat ini (yang disorot) yang dipilih di salah satu rentang aktif dalam sheet aktif atau null jika tidak ada sel saat ini.
getSelection()SelectionMenampilkan Selection saat ini di spreadsheet.
getUi()UiMengembalikan instance lingkungan antarmuka pengguna spreadsheet yang memungkinkan skrip untuk menambahkan fitur seperti menu, dialog, dan bilah sisi.
newCellImage()CellImageBuilderMembuat builder untuk CellImage.
newColor()ColorBuilderMembuat builder untuk Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderMembuat builder untuk aturan format bersyarat.
newDataSourceSpec()DataSourceSpecBuilderMembuat builder untuk DataSourceSpec.
newDataValidation()DataValidationBuilderMembuat builder untuk aturan validasi data.
newFilterCriteria()FilterCriteriaBuilderMembuat builder untuk FilterCriteria.
newRichTextValue()RichTextValueBuilderMembuat builder untuk nilai Rich Text.
newTextStyle()TextStyleBuilderMembuat builder untuk gaya teks.
open(file)SpreadsheetMembuka spreadsheet yang sesuai dengan objek File yang ditentukan.
openById(id)SpreadsheetMembuka spreadsheet yang berisi ID yang diberikan.
openByUrl(url)SpreadsheetMembuka spreadsheet yang berisi URL tertentu.
setActiveRange(range)RangeMenetapkan rentang yang ditentukan sebagai active range, dengan bagian atas sel kiri dalam rentang sebagai current cell.
setActiveRangeList(rangeList)RangeListMenetapkan daftar rentang yang ditentukan sebagai active ranges.
setActiveSheet(sheet)SheetMenetapkan sheet aktif dalam spreadsheet.
setActiveSheet(sheet, restoreSelection)SheetMenetapkan sheet aktif dalam spreadsheet, dengan opsi untuk memulihkan pilihan terbaru yang berada di dalam {i>sheet<i} tersebut.
setActiveSpreadsheet(newActiveSpreadsheet)voidMenetapkan spreadsheet aktif.
setCurrentCell(cell)RangeMenetapkan sel yang ditentukan sebagai current cell.

Dokumentasi mendetail

create(name)

Membuat spreadsheet baru dengan nama tertentu.

// The code below creates a new spreadsheet "Finances" and logs the URL for it
var ssNew = SpreadsheetApp.create("Finances");
Logger.log(ssNew.getUrl());

Parameter

NamaJenisDeskripsi
nameStringNama untuk {i>spreadsheet<i}.

Pulang pergi

Spreadsheet — spreadsheet baru

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

create(name, rows, columns)

Membuat {i>spreadsheet<i} baru dengan nama tertentu, jumlah baris dan kolom yang ditentukan.

// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the
// URL for it
var ssNew = SpreadsheetApp.create("Finances", 50, 5);
Logger.log(ssNew.getUrl());

Parameter

NamaJenisDeskripsi
nameStringNama untuk {i>spreadsheet<i}.
rowsIntegerJumlah baris pada {i>spreadsheet<i}.
columnsIntegerJumlah kolom di {i>spreadsheet<i}.

Pulang pergi

Spreadsheet — spreadsheet baru

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

enableAllDataSourcesExecution()

Mengaktifkan eksekusi data untuk semua jenis sumber data.

Eksekusi data akan menampilkan pengecualian jika jenis sumber data tidak diaktifkan. Gunakan metode ini untuk mengaktifkan eksekusi data bagi semua jenis sumber data.

// Turns data execution on for all types of data sources.
SpreadsheetApp.enableAllDataSourcesExecution();

// 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 the first data source sheet in the spreadsheet and refreshes the data.
ss.getDataSourceSheets()[0].refreshData();

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

  • https://www.googleapis.com/auth/bigquery.readonly

enableBigQueryExecution()

Mengaktifkan eksekusi data untuk sumber data BigQuery.

Eksekusi data untuk sumber data BigQuery akan menampilkan pengecualian jika tidak diaktifkan.

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

// 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 the first data source sheet in the spreadsheet and refreshes the BigQuery data.
ss.getDataSourceSheets()[0].refreshData();

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

  • https://www.googleapis.com/auth/bigquery.readonly

enableLookerExecution()

Mengaktifkan eksekusi data untuk sumber data Looker.

Eksekusi data untuk sumber data Looker akan menampilkan pengecualian jika tidak diaktifkan.

// Turns data execution on for Looker data sources.
SpreadsheetApp.enableLookerExecution();

// 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 the first data source sheet in the spreadsheet and refreshes the associated Looker
// data.
ss.getDataSourceSheets()[0].refreshData();

flush()

Menerapkan semua perubahan Spreadsheet yang tertunda.

Operasi {i>spreadsheet<i} terkadang dipaketkan bersama untuk meningkatkan performa, seperti ketika melakukan beberapa panggilan ke Range.getValue(). Namun, terkadang Anda mungkin ingin memastikan bahwa semua perubahan yang tertunda akan langsung dibuat, misalnya untuk menampilkan data pengguna saat skrip dijalankan.

// The code below changes the background color of cells A1 and B1 twenty times. You should be
// able to see the updates live in the spreadsheet. If flush() is not called, the updates may
// be applied live or may all be applied at once when the script completes.
function colors() {
  var sheet = SpreadsheetApp.getActiveSheet();
  for (var i = 0; i < 20; i++) {
    if ((i % 2) == 0) {
      sheet.getRange('A1').setBackground('green');
      sheet.getRange('B1').setBackground('red');
    } else {
      sheet.getRange('A1').setBackground('red');
      sheet.getRange('B1').setBackground('green');
    }
    SpreadsheetApp.flush();
  }
}

getActive()

Menampilkan spreadsheet yang sedang aktif, atau null jika tidak ada.

Fungsi yang dijalankan dalam konteks {i>spreadsheet<i} bisa mendapatkan referensi ke objek {i>Spreadsheet<i} yang sesuai dengan memanggil fungsi ini.

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActive().getUrl());

Pulang pergi

Spreadsheet — objek Spreadsheet aktif

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getActiveRange()

Menampilkan rentang yang dipilih dalam sheet aktif, atau null jika tidak ada rentang yang aktif. Jika beberapa rentang dipilih, metode ini hanya menampilkan rentang terakhir yang dipilih.

Ini umumnya berarti rentang yang telah dipilih pengguna dalam sheet aktif, tetapi dalam itu mengacu pada sel yang secara aktif dihitung ulang.

// The code below logs the background color for the active range.
var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

Pulang pergi

Range — Rentang aktif.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getActiveRangeList()

Menampilkan daftar rentang aktif dalam sheet aktif atau null jika tidak ada rentang dipilih. Rentang aktif yang berisi sel yang disorot saat ini ditempatkan terakhir dalam daftar.

Jika ada satu rentang yang dipilih, rentang ini akan berperilaku sebagai panggilan getActiveRange().

// Returns the list of active ranges.
var rangeList = SpreadsheetApp.getActiveRangeList();

Pulang pergi

RangeList — daftar rentang aktif

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getActiveSheet()

Mendapatkan sheet aktif dalam spreadsheet.

{i>Sheet<i} aktif dalam {i>spreadsheet<i} adalah lembar kerja yang sedang ditampilkan di {i>spreadsheet<i} UI.

// The code below logs the name of the active sheet.
Logger.log(SpreadsheetApp.getActiveSheet().getName());

Pulang pergi

Sheet — objek Sheet yang aktif

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getActiveSpreadsheet()

Menampilkan spreadsheet yang sedang aktif, atau null jika tidak ada.

Fungsi yang dijalankan dalam konteks {i>spreadsheet<i} bisa mendapatkan referensi ke objek Spreadsheet yang sesuai dengan memanggil fungsi ini.

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

Pulang pergi

Spreadsheet — objek Spreadsheet aktif

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getCurrentCell()

Mengembalikan sel saat ini (yang disorot) yang dipilih di salah satu rentang aktif dalam sheet aktif atau null jika tidak ada sel saat ini.

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

Pulang pergi

Range — sel saat ini

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getSelection()

Menampilkan Selection saat ini di spreadsheet.

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

Pulang pergi

Selection — pilihan saat ini

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getUi()

Mengembalikan instance lingkungan antarmuka pengguna spreadsheet yang memungkinkan skrip untuk menambahkan fitur seperti menu, dialog, dan bilah sisi. Skrip hanya dapat berinteraksi dengan UI untuk instance spreadsheet yang terbuka saat ini, dan hanya jika skrip terikat ke spreadsheet tersebut. Untuk informasi selengkapnya, lihat panduan untuk menu serta dialog dan sidebar.

// Add a custom menu to the active spreadsheet, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Pulang pergi

Ui — instance lingkungan antarmuka pengguna spreadsheet ini


newCellImage()

Membuat builder untuk CellImage.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 on Sheet1.
const range = sheet.getRange('A1');

// Builds an image using a source URL.
const cellImage = SpreadsheetApp.newCellImage()
  .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png')
  .build();

// Sets the image in cell A1.
range.setValue(cellImage);

Pulang pergi

CellImageBuilder — Builder baru.


newColor()

Membuat builder untuk Color.

var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();

Pulang pergi

ColorBuilder — Builder baru.


newConditionalFormatRule()

Membuat builder untuk aturan format bersyarat.

// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red
// if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActive().getActiveSheet();
var range = sheet.getRange('A1:B3');
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build()
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Pulang pergi

ConditionalFormatRuleBuilder — builder baru.


newDataSourceSpec()

Membuat builder untuk DataSourceSpec.

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

// Enables BigQuery.
SpreadsheetApp.enableBigQueryExecution();

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

Pulang pergi

DataSourceSpecBuilder — Builder baru.


newDataValidation()

Membuat builder untuk aturan validasi data.

var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireNumberBetween(1, 100)
    .setAllowInvalid(false)
    .setHelpText('Number must be between 1 and 100.')
    .build();
cell.setDataValidation(rule);

Pulang pergi

DataValidationBuilder — Builder baru.


newFilterCriteria()

Membuat builder untuk FilterCriteria.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the range to A1:D20.
const range = sheet.getRange('A1:D20');

// Creates a filter and applies it to the specified range.
range.createFilter();

// Gets the current filter for the range and creates filter criteria that only shows cells
// that aren't empty.
const filter = range.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();

// Sets the criteria to  column C.
filter.setColumnFilterCriteria(3, criteria);

Pulang pergi

FilterCriteriaBuilder — builder baru


newRichTextValue()

Membuat builder untuk nilai Rich Text.

// Sets cell A1 to have the text "Hello world", with "Hello" bolded.
var cell = SpreadsheetApp.getActive().getRange('A1');
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
cell.setRichTextValue(value);

Pulang pergi

RichTextValueBuilder — Builder baru.


newTextStyle()

Membuat builder untuk gaya teks.

// Sets range A1:B3 to have red, size 22, bolded, underlined text.
var range = SpreadsheetApp.getActive().getRange('A1:B3');
var style = SpreadsheetApp.newTextStyle()
    .setForegroundColor("red")
    .setFontSize(22)
    .setBold(true)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Pulang pergi

TextStyleBuilder — Builder baru.


open(file)

Membuka spreadsheet yang sesuai dengan objek File yang diberikan.

// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name
// of the first sheet within each spreadsheet.
var files = DriveApp.searchFiles(
    'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"');
while (files.hasNext()) {
  var spreadsheet = SpreadsheetApp.open(files.next());
  var sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

Parameter

NamaJenisDeskripsi
fileFileFile yang akan dibuka.

Pulang pergi

Spreadsheet — spreadsheet

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

openById(id)

Membuka spreadsheet yang berisi ID yang diberikan. ID spreadsheet dapat diekstrak dari URL-nya. Sebagai contoh, ID spreadsheet di URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 adalah "abc1234567".

// The code below opens a spreadsheet using its ID and logs the name for it.
// Note that the spreadsheet is NOT physically opened on the client side.
// It is opened on the server only (for modification by the script).
var ss = SpreadsheetApp.openById("abc1234567");
Logger.log(ss.getName());

Parameter

NamaJenisDeskripsi
idStringID unik untuk spreadsheet.

Pulang pergi

Spreadsheet — objek Spreadsheet dengan ID yang diberikan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

openByUrl(url)

Membuka spreadsheet yang berisi URL tertentu. Menampilkan pengecualian pembuatan skrip jika URL tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.

// Opens a spreadsheet by its URL and logs its name.
// Note that the spreadsheet doesn't physically open on the client side.
// It opens on the server only (for modification by the script).
var ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit');
console.log(ss.getName());

Parameter

NamaJenisDeskripsi
urlStringURL untuk spreadsheet.

Pulang pergi

Spreadsheet — Objek spreadsheet dengan URL yang diberikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

setActiveRange(range)

Menetapkan rentang yang ditentukan sebagai active range, dengan bagian atas sel kiri dalam rentang sebagai current cell.

UI {i>spreadsheet<i} menampilkan {i>sheet<i} yang berisi rentang yang dipilih dan memilih sel yang ditentukan dalam rentang yang dipilih.

// The code below sets range C1:D4 in the first sheet as the active range.
var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

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

Parameter

NamaJenisDeskripsi
rangeRangeRentang yang akan dijadikan rentang aktif.

Pulang pergi

Range — Rentang baru yang aktif


setActiveRangeList(rangeList)

Menetapkan daftar rentang yang ditentukan sebagai active ranges. Terakhir rentang dalam daftar ditetapkan sebagai active range.

// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges.
var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

var selection = SpreadsheetApp.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();

Parameter

NamaJenisDeskripsi
rangeListRangeListDaftar rentang untuk dipilih.

Pulang pergi

RangeList — daftar rentang yang baru dipilih

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

setActiveSheet(sheet)

Menetapkan sheet aktif dalam spreadsheet. UI Google Spreadsheet menampilkan sheet yang dipilih kecuali {i>sheet<i} itu berasal dari {i>spreadsheet <i}yang berbeda.

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

Parameter

NamaJenisDeskripsi
sheetSheetSheet baru yang aktif.

Pulang pergi

Sheet — sheet yang telah dijadikan sheet aktif baru


setActiveSheet(sheet, restoreSelection)

Menetapkan sheet aktif dalam spreadsheet, dengan opsi untuk memulihkan pilihan terbaru yang berada di dalam {i>sheet<i} tersebut. UI Google Spreadsheet menampilkan sheet yang dipilih kecuali jika sheet tersebut berada di file {i>spreadsheet <i}yang berbeda.

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

Parameter

NamaJenisDeskripsi
sheetSheetSheet baru yang aktif.
restoreSelectionBooleanJika true, pilihan terbaru dari sheet aktif baru dipilih lagi saat sheet baru menjadi aktif; jika false, sheet baru menjadi aktif tanpa mengubah pilihan yang ada.

Pulang pergi

Sheet — sheet aktif baru

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

setActiveSpreadsheet(newActiveSpreadsheet)

Menetapkan spreadsheet aktif.

// The code below makes the spreadsheet with key "1234567890" the active spreadsheet
var ss = SpreadsheetApp.openById("1234567890");
SpreadsheetApp.setActiveSpreadsheet(ss);

Parameter

NamaJenisDeskripsi
newActiveSpreadsheetSpreadsheetSpreadsheet yang akan dijadikan spreadsheet aktif.

setCurrentCell(cell)

Menetapkan sel yang ditentukan sebagai current cell.

Jika sel yang ditentukan ada dalam rentang yang sudah dipilih, maka rentang tersebut akan menjadi rentang aktif dengan sel sebagai sel saat ini.

Jika sel yang ditentukan tidak ada dalam rentang yang dipilih, maka pilihan yang ada akan dihapus dan sel menjadi sel saat ini dan rentang aktif.

Catatan: Range yang ditentukan harus terdiri dari satu sel; jika tidak, metode ini menampilkan pengecualian.

// The code below sets the cell B5 in the first sheet as the current cell.
var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

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

Parameter

NamaJenisDeskripsi
cellRangeSel yang akan ditetapkan sebagai sel saat ini.

Pulang pergi

Range — sel saat ini yang baru ditetapkan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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