このページは Cloud Translation API によって翻訳されました。

Google スプレッドシートでの Apps Script の基礎 #2: スプレッドシート、シート、範囲

1. はじめに

「Google スプレッドシートでの Apps Script の基礎」Codelab 再生リストの第 2 部へようこそ。前回の Codelab では、スクリプトエディタ、マクロ、カスタム関数のコンセプトに焦点を当てました。この Codelab では、Google スプレッドシートでデータの読み取り、書き込み、操作に使用できる Spreadsheet サービスについて詳しく説明します。

学習内容

Apps Script でスプレッドシート、シート、範囲がどのように表されるか。
SpreadsheetApp クラスと Spreadsheet クラスを使用して、アクティブな（開いている）スプレッドシートにアクセスし、作成し、名前を変更する方法。
Sheet クラスを使用して、シートの名前と範囲の列/行の向きを変更する方法。
Range クラスを使用して、セルのグループまたはデータ範囲を指定、アクティブ化、移動、並べ替える方法。

始める前に

これは、「Google スプレッドシートでの Apps Script の基礎」プレイリストの 2 番目の Codelab です。始める前に、最初の Codelab「マクロとカスタム関数」を完了しておいてください。

必要なもの

この再生リストの前の Codelab で説明した Apps Script の基本的なトピックを理解している。
Apps Script エディタに関する基本的な知識
Google スプレッドシートに関する基礎知識
スプレッドシートの A1 形式を読み取る機能
JavaScript とその String クラスに関する基本的な知識

次のセクションでは、スプレッドシートサービスのコアクラスについて説明します。

2. スプレッドシートサービスの概要

スプレッドシートサービスの基盤となる 4 つのクラスは、SpreadsheetApp、Spreadsheet、Sheet、Range です。このセクションでは、これらのクラスとその用途について説明します。

SpreadsheetApp クラス

スプレッドシート、シート、範囲について詳しく説明する前に、親クラスである SpreadsheetApp を確認してください。多くのスクリプトは SpreadsheetApp メソッドの呼び出しから始まります。これは、Google スプレッドシートファイルへの最初のアクセスポイントを提供できるためです。SpreadsheetApp は、スプレッドシートサービスのメインクラスと考えることができます。SpreadsheetApp クラスについては、ここでは詳しく説明しません。ただし、この Codelab の後半では、このクラスを理解するのに役立つ例と演習を紹介します。

スプレッドシート、シート、クラス

スプレッドシートという用語は、行と列で整理されたデータを含む Google スプレッドシートファイル（Google ドライブに保存）を指します。スプレッドシートは、ドキュメントが「Google ドキュメント」と呼ばれるのと同じように、「Google スプレッドシート」と呼ばれることもあります。

Spreadsheet クラスを使用すると、Google スプレッドシートファイルのデータにアクセスして変更できます。このクラスは、共同編集者の追加など、他のファイルレベルのオペレーションにも使用できます。

シート** は、スプレッドシートの個々のページを表します。これは「タブ」と呼ばれることもあります。各スプレッドシートには 1 つ以上のシートを含めることができます。 Sheet** クラスを使用すると、データの行や列の移動など、シートレベルのデータと設定にアクセスして変更できます。

重要なポイント: スプレッドシートには、名前のほかに、そのシートに固有の ID 文字列もあります。ID は、スプレッドシートの URL に次の形式で含まれています。

https://docs.google.com/spreadsheets/d/spreadsheetID/edit#gid=0

スプレッドシート内の各シートにも、そのスプレッドシートに固有の ID 番号が割り当てられています。この ID 番号はランダムに生成されますが、スプレッドシートの URL でも確認できます。URL の形式は次のとおりです。

https://docs.google.com/spreadsheets/d/spreadsheetID/edit#gid=sheetID

次の URL の例で両方の ID を確認できます。

スプレッドシートとシートの ID は一意ですが、スプレッドシート名は一意ではないため、可能な場合はID を使用してスプレッドシートとシートを指定することをおすすめします。たとえば、Google ドライブに同じ名前のスプレッドシートを複数作成できます。SpreadsheetApp.openById(id) などのスクリプトメソッドを使用してスプレッドシートを開くと、誤って間違ったファイルを編集してしまうことを防ぐことができます。

