הפונקציה מחזירה טווח ערכים אחד או יותר שתואם למסנני הנתונים שצוינו. מבצע הקריאה החוזרת חייב לציין את מזהה הגיליון האלקטרוני ולפחות DataFilters
אחד. יוחזרו טווחים שתואמים לאחד או יותר ממסנני הנתונים בבקשה.
בקשת HTTP
POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
spreadsheetId |
המזהה של הגיליון האלקטרוני שממנו יש לאחזר נתונים. |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "dataFilters": [ { object ( |
שדות | |
---|---|
dataFilters[] |
מסנני הנתונים שמשמשים להתאמה של טווחי הערכים שיש לאחזר. טווחים שתואמים לאחד ממסנני הנתונים שצוינו נכללים בתגובה. |
majorDimension |
המאפיין העיקרי שהתוצאות צריכות להשתמש בו. לדוגמה, אם הנתונים בגיליון האלקטרוני הם: |
valueRenderOption |
איך ערכים צריכים להיות מיוצגים בפלט. אפשרות ברירת המחדל לעיבוד היא |
dateTimeRenderOption |
איך תאריכים, שעות ומשכי זמן צריכים להיות מיוצגים בפלט. המערכת תתעלם מהמאפיין הזה אם הערך של |
גוף התשובה
התגובה בעת אחזור יותר מטווח ערכים אחד בגיליון אלקטרוני שנבחר על ידי DataFilters
.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"spreadsheetId": string,
"valueRanges": [
{
object ( |
שדות | |
---|---|
spreadsheetId |
המזהה של הגיליון האלקטרוני שממנו הנתונים אוחזרו. |
valueRanges[] |
הערכים המבוקשים עם רשימת מסנני הנתונים שתאמו להם. |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של 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[] |
הערך |