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)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode)
}
필드
spreadsheetId

string

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

object (SpreadsheetProperties)

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

object (Sheet)

스프레드시트에 포함된 시트입니다.
namedRanges[]

object (NamedRange)

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

string

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

object (DeveloperMetadata)

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

object (DataSource)

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

object (DataSourceRefreshSchedule)

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

object (CommentThread)

스프레드시트와 연결된 댓글 대화목록입니다.

commentsViewMode

enum (CommentsViewMode)

출력 전용입니다. 스프레드시트에 적용된 댓글 보기 모드입니다.

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

다음 형식 중 하나의 스프레드시트 언어입니다.

  • en와 같은 ISO 639-1 언어 코드

  • 639-1 코드가 없는 경우 fil와 같은 ISO 639-2 언어 코드

  • 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 휘발성 함수는 변경사항이 있을 때마다, 매분 업데이트됩니다.
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)
    }
  ],

  "bigQuery": {
    object (BigQueryDataSourceSpec)
  },
  "looker": {
    object (LookerDataSourceSpec)
  }
}
필드
parameters[]

object (DataSourceParameter)

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

object (BigQueryDataSourceSpec)

BigQueryDataSourceSpec -
looker

object (LookerDataSourceSpec)

[LookerDatasourceSpec][]입니다.

BigQueryDataSourceSpec

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

JSON 표현 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
필드
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 모델 탐색의 이름입니다.

DataSourceParameter

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

JSON 표현 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
필드
통합 필드 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)
  },

  "dailySchedule": {
    object (DataSourceRefreshDailySchedule)
  },
  "weeklySchedule": {
    object (DataSourceRefreshWeeklySchedule)
  },
  "monthlySchedule": {
    object (DataSourceRefreshMonthlySchedule)
  }
}
필드
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)

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

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)

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

지정된 경우 이 간격과 일치하는 타임스탬프는 종료 시간 이전이어야 합니다.

CommentThread

스프레드시트 내의 단일 댓글 스레드를 나타냅니다.

JSON 표현 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
필드
commentId

string

댓글 스레드의 고유 ID입니다.
anchorId

string

이 스레드가 연결된 시트의 CommentAnchor ID입니다.
headPost

object (Post)

대화목록의 첫 번째 게시물입니다.
replies[]

object (Post)

헤드 게시물에 대한 답글입니다.
status

enum (Status)

스레드가 열려 있는지 해결되었는지 여부입니다.
통합 필드 quote. 댓글이 작성될 때 문서에서 인용된 텍스트입니다. quote은 다음 중 하나여야 합니다.
plainTextQuote

string

댓글이 생성될 때 스프레드시트에서 인용된 텍스트로, 일반 텍스트 형식입니다.

게시

댓글 대화목록의 단일 게시물을 나타냅니다.

JSON 표현 
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedSpreadsheet": boolean,
  "fromCopiedSpreadsheet": boolean,
  "assigneeEmail": string,
  "commentAction": enum (CommentActionType)
}
필드
postId

string

출력 전용입니다. 게시물의 고유 ID입니다.
content

string

게시물의 콘텐츠입니다.

commentAction이 RESOLVE 또는 REOPEN이 아닌 경우 비어 있지 않아야 합니다.

이 텍스트 콘텐츠는 Sheets 편집기에서 생성된 댓글과 유사하게 처리됩니다. 서식, 알림 등에서 유사한 동작을 보입니다.

2048 UTF-8 코드 단위를 초과할 수 없습니다.
contentHtml

string

출력 전용입니다. 게시물의 콘텐츠(HTML)입니다.
author

object (PostAuthor)

출력 전용입니다. 게시물을 만든 사용자입니다.
createTime

string (Timestamp format)

출력 전용입니다. 게시물이 생성된 시간입니다.
updateTime

string (Timestamp format)

출력 전용입니다. 게시물이 마지막으로 업데이트된 시간입니다.
deleted

boolean

