Class SpreadsheetApp

지정된 이름으로 새 스프레드시트를 만듭니다.

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

매개변수

리턴

Spreadsheet: 새 스프레드시트

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

지정된 이름과 지정된 행 및 열 수를 사용하여 새 스프레드시트를 만듭니다.

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

매개변수

리턴

Spreadsheet: 새 스프레드시트

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

모든 유형의 데이터 소스에 데이터 실행을 사용 설정합니다.

데이터 소스 유형이 사용 설정되지 않은 경우 데이터 실행에서 예외가 발생합니다. 이 메서드를 사용하여 모든 데이터 소스 유형에 데이터 실행을 사용 설정합니다.

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

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

BigQuery 데이터 소스에 데이터 실행을 사용 설정합니다.

BigQuery 데이터 소스의 데이터 실행이 사용 설정되지 않으면 예외가 발생합니다.

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

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

Looker 데이터 소스의 데이터 실행을 사용 설정합니다.

Looker 데이터 소스의 데이터 실행을 사용 설정하지 않으면 예외가 발생합니다.

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

대기 중인 모든 스프레드시트 변경사항을 적용합니다.

스프레드시트 작업은 성능을 개선하기 위해 번들로 묶이는 경우가 있습니다(예: Range.getValue()를 여러 번 호출하는 경우). 그러나 스크립트가 실행되는 동안 사용자에게 데이터를 표시하는 경우와 같이 대기 중인 모든 변경사항을 즉시 적용해야 할 수도 있습니다.

// 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() {
  const sheet = SpreadsheetApp.getActiveSheet();
  for (let 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();
  }
}

현재 활성 상태인 스프레드시트를 반환하거나 스프레드시트가 없는 경우 null을 반환합니다.

스프레드시트 컨텍스트에서 실행되는 함수는 이 함수를 호출하여 해당 스프레드시트 객체의 참조를 가져올 수 있습니다.

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

리턴

Spreadsheet - 활성 스프레드시트 객체

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

활성 시트에서 선택한 범위를 반환하거나 활성 범위가 없는 경우 null을 반환합니다. 여러 범위가 선택된 경우 이 메서드는 마지막으로 선택한 범위만 반환합니다.

이는 일반적으로 사용자가 활성 시트에서 선택한 범위를 의미하지만 맞춤 함수에서는 활발하게 재계산 중인 셀을 나타냅니다.

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

리턴

Range - 활성 범위입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

활성 시트의 활성 범위 목록을 반환하거나 선택한 범위가 없는 경우 null를 반환합니다. 현재 강조 표시된 셀이 포함된 활성 범위가 목록의 마지막에 배치됩니다.

선택된 범위가 하나인 경우 getActiveRange() 호출처럼 작동합니다.

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

리턴

RangeList: 활성 범위 목록

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

스프레드시트에서 활성 시트를 가져옵니다.

스프레드시트의 활성 시트는 스프레드시트 UI에 표시되는 시트입니다.

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

리턴

Sheet - 활성 시트 객체

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

현재 활성 상태인 스프레드시트를 반환하거나 스프레드시트가 없는 경우 null을 반환합니다.

스프레드시트 컨텍스트에서 실행되는 함수는 이 함수를 호출하여 상응하는 Spreadsheet 객체 참조를 가져올 수 있습니다.

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

리턴

Spreadsheet - 활성 스프레드시트 객체

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

활성 시트의 활성 범위 중 하나에서 선택된 현재 (강조 표시된) 셀을 반환하거나 현재 셀이 없는 경우 null을 반환합니다.

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

리턴

Range: 현재 셀

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

스프레드시트의 현재 Selection를 반환합니다.

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

리턴

Selection: 현재 선택된 항목

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

스크립트가 메뉴, 대화상자, 사이드바와 같은 기능을 추가할 수 있는 스프레드시트의 사용자 인터페이스 환경 인스턴스를 반환합니다. 스크립트는 열려 있는 스프레드시트의 현재 인스턴스에 대한 UI와만 상호작용할 수 있으며, 스크립트가 스프레드시트에 바인딩된 경우에만 상호작용할 수 있습니다. 자세한 내용은 메뉴 및 대화상자 및 사이드바 가이드를 참고하세요.

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

