`airflow.providers.google.suite.hooks.sheets`¶

此模块包含 Google Sheets API 钩子。

模块内容¶

类¶

GSheetsHook

通过 Google Cloud 连接与 Google Sheets 交互。

class airflow.providers.google.suite.hooks.sheets.GSheetsHook(gcp_conn_id='google_cloud_default', api_version='v4', impersonation_chain=None)[来源]¶

基类: airflow.providers.google.common.hooks.base_google.GoogleBaseHook

通过 Google Cloud 连接与 Google Sheets 交互。

在 Google Sheet 中读取和写入单元格：https://developers.google.com/sheets/api/guides/values

参数

gcp_conn_id (str) – 获取连接信息时要使用的连接 ID。
api_version (str) – API 版本
impersonation_chain (str | collections.abc.Sequence[str] | None) – 可选的服务帐户，用于使用短期凭据进行模拟，或用于获取列表中最后一个帐户的 access_token 的帐户链式列表，该帐户将在请求中被模拟。如果设置为字符串，则该帐户必须授予发起帐户“服务帐户令牌创建者”IAM 角色。如果设置为序列，则列表中的身份必须将“服务帐户令牌创建者”IAM 角色授予紧接在前的身份，列表中的第一个帐户将此角色授予发起帐户。

get_conn()[来源]¶

检索与 Google Sheets 的连接。

返回: Google Sheets 服务对象。
返回类型: Any

get_values(spreadsheet_id, range_, major_dimension='DIMENSION_UNSPECIFIED', value_render_option='FORMATTED_VALUE', date_time_render_option='SERIAL_NUMBER')[来源]¶

从单个范围获取 Google Sheet 中的值。

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/get

参数

spreadsheet_id (str) – 要与之交互的 Google Sheet ID
range – 要检索的值的 A1 表示法。
major_dimension (str) – 指示操作应应用于哪个维度。DIMENSION_UNSPECIFIED、ROWS 或 COLUMNS
value_render_option (str) – 确定如何在输出中呈现值。FORMATTED_VALUE、UNFORMATTED_VALUE 或 FORMULA
date_time_render_option (str) – 确定如何在输出中呈现日期。SERIAL_NUMBER 或 FORMATTED_STRING

返回

来自指定 sheet 的 sheet 值数组。

返回类型

list

batch_get_values(spreadsheet_id, ranges, major_dimension='DIMENSION_UNSPECIFIED', value_render_option='FORMATTED_VALUE', date_time_render_option='SERIAL_NUMBER')[来源]¶

从 Google Sheet 中的范围列表获取值。

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchGet

参数

spreadsheet_id (str) – 要与之交互的 Google Sheet ID
ranges (list) – 要检索的值的 A1 表示法。
major_dimension (str) – 指示操作应应用于哪个维度。DIMENSION_UNSPECIFIED、ROWS 或 COLUMNS
value_render_option (str) – 确定如何在输出中呈现值。FORMATTED_VALUE、UNFORMATTED_VALUE 或 FORMULA
date_time_render_option (str) – 确定如何在输出中呈现日期。SERIAL_NUMBER 或 FORMATTED_STRING

返回

Google Sheets API 响应。

返回类型

dict

update_values(spreadsheet_id, range_, values, major_dimension='ROWS', value_input_option='RAW', include_values_in_response=False, value_render_option='FORMATTED_VALUE', date_time_render_option='SERIAL_NUMBER')[来源]¶

从单个范围更新 Google Sheet 中的值。

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/update

参数

spreadsheet_id (str) – 要与之交互的 Google Sheet ID。
range – 要检索的值的 A1 表示法。
values (list) – 电子表格范围内的数据。
major_dimension (str) – 指示操作应应用于哪个维度。DIMENSION_UNSPECIFIED、ROWS 或 COLUMNS
value_input_option (str) – 确定应如何解释输入数据。RAW 或 USER_ENTERED
include_values_in_response (bool) – 确定更新响应是否应包括已更新单元格的值。
value_render_option (str) – 确定如何在输出中呈现值。FORMATTED_VALUE、UNFORMATTED_VALUE 或 FORMULA
date_time_render_option (str) – 确定如何在输出中呈现日期。SERIAL_NUMBER 或 FORMATTED_STRING