Google スプレッドシートの ID について詳しくは、Google スプレッドシートの概要をご覧ください。

まとめると、Spreadsheet クラスはシートのコレクションを操作し、Google ドライブで Google スプレッドシートファイルを定義します。Sheet クラスは、スプレッドシート内の個々のシートを操作します。

Range クラス

ほとんどのデータ操作（セルのデータの読み取り、書き込み、書式設定など）では、オペレーションの対象となるセルを定義する必要があります。Range クラスを使用すると、シート内の特定のセルセットを選択できます。このクラスのインスタンスは、シート内の 1 つ以上の隣接するセルのグループである範囲を表します。範囲は、行番号と列番号で指定することも、A1 形式で指定することもできます。

キー用語: Apps Script では、アクティブなシートは、Google スプレッドシートのインターフェースで現在開いて表示されているシートです。同様に、アクティブな範囲は、アクティブなシート内で現在ハイライト表示されている 1 つ以上のセルのグループです。アクティブセルとは、アクティブなシート内でカーソルがフォーカスされている 1 つのハイライト表示されたセルです。

多くのクラスメソッドは、リクエストされたクラスのアクティブオブジェクトを返します。たとえば、SpreadsheetApp.getActiveSpreadsheet() を実行すると、ユーザーのアクティブなスプレッドシートまたは現在のスプレッドシートが返されます。アクティブなスプレッドシートを取得することで、そのスプレッドシートにオペレーションを適用できます。同様に、Sheet.activate() メソッドなどのメソッドは、アクティブなオブジェクトを変更できます。

シート、範囲、セルをアクティブにすることは、Google スプレッドシートのインターフェースでシート、範囲、セルをクリックすることと同じです。これにより、カーソルのフォーカスがその場所に移動します。

この Codelab の残りの部分では、これらのクラスとそのメソッドを使用するスクリプトの例を示します。

3. セットアップ

続行する前に、データを含むスプレッドシートが必要です。Google が用意したデータシートをご利用いただけます。このリンクをクリックしてデータシートをコピーし、[コピーを作成] をクリックしてください。

使用できるサンプルスプレッドシートのコピーが Google ドライブフォルダに保存され、「無題のスプレッドシートのコピー」という名前が付けられます。このスプレッドシートを使用して、この Codelab の演習を完了します。

スクリプトエディタは、Google スプレッドシートで [拡張機能] > [Apps Script] の順にクリックして開くことができます。

Apps Script プロジェクトをスクリプトエディタで初めて開くと、スクリプトエディタによってスクリプトプロジェクトとスクリプトファイルの両方が作成されます。

次のセクションでは、Spreadsheet クラスを使用してこのスプレッドシートを改善する方法について説明します。

4. スプレッドシートへのアクセスと変更

このセクションでは、SpreadsheetApp クラスと Spreadsheet クラスを使用してスプレッドシートにアクセスして変更する方法について説明します。具体的には、スプレッドシートの名前を変更する方法と、スプレッドシート内でシートを複製する方法を学びます。

これらは単純なオペレーションですが、多くの場合、より大規模で複雑なワークフローの一部です。スクリプトコードでこれらのタスクを自動化する方法を理解できれば、より複雑なオペレーションを自動化する方法を簡単に学習できます。

アクティブなスプレッドシートの名前を変更する

たとえば、デフォルトの名前「無題のスプレッドシートのコピー」を、スプレッドシートの目的に合ったタイトルに変更したいとします。これは、SpreadsheetApp クラスと Spreadsheet クラスで行うことができます。

スクリプトエディタで、デフォルトの myFunction() コードブロックを次のコードに置き換えます。

function renameSpreadsheet() {
  var mySS = SpreadsheetApp.getActiveSpreadsheet();
  mySS.rename("2017 Avocado Prices in Portland, Seattle");
}

スクリプトを保存するには、[保存] をクリックします。
Apps Script プロジェクトの名前を変更するには、[無題のプロジェクト] をクリックし、新しいプロジェクト名として「アボカドの価格」と入力して、[名前を変更] をクリックします。
スクリプトを実行するには、関数リストから renameSpreadsheet を選択して [実行] をクリックします。
画面上の指示に沿って操作し、マクロを承認します。「このアプリは確認されていません」というメッセージが表示された場合は、[詳細] をクリックし、[アボカドの価格（安全ではないページ）に移動] をクリックします。次の画面で [許可] をクリックします。

