mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-11 22:13:19 +01:00
220 lines
15 KiB
Markdown
220 lines
15 KiB
Markdown
<!---
|
|
DO NOT EDIT !
|
|
This file was generated automatically from 'src/generator/templates/api/README.md.mako'
|
|
DO NOT EDIT !
|
|
-->
|
|
The `google-books1` library allows access to all features of the *Google books* service.
|
|
|
|
This documentation was generated from *books* crate version *4.0.1+20220301*, where *20220301* is the exact revision of the *books:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v4.0.1*.
|
|
|
|
Everything else about the *books* *v1* API can be found at the
|
|
[official documentation site](https://code.google.com/apis/books/docs/v1/getting_started.html).
|
|
# Features
|
|
|
|
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-books1/4.0.1+20220301/google_books1/Books) ...
|
|
|
|
* bookshelves
|
|
* [*get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::BookshelveGetCall), [*list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::BookshelveListCall) and [*volumes list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::BookshelveVolumeListCall)
|
|
* cloudloading
|
|
* [*add book*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::CloudloadingAddBookCall), [*delete book*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::CloudloadingDeleteBookCall) and [*update book*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::CloudloadingUpdateBookCall)
|
|
* dictionary
|
|
* [*list offline metadata*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::DictionaryListOfflineMetadataCall)
|
|
* familysharing
|
|
* [*get family info*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::FamilysharingGetFamilyInfoCall), [*share*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::FamilysharingShareCall) and [*unshare*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::FamilysharingUnshareCall)
|
|
* layers
|
|
* [*annotation data get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::LayerAnnotationDataGetCall), [*annotation data list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::LayerAnnotationDataListCall), [*get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::LayerGetCall), [*list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::LayerListCall), [*volume annotations get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::LayerVolumeAnnotationGetCall) and [*volume annotations list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::LayerVolumeAnnotationListCall)
|
|
* myconfig
|
|
* [*get user settings*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MyconfigGetUserSettingCall), [*release download access*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MyconfigReleaseDownloadAccesCall), [*request access*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MyconfigRequestAccesCall), [*sync volume licenses*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MyconfigSyncVolumeLicenseCall) and [*update user settings*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MyconfigUpdateUserSettingCall)
|
|
* mylibrary
|
|
* [*annotations delete*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryAnnotationDeleteCall), [*annotations insert*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryAnnotationInsertCall), [*annotations list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryAnnotationListCall), [*annotations summary*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryAnnotationSummaryCall), [*annotations update*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryAnnotationUpdateCall), [*bookshelves add volume*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryBookshelveAddVolumeCall), [*bookshelves clear volumes*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryBookshelveClearVolumeCall), [*bookshelves get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryBookshelveGetCall), [*bookshelves list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryBookshelveListCall), [*bookshelves move volume*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryBookshelveMoveVolumeCall), [*bookshelves remove volume*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryBookshelveRemoveVolumeCall), [*bookshelves volumes list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryBookshelveVolumeListCall), [*readingpositions get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryReadingpositionGetCall) and [*readingpositions set position*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::MylibraryReadingpositionSetPositionCall)
|
|
* [notification](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::Notification)
|
|
* [*get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::NotificationGetCall)
|
|
* onboarding
|
|
* [*list categories*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::OnboardingListCategoryCall) and [*list category volumes*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::OnboardingListCategoryVolumeCall)
|
|
* personalizedstream
|
|
* [*get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::PersonalizedstreamGetCall)
|
|
* promooffer
|
|
* [*accept*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::PromoofferAcceptCall), [*dismiss*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::PromoofferDismisCall) and [*get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::PromoofferGetCall)
|
|
* series
|
|
* [*get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::SeryGetCall) and [*membership get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::SeryMembershipGetCall)
|
|
* [volumes](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::Volume)
|
|
* [*associated list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::VolumeAssociatedListCall), [*get*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::VolumeGetCall), [*list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::VolumeListCall), [*mybooks list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::VolumeMybookListCall), [*recommended list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::VolumeRecommendedListCall), [*recommended rate*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::VolumeRecommendedRateCall) and [*useruploaded list*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/api::VolumeUseruploadedListCall)
|
|
|
|
|
|
|
|
|
|
# Structure of this Library
|
|
|
|
The API is structured into the following primary items:
|
|
|
|
* **[Hub](https://docs.rs/google-books1/4.0.1+20220301/google_books1/Books)**
|
|
* a central object to maintain state and allow accessing all *Activities*
|
|
* creates [*Method Builders*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::MethodsBuilder) which in turn
|
|
allow access to individual [*Call Builders*](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::CallBuilder)
|
|
* **[Resources](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::Resource)**
|
|
* primary types that you can apply *Activities* to
|
|
* a collection of properties and *Parts*
|
|
* **[Parts](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::Part)**
|
|
* a collection of properties
|
|
* never directly used in *Activities*
|
|
* **[Activities](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::CallBuilder)**
|
|
* operations to apply to *Resources*
|
|
|
|
All *structures* are marked with applicable traits to further categorize them and ease browsing.
|
|
|
|
Generally speaking, you can invoke *Activities* like this:
|
|
|
|
```Rust,ignore
|
|
let r = hub.resource().activity(...).doit().await
|
|
```
|
|
|
|
Or specifically ...
|
|
|
|
```ignore
|
|
let r = hub.cloudloading().delete_book(...).doit().await
|
|
let r = hub.familysharing().share(...).doit().await
|
|
let r = hub.familysharing().unshare(...).doit().await
|
|
let r = hub.mylibrary().annotations_delete(...).doit().await
|
|
let r = hub.mylibrary().bookshelves_add_volume(...).doit().await
|
|
let r = hub.mylibrary().bookshelves_clear_volumes(...).doit().await
|
|
let r = hub.mylibrary().bookshelves_move_volume(...).doit().await
|
|
let r = hub.mylibrary().bookshelves_remove_volume(...).doit().await
|
|
let r = hub.mylibrary().readingpositions_set_position(...).doit().await
|
|
let r = hub.promooffer().accept(...).doit().await
|
|
let r = hub.promooffer().dismiss(...).doit().await
|
|
```
|
|
|
|
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
|
|
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
|
|
specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired.
|
|
The `doit()` method performs the actual communication with the server and returns the respective result.
|
|
|
|
# Usage
|
|
|
|
## Setting up your Project
|
|
|
|
To use this library, you would put the following lines into your `Cargo.toml` file:
|
|
|
|
```toml
|
|
[dependencies]
|
|
google-books1 = "*"
|
|
serde = "^1.0"
|
|
serde_json = "^1.0"
|
|
```
|
|
|
|
## A complete example
|
|
|
|
```Rust
|
|
extern crate hyper;
|
|
extern crate hyper_rustls;
|
|
extern crate google_books1 as books1;
|
|
use books1::{Result, Error};
|
|
use std::default::Default;
|
|
use books1::{Books, oauth2, hyper, hyper_rustls};
|
|
|
|
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
|
|
// `client_secret`, among other things.
|
|
let secret: oauth2::ApplicationSecret = Default::default();
|
|
// Instantiate the authenticator. It will choose a suitable authentication flow for you,
|
|
// unless you replace `None` with the desired Flow.
|
|
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
|
|
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
|
|
// retrieve them from storage.
|
|
let auth = oauth2::InstalledFlowAuthenticator::builder(
|
|
secret,
|
|
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
|
|
).build().await.unwrap();
|
|
let mut hub = Books::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().enable_http2().build()), auth);
|
|
// You can configure optional parameters by calling the respective setters at will, and
|
|
// execute the final call using `doit()`.
|
|
// Values shown here are possibly random and not representative !
|
|
let result = hub.promooffer().accept()
|
|
.volume_id("et")
|
|
.serial("magna")
|
|
.product("no")
|
|
.offer_id("ipsum")
|
|
.model("voluptua.")
|
|
.manufacturer("At")
|
|
.device("sanctus")
|
|
.android_id("sed")
|
|
.doit().await;
|
|
|
|
match result {
|
|
Err(e) => match e {
|
|
// The Error enum provides details about what exactly happened.
|
|
// You can also just use its `Debug`, `Display` or `Error` traits
|
|
Error::HttpError(_)
|
|
|Error::Io(_)
|
|
|Error::MissingAPIKey
|
|
|Error::MissingToken(_)
|
|
|Error::Cancelled
|
|
|Error::UploadSizeLimitExceeded(_, _)
|
|
|Error::Failure(_)
|
|
|Error::BadRequest(_)
|
|
|Error::FieldClash(_)
|
|
|Error::JsonDecodeError(_, _) => println!("{}", e),
|
|
},
|
|
Ok(res) => println!("Success: {:?}", res),
|
|
}
|
|
|
|
```
|
|
## Handling Errors
|
|
|
|
All errors produced by the system are provided either as [Result](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::Result) enumeration as return value of
|
|
the doit() methods, or handed as possibly intermediate results to either the
|
|
[Hub Delegate](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
|
|
|
|
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
|
|
makes the system potentially resilient to all kinds of errors.
|
|
|
|
## Uploads and Downloads
|
|
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::Result), should be
|
|
read by you to obtain the media.
|
|
If such a method also supports a [Response Result](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::ResponseResult), it will return that by default.
|
|
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
|
|
this call: `.param("alt", "media")`.
|
|
|
|
Methods supporting uploads can do so using up to 2 different protocols:
|
|
*simple* and *resumable*. The distinctiveness of each is represented by customized
|
|
`doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively.
|
|
|
|
## Customization and Callbacks
|
|
|
|
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::Delegate) to the
|
|
[Method Builder](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::CallBuilder) before making the final `doit()` call.
|
|
Respective methods will be called to provide progress information, as well as determine whether the system should
|
|
retry on failure.
|
|
|
|
The [delegate trait](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
|
|
|
|
## Optional Parts in Server-Requests
|
|
|
|
All structures provided by this library are made to be [encodable](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::RequestValue) and
|
|
[decodable](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
|
|
are valid.
|
|
Most optionals are are considered [Parts](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::Part) which are identifiable by name, which will be sent to
|
|
the server to indicate either the set parts of the request or the desired parts in the response.
|
|
|
|
## Builder Arguments
|
|
|
|
Using [method builders](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
|
|
These will always take a single argument, for which the following statements are true.
|
|
|
|
* [PODs][wiki-pod] are handed by copy
|
|
* strings are passed as `&str`
|
|
* [request values](https://docs.rs/google-books1/4.0.1+20220301/google_books1/client::RequestValue) are moved
|
|
|
|
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
|
|
|
|
[wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure
|
|
[builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern
|
|
[google-go-api]: https://github.com/google/google-api-go-client
|
|
|
|
# License
|
|
The **books1** library was generated by Sebastian Thiel, and is placed
|
|
under the *MIT* license.
|
|
You can read the full text at the repository's [license file][repo-license].
|
|
|
|
[repo-license]: https://github.com/Byron/google-apis-rsblob/main/LICENSE.md
|
|
|