The google-dfareporting2d8 library allows access to all features of the Google dfareporting service.

This documentation was generated from dfareporting crate version 6.0.0+20180830, where 20180830 is the exact revision of the dfareporting:v2.8 schema built by the mako code generator v6.0.0.

Everything else about the dfareporting v2d8 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 and batchupdate
• 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
• languages
• list
• 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
• targeting templates
• get, insert, list, patch and update
• 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
• video formats
• get and list

Upload supported by ...

• insert creative assets

Download supported by ...

• get files
• files get reports

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().await

Or specifically ...

let r = hub.reports().compatible_fields_query(...).doit().await
let r = hub.reports().files_get(...).doit().await
let r = hub.reports().files_list(...).doit().await
let r = hub.reports().delete(...).doit().await
let r = hub.reports().get(...).doit().await
let r = hub.reports().insert(...).doit().await
let r = hub.reports().list(...).doit().await
let r = hub.reports().patch(...).doit().await
let r = hub.reports().run(...).doit().await
let r = hub.reports().update(...).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.

Usage

Setting up your Project

To use this library, you would put the following lines into your Cargo.toml file:

[dependencies]
google-dfareporting2d8 = "*"
serde = "1"
serde_json = "1"

A complete example

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dfareporting2d8 as dfareporting2d8;
use dfareporting2d8::{Result, Error};
use dfareporting2d8::{Dfareporting, 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 = Dfareporting::new(client, 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().files_list(-22, -33)
             .sort_order("no")
             .sort_field("ipsum")
             .page_token("voluptua.")
             .max_results(-27)
             .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 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 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.

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.

Cargo Features

• utoipa - Add support for 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 dfareporting2d8 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.