Google Sheets API，在 Google Apps Script 上的好用部份

本篇要解決的問題

概念：試算表 > 工作表

var ss = SpreadsheetApp.getActiveSpreadsheet();

建立模擬資料

試算表好用函式

const s = SpreadsheetApp.getActiveSpreadsheet();

取得試算表的 ID

function getId() {
  const id = s.getId();
  Logger.log(id)  
}

取得試算表的名稱

function getName() {
  const name = s.getName();
  Logger.log(name)  
}

取得所有工作表

function getSheets() {
  const sheets = s.getSheets();
  if (sheets.length > 1) {
    for(let ss of sheets) {
      Logger.log(ss.getName())
    }
  }
}

新增工作表

function insertSheet() {
  s.insertSheet('測試新增工作表');
}

刪除工作表

function deleteSheet() {
  const sheet = s.getSheetByName('測試新增工作表');
  s.deleteSheet(sheet);
}

試算表加上客製選單

function addMenu() {
  const menu = [];
  // name：項目名稱。functionName：點擊時執行哪個 function
  menu.push({ name: '新增工作表', functionName: 'insertSheet' });
  menu.push(null); // 分隔線
  menu.push({ name: '刪除工作表', functionName: 'deleteSheet' });
  s.addMenu("加上客製選單", menu);
}
// 試算表打開時執行
function onOpen() {
  addMenu();
}

更新試算表的客製選單

// 選單名稱相同會覆蓋原本 addMenu 時新增的
function updateMenu_update() {
  const menu = [];
  menu.push({name: '更新成只有新增工作表', functionName: 'insertSheet'});
  s.updateMenu('加上客製選單', menu);
}
// 選單名稱不同，就會新增一個客製按鈕
function updateMenu_create() {
  const menu = [];
  menu.push({name: '來啊再新增一個加入工作表', functionName: 'insertSheet'});
  menu.push(null); // 分隔線
  menu.push({name: '來啊再新增一個刪除工作表', functionName: 'deleteSheet'});
  s.updateMenu('加上客製選單2', menu);
}

右下角彈出視窗

function toast() {
  s.toast("Let's Write - 這是一個 Toast 的內文部份。", "開啟一個 Toast");
}

工作表好用函式

從名稱找工作表

function getSheetByName() {
  const sheet = s.getSheetByName('測試表1');
  if (sheet != null) {
    Logger.log(sheet.getIndex());
  }
}

取得工作表的名稱

function getSheetName() {
  const sheet = s.getSheets()[0];
  Logger.log(sheet.getSheetName());
}

取得工作表的值

• startRow：第幾列開始
• startColumn：第幾欄開始
• numRows：共要抓幾列的值
• numColumns：共要抓幾欄的值

function getSheetValues() {
  const sheet = s.getSheets()[0];
  // 方法 1：getSheetValues
  const values1 = sheet.getSheetValues(1, 1, 6, 2);
  Logger.log(values1);
  // 方法 2：getRange
  const range = sheet.getRange(1, 1, 6, 2);
  values2 = range.getValues();
  Logger.log(values2);
}

清空工作表的值

function clear() {
  const first = s.getSheetByName('測試表1');
  first.clear();
}

function clear() {
  const first = s.getSheetByName('測試表1');
  first.clear({ formatOnly: false, contentsOnly: true });
}

=countif($A:$A,$A1)>1

工作表最底部新增一列值

function appendRow() {
  const sheet = s.getSheets()[0];
  sheet.appendRow(['ID', '姓名', 'email', '電話']);
}

取得最後有值的列是第幾列

function getLastRow() {
  const sheet = s.getSheets()[0];
  const lastRow = sheet.getLastRow();
  Logger.log(lastRow);
}

取得最後有值的欄是第幾欄

function getLastColumn() {
  const sheet = s.getSheets()[0];
  const lastCol = sheet.getLastColumn();
  Logger.log(lastCol);
}

結合應用，直接取整張工作表的值

function getSheetVal() {
  const sheet = s.getSheets()[0];
  const lastRow = sheet.getLastRow();
  const lastColumn = sheet.getLastColumn();
  const values = sheet.getSheetValues(1, 1, lastRow, lastColumn);
  Logger.log(values);
}

原始碼