Google Sheets API 可讓您讀取儲存格、範圍、範圍組合和整個試算表的值。本頁的範例說明瞭使用 spreadsheets.values
資源的常見讀取作業。您也可以使用 spreadsheets.get
方法讀取儲存格值,但通常 spreadsheets.values.get
或 spreadsheets.values.batchGet
較為簡單。
這些範例以 HTTP 要求的形式呈現,以便不受語言限制。如要瞭解如何使用 Google API 用戶端程式庫,以不同語言實作讀取功能,請參閱「讀取及寫入儲存格值」。
在這些範例中,預留位置 SPREADSHEET_ID 會指出您要提供的試算表 ID,可透過試算表網址找到。在要求網址中,使用 A1 符號指定要讀取的範圍。範例範圍是 Sheet1!A1:D5。
來源資料
在這些範例中,假設要讀取的試算表在第一張工作表 (「工作表 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
程式碼範例說明如何讀取工作表工作表 1!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": [ [...], [...] ] } ] }