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

Авторизация

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

  • 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