Method: spreadsheets.getByDataFilter

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

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

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

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

  • מגדירים את הפרמטר includeGridData לערך true. אם מוגדר מסכת שדה, המערכת מתעלמת מהפרמטר includeGridData

לגבי גיליונות אלקטרוניים גדולים, מומלץ לאחזר רק את השדות הספציפיים של הגיליון האלקטרוני שרוצים.

בקשת HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:getByDataFilter

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
spreadsheetId

string

הגיליון האלקטרוני שרוצים לבקש.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean,
  "excludeTablesInBandedRanges": boolean
}
שדות
dataFilters[]

object (DataFilter)

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

boolean

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

boolean

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

גוף התשובה

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

היקפי הרשאה

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

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

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