Class SpreadsheetApp

Verilen adla yeni bir e-tablo oluşturur.

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

Parametreler

Return

Spreadsheet — yeni bir e-tablo

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Belirtilen ada ve belirtilen sayıda satır ile sütuna sahip yeni bir e-tablo oluşturur.

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

Parametreler

Return

Spreadsheet — yeni bir e-tablo

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Tüm veri kaynağı türleri için veri yürütmeyi etkinleştirir.

Veri kaynağı türü etkin değilse veri yürütme işlemi bir istisna gönderir. Tüm veri kaynağı türlerinde veri yürütmeyi etkinleştirmek için bu yöntemi kullanın.

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

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

BigQuery veri kaynakları için veri yürütmeyi etkinleştirir.

BigQuery veri kaynağı için veri yürütme işlemi, etkinleştirilmemişse bir istisna oluşturur.

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

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Beklemedeki tüm e-tablo değişiklikleri uygulanır.

Örneğin, Range.getValue() işlevine birden fazla çağrı yapıldığında olduğu gibi, e-tablo işlemleri bazen performansı artırmak için birlikte gruplandırılır. Ancak bazen, örneğin kullanıcı verilerini bir komut dosyası çalışırken göstermek için, bekleyen tüm değişikliklerin hemen yapıldığından emin olmak isteyebilirsiniz.

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

O anda etkin olan e-tabloyu veya e-tablo yoksa null değerini döndürür.

Bir e-tablo bağlamında çalıştırılan işlevler, bu işlevi çağırarak karşılık gelen E-tablo nesnesine referans alabilir.

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

Return

Spreadsheet — etkin E-tablo nesnesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Etkin sayfada seçilen aralığı veya etkin aralık yoksa null değerini döndürür. Birden fazla aralık seçilirse bu yöntem yalnızca son seçilen aralığı döndürür.

Bu, genellikle kullanıcının etkin sayfada seçtiği aralık anlamına gelir. Ancak özel işlevde, etkin olarak yeniden hesaplanan hücreyi ifade eder.

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

Return

Range: Etkin aralık.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Etkin sayfadaki etkin aralıkların listesini veya seçili aralık yoksa null değerini döndürür. Vurgulanan geçerli hücreyi içeren etkin aralık, listede sonuncuya yerleştirilir.

Tek bir aralık seçiliyse bu bir getActiveRange() çağrısı olarak davranır.

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

Return

RangeList - etkin aralıkların listesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Bir e-tablodaki etkin sayfayı alır.

Bir e-tablodaki etkin sayfa, e-tablo kullanıcı arayüzünde görüntülenen sayfadır.

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

Return

Sheet - etkin E-tablo nesnesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

O anda etkin olan e-tabloyu veya e-tablo yoksa null değerini döndürür.

Bir e-tablo bağlamında çalıştırılan işlevler, bu işlevi çağırarak karşılık gelen Spreadsheet nesnesine referans alabilir.

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

Return

Spreadsheet — etkin E-tablo nesnesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Etkin sayfadaki etkin aralıklardan birinde seçilmiş geçerli (vurgulanan) hücreyi veya geçerli hücre yoksa null değerini döndürür.

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

Return

Range - geçerli hücre

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

E-tablodaki geçerli Selection değerini döndürür.

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

Return

Selection — mevcut seçim

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

E-tablo'nun, komut dosyasının menü, iletişim kutusu ve kenar çubuğu gibi özellikleri eklemesine olanak tanıyan kullanıcı arayüzü ortamının bir örneğini döndürür. Bir komut dosyası yalnızca açık bir e-tablonun geçerli örneği için kullanıcı arayüzüyle ve sadece komut dosyası e-tabloya bağlı olduğunda etkileşimde bulunabilir. Daha fazla bilgi için menüler ile iletişim kutuları ve kenar çubukları kılavuzlarına bakın.

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

Return

Ui — bu e-tablonun kullanıcı arayüzü ortamının bir örneği

CellImage için derleyici oluşturur.

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

Return

CellImageBuilder — Yeni derleyici.

Color için derleyici oluşturur.

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

Return

ColorBuilder — Yeni derleyici.

Koşullu biçimlendirme kuralı için derleyici oluşturur.

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

Return

ConditionalFormatRuleBuilder - yeni derleyici.

DataSourceSpec için derleyici oluşturur.

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

Return

DataSourceSpecBuilder — Yeni derleyici.

Veri doğrulama kuralı için bir derleyici oluşturur.

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

Return

DataValidationBuilder — Yeni derleyici.

FilterCriteria için derleyici oluşturur.

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

Return

FilterCriteriaBuilder - yeni derleyici

Zengin Metin değeri için bir oluşturucu oluşturur.

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

Return

RichTextValueBuilder — Yeni derleyici.

Metin stili için derleyici oluşturur.

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

Return

TextStyleBuilder — Yeni derleyici.

Belirtilen Dosya nesnesine karşılık gelen e-tabloyu açar.

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

Parametreler

Return

Spreadsheet — e-tablo

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Verilen kimliğe sahip e-tabloyu açar. E-tablo kimliği URL'sinden çıkarılabilir. Örneğin https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 URL'sindeki e-tablo kimliği "abc1234567"dir.

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

Parametreler

Return

Spreadsheet - Belirtilen kimliğe sahip E-tablo nesnesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Verilen URL'yi içeren e-tabloyu açar. URL yoksa veya kullanıcının URL'ye erişim izni yoksa bir komut dosyası istisnası oluşturur.

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

Parametreler

Return

Spreadsheet — Belirtilen URL'ye sahip e-tablo nesnesi.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Belirtilen aralığı active range olarak ayarlar. Aralıktaki sol üst hücre ise current cell olur.

E-tablo kullanıcı arayüzü, seçilen aralığı içeren sayfayı görüntüler ve seçilen aralıkta tanımlanan hücreleri seçer.

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

Parametreler

Return

Range — yeni etkin Aralık

Belirtilen aralık listesini active ranges olarak ayarlar. Listedeki son aralık active range olarak ayarlanmıştır.

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

Parametreler

Return

RangeList: Yeni seçilen aralık listesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Bir e-tablodaki etkin sayfayı ayarlar. Google E-Tablolar kullanıcı arayüzü, sayfa farklı bir e-tabloya ait değilse seçilen sayfayı görüntüler.

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

Parametreler

Return

Sheet: Yeni etkin sayfa yapılan sayfa

Bir e-tablodaki etkin sayfayı, içindeki en son seçimi geri yükleme seçeneğiyle birlikte ayarlar. Google E-Tablolar kullanıcı arayüzü, sayfa farklı bir e-tabloya ait değilse seçilen sayfayı görüntüler.

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

Parametreler

Return

Sheet — yeni etkin sayfa

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Etkin e-tabloyu ayarlar.

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

Parametreler

Belirtilen hücreyi current cell olarak ayarlar.

Belirtilen hücre zaten seçili olan bir aralıkta bulunuyorsa bu aralık, geçerli hücre olarak hücreyle etkin aralık haline gelir.

Belirtilen hücre seçilen herhangi bir aralıkta yer almıyorsa mevcut seçim kaldırılır ve hücre, geçerli hücre ve etkin aralık olur.

Not: Belirtilen Range, bir hücreden oluşmalıdır. Aksi takdirde bu yöntem bir istisnaya neden olur.

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

Parametreler

Return

Range: Yeni ayarlanan geçerli hücre

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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