Method: spreadsheets.values.batchGet

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

בקשת HTTP

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}/values:batchGet

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

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

פרמטרים
spreadsheetId

string

מזהה הגיליון האלקטרוני שממנו יש לאחזר את הנתונים.

פרמטרים של שאילתה

פרמטרים
ranges[]

string

סימון A1 או סימון R1C1 של הטווח שממנו יש לאחזר את הערכים.
majorDimension

enum (Dimension)

המאפיין העיקרי שבו יש להשתמש בתוצאות.

לדוגמה, אם נתוני הגיליון האלקטרוני הם: A1=1,B1=2,A2=3,B2=4, אז הבקשה ranges=["A1:B2"],majorDimension=ROWS תחזיר את [[1,2],[3,4]], ואילו הבקשה ranges=["A1:B2"],majorDimension=COLUMNS תחזיר [[1,3],[2,4]].
valueRenderOption

enum (ValueRenderOption)

איך לייצג את הערכים בפלט. אפשרות הרינדור שמוגדרת כברירת המחדל היא ValueRenderOption.FORMATTED_VALUE.
dateTimeRenderOption

enum (DateTimeRenderOption)

האופן שבו תאריכים, שעות ומשכים צריכים להיות מיוצגים בפלט. המערכת תתעלם מהמדיניות הזו אם valueRenderOption הוא FORMATTED_VALUE. אפשרות העיבוד המוגדרת כברירת מחדל של תאריך ושעה היא SERIAL_NUMBER.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

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

אם התגובה הצליחה, גוף התגובה מכיל נתונים עם המבנה הבא:

ייצוג JSON 
{
  "spreadsheetId": string,
  "valueRanges": [
    {
      object (ValueRange)
    }
  ]
}
שדות
spreadsheetId

string

המזהה של הגיליון האלקטרוני שהנתונים אוחזרו ממנו.
valueRanges[]

object (ValueRange)

הערכים המבוקשים. הסדר של ValueRanges זהה לסדר של הטווחים המבוקשים.

היקפי הרשאה

מחייב אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

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