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-адресам для функций изображений и импорта. Читать только тогда, когда это правда. Если значение false, вы можете установить значение 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 )

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

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

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

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

Спецификация источника данных

Это указывает детали источника данных. Например, для BigQuery здесь указывается информация об источнике BigQuery.

JSON-представление
{
  "parameters": [
    {
      object (DataSourceParameter)
    }
  ],

  // Union field spec can be only one of the following:
  "bigQuery": {
    object (BigQueryDataSourceSpec)
  }
  // End of list of possible types for union field spec.
}
Поля
parameters[]

object ( DataSourceParameter )

Параметры источника данных, используемые при запросе источника данных.

spec поля Union. Фактическая спецификация для каждого типа источника данных. spec может быть только одной из следующих:
bigQuery

object ( BigQueryDataSourceSpec )

BigQueryDataSourceSpec .

Спецификация 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 поля Union. Фактическая спецификация. spec может быть только одной из следующих:
querySpec

object ( BigQueryQuerySpec )

BigQueryQuerySpec .

tableSpec

object ( BigQueryTableSpec )

BigQueryTableSpec .

Спецификация BigQueryQuerySpec

Указывает пользовательский запрос BigQuery.

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

string

Необработанная строка запроса.

Бигкуеритаблеспек

Указывает определение таблицы BigQuery. Разрешены только собственные таблицы .

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

string

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

tableId

string

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

datasetId

string

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

Параметр источника данных

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

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:00, обновление будет происходить с 8:00 до 12:00 каждый день.

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 )

График ежемесячного обновления.

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

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

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

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

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

Методы

batchUpdate

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

create

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

get

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

getByDataFilter

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