REST Resource: spreadsheets

리소스: 스프레드시트

스프레드시트를 나타내는 리소스입니다.

JSON 표현 
{
  "spreadsheetId": string,
  "properties": {
    object (SpreadsheetProperties)
  },
  "sheets": [
    {
      object (Sheet)
    }
  ],
  "namedRanges": [
    {
      object (NamedRange)
    }
  ],
  "spreadsheetUrl": string,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSources": [
    {
      object (DataSource)
    }
  ],
  "dataSourceSchedules": [
    {
      object (DataSourceRefreshSchedule)
    }
  ]
}
필드
spreadsheetId

string

스프레드시트의 ID입니다. 이 필드는 읽기 전용입니다.
properties

object (SpreadsheetProperties)

스프레드시트의 전체 속성입니다.
sheets[]

object (Sheet)

스프레드시트의 일부인 시트입니다.
namedRanges[]

object (NamedRange)

스프레드시트에 정의된 이름이 지정된 범위입니다.
spreadsheetUrl

string

스프레드시트의 URL입니다. 이 필드는 읽기 전용입니다.
developerMetadata[]

object (DeveloperMetadata)

스프레드시트와 연결된 개발자 메타데이터입니다.
dataSources[]

object (DataSource)

스프레드시트와 연결된 외부 데이터 소스의 목록입니다.
dataSourceSchedules[]

object (DataSourceRefreshSchedule)

출력 전용입니다. 데이터 소스 새로고침 일정 목록입니다.

SpreadsheetProperties

스프레드시트의 속성입니다.

JSON 표현 
{
  "title": string,
  "locale": string,
  "autoRecalc": enum (RecalculationInterval),
  "timeZone": string,
  "defaultFormat": {
    object (CellFormat)
  },
  "iterativeCalculationSettings": {
    object (IterativeCalculationSettings)
  },
  "spreadsheetTheme": {
    object (SpreadsheetTheme)
  },
  "importFunctionsExternalUrlAccessAllowed": boolean
}
필드
title

string

스프레드시트의 제목입니다.
locale

string

다음 형식 중 하나로 된 스프레드시트의 언어:

  • ISO 639-1 언어 코드(예: en)

  • 639-1 코드가 없는 경우 ISO 639-2 언어 코드(예: fil)

  • ISO 언어 코드와 국가 코드의 조합(예: en_US)

참고: 이 필드를 업데이트하면 일부 언어/언어는 지원되지 않습니다.
autoRecalc

enum (RecalculationInterval)

휘발성 함수가 다시 계산될 때까지 기다리는 시간입니다.
timeZone

string

스프레드시트의 시간대입니다(America/New_York와 같은 CLDR 형식). 시간대가 인식되지 않으면 GMT-07:00와 같은 맞춤 시간대일 수 있습니다.
defaultFormat

object (CellFormat)

스프레드시트에 있는 모든 셀의 기본 형식입니다. 셀의 형식이 이 기본 형식과 동일하면 CellData.effectiveFormat이 설정되지 않습니다. 이 필드는 읽기 전용입니다.
iterativeCalculationSettings

object (IterativeCalculationSettings)

반복 계산으로 순환 참조를 처리할지 여부 및 해결 방법을 결정합니다. 이 필드가 없으면 순환 참조로 인해 계산 오류가 발생합니다.
spreadsheetTheme

object (SpreadsheetTheme)

스프레드시트에 테마가 적용되었습니다.
importFunctionsExternalUrlAccessAllowed

boolean

이미지 및 가져오기 함수의 외부 URL 액세스 허용 여부입니다. true인 경우에만 읽을 수 있습니다. false인 경우 true로 설정할 수 있습니다. 이 값은 관리자가 허용 목록 기능을 사용 설정한 경우 우회되고 항상 true를 반환합니다.

RecalculationInterval

가능한 다시 계산 간격 옵션의 열거형입니다.

열거형
RECALCULATION_INTERVAL_UNSPECIFIED 기본값 이 값은 사용하면 안 됩니다.
ON_CHANGE 휘발성 함수는 변경될 때마다 업데이트됩니다.
MINUTE 휘발성 함수는 변경사항이 있을 때마다 그리고 1분마다 업데이트됩니다.
HOUR 휘발성 함수는 변경될 때마다 매시간 업데이트됩니다.

