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