Method: spreadsheets.values.batchGetByDataFilter

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

בקשת HTTP

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

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

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

פרמטרים
spreadsheetId

string

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

גוף הבקשה

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

ייצוג ב-JSON 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "majorDimension": enum (Dimension),
  "valueRenderOption": enum (ValueRenderOption),
  "dateTimeRenderOption": enum (DateTimeRenderOption)
}
שדות
dataFilters[]

object (DataFilter)

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

enum (Dimension)

המאפיין הראשי שבו צריך להשתמש בתוצאות.

לדוגמה, אם נתוני הגיליון האלקטרוני הם: A1=1,B1=2,A2=3,B2=4, אז בקשה שבוחרת את הטווח הזה ומגדירה את majorDimension=ROWS מחזירה את הערך [[1,2],[3,4]], ואילו בקשה שמגדירה את majorDimension=COLUMNS מחזירה את הערך [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

האופן שבו הערכים יוצגו בפלט. אפשרות העיבוד שמוגדרת כברירת מחדל היא FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

האופן שבו תאריכים, שעות ופרק זמן צריכים להופיע בפלט. המערכת מתעלמת מהערך הזה אם valueRenderOption הוא FORMATTED_VALUE. אפשרות ברירת המחדל של עיבוד dateTime היא SERIAL_NUMBER.

גוף התשובה

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

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (MatchedValueRange)
    }
  ]
}
שדות
spreadsheetId

string

המזהה של הגיליון האלקטרוני שממנו הנתונים אוחזו.
valueRanges[]

object (MatchedValueRange)

הערכים המבוקשים עם רשימת מסנני הנתונים שתואמים להם.

היקפי הרשאה

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

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

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

MatchedValueRange

טווח ערכים שסוננו על ידי מסנן נתונים אחד או יותר.

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

object (ValueRange)

הערכים שמותאמים ל-DataFilter.
dataFilters[]

object (DataFilter)

הערך של DataFilters מהבקשה שתואמת לטווח הערכים.