Method: spreadsheets.values.batchGet

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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. אפשרות ברירת המחדל של עיבוד dateTime היא 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

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