Method: spreadsheets.values.batchUpdateByDataFilter

스프레드시트의 하나 이상의 범위에 값을 설정합니다. 호출자는 스프레드시트 ID, valueInputOption 및 하나 이상의 DataFilterValueRanges를 지정해야 합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
spreadsheetId

string

업데이트할 스프레드시트의 ID입니다.

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "valueInputOption": enum (ValueInputOption),
  "data": [
    {
      object (DataFilterValueRange)
    }
  ],
  "includeValuesInResponse": boolean,
  "responseValueRenderOption": enum (ValueRenderOption),
  "responseDateTimeRenderOption": enum (DateTimeRenderOption)
}
필드
valueInputOption

enum (ValueInputOption)

입력 데이터가 해석되는 방식입니다.
data[]

object (DataFilterValueRange)

스프레드시트에 적용할 새 값입니다. 지정된 DataFilter와 일치하는 범위가 둘 이상이면 지정된 값이 모든 범위에 적용됩니다.
includeValuesInResponse

boolean

업데이트 응답에 업데이트된 셀의 값을 포함할지 결정합니다. 기본적으로 응답에는 업데이트된 값이 포함되지 않습니다. 각 BatchUpdateValuesResponse.responses 내의 updatedData 필드에는 업데이트된 값이 포함됩니다. 쓰기 범위가 실제 쓰기 범위보다 큰 경우 응답에는 요청된 범위의 모든 값이 포함됩니다 (후행 빈 행과 열 제외).
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

행에서 하나 이상의 셀이 업데이트된 총 행 수입니다.
totalUpdatedColumns

integer

열에 있는 하나 이상의 셀이 업데이트된 총 열 수입니다.
totalUpdatedCells

integer

업데이트된 셀의 총 개수입니다.
totalUpdatedSheets

integer

시트의 하나 이상의 셀이 업데이트된 시트의 총 개수입니다.
responses[]

object (UpdateValuesByDataFilterResponse)

각 범위의 응답이 업데이트되었습니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 승인 가이드를 참고하세요.

데이터 필터 값 범위

위치가 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

행에서 하나 이상의 셀이 업데이트된 행 수입니다.
updatedColumns

integer

열의 셀 중 하나 이상이 업데이트된 열 수입니다.
updatedCells

integer

업데이트된 셀 수입니다.
dataFilter

object (DataFilter)

업데이트된 범위를 선택한 데이터 필터입니다.
updatedData

object (ValueRange)

모든 업데이트가 적용된 후 dataFilter와 일치하는 범위 내 셀 값입니다. 요청의 includeValuesInResponse 필드가 true인 경우에만 포함됩니다.