Method: spreadsheets.batchUpdate

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

כל request מאומת לפני היישום. אם אחת מהבקשות לא תקפה, הבקשה כולה תיכשל ולא תתבצע אף פעולה.

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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