Method: spreadsheets.getByDataFilter

מחזירה את הגיליון האלקטרוני עם המזהה הנתון. מבצע הקריאה החוזרת צריך לציין את המזהה של הגיליון האלקטרוני.

השיטה הזו שונה מ-Sheets.get בכך שהיא מאפשרת לבחור אילו קבוצות משנה של נתונים בגיליון אלקטרוני יוחזרו על ידי ציון הפרמטר dataFilters. אפשר לציין כמה ערכי DataFilters. ציון של מסנן נתונים אחד או יותר יחזיר את החלקים בגיליון האלקטרוני שחוצים טווחים שתואמים למסננים כלשהם.

כברירת מחדל, לא מוחזרים נתונים שנמצאים ברשתות. אפשר לכלול נתוני רשת באחת משתי הדרכים הבאות:

  • מציינים מסכת שדות שמפרטת את השדות הרצויים באמצעות הפרמטר fields של כתובת ה-URL ב-HTTP

  • מגדירים את הפרמטר includeGridData כ-True. אם מוגדרת מסכת שדות, המערכת מתעלמת מהפרמטר 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

הערך הוא True אם צריך להחזיר נתוני רשת. המערכת תתעלם מהפרמטר הזה אם הוגדרה מסכת שדות בבקשה.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Spreadsheet.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

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

מידע נוסף זמין במדריך להרשאות.