Google Sheets API は、スプレッドシートのデータの読み取りや変更を可能にする RESTful インターフェースです。この API の一般的な用途は次のとおりです。
- スプレッドシートの作成
- スプレッドシートのセル値の読み取りと書き込み
- スプレッドシートの形式を更新
- コネクテッド シートを管理する
Sheets API で使用される一般的な用語を以下に示します。
- スプレッドシート
Google スプレッドシートのメイン オブジェクト。複数のシートを含めることができます。各シートには、構造化された情報がセルに含まれています。スプレッドシート リソースは、すべてのスプレッドシートを表し、文字、数字、ハイフン、アンダースコアを含む一意の
spreadsheetId
値を持ちます。スプレッドシート ID は Google スプレッドシートの URL で確認できます。https://docs.google.com/spreadsheets/d/spreadsheetId/edit#gid=0
- シート
スプレッドシート内のページまたはタブ。シート リソースは各シートを表し、一意のタイトルと数値
sheetId
の値があります。シート ID は Google スプレッドシートの URL で確認できます。https://docs.google.com/spreadsheets/d/aBC-123_xYz/edit#gid=sheetId
- セル
シート内のテキストまたはデータの個々のフィールド。セルは行と列の形式で配置され、セルの範囲としてグループ化できます。CellData リソースは各セルを表しますが、一意の ID 値はありません。代わりに、行と列の座標でセルを識別します。
- A1 表記
シート名を含む文字列を含むセルまたはセル範囲を定義するために使用される構文。列文字と行番号は、開始と終了のセル座標です。この方法は、セルの絶対範囲を参照する場合に最も一般的で便利です。
例を表示
Sheet1!A1:B2
は、シート 1 の上 2 行の最初の 2 つのセルを指します。Sheet1!A:A
は、シート 1 の最初の列のすべてのセルを参照します。Sheet1!1:2
は、シート 1 の最初の 2 行のすべてのセルを参照します。Sheet1!A5:A
は、行 5 以降にあるシート 1 の最初の列のすべてのセルを指します。A1:B2
は、最初に表示されるシートの一番上の 2 行内にある最初の 2 つのセルを参照します。Sheet1
はシート 1 のすべてのセルを参照します。'My Custom Sheet'!A:A
は、「My Custom Sheet」という名前のシートの最初の列のすべてのセルを表します。スペース、特殊文字、または英数字の組み合わせを含むシート名には、単一引用符が必要です。'My Custom Sheet'
は、[カスタムシート] のすべてのセルを指します。
ヒント: 可能であれば、スプレッドシート内のオブジェクトに一意の名前を使用してください。たとえば、A1 は最初に表示されるシートのセル A1 を指し、「A1」は A1 という名前のシート内のすべてのセルを指します。同様に、Sheet1 は Sheet1 のすべてのセルを参照します。ただし、「Sheet1」という名前の名前付き範囲がある場合、Sheet1 は名前付き範囲を指し、「Sheet1」はシートを指します。
- R1C1 表記
シート名を含む文字列にセルまたはセル範囲を定義するために使用する構文です。シート番号には、行番号と列番号を使用して開始と終了のセル座標を指定します。この方法は A1 表記より一般的ではありませんが、特定のセルの位置を基準にしてセルの範囲を参照する場合に便利です。
例を表示
Sheet1!R1C1:R2C2
は、シート 1 の上 2 行の最初の 2 つのセルを指します。R1C1:R2C2
は、最初に表示されるシートの一番上の 2 行内にある最初の 2 つのセルを参照します。Sheet1!R[3]C[1]
は、現在のセルの 3 行下、1 列右にあるセルを指します。
- 名前付き範囲
アプリ全体で参照を簡素化するため、カスタム名で定義したセルまたはセルの範囲です。FilterView リソースは名前付き範囲を表します。
- 保護されている範囲
変更できない定義済みのセルまたはセルの範囲です。ProtectedRange リソースは、保護された範囲を表します。
次のステップ
認証と認可の処理など、Google Workspace API を使用した開発の詳細については、Google Workspace での開発をご覧ください。
シンプルな Sheets API アプリを構成して実行する方法については、クイックスタートの概要をご覧ください。