Method: spreadsheets.values.batchUpdate

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
spreadsheetId

string

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

גוף הבקשה

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

ייצוג ב-JSON
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (ValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
שדות
valueInputOption

enum (ValueInputOption)

איך צריך לפרש את נתוני הקלט.

data[]

object (ValueRange)

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

includeValuesInResponse

boolean

קובע אם תגובת העדכון צריכה לכלול את הערכים של התאים שעודכנו. כברירת מחדל, התשובות לא כוללות את הערכים המעודכנים. השדה updatedData בכל אחד מה-BatchUpdateValuesResponse.responses מכיל את הערכים המעודכנים. אם הטווח לכתיבה היה גדול מהטווח שנכתב בפועל, התגובה כוללת את כל הערכים בטווח המבוקש (לא כולל שורות ועמודות ריקות בסוף).

responseValueRenderOption

enum (ValueRenderOption)

קובעת את האופן שבו יש להציג את הערכים בתגובה. אפשרות העיבוד שמוגדרת כברירת מחדל היא FORMATTED_VALUE.

responseDateTimeRenderOption

enum (DateTimeRenderOption)

קובע איך יתבצע העיבוד של תאריכים, שעות ומרווחי זמן בתגובה. המערכת מתעלמת מהערך הזה אם responseValueRenderOption הוא FORMATTED_VALUE. אפשרות ברירת המחדל של עיבוד dateTime היא SERIAL_NUMBER.

גוף התשובה

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

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

ייצוג ב-JSON
{
  "spreadsheetId": string,
  "totalUpdatedRows": integer,
  "totalUpdatedColumns": integer,
  "totalUpdatedCells": integer,
  "totalUpdatedSheets": integer,
  "responses": [
    {
      object (UpdateValuesResponse)
    }
  ]
}
שדות
spreadsheetId

string

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

totalUpdatedRows

integer

המספר הכולל של השורות שבהן לפחות תא אחד בשורה עודכן.

totalUpdatedColumns

integer

המספר הכולל של העמודות שבהן לפחות תא אחד בעמודה עודכן.

totalUpdatedCells

integer

המספר הכולל של התאים שעודכנו.

totalUpdatedSheets

integer

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

responses[]

object (UpdateValuesResponse)

תשובה אחת של UpdateValuesResponse לכל טווח שביקשת, באותו סדר שבו הבקשות הופיעו.

היקפי הרשאה

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

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

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