מחזירה טווח אחד או יותר של ערכים שתואמים למסנני הנתונים שצוינו. המתקשר חייב לציין את מזהה הגיליון האלקטרוני ולפחות 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
למידע נוסף, ניתן לעיין במדריך ההרשאה.
טווח של ערך תואם
טווח ערכים שהתאים למגיש נתונים אחד או יותר.
ייצוג JSON |
---|
{ "valueRange": { object ( |
שדות | |
---|---|
valueRange |
הערכים שתואמים ל- |
dataFilters[] |
ה- |