Method: spreadsheets.values.batchUpdateByDataFilter

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
spreadsheetId

string

รหัสของสเปรดชีตที่จะอัปเดต

เนื้อหาของคำขอ

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
ช่อง
valueInputOption

enum (ValueInputOption)

วิธีตีความข้อมูลอินพุต
data[]

object (DataFilterValueRange)

ค่าใหม่ที่จะใช้กับสเปรดชีต หากมีมากกว่า 1 ช่วงที่ตรงกับ DataFilter ที่ระบุ ระบบจะใช้ค่าที่ระบุกับช่วงดังกล่าวทั้งหมด
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 (UpdateValuesByDataFilterResponse)
    }
  ]
}
ช่อง
spreadsheetId

string

สเปรดชีตที่ใช้การอัปเดต
totalUpdatedRows

integer

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

integer

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

integer

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

integer

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

object (UpdateValuesByDataFilterResponse)

อัปเดตคำตอบสำหรับแต่ละช่วงแล้ว

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

ต้องใช้ขอบเขต OAuth รายการใดรายการหนึ่งต่อไปนี้

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

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

DataFilterValueRange

ช่วงของค่าที่ DataFilter ระบุสถานที่ตั้ง

การแสดง JSON 
{
  "dataFilter": {
    object (DataFilter)
  },
  "majorDimension": enum (Dimension),
  "values": [
    array
  ]
}
ช่อง
dataFilter

object (DataFilter)

ตัวกรองข้อมูลที่อธิบายตำแหน่งของค่าในสเปรดชีต
majorDimension

enum (Dimension)

มิติข้อมูลหลักของค่า
values[]

array (ListValue format)

ข้อมูลที่จะเขียน ถ้าค่าที่ระบุเกินช่วงใดๆ ที่ตรงตามตัวกรองข้อมูล คำขอจะล้มเหลว หากค่าที่ระบุน้อยกว่าช่วงที่ตรงกัน ระบบจะเขียนเฉพาะค่าที่ระบุ ค่าที่มีอยู่ในช่วงที่ตรงกันจะไม่ได้รับผลกระทบ

UpdateValuesByDataFilterResponse

คำตอบเมื่ออัปเดตช่วงของค่าโดยตัวกรองข้อมูลในสเปรดชีต

การแสดง JSON 
{
  "updatedRange": string,
  "updatedRows": integer,
  "updatedColumns": integer,
  "updatedCells": integer,
  "dataFilter": {
    object (DataFilter)
  },
  "updatedData": {
    object (ValueRange)
  }
}
ช่อง
updatedRange

string

ช่วง (ในรูปแบบ A1) ที่ใช้การอัปเดต
updatedRows

integer

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

integer

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

integer

จำนวนเซลล์ที่อัปเดต
dataFilter

object (DataFilter)

ตัวกรองข้อมูลที่เลือกช่วงที่ได้รับการอัปเดต
updatedData

object (ValueRange)

ค่าของเซลล์ในช่วงที่ตรงกับ dataFilter หลังจากใช้การอัปเดตทั้งหมด โดยจะรวมเฉพาะในกรณีที่ช่อง includeValuesInResponse ของคำขอคือ true