Crates.io | google-androidpublisher3 |
lib.rs | google-androidpublisher3 |
version | 5.0.5+20240229 |
source | src |
created_at | 2018-10-13 14:15:57.402757 |
updated_at | 2024-03-11 09:36:39.093018 |
description | A complete library to interact with Android Publisher (protocol v3) |
homepage | https://developers.google.com/android-publisher |
repository | https://github.com/Byron/google-apis-rs/tree/main/gen/androidpublisher3 |
max_upload_size | |
id | 89643 |
size | 1,981,721 |
The google-androidpublisher3
library allows access to all features of the Google Android Publisher service.
This documentation was generated from Android Publisher crate version 5.0.5+20240229, where 20240229 is the exact revision of the androidpublisher:v3 schema built by the mako code generator v5.0.5.
Everything else about the Android Publisher v3 API can be found at the official documentation site.
Handle the following Resources with ease from the central hub ...
applications
data safety, device tier configs create, device tier configs get and device tier configs list
apprecovery
edits
apks addexternallyhosted, apks list, apks upload, bundles list, bundles upload, commit, countryavailability get, delete, deobfuscationfiles upload, details get, details patch, details update, expansionfiles get, expansionfiles patch, expansionfiles update, expansionfiles upload, get, images delete, images deleteall, images list, images upload, insert, listings delete, listings deleteall, listings get, listings list, listings patch, listings update, testers get, testers patch, testers update, tracks create, tracks get, tracks list, tracks patch, tracks update and validate
externaltransactions
createexternaltransaction, getexternaltransaction and refundexternaltransaction
generatedapks
inappproducts
batch delete, batch get, batch update, delete, get, insert, list, patch and update
internalappsharingartifacts
monetization
convert region prices, subscriptions archive, subscriptions base plans activate, subscriptions base plans batch migrate prices, subscriptions base plans batch update states, subscriptions base plans deactivate, subscriptions base plans delete, subscriptions base plans migrate prices, subscriptions base plans offers activate, subscriptions base plans offers batch get, subscriptions base plans offers batch update, subscriptions base plans offers batch update states, subscriptions base plans offers create, subscriptions base plans offers deactivate, subscriptions base plans offers delete, subscriptions base plans offers get, subscriptions base plans offers list, subscriptions base plans offers patch, subscriptions batch get, subscriptions batch update, subscriptions create, subscriptions delete, subscriptions get, subscriptions list and subscriptions patch
orders
purchases
products acknowledge, products consume, products get, subscriptions acknowledge, subscriptions cancel, subscriptions defer, subscriptions get, subscriptions refund, subscriptions revoke, subscriptionsv2 get, subscriptionsv2 revoke and voidedpurchases list
systemapks
variants create, variants download, variants get and variants list
Upload supported by ...
Download supported by ...
The API is structured into the following primary items:
All structures are marked with applicable traits to further categorize them and ease browsing.
Generally speaking, you can invoke Activities like this:
let r = hub.resource().activity(...).doit().await
Or specifically ...
let r = hub.monetization().subscriptions_base_plans_activate(...).doit().await
let r = hub.monetization().subscriptions_base_plans_deactivate(...).doit().await
let r = hub.monetization().subscriptions_archive(...).doit().await
let r = hub.monetization().subscriptions_create(...).doit().await
let r = hub.monetization().subscriptions_get(...).doit().await
let r = hub.monetization().subscriptions_patch(...).doit().await
The resource()
and activity(...)
calls create builders. 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 as desired.
The doit()
method performs the actual communication with the server and returns the respective result.
To use this library, you would put the following lines into your Cargo.toml
file:
[dependencies]
google-androidpublisher3 = "*"
serde = "^1.0"
serde_json = "^1.0"
extern crate hyper;
extern crate hyper_rustls;
extern crate google_androidpublisher3 as androidpublisher3;
use androidpublisher3::api::Subscription;
use androidpublisher3::{Result, Error};
use std::default::Default;
use androidpublisher3::{AndroidPublisher, oauth2, hyper, hyper_rustls, chrono, FieldMask};
// 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 = AndroidPublisher::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), 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 = Subscription::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.monetization().subscriptions_patch(req, "packageName", "productId")
.update_mask(&Default::default())
.regions_version_version("no")
.latency_tolerance("ipsum")
.allow_missing(false)
.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),
}
All errors produced by the system are provided either as Result enumeration as return value of the doit() methods, or handed as possibly intermediate results to either the Hub Delegate, or the Authenticator Delegate.
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.
If a method supports downloads, the response body, which is part of the Result, should be
read by you to obtain the media.
If such a method also supports a Response Result, 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.
You may alter the way an doit()
method is called by providing a delegate to the
Method Builder 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 is default-implemented, allowing you to customize it with minimal effort.
All structures provided by this library are made to be encodable and decodable via json. Optionals are used to indicate that partial requests are responses are valid. Most optionals are are considered Parts 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.
Using method builders, 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.
&str
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
The androidpublisher3 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.