Method: spreadsheets.values.batchGetByDataFilter

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

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

בקשת HTTP

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

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

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

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