Crate sheets

Expand description

A fully generated, opinionated API client library for Google Sheets.

API Details

Reads and writes Google Sheets.

Contact

name	url
Google	https://google.com

License

name	url
Creative Commons Attribution 3.0	http://creativecommons.org/licenses/by/3.0/

This client is generated from the Google Sheets OpenAPI specs based on API spec version v4. This way it will remain up to date as features are added. The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
sheets = "0.4.0"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use sheets::Client;

let google sheets = Client::new(
    String::from("client-id"),
    String::from("client-secret"),
    String::from("redirect-uri"),
    String::from("token"),
    String::from("refresh-token")
);

Alternatively, the library can search for most of the variables required for the client in the environment:

GOOGLE SHEETS_CLIENT_ID
GOOGLE SHEETS_CLIENT_SECRET
GOOGLE SHEETS_REDIRECT_URI

And then you can create a client from the environment.

use sheets::Client;

let google sheets = Client::new_from_env(
    String::from("token"),
    String::from("refresh-token")
);

It is okay to pass empty values for token and refresh_token. In the initial state of the client, you will not know these values.

To start off a fresh client and get a token and refresh_token, use the following.

use sheets::Client;

async fn do_call() {
    let mut google sheets = Client::new_from_env("", "");

    // Get the URL to request consent from the user.
    // You can optionally pass in scopes. If none are provided, then the
    // resulting URL will not have any scopes.
    let user_consent_url = google sheets.user_consent_url(&["some-scope".to_string()]);

    // In your redirect URL capture the code sent and our state.
    // Send it along to the request for the token.
    let code = "thing-from-redirect-url";
    let state = "state-from-redirect-url";
    let mut access_token = google sheets.get_access_token(code, state).await.unwrap();

    // You can additionally refresh the access token with the following.
    // You must have a refresh token to be able to call this function.
    access_token = google sheets.refresh_access_token().await.unwrap();
}

Modules

spreadsheets

traits

types

The data types sent to and returned from the API client.

Structs

AccessToken

Client

Entrypoint for interacting with the API client.

Constants

DEFAULT_HOST