関数が実行されると、スプレッドシートのファイル名が変更されます。

入力したコードを見てみましょう。getActiveSpreadsheet() メソッドは、アクティブなスプレッドシート（作成した演習用スプレッドシートのコピー）を表すオブジェクトを返します。このスプレッドシートオブジェクトは mySS 変数に格納されます。mySS で rename(newName) を呼び出すと、Google ドライブ内のスプレッドシートファイルの名前が「2017 Avocado Prices in Portland, Seattle」に変更されます。

mySS 変数はスプレッドシートへの参照であるため、getActiveSpreadsheet() を繰り返し呼び出すのではなく、mySS で Spreadsheet メソッドを呼び出すことで、コードをよりクリーンで効率的にすることができます。

アクティブなシートを複製する

現在のスプレッドシートにはシートが 1 つしかありません。Spreadsheet.duplicateActiveSheet() メソッドを呼び出して、シートのコピーを作成できます。

スクリプトプロジェクトにすでにある renameSpreadsheet() 関数の下に、次の新しい関数を追加します。

function duplicateAndOrganizeActiveSheet() {
  var mySS = SpreadsheetApp.getActiveSpreadsheet();
  var duplicateSheet = mySS.duplicateActiveSheet();
}

スクリプトプロジェクトを保存します。
スクリプトを実行するには、関数リストから duplicateAndOrganizeActiveSheet を選択して [実行] をクリックします。

スプレッドシートに「Sheet_Original のコピー」という新しいシートタブが追加されていることを確認します。

この新しい関数では、duplicateActiveSheet() メソッドがスプレッドシートの複製シートを作成、有効化して返します。この結果のシートは duplicateSheet に保存されますが、コードではまだこの変数を使用していません。

次のセクションでは、Sheet クラスを使用して、重複したシートの名前を変更して書式設定します。

5. Sheet クラスを使用してシートの形式を設定する

Sheet クラスには、スクリプトでシートの読み取りと更新を行うためのメソッドが用意されています。このセクションでは、Sheet クラスのメソッドを使用してシートの名前と列幅を変更する方法について説明します。

シートの名前を変更する

シートの名前の変更は、renameSpreadsheet() でスプレッドシートの名前を変更するのと同じくらい簡単です。必要なメソッド呼び出しは 1 つだけです。

Google スプレッドシートで、Sheet_Original シートをクリックしてアクティブにします。
Apps Script で、duplicateAndOrganizeActiveSheet() 関数を次のように変更します。

function duplicateAndOrganizeActiveSheet() {
  var mySS = SpreadsheetApp.getActiveSpreadsheet();
  var duplicateSheet = mySS.duplicateActiveSheet();

  // Change the name of the new sheet.
  duplicateSheet.setName("Sheet_" + duplicateSheet.getSheetId());
}

関数を保存して実行します。

Google スプレッドシートで関数を実行すると、シートの複製が作成され、名前が変更されます。

追加されたコードでは、setName(name) メソッドが duplicateSheet の名前を変更します。getSheetID() を使用してシートの一意の ID 番号を取得します。+ 演算子は、シート ID を "Sheet_" 文字列の末尾に連結します。

シートの列と行を変更する

Sheet クラスを使用してシートの書式を設定することもできます。たとえば、duplicateAndOrganizeActiveSheet() 関数を更新して、複製されたシートの列のサイズを変更し、固定行を追加できます。

Google スプレッドシートで、Sheet_Original シートをクリックしてアクティブにします。
Apps Script で、duplicateAndOrganizeActiveSheet() 関数を次のように変更します。

function duplicateAndOrganizeActiveSheet() {
  var mySS = SpreadsheetApp.getActiveSpreadsheet();
  var duplicateSheet = mySS.duplicateActiveSheet();

  // Change the name of the new sheet.
  duplicateSheet.setName("Sheet_" + duplicateSheet.getSheetId());

  // Format the new sheet.
  duplicateSheet.autoResizeColumns(1, 5);
  duplicateSheet.setFrozenRows(2);
}

