Method: spreadsheets.getByDataFilter

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

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

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

  • מציינים מסכת שדות שבה מפורטים השדות הרצויים באמצעות הפרמטר של כתובת ה-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
}
שדות
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

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