Method: spreadsheets.values.batchGet

แสดงผลช่วงของค่าอย่างน้อยหนึ่งช่วงจากสเปรดชีต ผู้โทรต้องระบุรหัสสเปรดชีตและช่วงอย่างน้อย 1 ช่วง

คำขอ HTTP

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

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

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

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

string

รหัสของสเปรดชีตที่จะดึงข้อมูล

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

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

string

ค่า A1 หรือ R1C1 ของช่วงที่จะดึงค่า

majorDimension

enum (Dimension)

มิติข้อมูลหลักที่ผลลัพธ์ควรใช้

เช่น หากข้อมูลสเปรดชีตคือ A1=1,B1=2,A2=3,B2=4 คำขอ ranges=["A1:B2"],majorDimension=ROWS จะแสดงผล [[1,2],[3,4]] ในขณะที่การขอ ranges=["A1:B2"],majorDimension=COLUMNS จะแสดงผล [[1,3],[2,4]]

valueRenderOption

enum (ValueRenderOption)

ควรแสดงค่าอย่างไรในเอาต์พุต ตัวเลือกการแสดงผลเริ่มต้นคือ ValueRenderOption.FORMATTED_VALUE

dateTimeRenderOption

enum (DateTimeRenderOption)

วิธีที่ควรแสดงวันที่ เวลา และระยะเวลาในเอาต์พุต ระบบจะละเว้นค่านี้หาก valueRenderOption คือ FORMATTED_VALUE ตัวเลือกการแสดงผล dateTime ตามค่าเริ่มต้นคือ SERIAL_NUMBER

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

คำตอบเมื่อเรียกช่วงของค่ามากกว่า 1 ช่วงในสเปรดชีต

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (ValueRange)
    }
  ]
}
ช่อง
spreadsheetId

string

รหัสของสเปรดชีตที่ดึงข้อมูล

valueRanges[]

object (ValueRange)

ค่าที่ขอ ลำดับของ ValueRanges จะเหมือนกับลำดับของช่วงที่ขอ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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

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