Method: spreadsheets.getByDataFilter

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

วิธีการนี้แตกต่างจากสเปรดชีต.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
}
ช่อง
dataFilters[]

object (DataFilter)

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

boolean

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

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

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

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

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

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

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