返回

Google Sheets API 响应。

返回类型

dict

batch_update_values(spreadsheet_id, ranges, values, major_dimension='ROWS', value_input_option='RAW', include_values_in_response=False, value_render_option='FORMATTED_VALUE', date_time_render_option='SERIAL_NUMBER')[source]¶

更新 Google 表格中多个范围的值。

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdate

参数

spreadsheet_id (str) – 要与之交互的 Google Sheet ID
ranges (list) – 要检索的值的 A1 表示法。
values (list) – 电子表格范围内的数据。
major_dimension (str) – 指示操作应应用于哪个维度。DIMENSION_UNSPECIFIED、ROWS 或 COLUMNS
value_input_option (str) – 确定应如何解释输入数据。RAW 或 USER_ENTERED
include_values_in_response (bool) – 确定更新响应是否应包括已更新单元格的值。
value_render_option (str) – 确定如何在输出中呈现值。FORMATTED_VALUE、UNFORMATTED_VALUE 或 FORMULA
date_time_render_option (str) – 确定如何在输出中呈现日期。SERIAL_NUMBER 或 FORMATTED_STRING

返回

Google Sheets API 响应。

返回类型

dict

append_values(spreadsheet_id, range_, values, major_dimension='ROWS', value_input_option='RAW', insert_data_option='OVERWRITE', include_values_in_response=False, value_render_option='FORMATTED_VALUE', date_time_render_option='SERIAL_NUMBER')[source]¶

从单个范围附加 Google 表格的值。

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append

参数

spreadsheet_id (str) – 要与之交互的 Google Sheet ID
range – 要检索的值的 A1 表示法。
values (list) – 电子表格范围内的数据。
major_dimension (str) – 指示操作应应用于哪个维度。DIMENSION_UNSPECIFIED、ROWS 或 COLUMNS
value_input_option (str) – 确定应如何解释输入数据。RAW 或 USER_ENTERED
insert_data_option (str) – 确定输入新数据时如何更改现有数据。OVERWRITE 或 INSERT_ROWS
include_values_in_response (bool) – 确定更新响应是否应包括已更新单元格的值。
value_render_option (str) – 确定如何在输出中呈现值。FORMATTED_VALUE、UNFORMATTED_VALUE 或 FORMULA
date_time_render_option (str) – 确定如何在输出中呈现日期。SERIAL_NUMBER 或 FORMATTED_STRING

返回

Google Sheets API 响应。

返回类型

dict

clear(spreadsheet_id, range_)[source]¶

清除 Google 表格中单个范围的值。

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/clear

参数

spreadsheet_id (str) – 要与之交互的 Google Sheet ID
range – 要检索的值的 A1 表示法。

返回

Google Sheets API 响应。

返回类型

dict

batch_clear(spreadsheet_id, ranges)[source]¶

清除 Google 表格中一系列范围的值。

https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchClear

参数

spreadsheet_id (str) – 要与之交互的 Google Sheet ID
ranges (list) – 要检索的值的 A1 表示法。

返回

Google Sheets API 响应。

返回类型

dict

get_spreadsheet(spreadsheet_id)[source]¶

检索与给定 ID 匹配的电子表格。

参数: spreadsheet_id (str) – 电子表格 ID。
返回: 与表格过滤器匹配的电子表格。

get_sheet_titles(spreadsheet_id, sheet_filter=None)[source]¶

检索与给定 ID 和表格过滤器匹配的电子表格中的表格标题。

参数

spreadsheet_id (str) – 电子表格 ID。
sheet_filter (list[str] | None) – 要从表格中检索的表格标题列表。

返回

与表格过滤器匹配的指定表格中的表格标题列表。

create_spreadsheet(spreadsheet)[source]¶

创建一个电子表格，返回新创建的电子表格。

参数: spreadsheet (dict[str, Any]) – Spreadsheet 的实例 https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#Spreadsheet
返回: 一个电子表格对象。
返回类型: dict[str, Any]

airflow.providers.google.suite.hooks.sheets¶

模块内容¶

类¶

`airflow.providers.google.suite.hooks.sheets`¶