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)

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

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