Доступ и изменение существующей таблицы источника данных. Чтобы создать новый лист источника данных, используйте Spreadsheet.insertDataSourceSheet(spec)
.
Используйте этот класс только с данными, подключенными к базе данных.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Добавляет фильтр, примененный к листу источника данных. |
asSheet() | Sheet | Возвращает лист источника данных как обычный объект листа. |
autoResizeColumn(columnName) | DataSourceSheet | Автоматически изменяет ширину указанного столбца. |
autoResizeColumns(columnNames) | DataSourceSheet | Автоматически изменяет ширину указанных столбцов. |
cancelDataRefresh() | DataSourceSheet | Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется. |
forceRefreshData() | DataSourceSheet | Обновляет данные этого объекта независимо от текущего состояния. |
getColumnWidth(columnName) | Integer | Возвращает ширину указанного столбца. |
getDataSource() | DataSource | Получает источник данных, с которым связан объект. |
getFilters() | DataSourceSheetFilter[] | Возвращает все фильтры, примененные к листу источника данных. |
getSheetValues(columnName) | Object[] | Возвращает все значения листа источника данных для указанного имени столбца. |
getSheetValues(columnName, startRow, numRows) | Object[] | Возвращает все значения для листа источника данных для указанного имени столбца, начиная с указанной начальной строки (на основе 1) и заканчивая предоставленным numRows . |
getSortSpecs() | SortSpec[] | Получает все характеристики сортировки на листе источника данных. |
getStatus() | DataExecutionStatus | Получает статус выполнения данных объекта. |
refreshData() | DataSourceSheet | Обновляет данные объекта. |
removeFilters(columnName) | DataSourceSheet | Удаляет все фильтры, примененные к столбцу листа источника данных. |
removeSortSpec(columnName) | DataSourceSheet | Удаляет спецификацию сортировки для столбца на листе источника данных. |
setColumnWidth(columnName, width) | DataSourceSheet | Устанавливает ширину указанного столбца. |
setColumnWidths(columnNames, width) | DataSourceSheet | Устанавливает ширину указанных столбцов. |
setSortSpec(columnName, ascending) | DataSourceSheet | Устанавливает спецификацию сортировки для столбца на листе источника данных. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Устанавливает спецификацию сортировки для столбца на листе источника данных. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. |
Подробная документация
addFilter(columnName, filterCriteria)
Добавляет фильтр, примененный к листу источника данных.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца, к которому нужно применить этот фильтр. |
filterCriteria | FilterCriteria | Критерии фильтра, которые необходимо применить. |
Возвращаться
DataSourceSheet
— лист источника данных для цепочки методов.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
asSheet()
Возвращает лист источника данных как обычный объект листа.
Возвращаться
Sheet
— обычный лист.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumn(columnName)
Автоматически изменяет ширину указанного столбца.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца. |
Возвращаться
DataSourceSheet
— этот лист источника данных для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoResizeColumns(columnNames)
Автоматически изменяет ширину указанных столбцов.
Параметры
Имя | Тип | Описание |
---|---|---|
columnNames | String[] | Список имен столбцов для обновления. |
Возвращаться
DataSourceSheet
— этот лист источника данных для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
cancelDataRefresh()
Отменяет обновление данных, связанное с этим объектом, если оно в данный момент выполняется.
В этом примере показано, как отменить обновление формулы.
const spreadsheet = SpreadsheetApp.getActive(); const formula = spreadsheet.getDataSourceFormulas()[0]; // Cancel the ongoing refresh on the formula. formula.cancelDataRefresh();
Выдает исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution()
чтобы включить выполнение данных для определенного типа источника данных.
Возвращаться
DataSourceSheet
— объект данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
forceRefreshData()
Обновляет данные этого объекта независимо от текущего состояния. Дополнительную информацию см. refreshData()
. Если вы хотите отменить текущее обновление этого объекта, см. cancelDataRefresh()
.
Выдает исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution()
чтобы включить выполнение данных для определенного типа источника данных.
Возвращаться
DataSourceSheet
— объект данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnName)
Возвращает ширину указанного столбца.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца. |
Возвращаться
Integer
— ширина столбца или null
, если столбец использует ширину по умолчанию.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSource()
Получает источник данных, с которым связан объект.
Возвращаться
DataSource
— источник данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilters()
Возвращает все фильтры, примененные к листу источника данных.
Возвращаться
DataSourceSheetFilter[]
— Массив всех фильтров, примененных к листу источника данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName)
Возвращает все значения листа источника данных для указанного имени столбца.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца источника данных, для которого нужно получить значения. |
Возвращаться
Object[]
— Одномерный массив значений.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetValues(columnName, startRow, numRows)
Возвращает все значения для листа источника данных для указанного имени столбца, начиная с предоставленной начальной строки (на основе 1) и до предоставленного numRows
.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца источника данных, для которого нужно получить значения. |
startRow | Integer | Позиция строки, с которой начинается получение значений. |
numRows | Integer | Количество строк для выборки. |
Возвращаться
Object[]
— Одномерный массив значений.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSortSpecs()
Получает все характеристики сортировки на листе источника данных.
Возвращаться
SortSpec[]
— Список спецификаций сортировки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getStatus()
Получает статус выполнения данных объекта.
Возвращаться
DataExecutionStatus
— Статус выполнения данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
refreshData()
Обновляет данные объекта.
Выдает исключение, если в данный момент находится в состоянии error
. Используйте DataSource#updateSpec()
для обновления спецификации. Этот метод предпочтительнее, чем forceRefreshData()
, чтобы предотвратить непредвиденные изменения в источнике данных.
Выдает исключение, если тип источника данных не включен. Используйте методы SpreadsheetApp#enable...Execution()
чтобы включить выполнение данных для определенного типа источника данных.
Возвращаться
DataSourceSheet
— объект данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeFilters(columnName)
Удаляет все фильтры, примененные к столбцу листа источника данных.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца, из которого нужно удалить фильтры. |
Возвращаться
DataSourceSheet
— лист источника данных для цепочки методов.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeSortSpec(columnName)
Удаляет спецификацию сортировки для столбца на листе источника данных.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца. |
Возвращаться
DataSourceSheet
— лист источника данных для связывания.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidth(columnName, width)
Устанавливает ширину указанного столбца.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца. |
width | Integer | Новая ширина столбца. |
Возвращаться
DataSourceSheet
— этот лист источника данных для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setColumnWidths(columnNames, width)
Устанавливает ширину указанных столбцов.
Параметры
Имя | Тип | Описание |
---|---|---|
columnNames | String[] | Список имен столбцов для обновления. |
width | Integer | Новая ширина столбцов. |
Возвращаться
DataSourceSheet
— этот лист источника данных для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, ascending)
Устанавливает спецификацию сортировки для столбца на листе источника данных.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца для сортировки. |
ascending | Boolean | Если true , отсортируйте столбец в порядке возрастания; если false , отсортируйте столбец в порядке убывания. |
Возвращаться
DataSourceSheet
— лист источника данных для связывания.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setSortSpec(columnName, sortOrder)
Устанавливает спецификацию сортировки для столбца на листе источника данных.
Параметры
Имя | Тип | Описание |
---|---|---|
columnName | String | Имя столбца для сортировки. |
sortOrder | SortOrder | Порядок сортировки. |
Возвращаться
DataSourceSheet
— лист источника данных для связывания.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Ожидает завершения текущего выполнения, время ожидания истекает через указанное количество секунд. Вызывает исключение, если выполнение не завершено по истечении времени ожидания, но не отменяет выполнение данных.
Параметры
Имя | Тип | Описание |
---|---|---|
timeoutInSeconds | Integer | Время ожидания выполнения данных в секундах. Максимум — 300 секунд. |
Возвращаться
DataExecutionStatus
— Статус выполнения данных.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets