Method: spreadsheets.values.batchUpdate

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

בקשת HTTP

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

כתובת ה-URL כוללת תחביר של קידוד 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. אפשרות העיבוד המוגדרת כברירת מחדל של תאריך ושעה היא 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)

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

היקפי הרשאה

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

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

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