関数を保存して実行します。

Google スプレッドシートで、シートの複製、名前の変更、有効化、書式設定が行われます。

追加したコードでは、autoResizeColumns(startColumn, numColumns) を使用してシートの列のサイズを変更し、読みやすくしています。setFrozenRows(rows) メソッドは、指定された行数（この場合は 2 行）を固定します。これにより、読者がスプレッドシートを下にスクロールしても、ヘッダー行が表示されたままになります。

次のセクションでは、範囲と基本的なデータ操作について説明します。

6. Range クラスを使用してデータを並べ替える

Range クラスとそのメソッドは、スプレッドシートサービスのデータ操作と書式設定のオプションのほとんどを提供します。

このセクションでは、範囲を使用した基本的なデータ操作について説明します。このプレイリストの他の Codelab では、データの操作とデータ形式について詳しく説明しますが、この演習では Apps Script で範囲を活用する方法に焦点を当てます。

範囲を移動する

クラスメソッドと A1 形式（スプレッドシート内の特定のセルセットを識別するための略記法）を使用して、データの範囲を有効にして移動できます。A1 形式について復習する必要がある場合は、A1 形式の説明をご覧ください。

duplicateAndOrganizeActiveSheet() メソッドを更新して、データの移動も行えるようにします。

Google スプレッドシートで、Sheet_Original シートをクリックしてアクティブにします。
Apps Script で、duplicateAndOrganizeActiveSheet() 関数を次のように変更します。

function duplicateAndOrganizeActiveSheet() {
  var mySS = SpreadsheetApp.getActiveSpreadsheet();
  var duplicateSheet = mySS.duplicateActiveSheet();

  // Change the name of the new sheet.
  duplicateSheet.setName("Sheet_" + duplicateSheet.getSheetId());

  // Format the new sheet.
  duplicateSheet.autoResizeColumns(1, 5);
  duplicateSheet.setFrozenRows(2);

  // Move column F to column C.
  var myRange = duplicateSheet.getRange("F2:F");
  myRange.moveTo(duplicateSheet.getRange("C2"));
}

関数を保存して実行します。

この関数を実行すると、シートの複製が作成、有効化、フォーマットされます。また、F 列の内容が C 列に移動します。

新しいコードでは、getRange(a1Notation) メソッドを使用して、移動するデータの範囲を特定します。メソッドのパラメータとして A1 形式の「F2:F」を入力すると、F 列（F1 を除く）が指定されます。指定された範囲が存在する場合、getRange(a1Notation) メソッドはその Range インスタンスを返します。このコードでは、使いやすさを考慮して、インスタンスを myRange 変数に保存しています。

範囲が特定されると、moveTo(target) メソッドは myRange の内容（値と書式設定の両方）を取得して移動します。宛先（C 列）は、A1 形式の「C2」で指定されています。これは列ではなく、単一のセルです。データを移動するときに、サイズをターゲット範囲と宛先範囲に一致させる必要はありません。Apps Script は、各シートの最初のセルを揃えるだけです。

範囲を並べ替える

Range クラスを使用すると、セルのグループを読み取り、更新し、整理できます。たとえば、Range.sort(sortSpecObj) メソッドを使用してデータ範囲を並べ替えることができます。

Google スプレッドシートで、Sheet_Original シートをクリックしてアクティブにします。
Apps Script で、duplicateAndOrganizeActiveSheet() 関数を次のように変更します。

function duplicateAndOrganizeActiveSheet() {
  var mySS = SpreadsheetApp.getActiveSpreadsheet();
  var duplicateSheet = mySS.duplicateActiveSheet();

  // Change the name of the new sheet.
  duplicateSheet.setName("Sheet_" + duplicateSheet.getSheetId());

  // Format the new sheet.
  duplicateSheet.autoResizeColumns(1, 5);
  duplicateSheet.setFrozenRows(2);

  // Move column F to column C.
  var myRange = duplicateSheet.getRange("F2:F");
  myRange.moveTo(duplicateSheet.getRange("C2"));

  // Sort all the data using column C (Price information).
  myRange = duplicateSheet.getRange("A3:D55");
  myRange.sort(3);
}

関数を保存して実行します。

これで、この関数は、以前の書式設定に加えて、C 列の価格情報を使用して表内のすべてのデータを並べ替えます。

