Method: spreadsheets.values.batchGetByDataFilter

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

בקשת HTTP

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

כתובת ה-URL כוללת תחביר של קידוד 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. אפשרות העיבוד המוגדרת כברירת מחדל של תאריך ושעה היא 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

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

טווח של ערך תואם

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

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

object (ValueRange)

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

object (DataFilter)

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