Method: spreadsheets.values.batchUpdate

ตั้งค่าในช่วงอย่างน้อย 1 ช่วงของสเปรดชีต ผู้เรียกต้องระบุรหัสสเปรดชีต, valueInputOption และ ValueRanges อย่างน้อย 1 รายการ

คำขอ 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

จํานวนแถวทั้งหมดที่มีการอัปเดตเซลล์อย่างน้อย 1 เซลล์ในแถว
totalUpdatedColumns

integer

จํานวนคอลัมน์ทั้งหมดที่มีการอัปเดตเซลล์อย่างน้อย 1 เซลล์ในคอลัมน์
totalUpdatedCells

integer

จํานวนเซลล์ทั้งหมดที่อัปเดต
totalUpdatedSheets

integer

จํานวนชีตทั้งหมดที่มีการอัปเดตเซลล์อย่างน้อย 1 เซลล์ในชีต
responses[]

object (UpdateValuesResponse)

UpdateValuesResponse 1 รายการต่อช่วงที่มีการขอตามลำดับเดียวกับที่คำขอปรากฏขึ้น

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์