google-dfareporting3d5 库允许访问 Google Dfareporting 服务所有功能。

此文档是从 Dfareporting crate 版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 dfareporting:v3.5 架构的确切修订版本。

有关 Dfareporting v3d5 API 的其他所有信息，请参阅 官方文档网站。

功能

轻松从中央 中心 处理以下 资源 ...

• 媒体
• 上传

支持上传的 ...

• 上传媒体

本库的结构

API 结构为以下主要项

• 中心
  • 一个中心对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，这些构建器又允许访问单个 调用构建器
• 资源
  • 可以将其应用于 活动 的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 从未在 活动 中直接使用
• 活动
  • 应用于 资源 的操作

所有 结构 都标记了适用的特质，以进一步分类它们并简化浏览。

一般来说，您可以像这样调用 活动

let r = hub.resource().activity(...).doit().await

或者具体地说 ...

let r = hub.media().upload(...).doit().await

资源（resource()）和活动（activity(...)）调用创建了构建器。后者处理Activities，支持各种配置即将进行的操作（此处未显示）的方法。它是这样的，即所有必需的参数都必须立即指定（即(...)），而所有可选的都可以按需构建。doit()方法执行与服务器实际通信，并返回相应的结果。

使用方法

设置您的项目

要使用此库，您需要将以下行放入您的Cargo.toml文件中

[dependencies]
google-dfareporting3d5 = "*"
serde = "^1.0"
serde_json = "^1.0"

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_dfareporting3d5 as dfareporting3d5;
use dfareporting3d5::api::CreativeAssetMetadata;
use dfareporting3d5::{Result, Error};
use std::fs;
use std::default::Default;
use dfareporting3d5::{Dfareporting, 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 = Dfareporting::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().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 = CreativeAssetMetadata::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `upload(...)`.
// Values shown here are possibly random and not representative !
let result = hub.media().upload(req, -22, -33)
             .upload(fs::File::open("file.ext").unwrap(), "application/octet-stream".parse().unwrap()).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),
}

错误处理

系统产生的所有错误都作为Result枚举提供，作为doit()方法的返回值，或者作为中间结果传递给Hub Delegate或Authenticator Delegate。

当代理处理错误或中间值时，它们可能会有机会指示系统重试。这使得系统可能对各种错误具有弹性。

上传和下载

如果方法支持下载，响应体（它是Result的一部分）应由您读取以获取媒体。如果该方法还支持Response Result，则默认返回该结果。您可以将其视为实际媒体的元数据。要触发媒体下载，您必须通过此调用设置构建器：.param("alt", "media")。

支持上传的方法可以使用多达2种不同的协议进行上传：简单和可恢复。每种方法的独特性由自定义的doit(...)方法表示，分别命名为upload(...)和upload_resumable(...)。