Method: spreadsheets.batchUpdate

הפעלת עדכון אחד או יותר בגיליון האלקטרוני.

כל request מאומת לפני היישום. אם בקשה כלשהי אינה חוקית, הבקשה כולה תיכשל ולא יושם שום דבר.

בבקשות מסוימות יש replies כדי לספק מידע על אופן היישום שלהן. התשובות ישקפו את הבקשות. לדוגמה, אם החלתם 4 עדכונים ובתגובה השלישית הייתה תשובה, התשובה תכלול 2 תשובות ריקות, התשובה עצמה ותשובה ריקה נוספת, בסדר הזה.

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

בקשת HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

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

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

פרמטרים
spreadsheetId

string

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
שדות
requests[]

object (Request)

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

boolean

הפונקציה קובעת אם תגובת העדכון צריכה לכלול את משאב הגיליון האלקטרוני.
responseRanges[]

string

הגבלת הטווחים שנכללים בגיליון האלקטרוני של התשובות. משמעות רק אם הערך של includeSpreadsheetInResponse הוא 'true'.
responseIncludeGridData

boolean

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

גוף התשובה

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

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

ייצוג JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
שדות
spreadsheetId

string

הגיליון האלקטרוני שעליו הוחלו העדכונים.
replies[]

object (Response)

התשובה לעדכונים. המערכת ממפה 1:1 עם העדכונים, אבל יכול להיות שהתשובות לחלק מהבקשות יהיו ריקות.
updatedSpreadsheet

object (Spreadsheet)

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

היקפי ההרשאות

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

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

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