Method: spreadsheets.getByDataFilter

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

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

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

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

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