출력 전용입니다. 게시물이 삭제되었는지 여부입니다. true, content, author 필드가 비어 있습니다.
fromImportedSpreadsheet

boolean

출력 전용입니다. 게시물이 가져온 스프레드시트에서 가져온 것인지 여부입니다. 이 필드는 호출자가 직접 설정할 수 없습니다.
fromCopiedSpreadsheet

boolean

출력 전용입니다. 게시물이 복사된 스프레드시트에서 가져온 것인지 여부입니다. 이 필드는 호출자가 직접 설정할 수 없습니다.
assigneeEmail

string

선택사항입니다. 이 게시물의 일부로 스레드에 새로 할당되는 사용자의 이메일입니다.

다음의 경우 400 잘못된 요청 오류를 반환합니다.

  • 상위 스레드는 headPost에 할당자가 없는 CommentThread입니다.

  • commentAction이 RESOLVE 또는 REOPEN로 지정됩니다.

  • assigneeEmail이 2048 UTF-8 코드 단위를 초과합니다.
commentAction

enum (CommentActionType)

게시물을 만드는 과정에서 취해진 조치입니다.

PostAuthor

댓글 게시물을 작성한 사용자를 나타냅니다.

JSON 표현 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
필드
displayName

string

사용자의 표시 이름입니다. 작성자가 익명인 경우 없을 수 있습니다.
me

boolean

사용자가 요청을 보내는 인증된 사용자인지 여부입니다.
anonymous

boolean

사용자가 익명인지 여부입니다.
user

string

게시물 작성자 사용자의 리소스 이름입니다. Google People API에서 사용자를 식별하는 데도 사용할 수 있습니다. 형식은 users/{user}입니다. 익명 필드가 true이거나 가져온 스프레드시트의 게시물인 경우 채워지지 않습니다.

CommentActionType

댓글 대화목록에 대한 이 답글로 취해진 조치입니다.

열거형
COMMENT_ACTION_TYPE_UNSPECIFIED 기본값 이 값은 사용되지 않습니다.
NO_COMMENT_ACTION_CHANGE 이 게시물에는 작업 변경사항이 없습니다.
RESOLVE 이 게시물로 스레드가 해결됩니다.
REOPEN 이 게시물은 대화목록을 다시 엽니다.

상태

댓글 스레드의 상태 옵션입니다.

열거형
STATUS_UNSPECIFIED 기본값 이 값은 사용되지 않습니다.
OPEN 댓글 대화목록이 열려 있습니다.
RESOLVED 댓글 대화목록이 해결됩니다.

CommentsViewMode

댓글이 포함되었는지 여부를 나타내는 스프레드시트에 적용된 댓글 보기 모드입니다. 댓글 및 댓글 앵커를 포함하거나 제외하여 스프레드시트를 읽는 옵션을 제공합니다.

열거형
COMMENTS_VIEW_MODE_UNSPECIFIED CommentsViewMode가 지정되지 않았습니다. COMMENTS_VIEW_MODE_OMITTED이 적용됩니다.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS 반환된 스프레드시트에 적용된 CommentsViewMode는 사용자의 현재 액세스 수준에 따라 달라집니다. 사용자에게 보기 권한만 있는 경우 COMMENTS_VIEW_MODE_OMITTED가 적용됩니다. 그렇지 않으면 COMMENTS_VIEW_MODE_INCLUDED이 적용됩니다.
COMMENTS_VIEW_MODE_OMITTED 반환된 스프레드시트에서 댓글이 누락되었습니다.
COMMENTS_VIEW_MODE_INCLUDED

반환된 스프레드시트에는 댓글이 포함되어 있습니다.

이 모드를 사용하여 스프레드시트를 가져오려는 요청은 사용자에게 댓글을 볼 권한이 없는 경우 403 오류를 반환합니다.

메서드

batchUpdate

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

create

 스프레드시트를 생성하고 새로 생성된 스프레드시트를 반환합니다.

get

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

getByDataFilter

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