“google-authorizedbuyersmarketplace1”库允许访问 Google 授权买家市场服务（协议版本 v1）的所有功能。

本文档是从 授权买家市场 包版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 authorizedbuyersmarketplace:v1 架构的精确版本。

关于授权买家市场 v1 API 的其他信息可以在 官方文档网站 找到。

功能

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

• bidders
• 拍卖包列表 和 最终成交列表
• buyers
• auction packages get, auction packages list, auction packages subscribe, auction packages subscribe clients, auction packages unsubscribe, auction packages unsubscribe clients, clients activate, clients create, clients deactivate, clients get, clients list, clients patch, clients users activate, clients users create, clients users deactivate, clients users delete, clients users get, clients users list, finalized deals add creative, finalized deals get, finalized deals list, finalized deals pause, finalized deals resume, finalized deals set ready to serve, proposals accept, proposals add note, proposals cancel negotiation, proposals deals batch update, proposals deals get, proposals deals list, proposals deals patch, proposals get, proposals list, proposals patch, proposals send rfp, publisher profiles get and publisher profiles list

此库的结构

API 被构建为以下主要项

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

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

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

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

或具体地 ...

let r = hub.buyers().proposals_accept(...).doit().await
let r = hub.buyers().proposals_add_note(...).doit().await
let r = hub.buyers().proposals_cancel_negotiation(...).doit().await
let r = hub.buyers().proposals_get(...).doit().await
let r = hub.buyers().proposals_patch(...).doit().await
let r = hub.buyers().proposals_send_rfp(...).doit().await

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

使用方法

设置项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_authorizedbuyersmarketplace1 as authorizedbuyersmarketplace1;
use authorizedbuyersmarketplace1::api::Proposal;
use authorizedbuyersmarketplace1::{Result, Error};
use std::default::Default;
use authorizedbuyersmarketplace1::{AuthorizedBuyersMarketplace, 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 = AuthorizedBuyersMarketplace::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 = Proposal::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.buyers().proposals_patch(req, "name")
             .update_mask(FieldMask::new::<&str>(&[]))
             .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(...)。

定制和回调

您可以通过向Method Builder提供delegate来更改doit()方法被调用的方式，在最终调用doit()之前。将调用相应的方法来提供进度信息，以及确定系统是否应在失败时重试。

默认实现了delegate trait，允许您以最小的努力进行定制。

服务器请求中的可选部分

本库提供的所有结构都设计为可以通过 编码 和 解码 为 json 格式。使用可选参数来表示部分请求或响应是有效的。大多数可选参数被认为是 部分，可以通过名称识别，这些部分将被发送到服务器以指示请求或响应中所需的部分。

构建器参数

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

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

参数将始终被复制或克隆到构建器中，以确保它们与其原始的生命周期无关。

Cargo 特性

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

许可证

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