9 stable releases
Uses old Rust 2015
1.0.6+20170428 | Sep 24, 2017 |
---|---|
1.0.5+20170428 | May 26, 2017 |
1.0.4+20161027 | Feb 4, 2017 |
1.0.2+20161027 | Dec 27, 2016 |
0.1.15+20160803 | Sep 11, 2016 |
#16 in #dfareporting
Used in google-dfareporting2d5-cl…
3MB
40K
SLoC
The google-dfareporting2d5
library allows access to all features of the Google dfareporting service.
This documentation was generated from dfareporting crate version 1.0.6+20170428, where 20170428 is the exact revision of the dfareporting:v2.5 schema built by the mako code generator v1.0.6.
Everything else about the dfareporting v2d5 API can be found at the official documentation site.
Features
Handle the following Resources with ease from the central hub ...
- account active ad summaries
- get
- account permission groups
- get and list
- account permissions
- get and list
- account user profiles
- get, insert, list, patch and update
- accounts
- get, list, patch and update
- ads
- get, insert, list, patch and update
- advertiser groups
- delete, get, insert, list, patch and update
- advertisers
- get, insert, list, patch and update
- browsers
- list
- campaign creative associations
- insert and list
- campaigns
- get, insert, list, patch and update
- change logs
- get and list
- cities
- list
- connection types
- get and list
- content categories
- delete, get, insert, list, patch and update
- conversions
- batchinsert
- countries
- get and list
- creative assets
- insert
- creative field values
- delete, get, insert, list, patch and update
- creative fields
- delete, get, insert, list, patch and update
- creative groups
- get, insert, list, patch and update
- creatives
- get, insert, list, patch and update
- dimension values
- query
- directory site contacts
- get and list
- directory sites
- get, insert and list
- dynamic targeting keys
- delete, insert and list
- event tags
- delete, get, insert, list, patch and update
- files
- get and list
- floodlight activities
- delete, generatetag, get, insert, list, patch and update
- floodlight activity groups
- get, insert, list, patch and update
- floodlight configurations
- get, list, patch and update
- inventory items
- get and list
- landing pages
- delete, get, insert, list, patch and update
- metros
- list
- mobile carriers
- get and list
- operating system versions
- get and list
- operating systems
- get and list
- order documents
- get and list
- orders
- get and list
- placement groups
- get, insert, list, patch and update
- placement strategies
- delete, get, insert, list, patch and update
- placements
- generatetags, get, insert, list, patch and update
- platform types
- get and list
- postal codes
- get and list
- projects
- get and list
- regions
- list
- remarketing list shares
- get, patch and update
- remarketing lists
- get, insert, list, patch and update
- reports
- compatible fields query, delete, files get, files list, get, insert, list, patch, run and update
- sites
- get, insert, list, patch and update
- sizes
- get, insert and list
- subaccounts
- get, insert, list, patch and update
- targetable remarketing lists
- get and list
- user profiles
- get and list
- user role permission groups
- get and list
- user role permissions
- get and list
- user roles
- delete, get, insert, list, patch and update
Upload supported by ...
Download supported by ...
Structure of this Library
The API is structured into the following primary items:
- Hub
- a central object to maintain state and allow accessing all Activities
- creates Method Builders which in turn allow access to individual Call Builders
- Resources
- primary types that you can apply Activities to
- a collection of properties and Parts
- Parts
- a collection of properties
- never directly used in Activities
- Activities
- 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:
let r = hub.resource().activity(...).doit()
Or specifically ...
let r = hub.reports().run(...).doit()
let r = hub.reports().get(...).doit()
let r = hub.reports().list(...).doit()
let r = hub.reports().delete(...).doit()
let r = hub.reports().files_list(...).doit()
let r = hub.reports().insert(...).doit()
let r = hub.reports().patch(...).doit()
let r = hub.reports().compatible_fields_query(...).doit()
let r = hub.reports().update(...).doit()
let r = hub.reports().files_get(...).doit()
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.
Usage
Setting up your Project
To use this library, you would put the following lines into your Cargo.toml
file:
[dependencies]
google-dfareporting2d5 = "*"
A complete example
extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_dfareporting2d5 as dfareporting2d5;
use dfareporting2d5::{Result, Error};
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use dfareporting2d5::Dfareporting;
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: 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 = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
<MemoryStorage as Default>::default(), None);
let mut hub = Dfareporting::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), 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.reports().list("profileId")
.sort_order("sit")
.sort_field("Stet")
.scope("sed")
.page_token("et")
.max_results(-18)
.doit();
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::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 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.
Uploads and Downloads
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.
Customization and Callbacks
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.
Optional Parts in Server-Requests
All structures provided by this library are made to be enocodable 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.
Builder Arguments
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.
- PODs are handed by copy
- strings are passed as
&str
- request values are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
License
The dfareporting2d5 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.
Dependencies
~8–18MB
~296K SLoC