Method: spreadsheets.getByDataFilter

แสดงผลสเปรดชีตที่รหัสที่ระบุ ผู้โทรต้องระบุรหัสสเปรดชีต ดูข้อมูลเพิ่มเติมได้ที่อ่าน เขียน และค้นหาข้อมูลเมตา

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

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

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

  • ตั้งค่าพารามิเตอร์ includeGridData เป็น true หากตั้งค่ามาสก์ฟิลด์ ระบบจะเพิกเฉยต่อพารามิเตอร์ 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

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