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. אפשרות ברירת המחדל לרינדור 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

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