#recommender #google-api #google #protocols #web #web-api

google-recommender1

与 Recommender(协议 v1)交互的完整库

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

5.0.5+20240623 2024 年 6 月 27 日
5.0.4+20240226 2024 年 3 月 5 日
5.0.3+20230108 2023 年 8 月 24 日
5.0.2+20230108 2023 年 3 月 17 日
1.0.14+20200704 2020 年 7 月 10 日

#1918 in Web 编程

Download history 4/week @ 2024-05-19 1/week @ 2024-06-09 1/week @ 2024-06-16 104/week @ 2024-06-23 8/week @ 2024-06-30

777 每月下载量
用于 google-recommender1-cli

MIT 许可证

1MB
10K SLoC

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

本文档是从 Recommender crate 版本 5.0.5+20240623 生成的,其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 recommender:v1 模式的确切修订版本。

关于 Recommender v1 API 的其他信息可以在 官方文档网站 上找到。

特性

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

本库结构

API结构分为以下主要项目

  • 中心
  • 资源
    • 可以应用活动主要类型
    • 属性和部分的集合
    • 部分
      • 属性的集合
      • 从不直接用于活动
  • 活动
    • 应用于资源的操作

所有结构都标有适用特性,以进一步分类它们并简化浏览。

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

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

或者具体地说...

let r = hub.billing_accounts().locations_recommenders_recommendations_get(...).doit().await
let r = hub.billing_accounts().locations_recommenders_recommendations_mark_claimed(...).doit().await
let r = hub.billing_accounts().locations_recommenders_recommendations_mark_dismissed(...).doit().await
let r = hub.billing_accounts().locations_recommenders_recommendations_mark_failed(...).doit().await
let r = hub.billing_accounts().locations_recommenders_recommendations_mark_succeeded(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_get(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_mark_claimed(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_mark_dismissed(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_mark_failed(...).doit().await
let r = hub.folders().locations_recommenders_recommendations_mark_succeeded(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_get(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_mark_claimed(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_mark_dismissed(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_mark_failed(...).doit().await
let r = hub.organizations().locations_recommenders_recommendations_mark_succeeded(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_get(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_mark_claimed(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_mark_dismissed(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_mark_failed(...).doit().await
let r = hub.projects().locations_recommenders_recommendations_mark_succeeded(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_recommender1 as recommender1;
use recommender1::api::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest;
use recommender1::{Result, Error};
use std::default::Default;
use recommender1::{Recommender, 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 = Recommender::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 = GoogleCloudRecommenderV1MarkRecommendationClaimedRequest::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.billing_accounts().locations_recommenders_recommendations_mark_claimed(req, "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 Delegate,或者Authenticator Delegate

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

上传和下载

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

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

自定义和回调

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

delegate trait默认实现,允许您以最小努力对其进行自定义。

服务器请求中的可选部分

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

Builder参数

通过使用method builders,您可以通过反复调用它的方法来准备一个动作调用。这些方法始终接受单个参数,以下语句成立。

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~346K SLoC