IterativeCalculationSettings

반복 계산으로 순환 종속 항목이 해결되는 방식을 제어하는 설정입니다.

JSON 표현 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
필드
maxIterations

integer

반복 계산이 사용 설정된 경우 실행할 최대 계산 횟수
convergenceThreshold

number

반복 계산이 사용 설정되어 있고 연속된 결과의 차이가 이 임곗값보다 작으면 계산 라운드가 중지됩니다.

SpreadsheetTheme

스프레드시트 테마를 나타냅니다.

JSON 표현 
{
  "primaryFontFamily": string,
  "themeColors": [
    {
      object (ThemeColorPair)
    }
  ]
}
필드
primaryFontFamily

string

기본 글꼴 모음의 이름입니다.
themeColors[]

object (ThemeColorPair)

스프레드시트 테마 색상 쌍입니다. 업데이트하려면 모든 테마 색상 쌍을 제공해야 합니다.

ThemeColorPair

스프레드시트 테마 색상 유형을 이를 나타내는 구체적인 색상으로 매핑하는 쌍입니다.

JSON 표현 
{
  "colorType": enum (ThemeColorType),
  "color": {
    object (ColorStyle)
  }
}
필드
colorType

enum (ThemeColorType)

스프레드시트 테마 색상의 유형입니다.
color

object (ColorStyle)

테마 색상 유형에 해당하는 구체적인 색상입니다.

NamedRange

이름이 지정된 범위

JSON 표현 
{
  "namedRangeId": string,
  "name": string,
  "range": {
    object (GridRange)
  }
}
필드
namedRangeId

string

이름이 지정된 범위의 ID입니다.
name

string

이름이 지정된 범위의 이름입니다.
range

object (GridRange)

이 값이 나타내는 범위입니다.

DataSource

스프레드시트의 외부 데이터 소스에 관한 정보입니다.

JSON 표현 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
필드
dataSourceId

string

데이터 소스를 식별하는 스프레드시트 범위의 고유 ID입니다. 예: 1080547365.
spec

object (DataSourceSpec)

이 스프레드시트와 연결된 데이터 소스의 DataSourceSpec입니다.
calculatedColumns[]

object (DataSourceColumn)

데이터 소스의 계산된 모든 열입니다.
sheetId

integer

데이터 소스와 연결된 Sheet의 ID입니다. 한 번 설정된 필드는 변경할 수 없습니다.

데이터 소스를 만들 때 연결된 DATA_SOURCE 시트도 생성되며, 필드를 지정하지 않으면 생성된 시트의 ID가 무작위로 생성됩니다.

DataSourceSpec

데이터 소스의 세부정보를 지정합니다. 예를 들어 BigQuery의 경우 BigQuery 소스에 대한 정보를 지정합니다.

JSON 표현 
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
필드
parameters[]

object (DataSourceParameter)

데이터 소스를 쿼리할 때 사용되는 데이터 소스의 매개변수입니다.
통합 필드 spec. 데이터 소스 유형별 실제 사양입니다. spec은 다음 중 하나여야 합니다.
bigQuery

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec -
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][]입니다.

BigQueryDataSourceSpec

시트에 연결된 BigQuery 데이터 소스의 사양입니다.

JSON 표현 
{
  "projectId": string,

  // Union field spec can be only one of the following:
  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
  // End of list of possible types for union field spec.
}
필드
projectId

string

결제 계정이 연결된 BigQuery 지원 Google Cloud 프로젝트의 ID입니다. 데이터 소스를 대상으로 실행된 모든 쿼리의 경우 프로젝트에 요금이 청구됩니다.
통합 필드 spec. 실제 사양 spec은 다음 중 하나여야 합니다.
querySpec

object (BigQueryQuerySpec)

BigQueryQuerySpec -
tableSpec

object (BigQueryTableSpec)

BigQueryTableSpec -

BigQueryQuerySpec

맞춤 BigQuery 쿼리를 지정합니다.

