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

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

properties

object ( SpreadsheetProperties )

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

sheets[]

object ( Sheet )

Листы, являющиеся частью электронной таблицы.

namedRanges[]

object ( NamedRange )

Именованные диапазоны, определенные в электронной таблице.

spreadsheetUrl

string

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

developerMetadata[]

object ( DeveloperMetadata )

Метаданные разработчика, связанные с электронной таблицей.

dataSources[]

object ( DataSource )

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

dataSourceSchedules[]

object ( DataSourceRefreshSchedule )

Только вывод. Список расписаний обновления источников данных.

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

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

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

  • код языка ISO 639-2, например fil , если код 639-1 не существует

  • комбинация кода языка 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, если администратор включил функцию allowlisting .

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

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

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

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

ТемаЦветПара

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

JSON-представление 
{   "colorType": enum (ThemeColorType),   "color": {     object (ColorStyle)   } }
Поля
colorType

enum ( ThemeColorType )

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

color

object ( ColorStyle )

Конкретный цвет, соответствующий цветовому типу темы.

ИменованныйДиапазон

Именованный диапазон.

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)     }   ],    // 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

Идентификатор проекта 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 исследуйте.

ИсточникДанныеПараметр

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

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 . Его размер должен быть 1x1.

range

object ( GridRange )

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

DataSourceRefreshSchedule

График обновления источника данных.

Источники данных в таблице обновляются в течение определенного интервала времени. Вы можете указать время начала, нажав кнопку «Запланированное обновление» в редакторе таблиц, но интервал фиксирован и составляет 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 Обновляет все источники данных и связанные с ними объекты источников данных в электронной таблице.

Источник данныхОбновлениеЕжедневноеРасписание

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

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.

Источник данныхОбновлениеНедельный график

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

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 Воскресенье

Источник данныхОбновлениеЕжемесячное расписание

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

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)

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

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

Методы

batchUpdate

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

create

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

get

 Возвращает электронную таблицу по указанному идентификатору.

getByDataFilter

 Возвращает электронную таблицу по указанному идентификатору.