Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.google_sheets Namespace Reference

Namespaces

 application_credentials
 
 config_flow
 
 const
 

Functions

bool async_entry_has_scopes (HomeAssistant hass, GoogleSheetsConfigEntry entry)
 
bool async_setup_entry (HomeAssistant hass, GoogleSheetsConfigEntry entry)
 
None async_setup_service (HomeAssistant hass)
 
bool async_unload_entry (HomeAssistant hass, GoogleSheetsConfigEntry entry)
 

Variables

string DATA = "data"
 
string DATA_CONFIG_ENTRY = "config_entry"
 
 GoogleSheetsConfigEntry
 
string SERVICE_APPEND_SHEET = "append_sheet"
 
 SHEET_SERVICE_SCHEMA
 
string WORKSHEET = "worksheet"
 

Detailed Description

Support for Google Sheets.

Function Documentation

◆ async_entry_has_scopes()

bool homeassistant.components.google_sheets.async_entry_has_scopes ( HomeAssistant  hass,
GoogleSheetsConfigEntry  entry 
)
Verify that the config entry desired scope is present in the oauth token.

Definition at line 75 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.google_sheets.async_setup_entry ( HomeAssistant  hass,
GoogleSheetsConfigEntry   entry 
)
Set up Google Sheets from a config entry.

Definition at line 49 of file __init__.py.

◆ async_setup_service()

None homeassistant.components.google_sheets.async_setup_service ( HomeAssistant  hass)
Add the services for Google Sheets.

Definition at line 96 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.google_sheets.async_unload_entry ( HomeAssistant  hass,
GoogleSheetsConfigEntry   entry 
)
Unload a config entry.

Definition at line 80 of file __init__.py.

Variable Documentation

◆ DATA

string homeassistant.components.google_sheets.DATA = "data"

Definition at line 34 of file __init__.py.

◆ DATA_CONFIG_ENTRY

string homeassistant.components.google_sheets.DATA_CONFIG_ENTRY = "config_entry"

Definition at line 35 of file __init__.py.

◆ GoogleSheetsConfigEntry

homeassistant.components.google_sheets.GoogleSheetsConfigEntry

Definition at line 32 of file __init__.py.

◆ SERVICE_APPEND_SHEET

string homeassistant.components.google_sheets.SERVICE_APPEND_SHEET = "append_sheet"

Definition at line 38 of file __init__.py.

◆ SHEET_SERVICE_SCHEMA

homeassistant.components.google_sheets.SHEET_SERVICE_SCHEMA
Initial value:
1 = vol.All(
2  {
3  vol.Required(DATA_CONFIG_ENTRY): ConfigEntrySelector(),
4  vol.Optional(WORKSHEET): cv.string,
5  vol.Required(DATA): vol.Any(cv.ensure_list, [dict]),
6  },
7 )

Definition at line 40 of file __init__.py.

◆ WORKSHEET

string homeassistant.components.google_sheets.WORKSHEET = "worksheet"

Definition at line 36 of file __init__.py.