JSON 표현 
{
  "rawQuery": string
}
필드
rawQuery

string

원시 쿼리 문자열입니다.

BigQueryTableSpec

BigQuery 테이블 정의를 지정합니다. 네이티브 테이블만 허용됩니다.

JSON 표현 
{
  "tableProjectId": string,
  "tableId": string,
  "datasetId": string
}
필드
tableProjectId

string

테이블이 속한 BigQuery 프로젝트의 ID입니다. 지정하지 않으면 projectId으로 간주됩니다.
tableId

string

BigQuery 테이블 ID입니다.
datasetId

string

BigQuery 데이터 세트 ID입니다.

LookerDataSourceSpec

Looker 데이터 소스의 사양입니다.

JSON 표현 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
필드
instanceUri

string

Looker 인스턴스 URL입니다.
model

string

Looker 모델의 이름입니다.
explore

string

Looker 모델 Explore의 이름입니다.

DataSourceParameter

데이터 소스 쿼리의 매개변수입니다. 이 매개변수를 사용하면 사용자가 스프레드시트의 값을 쿼리에 전달할 수 있습니다.

JSON 표현 
{

  // Union field identifier can be only one of the following:
  "name": string
  // End of list of possible types for union field identifier.

  // Union field value can be only one of the following:
  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
  // End of list of possible types for union field value.
}
필드
통합 필드 identifier. 매개변수 식별자입니다. identifier은 다음 중 하나여야 합니다.
name

string

이름이 지정된 매개변수입니다. 이를 지원하는 DataSource의 합법적인 식별자여야 합니다. 예를 들면 BigQuery 식별자입니다.
통합 필드 value. 매개변수 값입니다. value은 다음 중 하나여야 합니다.
namedRangeId

string

NamedRange의 ID입니다. 크기는 1x1이어야 합니다.
range

object (GridRange)

매개변수의 값을 포함하는 범위입니다. 크기는 1x1이어야 합니다.

DataSourceRefreshSchedule

데이터 소스 새로고침 일정

스프레드시트의 데이터 소스는 시간 간격 내에 새로고침됩니다. Sheets 편집기에서 새로고침 예약 버튼을 클릭하여 시작 시간을 지정할 수 있지만 간격은 4시간으로 고정됩니다. 예를 들어 시작 시간을 오전 8시 로 지정하면 매일 오전 8시에서 오후 12시 사이에 새로고침이 실행됩니다.

JSON 표현 
{
  "enabled": boolean,
  "refreshScope": enum (DataSourceRefreshScope),
  "nextRun": {
    object (Interval)
  },

  // Union field schedule_config can be only one of the following:
  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
  // End of list of possible types for union field schedule_config.
}
필드
enabled

boolean

새로고침 일정이 사용 설정되어 있으면 true이고, 그렇지 않으면 false입니다.
refreshScope

enum (DataSourceRefreshScope)

새로고침 범위입니다. ALL_DATA_SOURCES이어야 합니다.
nextRun

object (Interval)

출력 전용입니다. 다음 실행의 시간 간격입니다.
통합 필드 schedule_config. 일정 구성(schedule_config)은 다음 중 하나여야 합니다.
dailySchedule

object (DataSourceRefreshDailySchedule)

일일 새로고침 일정
weeklySchedule

object (DataSourceRefreshWeeklySchedule)

주간 업데이트 일정
monthlySchedule

object (DataSourceRefreshMonthlySchedule)

월별 새로고침 일정

DataSourceRefreshScope

데이터 소스 새로고침 범위

열거형
DATA_SOURCE_REFRESH_SCOPE_UNSPECIFIED 기본값이며 사용할 수 없습니다.
ALL_DATA_SOURCES 스프레드시트에서 모든 데이터 소스 및 연결된 데이터 소스 객체를 새로고침합니다.

DataSourceRefreshDailySchedule

지정된 시간 간격으로 데이터를 매일 새로고침하는 일정입니다.

JSON 표현 
{
  "startTime": {
    object (TimeOfDay)
  }
}
필드
startTime

object (TimeOfDay)

