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. אפשרות ברירת המחדל לרינדור 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

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