Method: spreadsheets.getByDataFilter

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

เมธอดนี้แตกต่างจากอัปโหลดสเปรดชีตs.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

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