google-partners2 库允许访问 Google Partners 服务的所有功能。

本文档是从 Partners 包版本 5.0.5+20180925 生成的，其中 20180925 是由 mako 代码生成器 v5.0.5 构建的 partners:v2 模式的确切修订。

有关 Partners v2 API 的其他所有信息，请参阅官方文档站点。

功能

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

• 分析
• 列表
• 客户端消息
• 日志
• 公司
• 获取、创建线索 和 列表
• 线索
• 列表
• 报价
• 历史列表 和 列表
• 用户事件
• 日志
• 用户状态
• 列表
• 用户
• 创建公司关系、删除公司关系、获取 和 更新配置文件

其他活动是 ...

• 获取合作伙伴状态
• 更新公司
• 更新线索

此库的结构

API结构如下

• 枢纽
  • 一个中心对象，用于维护状态和允许访问所有 活动
  • 创建方法构建器，进而允许访问单个调用构建器
• 资源
  • 你可以将这些活动应用到的主要类型
  • 一系列属性和部分
  • 部分
    • 一系列属性
    • 永远不会直接在活动中使用
• 活动
  • 应用于资源的操作

所有结构都带有适用的特征，以便进一步分类并简化浏览。

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

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

或者具体来说...

let r = hub.users().update_profile(...).doit().await
let r = hub.users().create_company_relation(...).doit().await
let r = hub.users().delete_company_relation(...).doit().await
let r = hub.users().get(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_partners2 as partners2;
use partners2::api::CompanyRelation;
use partners2::{Result, Error};
use std::default::Default;
use partners2::{Partners, 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 = Partners::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 = CompanyRelation::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.users().create_company_relation(req, "userId")
             .request_metadata_user_overrides_user_id("magna")
             .request_metadata_user_overrides_ip_address("no")
             .request_metadata_traffic_source_traffic_sub_id("ipsum")
             .request_metadata_traffic_source_traffic_source_id("voluptua.")
             .request_metadata_partners_session_id("At")
             .request_metadata_locale("sanctus")
             .add_request_metadata_experiment_ids("sed")
             .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()枚举提供，作为doit()方法的返回值，或者作为可能的中继结果传递给Hub Delegate，或者Authenticator Delegate。

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

上传和下载

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

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

自定义和回调

您可以通过在调用最终的 doit() 之前提供一个 代理 给 方法构建器 来修改调用 doit() 方法的方式。相应的函数将被调用以提供进度信息，并确定系统在失败时是否应该重试。

默认实现了 代理特质，您只需付出最小的努力即可自定义它。

服务器请求中的可选部分

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

构建器参数

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

• POD 通过复制传递
• 字符串作为 &str 传递
• 请求值 被移动

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

Cargo 功能

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

许可证

partners2 库是由 Sebastian Thiel 生成的，并置于 MIT 许可证之下。您可以在存储库的 许可证文件 中阅读全文。