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

Идентификатор электронной таблицы. Это поле доступно только для чтения.

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 )

Только вывод. К электронной таблице применен режим просмотра комментариев.

Свойства электронной таблицы

Свойства электронной таблицы.

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

Часовой пояс электронной таблицы в формате CLDR, например, America/New_York . Если часовой пояс не распознан, это может быть пользовательский часовой пояс, например, GMT-07:00 .

defaultFormat

object ( CellFormat )

Формат по умолчанию для всех ячеек в электронной таблице. CellData.effectiveFormat не будет установлено, если формат ячейки совпадает с этим форматом по умолчанию. Это поле доступно только для чтения.

iterativeCalculationSettings

object ( IterativeCalculationSettings )

Определяет, разрешаются ли циклические ссылки при итеративных вычислениях и каким образом. Отсутствие этого поля означает, что циклические ссылки приводят к ошибкам вычислений.

spreadsheetTheme

object ( SpreadsheetTheme )

Тема оформления применена к электронной таблице.

importFunctionsExternalUrlAccessAllowed

boolean

Разрешать ли доступ к внешним URL-адресам для функций импорта изображений. Если значение равно true, то только для чтения. Если значение равно false, можно установить значение true. Это значение будет проигнорировано, и в этом случае всегда будет возвращаться true, если администратор включил функцию разрешения доступа .

Интервал перерасчета

Перечень возможных вариантов интервала перерасчета.

Перечисления
RECALCULATION_INTERVAL_UNSPECIFIED Значение по умолчанию. Это значение использовать нельзя.
ON_CHANGE Изменчивые функции обновляются при каждом изменении.
MINUTE Изменчивые функции обновляются при каждом изменении и каждую минуту.
HOUR Изменчивые функции обновляются при каждом изменении и ежечасно.

Настройки итеративного вычисления

Настройки, позволяющие управлять способом разрешения циклических зависимостей с помощью итеративных вычислений.

JSON-представление 
{
  "maxIterations": integer,
  "convergenceThreshold": number
}
Поля
maxIterations

integer

При включении итеративного вычисления определяется максимальное количество вычислительных итераций.

convergenceThreshold

number

Если включен итеративный режим вычислений и разница между последовательными результатами меньше этого порогового значения, циклы вычислений останавливаются.

Тема оформления электронных таблиц

Представляет собой тему электронных таблиц.

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

Идентификатор именованного диапазона.

name

string

Название именованного диапазона.

range

object ( GridRange )

Диапазон, который это представляет.

Источник данных

Информация о внешнем источнике данных в электронной таблице.

JSON-представление 
{
  "dataSourceId": string,
  "spec": {
    object (DataSourceSpec)
  },
  "calculatedColumns": [
    {
      object (DataSourceColumn)
    }
  ],
  "sheetId": integer
}
Поля
dataSourceId

string

Уникальный идентификатор, специфичный для электронной таблицы, который определяет источник данных. Пример: 1080547365.

spec

object ( DataSourceSpec )

Спецификация DataSourceSpec для источника данных, связанного с этой электронной таблицей.

calculatedColumns[]

object ( DataSourceColumn )

Все вычисляемые столбцы в источнике данных.

sheetId

integer

Идентификатор Sheet , связанного с источником данных. После установки значение поля изменить нельзя.

При создании источника данных также создается связанный с ним лист DATA_SOURCE ; если поле не указано, идентификатор созданного листа будет сгенерирован случайным образом.

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 )

A [LookerDatasourceSpec][].

BigQueryDataSourceSpec

Спецификация источника данных BigQuery, подключенного к электронной таблице.

JSON-представление 
{
  "projectId": string,

  "querySpec": {
    object (BigQueryQuerySpec)
  },
  "tableSpec": {
    object (BigQueryTableSpec)
  }
}
Поля
projectId

string

Идентификатор проекта Google Cloud с поддержкой BigQuery и привязанным платежным аккаунтом. За каждый запрос, выполняемый к источнику данных, проекту начисляется плата.

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, к которому принадлежит таблица. Если не указан, используется projectId .

tableId

string

Идентификатор таблицы BigQuery.

datasetId

string

Идентификатор набора данных BigQuery.

LookerDataSourceSpec

Описание источника данных Looker.

JSON-представление 
{
  "instanceUri": string,
  "model": string,
  "explore": string
}
Поля
instanceUri

string

URL-адрес экземпляра Looker.

model

string

Название модели Looker.

explore

string

Название модели Looker, которую необходимо исследовать.

DataSourceParameter

Параметр в запросе источника данных. Этот параметр позволяет пользователю передавать значения из электронной таблицы в запрос.

JSON-представление 
{

  "name": string

  "namedRangeId": string,
  "range": {
    object (GridRange)
  }
}
Поля
identifier поля объединения. Параметр identifier. identifier может принимать только одно из следующих значений:
name

string

Именованный параметр. Должен быть допустимым идентификатором для источника DataSource , который его поддерживает. Например, идентификатор BigQuery .

value поля объединения. Значение параметра. value может принимать только одно из следующих значений:
namedRangeId

string

Идентификатор NamedRange . Его размер должен быть 1x1.

range

object ( GridRange )

