Method: spreadsheets.getByDataFilter

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

วิธีนี้แตกต่างจาก spreadsheets.get ตรงที่ช่วยให้สามารถเลือกชุดย่อยของข้อมูลสเปรดชีตที่จะแสดงผลได้โดยระบุพารามิเตอร์ dataFilters คุณสามารถระบุ DataFilters ได้หลายรายการ การระบุตัวกรองข้อมูลอย่างน้อย 1 รายการจะแสดงผลส่วนของสเปรดชีตที่ตัดกับช่วงที่ตรงกับตัวกรองใดตัวกรองหนึ่ง

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

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

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

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

คำขอ HTTP

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

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

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

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

string

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

เนื้อความของคำขอ

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

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

object (DataFilter)

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

boolean

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

boolean

จริงหากต้องการยกเว้นตารางในแถบ เท็จหากไม่ได้ตั้งค่า

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Spreadsheet

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

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

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