Class SpreadsheetApp

Tạo một bảng tính mới có tên đã cho.

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

Tham số

Cầu thủ trả bóng

Spreadsheet – một bảng tính mới

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Tạo một bảng tính mới có tên đã cho và số lượng hàng và cột được chỉ định.

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

Tham số

Cầu thủ trả bóng

Spreadsheet – một bảng tính mới

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Bật tính năng thực thi dữ liệu cho tất cả các loại nguồn dữ liệu.

Quá trình thực thi dữ liệu sẽ gửi một ngoại lệ nếu bạn chưa bật loại nguồn dữ liệu. Sử dụng phương thức này để bật tính năng thực thi dữ liệu cho tất cả các loại nguồn dữ liệu.

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

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Bật tính năng thực thi dữ liệu cho các nguồn dữ liệu BigQuery.

Thao tác thực thi dữ liệu cho nguồn dữ liệu BigQuery sẽ gửi một ngoại lệ nếu không được bật.

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

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Bật tính năng thực thi dữ liệu cho các nguồn dữ liệu Looker.

Tính năng thực thi dữ liệu cho nguồn dữ liệu Looker sẽ gửi một ngoại lệ nếu không được bật.

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

Áp dụng tất cả các thay đổi đang chờ xử lý đối với Bảng tính.

Đôi khi, các thao tác trên bảng tính được gộp lại với nhau để cải thiện hiệu suất, chẳng hạn như khi thực hiện nhiều lệnh gọi đến Range.getValue(). Tuy nhiên, đôi khi bạn có thể muốn đảm bảo rằng tất cả các thay đổi đang chờ xử lý đều được thực hiện ngay lập tức, chẳng hạn như để hiển thị dữ liệu cho người dùng khi tập lệnh đang thực thi.

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

Trả về bảng tính đang hoạt động hoặc null nếu không có bảng tính nào.

Các hàm chạy trong ngữ cảnh của bảng tính có thể tham chiếu đến đối tượng Bảng tính tương ứng bằng cách gọi hàm này.

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

Cầu thủ trả bóng

Spreadsheet – đối tượng Bảng tính đang hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Trả về dải ô đã chọn trong trang tính đang hoạt động hoặc null nếu không có dải ô nào đang hoạt động. Nếu bạn chọn nhiều dải ô, phương thức này sẽ chỉ trả về dải ô được chọn gần đây nhất.

Thông thường, hàm này có nghĩa là dải ô mà người dùng đã chọn trong trang tính đang hoạt động, nhưng trong hàm tuỳ chỉnh, hàm này đề cập đến ô đang được tính toán lại.

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

Cầu thủ trả bóng

Range – Phạm vi đang hoạt động.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Trả về danh sách các dải ô đang hoạt động trong trang tính đang hoạt động hoặc null nếu không có dải ô nào được chọn. Dải ô đang hoạt động chứa ô được đánh dấu hiện tại được đặt ở cuối danh sách.

Nếu bạn chỉ chọn một dải ô, thì thao tác này sẽ hoạt động như một lệnh gọi getActiveRange().

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

Cầu thủ trả bóng

RangeList – danh sách các dải ô đang hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Lấy trang tính đang hoạt động trong bảng tính.

Trang tính đang hoạt động trong bảng tính là trang tính đang hiển thị trong giao diện người dùng của bảng tính.

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

Cầu thủ trả bóng

Sheet – đối tượng Trang tính đang hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Trả về bảng tính đang hoạt động hoặc null nếu không có bảng tính nào.

Các hàm chạy trong ngữ cảnh của bảng tính có thể tham chiếu đến đối tượng Spreadsheet tương ứng bằng cách gọi hàm này.

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

Cầu thủ trả bóng

Spreadsheet – đối tượng Bảng tính đang hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Trả về ô hiện tại (được làm nổi bật) được chọn trong một trong các dải ô đang hoạt động trong trang tính đang hoạt động hoặc null nếu không có ô hiện tại.

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

Cầu thủ trả bóng

Range – ô hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Trả về Selection hiện tại trong bảng tính.

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

Cầu thủ trả bóng

Selection – lựa chọn hiện tại

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Trả về một thực thể của môi trường giao diện người dùng của bảng tính cho phép tập lệnh thêm các tính năng như trình đơn, hộp thoại và thanh bên. Một tập lệnh chỉ có thể tương tác với giao diện người dùng cho bản sao hiện tại của một bảng tính đang mở và chỉ khi tập lệnh đó được liên kết với bảng tính. Để biết thêm thông tin, hãy xem hướng dẫn về trình đơn và hộp thoại và thanh bê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();
}

