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

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