데이터 소스 새로고침이 예약된 시간 간격의 시작 시간입니다. hours 부분만 사용됩니다. 시간 간격 크기는 기본적으로 Sheets 편집기의 크기로 설정됩니다.

TimeOfDay

하루 중 특정 시간을 나타냅니다. 날짜와 시간대가 중요하지 않거나 아무 곳으로 지정됩니다. API는 윤초를 허용하도록 선택할 수 있습니다. 관련된 유형은 google.type.Date 및 google.protobuf.Timestamp입니다.

JSON 표현 
{
  "hours": integer,
  "minutes": integer,
  "seconds": integer,
  "nanos": integer
}
필드
hours

integer

24시간 형식의 시간입니다. 0~23 사이의 값이어야 합니다. API는 비즈니스 종료 시간과 같은 시나리오에서 '24:00:00' 값을 허용하도록 선택할 수 있습니다.
minutes

integer

특정 시간의 분입니다. 0~59 사이의 값이어야 합니다.
seconds

integer

특정 분의 초입니다. 일반적으로 0~59 사이의 값이어야 합니다. API가 윤초를 허용하는 경우 값에 60을 사용할 수 있습니다.
nanos

integer

나노초 단위의 초수입니다. 0~999,999,999 사이의 값이어야 합니다.

DataSourceRefreshWeeklySchedule

지정된 시간 간격의 특정 날짜에 데이터가 새로고침되는 주간 일정입니다.

JSON 표현 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfWeek": [
    enum (DayOfWeek)
  ]
}
필드
startTime

object (TimeOfDay)

데이터 소스 새로고침이 예약된 시간 간격의 시작 시간입니다. hours 부분만 사용됩니다. 시간 간격 크기는 Sheets 편집기의 기본 시간으로 설정됩니다.
daysOfWeek[]

enum (DayOfWeek)

새로고침할 요일입니다. 날짜를 하나 이상 지정해야 합니다.

DayOfWeek

요일을 나타냅니다.

열거형
DAY_OF_WEEK_UNSPECIFIED 요일이 지정되지 않습니다.
MONDAY 월요일
TUESDAY 화요일
WEDNESDAY 수요일
THURSDAY 목요일
FRIDAY 금요일
SATURDAY 토요일
SUNDAY 일요일

DataSourceRefreshMonthlySchedule

매월 특정 날짜에 지정된 시간 간격으로 데이터를 새로고침하는 월별 일정입니다.

JSON 표현 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
필드
startTime

object (TimeOfDay)

데이터 소스 새로고침이 예약된 시간 간격의 시작 시간입니다. hours 부분만 사용됩니다. 시간 간격 크기는 기본적으로 Sheets 편집기의 크기로 설정됩니다.
daysOfMonth[]

integer

새로고침할 일입니다. 1~28만 지원되며 1~28일로 매핑됩니다. 날짜를 1개 이상 지정해야 합니다.

간격

타임스탬프 시작 (포함) 및 타임스탬프 종료 (제외)로 인코딩된 시간 간격을 나타냅니다.

시작은 종료보다 작거나 같아야 합니다. 시작이 끝과 같으면 간격은 비어 있습니다 (시간과 일치하지 않음). 시작과 끝이 모두 지정되지 않으면 간격은 항상 일치합니다.

JSON 표현 
{
  "startTime": string,
  "endTime": string
}
필드
startTime

string (Timestamp format)

선택사항입니다. 간격의 시작(포함)입니다.

지정된 경우 이 간격과 일치하는 타임스탬프는 시작 시간과 동일하거나 그 이후여야 합니다.
endTime

string (Timestamp format)

선택사항입니다. 간격의 끝(해당 값 제외)입니다.

지정된 경우 이 간격과 일치하는 타임스탬프가 끝부분 이전이어야 합니다.

메서드

batchUpdate

 스프레드시트에 하나 이상의 업데이트를 적용합니다.

create

 스프레드시트를 만들어 새로 만든 스프레드시트를 반환합니다.

get

 지정된 ID의 스프레드시트를 반환합니다.

getByDataFilter

 지정된 ID에 있는 스프레드시트를 반환합니다.