Cầu thủ trả bóng

Ui – một thực thể của môi trường giao diện người dùng của bảng tính này

Tạo trình tạo cho 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);

Cầu thủ trả bóng

CellImageBuilder – Trình tạo mới.

Tạo trình tạo cho Color.

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

Cầu thủ trả bóng

ColorBuilder – Trình tạo mới.

Tạo trình tạo cho quy tắc định dạng có điều kiện.

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

Cầu thủ trả bóng

ConditionalFormatRuleBuilder – trình tạo mới.

Tạo trình tạo cho 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);

Cầu thủ trả bóng

DataSourceSpecBuilder – Trình tạo mới.

Tạo một trình tạo cho quy tắc xác thực dữ liệu.

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

Cầu thủ trả bóng

DataValidationBuilder – Trình tạo mới.

Tạo trình tạo cho 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);

Cầu thủ trả bóng

FilterCriteriaBuilder – trình tạo mới

Tạo một trình tạo cho giá trị Văn bản đa dạng thức.

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

Cầu thủ trả bóng

RichTextValueBuilder – Trình tạo mới.

Tạo một trình tạo cho kiểu văn bản.

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

Cầu thủ trả bóng

TextStyleBuilder – Trình tạo mới.

Mở bảng tính tương ứng với đối tượng Tệp đã cho.

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

Tham số

Cầu thủ trả bóng

Spreadsheet – bảng tính

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Mở bảng tính có mã nhận dạng được cung cấp. Bạn có thể trích xuất mã nhận dạng bảng tính từ URL của bảng tính đó. Ví dụ: mã nhận dạng bảng tính trong URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 là "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());

Tham số

Cầu thủ trả bóng

Spreadsheet – đối tượng Bảng tính có mã nhận dạng đã cho

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Mở bảng tính bằng URL đã cho. Gửi một ngoại lệ tập lệnh nếu URL không tồn tại hoặc người dùng không có quyền truy cập vào 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());

Tham số

Cầu thủ trả bóng

Spreadsheet – Đối tượng bảng tính có URL đã cho.

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Đặt dải ô được chỉ định làm active range, trong đó ô trên cùng bên trái trong dải ô là current cell.

Giao diện người dùng của bảng tính hiển thị trang tính chứa dải ô đã chọn và chọn các ô được xác định trong dải ô đã chọn.

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

Tham số

Cầu thủ trả bóng

Range – Dải ô mới đang hoạt động

Đặt danh sách các dải ô được chỉ định làm active ranges. Dải ô cuối cùng trong danh sách được đặt thành 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();

Tham số

Cầu thủ trả bóng

RangeList – danh sách các dải ô mới được chọn

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Đặt trang tính đang hoạt động trong bảng tính. Giao diện người dùng của Google Trang tính sẽ hiển thị trang tính đã chọn, trừ phi trang tính đó thuộc một bảng tính khác.

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

Tham số

Cầu thủ trả bóng

Sheet – trang tính đã được đặt làm trang tính đang hoạt động mới

Đặt trang tính đang hoạt động trong một bảng tính, với tuỳ chọn khôi phục lựa chọn gần đây nhất trong trang tính đó. Giao diện người dùng của Google Trang tính sẽ hiển thị trang tính đã chọn, trừ phi trang tính đó thuộc một bảng tính khác.

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

Tham số

Cầu thủ trả bóng

Sheet – trang tính mới đang hoạt động

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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

Đặt bảng tính đang hoạt động.

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

Tham số

Đặt ô được chỉ định làm current cell.

Nếu ô được chỉ định nằm trong một dải ô đã chọn, thì dải ô đó sẽ trở thành dải ô đang hoạt động với ô đó là ô hiện tại.

Nếu ô được chỉ định không có trong bất kỳ dải ô nào đã chọn, thì lựa chọn hiện có sẽ bị xoá và ô đó sẽ trở thành ô hiện tại và dải ô đang hoạt động.

Lưu ý:Range được chỉ định phải bao gồm một ô, nếu không phương thức này sẽ gửi một ngoại lệ.

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

Tham số

Cầu thủ trả bóng

Range – ô hiện tại mới được đặt

Ủy quyền

Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:

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