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)

התשובה לגבי העדכונים. זהו מיפוי אחד על אחד עם העדכונים, אף על פי שתשובות לחלק מהבקשות עשויות להיות ריקות.
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

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