Google Sheets API を使用すると、セル、範囲、範囲のセット、シート全体から値を読み取ることができます。このページの例では、spreadsheets.values リソースを使用した一般的な読み取りオペレーションを示します。spreadsheets.get メソッドを使用してセル値を読み取ることもできますが、通常は spreadsheets.values.get または spreadsheets.values.batchGet の方が簡単です。
これらの例は、言語に依存しない HTTP リクエストの形式で示されています。Google API クライアント ライブラリを使用してさまざまな言語で読み取りを実装する方法については、セルの値の読み取りと書き込みをご覧ください。
以下の例では、SPREADSHEET_ID というプレースホルダを使用して、スプレッドシート ID をどこで指定するかを示しています。スプレッドシート ID はスプレッドシートの URL から確認できます。読み取る範囲は、リクエスト URL で A1 表記を使用して指定します。範囲の例: Sheet1!A1:D5。
ソースデータ
これらの例では、読み取るスプレッドシートの最初のシート（「Sheet1」）に次のソースデータが含まれているとします。1 行目の文字列は、個々の列のラベルです。スプレッドシートの他のシートから読み取る方法の例については、A1 形式をご覧ください。
| A | B | C | D | |
| 1 | 項目 | 費用 | 在庫あり | 発送日 |
| 2 | ホイール | $20.50 | 4 | 2016 年 3 月 1 日 |
| 3 | ドア | $15 | 2 | 2016 年 3 月 15 日 |
| 4 | エンジン | $100 | 1 | 2016 年 3 月 20 日 |
| 5 | 合計 | $135.5 | 7 | 2016 年 3 月 20 日 |
単一の範囲を読み取る
次の spreadsheets.values.get コードサンプルは、範囲 Sheet1!A1:D5 から値を読み取り、レスポンスで返す方法を示しています。末尾の空の行と列は省略されます。
リクエスト プロトコルがここに表示されます。
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5
レスポンスは、範囲の値を記述する ValueRange オブジェクトで構成されます。majorDimension フィールドは、配列が行ごとに整理された値のリストであることを示します。
{
"range": "Sheet1!A1:D5",
"majorDimension": "ROWS",
"values": [
["Item", "Cost", "Stocked", "Ship Date"],
["Wheel", "$20.50", "4", "3/1/2016"],
["Door", "$15", "2", "3/15/2016"],
["Engine", "$100", "1", "30/20/2016"],
["Totals", "$135.5", "7", "3/20/2016"]
],
}列でグループ化された単一の範囲を読み取る
次の spreadsheets.values.get コードサンプルは、範囲 Sheet1!A1:D3 から値を読み取り、レスポンスで列ごとにグループ化して返す方法を示しています。末尾の空の行と列は省略されます。
リクエスト プロトコルがここに表示されます。
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D3?majorDimension=COLUMNS
レスポンスは、範囲の値を記述する ValueRange オブジェクトで構成されます。majorDimension フィールドは、配列が列ごとに整理された値のリストであることを示します。
{
"range": "Sheet1!A1:D3",
"majorDimension": "COLUMNS",
"values": [
["Item", "Wheel", "Door"],
["Cost", "$20.50", "$15"],
["Stocked", "4", "2"],
["Ship Date", "3/1/2016", "3/15/2016"]
],
}レンダリング オプションを使用して単一の範囲を読み取る
次の spreadsheets.values.get コードサンプルは、範囲 Sheet1!A1:D5 から値を読み取り、レスポンスで返す方法を示しています。ただし、レンダリング オプションを使用して、その情報の返し方を管理しています。FORMULA の ValueRenderOption 設定は、計算値ではなく数式を返すことを示し、SERIAL_NUMBER の DateTimeRenderOption 設定は、日付を数値として返すことを示します。他の設定も可能です。末尾の空の行と列は省略されます。
リクエスト プロトコルがここに表示されます。
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values/Sheet1!A1:D5?
valueRenderOption=FORMULA&dateTimeRenderOption=SERIAL_NUMBERレスポンスは、範囲の値を記述する ValueRange オブジェクトで構成されます。majorDimension フィールドは、配列が行ごとに整理された値のリストであることを示します。
{
"range": "Sheet1!A1:D5",
"majorDimension": "ROWS",
"values": [
["Item", "Cost", "Stocked", "Ship Date"],
["Wheel", "$20.50", "4", "42430"],
["Door", "$15", "2", "42444"],
["Engine", "$100", "1", "42449"],
["Totals", "=SUM(B2:B4)", "=SUM(C2:C4)", "=MAX(D2:D4)"]
],
}複数の範囲を読み取る
次の spreadsheets.values.batchGet コードサンプルは、範囲 Sheet1!B:B と Sheet1!D:D から値を読み取り、レスポンスで返す方法を示しています。UNFORMATTED_VALUE の ValueRenderOption 設定は、値が計算されるが、レスポンスでフォーマットされないことを示します。末尾の空の行と列は省略されます。
リクエスト プロトコルがここに表示されます。
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchGet?
ranges=Sheet1!B:B&ranges=Sheet1!D:D&valueRenderOption=UNFORMATTED_VALUE&majorDimension=COLUMNSこのメソッド呼び出しのレスポンスは、スプレッドシート ID を持つオブジェクトと、リクエストされた順にリストされた、リクエストされた各範囲に対応する ValueRange オブジェクトの配列で構成されます。majorDimension フィールドは、配列が列ごとに整理された値のリストであることを示します。次に例を示します。
{
"spreadsheetId": SPREADSHEET_ID,
"valueRanges": [
{
"range": "Sheet1!B1:B1000",
"majorDimension": "COLUMNS",
"values": [
["Cost",20.5,15,100,135.5]
]
},
{
"range": "Sheet1!D1:D1000",
"majorDimension": "COLUMNS",
"values": [
["Ship Date",42430,42444,42449,42449]
]s
}
]
}複数のシートにまたがる複数の範囲を読み取る
次の spreadsheets.values.batchGet コードサンプルは、シート Sheet1!A1:D5、Products!D1:D100、Sales!E4:F6 の範囲から値を読み取り、レスポンスで返す方法を示しています。UNFORMATTED_VALUE の ValueRenderOption 設定は、値が計算されるが、レスポンスでフォーマットされないことを示します。末尾の空の行と列は省略されます。
リクエスト プロトコルがここに表示されます。
GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/values:batchGet?
ranges=Sheet1!A1:D5&ranges=Products!D1:D100&ranges=Sales!E4:F6&valueRenderOption=UNFORMATTED_VALUE&majorDimension=COLUMNSこのメソッド呼び出しのレスポンスは、スプレッドシート ID を持つオブジェクトと、リクエストされた順にリストされた、リクエストされた各範囲に対応する ValueRange オブジェクトの配列で構成されます。majorDimension フィールドは、配列が列ごとに整理された値のリストであることを示します。次に例を示します。
{
"spreadsheetId": SPREADSHEET_ID,
"valueRanges": [
{
"range": "Sheet1!A1:D5",
"majorDimension": "COLUMNS",
"values": [
[...],
[...]
]
},
{
"range": "Products!D1:D100",
"majorDimension": "COLUMNS",
"values": [
[...]
]
},
{
"range": "Sales!E4:F6",
"majorDimension": "COLUMNS",
"values": [
[...],
[...]
]
}
]
}