google-consumersurveys2 库允许访问 Google 消费者调查服务（协议版本 v2）的所有功能。

此文档是从 消费者调查 包版本 5.0.5+20170407 生成的，其中 20170407 是由 mako 代码生成器 v5.0.5 构建的 consumersurveys:v2 架构的确切修订版本。

功能

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

• mobileapppanels
• get, list 和 update
• results
• get
• surveys
• delete, get, insert, list, start, stop 和 update

支持从 ... 下载

• get results

本库结构

API 结构如下主要项目

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

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

一般来说，你可以这样调用活动：

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

或者具体来说...

let r = hub.surveys().delete(...).doit().await
let r = hub.surveys().get(...).doit().await
let r = hub.surveys().insert(...).doit().await
let r = hub.surveys().list(...).doit().await
let r = hub.surveys().start(...).doit().await
let r = hub.surveys().stop(...).doit().await
let r = hub.surveys().update(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_consumersurveys2 as consumersurveys2;
use consumersurveys2::{Result, Error};
use std::default::Default;
use consumersurveys2::{ConsumerSurveys, 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 = ConsumerSurveys::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), 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.surveys().list()
             .token("et")
             .start_index(68)
             .max_results(90)
             .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),
}

处理错误

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

当代理处理错误或中间值时，它们可能会有机会指导系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

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

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

定制和回调

您可以通过向 方法构建器 提供一个 委托 来修改 doit() 方法的调用方式。在执行最终的 doit() 调用之前，将调用相应的方 法以提供进度信息，并确定系统在失败时应否重试。

委托特质 默认实现，允许您以最少的努力进行自定义。

服务器请求中的可选部分

此库提供的所有结构都旨在通过 json 进行 编码 和 解码。使用可选部分来表示部分请求或响应是有效的。大多数可选部分都是可识别的 部分，它们可以通过名称识别，将它们发送到服务器以指示请求的设置部分或响应中所需的部分。

构建器参数

使用 方法构建器，您可以通过重复调用其方法来准备操作调用。这些方法始终接受单个参数，以下语句对此参数适用。

• PODs 通过复制传递
• 字符串作为 &str 传递
• 请求值 是移动的

参数将始终复制或克隆到构建器中，以使它们与其原始生命周期独立。

Cargo 功能

• utoipa - 添加对 utoipa 的支持并从所有类型中派生 utoipa::ToSchema。您必须在 #[openapi(schemas(...))] 中导入和注册所需类型，否则生成的 openapi 规范将是无效的。

许可证

由 Sebastian Thiel 生成的 consumersurveys2 库，并置于 MIT 许可证下。您可以在仓库的 许可证文件 中阅读全文。