The `google-androidpublisher2` library allows access to all features of the *Google Android Publisher* service. This documentation was generated from *Android Publisher* crate version *6.0.0+20200331*, where *20200331* is the exact revision of the *androidpublisher:v2* schema built by the [mako](http://www.makotemplates.org/) code generator *v6.0.0*. Everything else about the *Android Publisher* *v2* API can be found at the [official documentation site](https://developers.google.com/android-publisher). # Features Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/AndroidPublisher) ... * edits * [*apklistings delete*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApklistingDeleteCall), [*apklistings deleteall*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApklistingDeleteallCall), [*apklistings get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApklistingGetCall), [*apklistings list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApklistingListCall), [*apklistings patch*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApklistingPatchCall), [*apklistings update*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApklistingUpdateCall), [*apks addexternallyhosted*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApkAddexternallyhostedCall), [*apks list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApkListCall), [*apks upload*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApkUploadCall), [*bundles list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditBundleListCall), [*bundles upload*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditBundleUploadCall), [*commit*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditCommitCall), [*delete*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditDeleteCall), [*deobfuscationfiles upload*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditDeobfuscationfileUploadCall), [*details get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditDetailGetCall), [*details patch*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditDetailPatchCall), [*details update*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditDetailUpdateCall), [*expansionfiles get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditExpansionfileGetCall), [*expansionfiles patch*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditExpansionfilePatchCall), [*expansionfiles update*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditExpansionfileUpdateCall), [*expansionfiles upload*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditExpansionfileUploadCall), [*get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditGetCall), [*images delete*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditImageDeleteCall), [*images deleteall*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditImageDeleteallCall), [*images list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditImageListCall), [*images upload*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditImageUploadCall), [*insert*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditInsertCall), [*listings delete*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditListingDeleteCall), [*listings deleteall*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditListingDeleteallCall), [*listings get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditListingGetCall), [*listings list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditListingListCall), [*listings patch*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditListingPatchCall), [*listings update*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditListingUpdateCall), [*testers get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditTesterGetCall), [*testers patch*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditTesterPatchCall), [*testers update*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditTesterUpdateCall), [*tracks get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditTrackGetCall), [*tracks list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditTrackListCall), [*tracks patch*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditTrackPatchCall), [*tracks update*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditTrackUpdateCall) and [*validate*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditValidateCall) * inappproducts * [*delete*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::InappproductDeleteCall), [*get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::InappproductGetCall), [*insert*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::InappproductInsertCall), [*list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::InappproductListCall), [*patch*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::InappproductPatchCall) and [*update*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::InappproductUpdateCall) * orders * [*refund*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::OrderRefundCall) * purchases * [*products get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::PurchaseProductGetCall), [*subscriptions cancel*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::PurchaseSubscriptionCancelCall), [*subscriptions defer*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::PurchaseSubscriptionDeferCall), [*subscriptions get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::PurchaseSubscriptionGetCall), [*subscriptions refund*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::PurchaseSubscriptionRefundCall), [*subscriptions revoke*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::PurchaseSubscriptionRevokeCall) and [*voidedpurchases list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::PurchaseVoidedpurchaseListCall) * [reviews](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::Review) * [*get*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::ReviewGetCall), [*list*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::ReviewListCall) and [*reply*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::ReviewReplyCall) Upload supported by ... * [*apks upload edits*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditApkUploadCall) * [*bundles upload edits*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditBundleUploadCall) * [*deobfuscationfiles upload edits*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditDeobfuscationfileUploadCall) * [*expansionfiles upload edits*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditExpansionfileUploadCall) * [*images upload edits*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/api::EditImageUploadCall) # Structure of this Library The API is structured into the following primary items: * **[Hub](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/AndroidPublisher)** * a central object to maintain state and allow accessing all *Activities* * creates [*Method Builders*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::MethodsBuilder) which in turn allow access to individual [*Call Builders*](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::CallBuilder) * **[Resources](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::Resource)** * primary types that you can apply *Activities* to * a collection of properties and *Parts* * **[Parts](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::Part)** * a collection of properties * never directly used in *Activities* * **[Activities](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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.inappproducts().get(...).doit().await let r = hub.inappproducts().insert(...).doit().await let r = hub.inappproducts().patch(...).doit().await let r = hub.inappproducts().update(...).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-androidpublisher2 = "*" serde = "1" serde_json = "1" ``` ## A complete example ```Rust extern crate hyper; extern crate hyper_rustls; extern crate google_androidpublisher2 as androidpublisher2; use androidpublisher2::api::InAppProduct; use androidpublisher2::{Result, Error}; use androidpublisher2::{AndroidPublisher, FieldMask, hyper_rustls, hyper_util, yup_oauth2}; // Get an ApplicationSecret instance by some means. It contains the `client_id` and // `client_secret`, among other things. let secret: yup_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 = yup_oauth2::InstalledFlowAuthenticator::builder( secret, yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect, ).build().await.unwrap(); let client = hyper_util::client::legacy::Client::builder( hyper_util::rt::TokioExecutor::new() ) .build( hyper_rustls::HttpsConnectorBuilder::new() .with_native_roots() .unwrap() .https_or_http() .enable_http1() .build() ); let mut hub = AndroidPublisher::new(client, auth); // As the method needs a request, you would usually fill it with the desired information // into the respective structure. Some of the parts shown here might not be applicable ! // Values shown here are possibly random and not representative ! let mut req = InAppProduct::default(); // 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.inappproducts().patch(req, "packageName", "sku") .auto_convert_missing_prices(true) .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-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::Result) enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the [Hub Delegate](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::Result), should be read by you to obtain the media. If such a method also supports a [Response Result](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::Delegate) to the [Method Builder](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::RequestValue) and [decodable](https://docs.rs/google-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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-androidpublisher2/6.0.0+20200331/google_androidpublisher2/common::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 ## Cargo Features * `utoipa` - Add support for [utoipa](https://crates.io/crates/utoipa) and derive `utoipa::ToSchema` on all the types. You'll have to import and register the required types in `#[openapi(schemas(...))]`, otherwise the generated `openapi` spec would be invalid. # License The **androidpublisher2** 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