Method: spreadsheets.getByDataFilter

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

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

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

  • ระบุมาสก์ของช่องที่แสดงช่องที่ต้องการโดยใช้พารามิเตอร์ 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,
  "commentsViewMode": enum (CommentsViewMode)
}
ช่อง
dataFilters[]

object (DataFilter)

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

boolean

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

boolean

เป็น "จริง" หากควรยกเว้นตารางในกลุ่มช่วง เป็น "เท็จ" หากไม่ได้ตั้งค่า
commentsViewMode

enum (CommentsViewMode)

โหมดมุมมองความคิดเห็นที่จะใช้กับสเปรดชีต ซึ่งช่วยให้ดูสเปรดชีตโดยไม่แสดงหรือแสดงความคิดเห็นได้ หากไม่ได้ระบุ ระบบจะใช้ COMMENTS_VIEW_MODE_OMITTED

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

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

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

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

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

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