新しいコードでは、getRange(a1Notation) を使用して、A3:D55（列ヘッダーを除くテーブル全体）をカバーする新しい範囲を指定しています。次に、コードから sort(sortSpecObj) メソッドが呼び出され、テーブルが並べ替えられます。ここで、sortSpecObj パラメータは並べ替えの基準となる列番号です。このメソッドは、指定された列の値が最小から最大（昇順）になるように範囲を並べ替えます。sort(sortSpecObj) メソッドはより複雑な並べ替え要件を実行できますが、ここでは必要ありません。並べ替え範囲を呼び出すさまざまな方法については、メソッドリファレンスドキュメントをご覧ください。

お疲れさまでした。これで、この Codelab のすべての演習が完了しました。次のセクションでは、この Codelab の要点を確認し、このプレイリストの次の Codelab を紹介します。

7. まとめ

この Codelab は以上で終了です。Apps Script でスプレッドシートサービスの基本的なクラスと用語を使用および定義できるようになりました。

これで、次の Codelab に進む準備が整いました。

この Codelab は役に立ちましたか？

はい

いいえ

学習した内容

Apps Script でスプレッドシート、シート、範囲がどのように表されるか。
SpreadsheetApp、Spreadsheet、Sheet、Range クラスの基本的な使用方法。

主なコンセプト:

Apps Script では、すべての配列がリストのインデックスを 0 から始めるという規則に従っています。ただし、行と列のインデックスは 1 から始まります。
Apps Script では、現在開いているシート、ハイライト表示されている範囲、セルはアクティブと見なされます。Apps Script の多くのメソッドは、アクティブな要素にアクセスしたり、アクティブな要素を変更したりします。
Spreadsheet クラスと Sheet クラスは、シート固有のメソッドを共有しています。Spreadsheet クラスの重複メソッドは、呼び出し時に通常アクティブなシートを対象とするため、ユーザーの利便性のみを目的としています。
各スプレッドシートとシートには一意の ID があり、ブラウザの URL で確認できます。スプレッドシートとシートのクラスメソッドは ID を利用します。ID と URL の詳細については、Google スプレッドシートの概要をご覧ください。

主な用語:

Active（ステータス）: 指定されたスプレッドシート、シート、範囲、セルが、スプレッドシートのユーザーが現在表示またはハイライト表示しているものであることを示します。
アクティブセル: アクティブシート内でカーソルがフォーカスされている、ハイライト表示された単一のセル。
アクティブな範囲: アクティブなシート内で現在ハイライト表示されている 1 つ以上のセルのグループ。
承認: ユーザーが Apps Script に権限を付与して、関連する Google サービスでユーザーデータにアクセスしたり、ユーザーに代わって操作を行ったりできるようにするプロセス。
コンテナバインドスクリプト: Google スプレッドシートや Google ドキュメントなど、Google Workspace ドキュメントにバインドされ、そこから作成されたスクリプト。
範囲:** シート内の 1 つ以上の隣接するセルのグループ。 Range** クラスを使用すると、シート内の範囲を読み取って更新できます。
スクリプトエディタ: Apps Script のブラウザ内コードエディタ。
シート**: スプレッドシートの 1 ページ（Microsoft Excel のワークブックに似ています）。Google ドライブ内の Google スプレッドシートファイルを指すために使用されることがあります。 Sheet** クラスを使用すると、シートにアクセスして変更できます。
SpreadsheetApp: このクラスは、スプレッドシートサービスの親クラスとして機能し、Google スプレッドシートのデータを読み取ったり操作したりするコードの出発点となります。
スプレッドシート**: Google ドライブに保存されている Google スプレッドシートファイル。 Spreadsheet** クラスを使用すると、スプレッドシートにアクセスして変更できます。
スプレッドシートサービス: スクリプトが Google スプレッドシートファイルの作成、アクセス、変更を行えるようにする Apps Script サービス。

次のステップ

このプレイリストの次の Codelab では、スプレッドシート内のデータの読み取り、書き込み、変更について詳しく説明します。

次の Codelab は、データの操作で確認してください。

Google スプレッドシートでの Apps Script の基礎 #2: スプレッドシート、シート、範囲 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。