Method: spreadsheets.get

แสดงผลสเปรดชีตที่รหัสที่ระบุ ผู้โทรต้องระบุรหัสสเปรดชีต

โดยค่าเริ่มต้น ระบบจะไม่แสดงข้อมูลภายในตารางกริด คุณใส่ข้อมูลตารางกริดได้ 2 วิธีดังนี้

  • ระบุฟิลด์มาสก์ที่แสดงฟิลด์ที่ต้องการโดยใช้พารามิเตอร์ URL fields ใน HTTP

  • ตั้งค่าพารามิเตอร์ URL includeGridData เป็น true หากตั้งค่ามาสก์ฟิลด์ ระบบจะไม่สนใจพารามิเตอร์ includeGridData

สำหรับสเปรดชีตขนาดใหญ่ แนวทางปฏิบัติแนะนำคือให้ดึงเฉพาะช่องสเปรดชีตที่ต้องการ

หากต้องการดึงข้อมูลสเปรดชีตเพียงชุดย่อย ให้ใช้พารามิเตอร์ ranges ของ URL โดยจะระบุช่วงโดยใช้รูปแบบ A1 คุณสามารถกำหนดเซลล์เดียว (เช่น A1) หรือหลายเซลล์ (เช่น A1:D5) ได้ นอกจากนี้ยังรับเซลล์จากชีตอื่นๆ ภายในสเปรดชีตเดียวกัน (เช่น Sheet2!A1:C4) หรือเรียกข้อมูลหลายช่วงพร้อมกัน (เช่น ?ranges=A1:D5&ranges=Sheet2!A1:C4) ได้ด้วย การจำกัดช่วงจะแสดงเฉพาะส่วนของสเปรดชีตที่ทับซ้อนกับช่วงที่ขอ

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
spreadsheetId

string

สเปรดชีตที่จะขอ

พารามิเตอร์การค้นหา

พารามิเตอร์
ranges[]

string

ช่วงที่จะดึงข้อมูลจากสเปรดชีต
includeGridData

boolean

จริงหากควรแสดงข้อมูลตารางกริด ระบบจะไม่สนใจพารามิเตอร์นี้หากมีการตั้งค่า FieldMask ในคำขอ
excludeTablesInBandedRanges

boolean

จริง หากควรยกเว้นตารางในแถบช่วง เป็น "เท็จ" หากไม่ได้ตั้งค่า
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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์