Диапазон, содержащий значение параметра. Его размер должен быть 1х1.

DataSourceRefreshSchedule

Расписание обновления источника данных.

Данные в электронной таблице обновляются с заданным интервалом времени. Вы можете указать время начала, нажав кнопку «Запланированное обновление» в редакторе таблиц, но интервал фиксирован и составляет 4 часа. Например, если вы укажете время начала 8:00, обновление будет происходить ежедневно с 8:00 до 12:00.

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 . Размер временного интервала по умолчанию соответствует размеру, указанному в редакторе таблиц.

Время суток

Представляет собой время суток. Дата и часовой пояс либо не имеют значения, либо указаны в другом месте. 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 . Размер временного интервала по умолчанию соответствует размеру, указанному в редакторе таблиц.

daysOfWeek[]

enum ( DayOfWeek )

Дни недели для обновления. Необходимо указать хотя бы один день.

День недели

Обозначает день недели.

Перечисления
DAY_OF_WEEK_UNSPECIFIED День недели не указан.
MONDAY Понедельник
TUESDAY Вторник
WEDNESDAY Среда
THURSDAY Четверг
FRIDAY Пятница
SATURDAY Суббота
SUNDAY Воскресенье

DataSourceRefreshMonthlySchedule

Ежемесячный график обновления данных в определенные дни месяца в заданном временном интервале.

JSON-представление 
{
  "startTime": {
    object (TimeOfDay)
  },
  "daysOfMonth": [
    integer
  ]
}
Поля
startTime

object ( TimeOfDay )

Время начала временного интервала, в течение которого запланировано обновление источника данных. Используется только часть, относящаяся hours . Размер временного интервала по умолчанию соответствует размеру, указанному в редакторе таблиц.

daysOfMonth[]

integer

Дни месяца для обновления. Поддерживаются только дни с 1 по 28, соответствующие 1-му, 28-му и последующим дням месяца. Необходимо указать хотя бы один день.

Интервал

Представляет собой временной интервал, закодированный как начало (включительно) и конец (исключительно) временной метки.

Начальное значение должно быть меньше или равно конечному. Если начальное значение равно конечному, интервал пуст (не соответствует никакому времени). Если и начальное, и конечное значения не указаны, интервал соответствует любому времени.

JSON-представление 
{
  "startTime": string,
  "endTime": string
}
Поля
startTime

string ( Timestamp format)

Необязательно. Включает начало интервала.

Если указано иное, метка времени, соответствующая этому интервалу, должна совпадать с началом интервала или быть позже него.

endTime

string ( Timestamp format)

Необязательно. Исключительно в конце интервала.

Если указано иное, метка времени, соответствующая этому интервалу, должна быть до конца.

Комментарий

Представляет собой отдельную ветку комментариев внутри электронной таблицы.

JSON-представление 
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Поля
commentId

string

Уникальный идентификатор ветки комментариев.

anchorId

string

Идентификатор элемента CommentAnchor в таблице, к которой привязана эта ветка обсуждения.

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

Только вывод. Уникальный идентификатор записи.

content

string

Содержание поста.

Если commentAction не равно RESOLVE или REOPEN , поле должно быть непустым.

Обработка этого текстового содержимого будет аналогична обработке комментариев, созданных в редакторе таблиц. Будут применяться схожие правила форматирования, уведомлений и т.д.

Не должно превышать 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 "Неверный запрос", если:

  • Родительская ветка — это ветка CommentThread , у headPost которой (headPost) нет назначенного исполнителя.

  • В параметре commentAction указано значение RESOLVE или REOPEN .

  • assigneeEmail превышает 2048 кодовых единиц UTF-8.

commentAction

enum ( CommentActionType )

Действия, предпринятые в рамках создания публикации.

Автор поста

Представляет пользователя, оставившего комментарий.

JSON-представление 
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Поля
displayName

string

Отображаемое имя пользователя. Может отсутствовать, если автор анонимен.

me

boolean

Указывает, является ли пользователь авторизованным пользователем, отправляющим запрос.

anonymous

boolean

Является ли пользователь анонимным.

user

string

Имя ресурса пользователя-автора публикации, которое также может использоваться для идентификации пользователя в Google People API . Формат: users/{user} . Не будет заполнено, если поле anonymous имеет true или если публикация импортирована из электронной таблицы.

CommentActionType

Действие, предпринятое при ответе на этот комментарий.

Перечисления
COMMENT_ACTION_TYPE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
NO_COMMENT_ACTION_CHANGE В этом посте никаких изменений в действиях не предусмотрено.
RESOLVE Этот пост разрешает спор.
REOPEN Этот пост возобновляет обсуждение.

Статус

Варианты статуса ветки комментариев.

Перечисления
STATUS_UNSPECIFIED Значение по умолчанию. Это значение не используется.
OPEN Обсуждение в комментариях открыто.
RESOLVED Обсуждение в комментариях завершено.

КомментарииViewMode

Режим просмотра комментариев, применяемый к электронной таблице, показывает, включены ли комментарии. Он предоставляет возможности для чтения электронной таблицы с комментариями или без них, а также для просмотра ссылок на комментарии.

Перечисления
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.