리턴

Ui: 이 스프레드시트의 사용자 인터페이스 환경 인스턴스

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

리턴

CellImageBuilder: 새 빌더입니다.

Color 빌더를 만듭니다.

const rgbColor = SpreadsheetApp.newColor().setRgbColor('#FF0000').build();

리턴

ColorBuilder: 새 빌더입니다.

조건부 서식 지정 규칙의 빌더를 만듭니다.

// 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.
const sheet = SpreadsheetApp.getActive().getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

리턴

ConditionalFormatRuleBuilder: 새 빌더입니다.

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

리턴

DataSourceSpecBuilder: 새 빌더입니다.

데이터 유효성 검사 규칙의 빌더를 만듭니다.

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

리턴

DataValidationBuilder: 새 빌더입니다.

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

리턴

FilterCriteriaBuilder: 새 빌더

서식 있는 텍스트 값의 빌더를 만듭니다.

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

리턴

RichTextValueBuilder: 새 빌더입니다.

텍스트 스타일의 빌더를 만듭니다.

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

리턴

TextStyleBuilder: 새 빌더입니다.

지정된 File 객체에 해당하는 스프레드시트를 엽니다.

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

매개변수

리턴

Spreadsheet: 스프레드시트

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

지정된 ID로 스프레드시트를 엽니다. 스프레드시트 ID는 URL에서 추출할 수 있습니다. 예를 들어 URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0의 스프레드시트 ID는 '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).
const ss = SpreadsheetApp.openById('abc1234567');
Logger.log(ss.getName());

매개변수

리턴

Spreadsheet: 지정된 ID가 있는 스프레드시트 객체

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

지정된 URL로 스프레드시트를 엽니다. URL이 없거나 사용자에게 액세스 권한이 없는 경우 스크립트 예외를 발생시킵니다.

// 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).
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit',
);
console.log(ss.getName());

매개변수

리턴

Spreadsheet: 지정된 URL이 있는 스프레드시트 객체입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

지정된 범위를 active range로 설정하고 범위의 왼쪽 상단 셀을 current cell로 설정합니다.

스프레드시트 UI에는 선택한 범위가 포함된 시트가 표시되고 선택한 범위에 정의된 셀이 선택됩니다.

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

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

매개변수

리턴

Range - 새 활성 범위

지정된 범위 목록을 active ranges로 설정합니다. 목록의 마지막 범위는 active range로 설정됩니다.

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

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

매개변수

리턴

RangeList: 새로 선택된 범위 목록

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

스프레드시트에서 활성 시트를 설정합니다. 시트가 다른 스프레드시트에 속하지 않는 한 Google Sheets UI에는 선택한 시트가 표시됩니다.

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

매개변수

리턴

Sheet: 새 활성 시트로 설정된 시트입니다.

스프레드시트에서 활성 시트를 설정하고 해당 시트 내에서 가장 최근 선택을 복원할 수 있는 옵션을 제공합니다. 시트가 다른 스프레드시트에 속하지 않는 한 Google Sheets UI에는 선택한 시트가 표시됩니다.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const firstSheet = spreadsheet.getSheets()[0];
const 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
const range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

매개변수

리턴

Sheet - 새 활성 시트

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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

활성 스프레드시트를 설정합니다.

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

매개변수

지정된 셀을 current cell로 설정합니다.

지정된 셀이 이미 선택된 범위에 있는 경우 해당 범위가 활성 범위가 되며 이 범위의 현재 셀이 지정된 셀이 됩니다.

지정된 셀이 선택된 범위에 없으면 기존 선택이 삭제되고 해당 셀이 현재 셀 및 활성 범위가 됩니다.

참고: 지정된 Range는 하나의 셀로 구성되어야 합니다. 그렇지 않으면 이 메서드가 예외를 발생시킵니다.

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

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

매개변수

리턴

Range: 새로 설정된 현재 셀

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

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