airflow.providers.google.suite.hooks.sheets

此模組包含 Google Sheets API Hook。

模組內容

類別

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

返回

來自指定工作表的陣列工作表值。

返回類型

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')[原始碼]

從 Google Sheet 中針對多個範圍更新值。

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')[原始碼]

從單一範圍的 Google Sheet 附加值。

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_)[原始碼]

從單一範圍的 Google Sheet 清除值。

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)[原始碼]

從 Google Sheet 中從範圍清單清除值。

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)[原始碼]

擷取符合給定 ID 的試算表。

參數

spreadsheet_id (str) – 試算表 ID。

返回

符合工作表篩選器的試算表。

get_sheet_titles(spreadsheet_id, sheet_filter=None)[原始碼]

從符合給定 ID 和工作表篩選器的試算表擷取工作表標題。

參數

  • spreadsheet_id (str) – 試算表 ID。

  • sheet_filter (list[str] | None) – 要從工作表擷取的工作表標題清單。

返回

來自指定工作表且符合工作表篩選器的工作表標題清單。

create_spreadsheet(spreadsheet)[原始碼]

建立試算表，並傳回新建立的試算表。

參數

spreadsheet (dict[str, Any]) – Spreadsheet 的執行個體 https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets#Spreadsheet

返回

試算表物件。

返回類型

dict[str, Any]

此條目是否有幫助？