Method: spreadsheets.get

傳回指定 ID 的試算表。呼叫端必須指定試算表 ID。

根據預設，系統不會傳回格線內的資料。您可以透過下列兩種方式加入格線資料：

  • 使用 HTTP 中的 fields 網址參數，指定列出所需欄位的欄位遮罩

  • 將 includeGridData 網址參數設為 true。如果設定了欄位遮罩，系統會忽略 includeGridData 參數

如果是大型試算表，建議只擷取所需的特定試算表欄位。

如要只擷取試算表資料的子集，請使用 ranges 網址參數。範圍是使用 A1 標記法指定的。您可以定義單一儲存格 (例如 A1) 或多個儲存格 (例如 A1:D5)。您也可以從同一試算表中的其他工作表取得儲存格 (例如 Sheet2!A1:C4)，或一次擷取多個範圍 (例如 ?ranges=A1:D5&ranges=Sheet2!A1:C4)。限制範圍只會傳回與所要求範圍相交的試算表部分。

HTTP 要求

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
spreadsheetId

string

要要求的試算表。

查詢參數

參數
ranges[]

string

要從試算表擷取的範圍。
includeGridData

boolean

如果應傳回格線資料，則為 True。如果要求中已設定欄位遮罩，系統會忽略這個參數。
excludeTablesInBandedRanges

boolean

如果應在帶狀範圍中排除資料表，則為 True。如未設定，則為 False。
commentsViewMode

enum (CommentsViewMode)

要套用至試算表的註解檢視模式。這樣就能查看試算表，並選擇是否要顯示註解。如未指定，則會使用 COMMENTS_VIEW_MODE_OMITTED。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 Spreadsheet 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

詳情請參閱授權指南。