Class DataSourceSheet

데이터소스시트

기존 데이터 소스 시트에 액세스하여 수정합니다. 새 데이터 소스 시트를 만들려면 Spreadsheet.insertDataSourceSheet(spec)를 사용합니다.

이 클래스는 데이터베이스에 연결된 데이터에만 사용합니다.

메서드

메서드반환 유형간략한 설명
addFilter(columnName, filterCriteria)DataSourceSheet데이터 소스 시트에 적용된 필터를 추가합니다.
asSheet()Sheet데이터 소스 시트를 일반 시트 객체로 반환합니다.
autoResizeColumn(columnName)DataSourceSheet지정된 열의 너비를 자동으로 조정합니다.
autoResizeColumns(columnNames)DataSourceSheet지정된 열의 너비를 자동으로 조정합니다.
cancelDataRefresh()DataSourceSheet현재 실행 중인 경우 이 객체와 연결된 데이터 새로고침을 취소합니다.
forceRefreshData()DataSourceSheet현재 상태와 관계없이 이 객체의 데이터를 새로고침합니다.
getColumnWidth(columnName)Integer지정된 열의 너비를 반환합니다.
getDataSource()DataSource객체가 연결된 데이터 소스를 가져옵니다.
getFilters()DataSourceSheetFilter[]데이터 소스 시트에 적용된 모든 필터를 반환합니다.
getSheetValues(columnName)Object[]제공된 열 이름의 데이터 소스 시트의 모든 값을 반환합니다.
getSheetValues(columnName, startRow, numRows)Object[]지정된 열 이름에 대한 데이터 소스 시트의 모든 값을 지정된 시작 행 (based-1)부터 지정된 numRows까지 반환합니다.
getSortSpecs()SortSpec[]데이터 소스 시트의 모든 정렬 사양을 가져옵니다.
getStatus()DataExecutionStatus객체의 데이터 실행 상태를 가져옵니다.
refreshData()DataSourceSheet객체의 데이터를 새로고침합니다.
removeFilters(columnName)DataSourceSheet데이터 소스 시트 열에 적용된 모든 필터를 삭제합니다.
removeSortSpec(columnName)DataSourceSheet데이터 소스 시트의 열에서 정렬 사양을 삭제합니다.
setColumnWidth(columnName, width)DataSourceSheet지정된 열의 너비를 설정합니다.
setColumnWidths(columnNames, width)DataSourceSheet지정된 열의 너비를 설정합니다.
setSortSpec(columnName, ascending)DataSourceSheet데이터 소스 시트의 열에 정렬 사양을 설정합니다.
setSortSpec(columnName, sortOrder)DataSourceSheet데이터 소스 시트의 열에 정렬 사양을 설정합니다.
waitForCompletion(timeoutInSeconds)DataExecutionStatus현재 실행이 완료될 때까지 대기하고 지정된 시간(초)이 지나면 시간 초과됩니다.

자세한 문서

addFilter(columnName, filterCriteria)

데이터 소스 시트에 적용된 필터를 추가합니다.

매개변수

이름유형설명
columnNameString이 필터를 적용할 열의 이름입니다.
filterCriteriaFilterCriteria적용할 필터 기준입니다.

리턴

DataSourceSheet: 메서드 체이닝을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

asSheet()

데이터 소스 시트를 일반 시트 객체로 반환합니다.

리턴

Sheet - 일반 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumn(columnName)

지정된 열의 너비를 자동으로 조정합니다.

매개변수

이름유형설명
columnNameString열 이름입니다.

리턴

DataSourceSheet: 연결을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumns(columnNames)

지정된 열의 너비를 자동으로 조정합니다.

매개변수

이름유형설명
columnNamesString[]업데이트할 열 이름 목록입니다.

리턴

DataSourceSheet: 연결을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

cancelDataRefresh()

현재 실행 중인 경우 이 객체와 연결된 데이터 새로고침을 취소합니다.

이 예에서는 수식 새로고침을 취소하는 방법을 보여줍니다. 

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

데이터 소스 유형이 사용 설정되지 않은 경우 예외를 발생시킵니다. SpreadsheetApp#enable...Execution() 메서드를 사용하여 특정 데이터 소스 유형의 데이터 실행을 사용 설정합니다.

리턴

DataSourceSheet: 데이터 객체입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forceRefreshData()

현재 상태와 관계없이 이 객체의 데이터를 새로고침합니다. 자세한 내용은 refreshData()를 참고하세요. 현재 실행 중인 이 객체의 새로고침을 취소하려면 cancelDataRefresh()를 참고하세요.

데이터 소스 유형이 사용 설정되지 않은 경우 예외를 발생시킵니다. SpreadsheetApp#enable...Execution() 메서드를 사용하여 특정 데이터 소스 유형의 데이터 실행을 사용 설정합니다.

