方法
| 方法 | 返回类型 | 简介 | 
|---|---|---|
| build() | Data | 根据此构建工具中的设置构建数据源规范。 | 
| copy() | Data | 根据此数据源的设置创建 Data。 | 
| get | String | 获取 BigQuery 数据集 ID。 | 
| get | Data | 获取数据源的参数。 | 
| get | String | 获取结算项目 ID。 | 
| get | String | 获取原始查询字符串。 | 
| get | String | 获取 BigQuery 表 ID。 | 
| get | String | 获取表的 BigQuery 项目 ID。 | 
| get | Data | 获取数据源的类型。 | 
| remove | Big | 移除所有参数。 | 
| remove | Big | 移除指定的参数。 | 
| set | Big | 设置 BigQuery 数据集 ID。 | 
| set | Big | 添加参数;如果存在具有相应名称的参数,则更新类型为 Data的数据源规范构建器的来源单元格。 | 
| set | Big | 设置结算 BigQuery 项目 ID。 | 
| set | Big | 设置原始查询字符串。 | 
| set | Big | 设置 BigQuery 表 ID。 | 
| set | Big | 为表设置 BigQuery 项目 ID。 | 
详细文档
build()
根据此构建工具中的设置构建数据源规范。必须先使用 as...() 指定数据源类型,然后才能构建。
以下代码示例会构建 BigQuery DataSource 规范。
const bigQueryDataSourceSpec = SpreadsheetApp.newDataSourceSpec().asBigQuery(); // TODO(developer): Replace with the required dataset, project and table IDs. bigQueryDataSourceSpec.setDatasetId('my data set id'); bigQueryDataSourceSpec.setProjectId('my project id'); bigQueryDataSourceSpec.setTableId('my table id'); bigQueryDataSourceSpec.build();
以下代码示例会构建 Looker 数据源规范。
const lookerDataSourceSpecBuilder = SpreadsheetApp.newDataSourceSpec().asLooker(); const lookerSpec = lookerDataSourceSpecBuilder.setExploreName('my explore name') .setInstanceUrl('my instance url') .setModelName('my model name') .build();
返回
Data - 数据源规范。
copy()
根据此数据源的设置创建 Data。
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); const spec = ss.getDataSources()[0].getSpec(); const newSpec = spec.copy();
返回
Data - 构建器。
get
获取 BigQuery 数据集 ID。
返回
String - 数据集 ID,如果数据源规范由原始查询定义,则为空字符串。
get
获取数据源的参数。
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); const spec = ss.getDataSources()[0].getSpec(); const parameters = spec.getParameters();
此方法仅适用于 BigQuery 数据源。
返回
Data - 参数列表。
get
获取结算项目 ID。
返回
String - 项目 ID。
get
获取原始查询字符串。
返回
String - 原始查询字符串。
get
获取 BigQuery 表 ID。
返回
String - 表 ID,如果数据源规范由原始查询定义,则为空字符串。
get
获取表的 BigQuery 项目 ID。
返回
String - 表项目 ID;如果数据源规范由原始查询定义,则为空字符串。
get
获取数据源的类型。
// TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc123456/edit', ); const spec = ss.getDataSources()[0].getSpec(); const type = spec.getType();
返回
Data - 数据源类型。
remove
移除所有参数。
const specBuilder = SpreadsheetApp.newDataSourceSpec(); specBuilder.removeAllParameters();
返回
Big - 用于链接的构建器。
remove
移除指定的参数。
const specBuilder = SpreadsheetApp.newDataSourceSpec(); specBuilder.removeParameter('x');
参数
| 名称 | 类型 | 说明 | 
|---|---|---|
| parameter | String | 要移除的参数的名称。 | 
返回
Big - 用于链接的构建器。
set
设置 BigQuery 数据集 ID。
参数
| 名称 | 类型 | 说明 | 
|---|---|---|
| dataset | String | 数据集的 ID。 | 
返回
Big - 此构建器,用于链式调用。
set
添加参数;如果具有该名称的参数已存在,则更新类型为 Data 的数据源规范构建器的来源单元格。
此方法仅适用于 BigQuery 数据源。
const specBuilder = SpreadsheetApp.newDataSourceSpec().asBigQuery(); specBuilder.setParameterFromCell('x', 'A1'); const bigQuerySpec = specBuilder.build();
参数
| 名称 | 类型 | 说明 | 
|---|---|---|
| parameter | String | 参数名称。 | 
| source | String | 源单元格,如 A1 表示法中所指定。 | 
返回
Big - 用于链接的构建器。
set
设置结算 BigQuery 项目 ID。
参数
| 名称 | 类型 | 说明 | 
|---|---|---|
| project | String | 结算项目的 ID。 | 
返回
Big - 用于链接的构建器。
set
set
set
设置表的 BigQuery 项目 ID。
参数
| 名称 | 类型 | 说明 | 
|---|---|---|
| project | String | BigQuery 表的项目 ID。 | 
返回
Big - 用于链接的构建器。