【GASスプレッドシート】getSheet()で特定シート取得・操作・SEO最適化

/**
 * 現在アクティブなSpreadsheetオブジェクト（ファイル）を取得する関数。
 * スクリプトがスプレッドシートにバインドされている場合に最もよく使われます。
 */
function getActiveSpreadsheetExample() {
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  Logger.log(`アクティブなスプレッドシート名: ${spreadsheet.getName()}`);
}

/**
 * スプレッドシートIDを指定して特定のSpreadsheetオブジェクトを開く関数。
 * 外部スプレッドシートへのアクセスに利用されます。
 */
function openSpreadsheetByIdExample() {
  const spreadsheetId = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; // 対象スプレッドシートのIDをここに記述
  try {
    const spreadsheet = SpreadsheetApp.openById(spreadsheetId);
    Logger.log(`IDで開いたスプレッドシート名: ${spreadsheet.getName()}`);
  } catch (e) {
    Logger.log(`エラー: スプレッドシートID「${spreadsheetId}」が見つからないか、アクセス権がありません。`);
  }
}

/**
 * スプレッドシートのURLを指定して特定のSpreadsheetオブジェクトを開く関数。
 * IDでの指定が推奨されますが、URLでのアクセスも可能です。
 */
function openSpreadsheetByUrlExample() {
  const spreadsheetUrl = 'https://docs.google.com/spreadsheets/d/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/edit#gid=0'; // 対象スプレッドシートのURL
  try {
    const spreadsheet = SpreadsheetApp.openByUrl(spreadsheetUrl);
    Logger.log(`URLで開いたスプレッドシート名: ${spreadsheet.getName()}`);
  } catch (e) {
    Logger.log(`エラー: スプレッドシートURL「${spreadsheetUrl}」が見つからないか、アクセス権がありません。`);
  }
}

/**
 * 現在アクティブなSheetオブジェクトを取得し、シート名をログに出力する関数。
 */
function getActiveSheetExample() {
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  const activeSheet = spreadsheet.getActiveSheet();
  Logger.log(`現在アクティブなシート名: ${activeSheet.getName()}`);
}

/**
 * シート名を指定してSheetオブジェクトを取得する関数。
 * 指定したシート名が見つからない場合はnullを返します。
 */
function getSheetByNameExample() {
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  const targetSheetName = '月次レポート'; // 取得したいシート名
  const sheet = spreadsheet.getSheetByName(targetSheetName);

  if (sheet) {
    Logger.log(`シート「${targetSheetName}」を取得しました。`);
  } else {
    Logger.log(`エラー: シート「${targetSheetName}」が見つかりませんでした。`);
  }
}

/**
 * インデックス（位置）を指定してSheetオブジェクトを取得する関数。
 * 例: 一番左端のシート (インデックス0) を取得します。
 */
function getSheetByIndexExample() {
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  const allSheets = spreadsheet.getSheets(); // すべてのシートを配列として取得

  const sheetIndex = 0; // 取得したいシートのインデックス (0から始まる)
  if (allSheets.length > sheetIndex) {
    const firstSheet = allSheets[sheetIndex];
    Logger.log(`インデックス ${sheetIndex} のシート名: ${firstSheet.getName()}`);
  } else {
    Logger.log(`エラー: インデックス ${sheetIndex} のシートは存在しません。`);
  }
}

/**
 * スプレッドシート内のすべてのSheetオブジェクトを一括取得し、シート名をログに出力する関数。
 */
function getAllSheetsExample() {
  const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
  const allSheets = spreadsheet.getSheets(); // すべてのシートを配列として取得

  Logger.log("スプレッドシート内の全シート:");
  allSheets.forEach(sheet => {
    Logger.log(`- ${sheet.getName()}`);
    // ここで各シートに対する処理を追加
  });
}

/**
 * 指定したシート名でシートを取得します。
 * もしシートが存在しない場合は、その名前で新しいシートを作成して返します。
 */
function getOrCreateSheet(spreadsheet, sheetName) {
  let sheet = spreadsheet.getSheetByName(sheetName);
  if (!sheet) {
    sheet = spreadsheet.insertSheet(sheetName); // 新しいシートを作成
    Logger.log(`新しいシート「${sheetName}」を作成しました。`);
  }
  return sheet;
}

// 使用例
// const mySheet = getOrCreateSheet(SpreadsheetApp.getActiveSpreadsheet(), '日次データ');
// mySheet.getRange('A1').setValue('データ');

/**
 * 特定のキーワードをシート名に含むすべてのSheetオブジェクトを検索し、配列で返す関数。
 */
function findSheetsByPartialName(spreadsheet, partialName) {
  const matchingSheets = spreadsheet.getSheets().filter(sheet => 
    sheet.getName().includes(partialName) // シート名に部分文字列が含まれるかチェック
  );
  if (matchingSheets.length > 0) {
    Logger.log(`キーワード「${partialName}」を含むシートが見つかりました:`);
    matchingSheets.forEach(sheet => Logger.log(`- ${sheet.getName()}`));
  } else {
    Logger.log(`キーワード「${partialName}」を含むシートは見つかりませんでした。`);
  }
  return matchingSheets;
}

// 使用例
// const reportSheets = findSheetsByPartialName(SpreadsheetApp.getActiveSpreadsheet(), 'レポート');