Class DataSource

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

Доступ к существующим источникам данных и их изменение. Чтобы создать таблицу источников данных с новым источником данных, см. Data Source Table .

Используйте этот класс только с данными, подключенными к базе данных.

Методы

Метод Тип возвращаемого значения Краткое описание
cancel All Linked Data Source Object Refreshes() void Отменяет все текущие обновления объектов источника данных, связанных с этим источником данных.
create Calculated Column(name, formula) Data Source Column Создает вычисляемый столбец.
create Data Source Pivot Table On New Sheet() Data Source Pivot Table Создает сводную таблицу на основе этого источника данных в первой ячейке нового листа.
create Data Source Table On New Sheet() Data Source Table Создает таблицу-источник данных на основе этого источника данных в первой ячейке нового листа.
get Calculated Column By Name(columnName) Data Source Column |null Возвращает вычисляемый столбец в источнике данных, соответствующий имени столбца.
get Calculated Columns() Data Source Column[] Возвращает все вычисляемые столбцы в источнике данных.
get Columns() Data Source Column[] Возвращает все столбцы в источнике данных.
get Data Source Sheets() Data Source Sheet[] Возвращает листы источника данных, связанные с данным источником данных.
get Spec() Data Source Spec Получает спецификацию источника данных.
refresh All Linked Data Source Objects() void Обновляет все объекты источника данных, связанные с данным источником данных.
update Spec(spec) Data Source Обновляет спецификацию источника данных и обновляет объекты источника данных, связанные с этим источником данных, в соответствии с новой спецификацией.
update Spec(spec, refreshAllLinkedObjects) Data Source Обновляет спецификацию источника данных и обновляет связанные data source sheets в соответствии с новой спецификацией.
wait For All Data Executions Completion(timeoutInSeconds) void Ожидает завершения всех текущих выполнений объектов связанных источников данных, истекая по истечении заданного количества секунд.

Подробная документация

cancel All Linked Data Source Object Refreshes()

Отменяет все текущие обновления объектов источника данных, связанных с этим источником данных.

В этом примере показано, как отменить все обновления источника данных.

SpreadsheetApp.enableBigQueryExecution();
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const dataSource = spreadsheet.getDataSources()[0];
dataSource.cancelAllLinkedDataSourceObjectRefreshes();

Генерирует исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() для включения выполнения данных для конкретного типа источника данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

create Calculated Column(name, formula)

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

Параметры

Имя Тип Описание
name String Название вычисляемого столбца.
formula String Формула для расчета столбца.

Возвращаться

Data Source Column — вновь созданный вычисляемый столбец.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

create Data Source Pivot Table On New Sheet()

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

Возвращаться

Data Source Pivot Table — новая сводная таблица источника данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

create Data Source Table On New Sheet()

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

Этот метод доступен только для источников данных BigQuery.

Возвращаться

Data Source Table — Вновь созданная таблица источников данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Calculated Column By Name(columnName)

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

Параметры

Имя Тип Описание
column Name String Название вычисляемого столбца, который нужно получить.

Возвращаться

Data Source Column |null — Вычисляемый столбец, соответствующий имени столбца, или null если такого вычисляемого столбца нет.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Calculated Columns()

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

Спецификация источника данных типа Data Source Type.LOOKER возвращает пустой массив.

Возвращаться

Data Source Column[] — массив всех вычисляемых столбцов в источнике данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Columns()

Возвращает все столбцы в источнике данных.

Возвращаться

Data Source Column[] — массив всех Data Source Column .

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Data Source Sheets()

Возвращает листы источника данных, связанные с данным источником данных.

Возвращаться

Data Source Sheet[] — массив листов источников данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

get Spec()

Получает спецификацию источника данных.

Возвращаться

Data Source Spec — это описание источника данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refresh All Linked Data Source Objects()

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

Генерирует исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() для включения выполнения данных для конкретного типа источника данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

update Spec(spec)

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

Генерирует исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() для включения выполнения данных для конкретного типа источника данных.

Генерирует исключение, если тип спецификации источника данных отличается от текущего типа источника данных.

Параметры

Имя Тип Описание
spec Data Source Spec Спецификация источника данных, которую необходимо обновить.

Возвращаться

Data Source — Источник данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

update Spec(spec, refreshAllLinkedObjects)

Обновляет спецификацию источника данных и обновляет связанные data source sheets в соответствии с новой спецификацией.

Генерирует исключение, если тип источника данных не включен. Используйте методы Spreadsheet App#enable...Execution() для включения выполнения данных для конкретного типа источника данных.

Генерирует исключение, если тип спецификации источника данных отличается от текущего типа источника данных.

Параметры

Имя Тип Описание
spec Data Source Spec Спецификация источника данных, которую необходимо обновить.
refresh All Linked Objects Boolean Если true , то также обновляются все объекты источников данных, связанные с этим источником данных.

Возвращаться

Data Source — Источник данных.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

wait For All Data Executions Completion(timeoutInSeconds)

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

Параметры

Имя Тип Описание
timeout In Seconds Integer Время ожидания выполнения обработки данных, в секундах. Максимальное значение — 300 секунд.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets