Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voronchuk/elixir_google_spreadsheets
Elixir library to read and write data of Google Spreadsheets.
https://github.com/voronchuk/elixir_google_spreadsheets
elixir elixir-library google-spreadsheets service-accounton
Last synced: 6 days ago
JSON representation
Elixir library to read and write data of Google Spreadsheets.
- Host: GitHub
- URL: https://github.com/voronchuk/elixir_google_spreadsheets
- Owner: Voronchuk
- License: mit
- Created: 2016-11-20T21:28:59.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T00:14:11.000Z (5 months ago)
- Last Synced: 2024-12-10T18:05:25.282Z (13 days ago)
- Topics: elixir, elixir-library, google-spreadsheets, service-accounton
- Language: Elixir
- Size: 139 KB
- Stars: 80
- Watchers: 3
- Forks: 37
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Elixir Google Spreadsheets
Elixir library to read and write data of Google Spreadsheets.
This library is based on __Google Cloud API v4__ and uses __Google Service Accounts__ to manage it's content.
## Integration with Ecto
Check [ecto_gss](https://github.com/Voronchuk/ecto_gss) if you need to integrate your Google Spreadsheet with Ecto changesets for validation and other features.
# Setup
1. Use [this](https://console.developers.google.com/start/api?id=sheets.googleapis.com) wizard to create or select a project in the Google Developers Console and automatically turn on the API. Click __Continue__, then __Go to credentials__.
2. On the __Add credentials to your project page__, create __Service account key__.
3. Select your project name as service account and __JSON__ as key format, download the created key and rename it to __service_account.json__.
4. Press __Manage service accounts__ on a credential page, copy your __Service Account Identifier__: _[projectname]@[domain].iam.gserviceaccount.com_
5. Create or open existing __Google Spreadsheet document__ on your __Google Drive__ and add __Service Account Identifier__ as user invited in spreadsheet's __Collaboration Settings__.
6. Add `{:elixir_google_spreadsheets, "~> 0.3"}` to __mix.exs__ under `deps` function, add `:elixir_google_spreadsheets` in your application list.
7. Add __service_account.json__ in your `config.exs` or other config file, like `dev.exs` or `prod.secret.exs`.
config :elixir_google_spreadsheets,
json: "./config/service_account.json" |> File.read!
8. Run `mix deps.get && mix deps.compile`.
## API limits
All Google API limits, suggested params are the following:
```elixir
config :elixir_google_spreadsheets, :client,
request_workers: 50,
max_demand: 100,
max_interval: :timer.minutes(1),
interval: 100,
result_timeout: :timer.minutes(10)
```
Since elixir 1.14 the following request params are used by default, you can modify them as `:request_opts`:
```elixir
[
timeout: :timer.seconds(8),
recv_timeout: :timer.seconds(5),
ssl: [
versions: [:"tlsv1.2"],
verify: :verify_peer,
depth: 99,
cacerts: :certifi.cacerts(),
customize_hostname_check: [
match_fun: :public_key.pkix_verify_hostname_match_fun(:https)
],
reuse_sessions: false,
crl_check: true,
crl_cache: {:ssl_crl_cache, {:internal, [http: 30000]}}
]
]
```
# Usage
Initialise spreadsheet thread with it's id which you can fetch from URL:
```elixir
{:ok, pid} = GSS.Spreadsheet.Supervisor.spreadsheet("XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXX")
```
Or if you wish to edit only a specific list:
```elixir
{:ok, pid} = GSS.Spreadsheet.Supervisor.spreadsheet(
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXX",
list_name: "my_list3"
)
```
Sample operations:
* `GSS.Spreadsheet.id(pid)`
* `GSS.Spreadsheet.properties(pid)`
* `GSS.Spreadsheet.sheets(pid)`
* `GSS.Spreadsheet.rows(pid)`
* `GSS.Spreadsheet.read_row(pid, 1, column_to: 5)`
* `GSS.Spreadsheet.read_rows(pid, 1, 10, column_to: 5, pad_empty: true)`
* `GSS.Spreadsheet.read_rows(pid, [1, 3, 5], column_to: 5, pad_empty: true)`
* `GSS.Spreadsheet.read_rows(pid, ["A1:E1", "A2:E2"])`
* `GSS.Spreadsheet.write_row(pid, 1, ["1", "2", "3", "4", "5"])`
* `GSS.Spreadsheet.write_rows(pid, ["A2:E2", "A3:F3"], [["1", "2", "3", "4", "5"], ["1", "2", "3", "4", "5", "6"]])`
* `GSS.Spreadsheet.append_row(pid, 1, ["1", "2", "3", "4", "5"])`
* `GSS.Spreadsheet.append_rows(pid, 1, [["1", "2", "3", "4", "5"], ["1", "2", "3", "4", "5", "6"]])`
* `GSS.Spreadsheet.clear_row(pid, 1)`
* `GSS.Spreadsheet.clear_rows(pid, 1, 10)`
* `GSS.Spreadsheet.clear_rows(pid, ["A1:E1", "A2:E2"])`
Last function param of `GSS.Spreadsheet` function calls support the same `Keyword` options (in snake_case instead of camelCase), as defined in [Google API Docs](https://developers.google.com/sheets/reference/rest/v4/spreadsheets.values).
We also define `column_from` and `column_to` Keyword options which control range of cell which will be queried.
Default values:
* `column_from = 1` - default is configurable as `:default_column_from`
* `column_to = 26` - default is configurable as `:default_column_to`
* `major_dimension = "ROWS"`
* `value_render_option = "FORMATTED_VALUE"`
* `datetime_render_option = "FORMATTED_STRING"`
* `value_render_option = "USER_ENTERED"`
* `insert_data_option = "INSERT_ROWS"`
# Suggestions
* Recommended columns __26__ (more on your own risk), max rows in a batch __100-300__ depending on your data size per row, configurable as `:max_rows_per_request`;
* __Pull requests / reports / feedback are welcome.__