Method: spreadsheets.values.batchGetByDataFilter

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

คำขอ HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter

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

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

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

string

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

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

เนื้อหาของคำขอมีข้อมูลซึ่งมีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
ช่อง
dataFilters[]

object (DataFilter)

ตัวกรองข้อมูลที่ใช้ในการจับคู่ช่วงของค่าที่จะดึง ช่วงที่ตรงกับตัวกรองข้อมูลที่ระบุจะรวมอยู่ในคำตอบ
majorDimension

enum (Dimension)

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

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

enum (ValueRenderOption)

ลักษณะการแสดงค่าในเอาต์พุต ตัวเลือกการแสดงผลเริ่มต้นคือ FORMATTED_VALUE
dateTimeRenderOption

enum (DateTimeRenderOption)

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

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

คำตอบเมื่อเรียกค่ามากกว่า 1 ช่วงในสเปรดชีตที่ DataFilters เลือกไว้

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

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

string

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

object (MatchedValueRange)

ค่าที่ขอซึ่งมีรายการตัวกรองข้อมูลที่ตรงกัน

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

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

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

MatchedValueRange

ช่วงค่าที่ตรงกันโดยผู้ยื่นข้อมูลอย่างน้อย 1 ราย

การแสดง JSON 
{
  "valueRange": {
    object (ValueRange)
  },
  "dataFilters": [
    {
      object (DataFilter)
    }
  ]
}
ช่อง
valueRange

object (ValueRange)

ค่าที่ตรงกันโดย DataFilter
dataFilters[]

object (DataFilter)

DataFilters จากคำขอที่ตรงกับช่วงของค่า