#制造商 #谷歌API #谷歌 #API #协议 #Web API #Web

google-manufacturers1

与制造商中心(协议 v1)交互的完整库

29 个稳定版本 (4 个主要版本)

5.0.5+20240524 2024 年 6 月 27 日
5.0.4+20240205 2024 年 3 月 5 日
5.0.3+20230123 2023 年 8 月 24 日
5.0.2+20230123 2023 年 3 月 16 日
1.0.2+20161028 2016 年 12 月 27 日

#2562 in 网页编程


用于 google-manufacturers1-cli

MIT 许可证

235KB
3K SLoC

google-manufacturers1 库允许访问 谷歌制造商中心 服务所有功能。

此文档是根据 制造商中心 库版本 5.0.5+20240524 生成的,其中 20240524 是由 mako 代码生成器 v5.0.5 构建的 manufacturers:v1 架构的确切修订版。

有关 制造商中心 v1 API 的其他所有信息,请参阅 官方文档网站

功能

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

本库结构

API 结构化为以下主要项目

  • 枢纽
  • 资源
    • 可以应用 活动 的主要类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中从不直接使用
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有相应的特征,以进一步分类它们并简化浏览。

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

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

或者具体来说 ...

let r = hub.accounts().languages_product_certifications_delete(...).doit().await
let r = hub.accounts().products_delete(...).doit().await
let r = hub.accounts().products_update(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_manufacturers1 as manufacturers1;
use manufacturers1::api::Attributes;
use manufacturers1::{Result, Error};
use std::default::Default;
use manufacturers1::{ManufacturerCenter, 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 = ManufacturerCenter::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 = Attributes::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.accounts().products_update(req, "parent", "name")
             .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 DelegateAuthenticator Delegate

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

上传和下载

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

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

定制和回调

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

代理 trait 默认实现,允许您以最小的努力对其进行定制。

服务器请求中的可选部件

此库提供的所有结构都是为了能够通过json进行编码解码而设计的。可选部分用于表示部分请求或响应是有效的。大多数可选部分都是可以按名称识别的部件,这些部件将发送到服务器以指示请求的集合部件或响应中期望的部件。

构建器参数

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

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~343K SLoC