리턴

DataSourceSheet: 데이터 객체입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getColumnWidth(columnName)

지정된 열의 너비를 반환합니다.

매개변수

이름유형설명
columnNameString열 이름입니다.

리턴

Integer: 열의 너비 또는 열이 기본 너비를 사용하는 경우 null입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSource()

객체가 연결된 데이터 소스를 가져옵니다.

리턴

DataSource: 데이터 소스입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFilters()

데이터 소스 시트에 적용된 모든 필터를 반환합니다.

리턴

DataSourceSheetFilter[]: 데이터 소스 시트에 적용된 모든 필터의 배열입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName)

제공된 열 이름의 데이터 소스 시트의 모든 값을 반환합니다.

매개변수

이름유형설명
columnNameString값을 가져올 데이터 소스 열 이름입니다.

리턴

Object[]: 값의 1차원 배열입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(columnName, startRow, numRows)

지정된 열 이름에 대한 데이터 소스 시트의 모든 값을 지정된 시작 행 (based-1)부터 지정된 numRows까지 반환합니다.

매개변수

이름유형설명
columnNameString값을 가져올 데이터 소스 열 이름입니다.
startRowInteger값 가져오기를 시작할 행 위치입니다.
numRowsInteger가져올 행 수입니다.

리턴

Object[]: 값의 1차원 배열입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSortSpecs()

데이터 소스 시트의 모든 정렬 사양을 가져옵니다.

리턴

SortSpec[]: 정렬 사양 목록입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getStatus()

객체의 데이터 실행 상태를 가져옵니다.

리턴

DataExecutionStatus: 데이터 실행 상태입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshData()

객체의 데이터를 새로고침합니다.

현재 error 상태인 경우 예외가 발생합니다. DataSource#updateSpec()를 사용하여 사양을 업데이트합니다. 이 메서드는 데이터 소스의 예기치 않은 수정을 방지하기 위해 forceRefreshData()보다 선호됩니다.

데이터 소스 유형이 사용 설정되지 않은 경우 예외를 발생시킵니다. SpreadsheetApp#enable...Execution() 메서드를 사용하여 특정 데이터 소스 유형의 데이터 실행을 사용 설정합니다.

리턴

DataSourceSheet: 데이터 객체입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeFilters(columnName)

데이터 소스 시트 열에 적용된 모든 필터를 삭제합니다.

매개변수

이름유형설명
columnNameString필터를 삭제할 열의 이름입니다.

리턴

DataSourceSheet: 메서드 체이닝을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeSortSpec(columnName)

데이터 소스 시트의 열에서 정렬 사양을 삭제합니다.

매개변수

이름유형설명
columnNameString열의 이름입니다.

리턴

DataSourceSheet: 체이닝을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnWidth(columnName, width)

지정된 열의 너비를 설정합니다.

매개변수

이름유형설명
columnNameString열 이름입니다.
widthInteger열의 새 너비입니다.

리턴

DataSourceSheet: 연결을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnWidths(columnNames, width)

지정된 열의 너비를 설정합니다.

매개변수

이름유형설명
columnNamesString[]업데이트할 열 이름 목록입니다.
widthInteger열의 새 너비입니다.

리턴

DataSourceSheet: 연결을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSortSpec(columnName, ascending)

데이터 소스 시트의 열에 정렬 사양을 설정합니다.

매개변수

이름유형설명
columnNameString정렬할 열의 이름입니다.
ascendingBooleantrue인 경우 열을 오름차순으로 정렬하고 false인 경우 열을 내림차순으로 정렬합니다.

리턴

DataSourceSheet: 체이닝을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSortSpec(columnName, sortOrder)

데이터 소스 시트의 열에 정렬 사양을 설정합니다.

매개변수

이름유형설명
columnNameString정렬할 열의 이름입니다.
sortOrderSortOrder정렬 순서입니다.

리턴

DataSourceSheet: 체이닝을 위한 데이터 소스 시트입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForCompletion(timeoutInSeconds)

현재 실행이 완료될 때까지 대기하고 지정된 시간(초)이 지나면 시간 초과됩니다. 제한 시간 초과 시 실행이 완료되지 않은 경우 예외를 발생시키지만 데이터 실행을 취소하지는 않습니다.

매개변수

이름유형설명
timeoutInSecondsInteger데이터 실행을 기다리는 시간(초)입니다. 최댓값은 300초입니다.

리턴

DataExecutionStatus: 데이터 실행 상태입니다.

승인

이 메서드를 사용하는 스크립트에는 다음 범위 중 하나 이상의 승인이 필요합니다.

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets