Method: spreadsheets.getByDataFilter

지정된 ID의 스프레드시트를 반환합니다. 호출자가 스프레드시트 ID를 지정해야 합니다.

이 메서드는 dataFilters 매개변수를 지정하여 반환할 스프레드시트 데이터의 하위 집합을 선택할 수 있다는 점에서 spreadsheets.get과 다릅니다. 여러 개의 DataFilters를 지정할 수 있습니다. 하나 이상의 데이터 필터를 지정하면 필터와 일치하는 범위와 교차하는 스프레드시트의 부분이 반환됩니다.

기본적으로 그리드 내 데이터는 반환되지 않습니다. 다음 두 가지 방법 중 하나로 그리드 데이터를 포함할 수 있습니다.

  • HTTP에서 fields URL 매개변수를 사용하여 원하는 필드를 나열하는 필드 마스크를 지정합니다.

  • includeGridData 매개변수를 true로 설정합니다. 필드 마스크가 설정되면 includeGridData 매개변수가 무시됩니다.

대용량 스프레드시트의 경우 원하는 특정 스프레드시트 필드만 검색하는 것이 좋습니다.

HTTP 요청

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

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

경로 매개변수

매개변수
spreadsheetId

string

요청할 스프레드시트입니다.

요청 본문

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

JSON 표현 
{
  "dataFilters": [
    {
      object (DataFilter)
    }
  ],
  "includeGridData": boolean,
  "excludeTablesInBandedRanges": boolean
}
필드
dataFilters[]

object (DataFilter)

스프레드시트에서 가져올 범위를 선택하는 데 사용되는 DataFilters입니다.
includeGridData

boolean

그리드 데이터를 반환해야 하는 경우 true입니다. 요청에 필드 마스크가 설정된 경우 이 매개변수는 무시됩니다.
excludeTablesInBandedRanges

boolean

밴딩된 범위에서 테이블을 제외해야 하는 경우 true입니다. 설정되지 않은 경우 false입니다.

응답 본문

성공한 경우 응답 본문에 Spreadsheet의 인스턴스가 포함됩니다.

승인 범위

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

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

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