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)

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

היקפי ההרשאות

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

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

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