google-customsearch1 库允许访问 Google CustomSearch API 服务的所有功能。

本文档是从 CustomSearch API 包版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 customsearch:v1 模式的确切修订版。

关于 CustomSearch API v1 API 的其他所有内容都可以在 官方文档网站 找到。

功能

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

• cse
• list 和 siterestrict list

本库的结构

API 被组织成以下主要项目

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

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

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

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

或者具体来说 ...

let r = hub.cse().siterestrict_list(...).doit().await
let r = hub.cse().list(...).doit().await

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

用法

设置项目

要使用此库，您需要在您的Cargo.toml文件中添加以下行

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_customsearch1 as customsearch1;
use customsearch1::{Result, Error};
use std::default::Default;
use customsearch1::{CustomSearchAPI, 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 = CustomSearchAPI::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.cse().siterestrict_list()
             .start(79)
             .sort("magna")
             .snippet_length(-11)
             .site_search_filter("ipsum")
             .site_search("voluptua.")
             .search_type("At")
             .safe("sanctus")
             .rights("sed")
             .related_site("amet.")
             .q("takimata")
             .or_terms("amet.")
             .num(-20)
             .lr("ipsum")
             .low_range("gubergren")
             .link_site("Lorem")
             .img_type("gubergren")
             .img_size("eos")
             .img_dominant_color("dolor")
             .img_color_type("ea")
             .hq("ipsum")
             .hl("invidunt")
             .high_range("amet")
             .googlehost("duo")
             .gl("ipsum")
             .filter("sed")
             .file_type("ut")
             .exclude_terms("gubergren")
             .exact_terms("rebum.")
             .date_restrict("est")
             .cx("ipsum")
             .cr("ipsum")
             .c2coff("est")
             .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代理或认证代理。

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

上传和下载

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

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

定制和回调

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

代理特质默认实现，允许您以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过使用方法构建器，您可以通过多次调用其方法来准备一个操作调用。这些方法始终接受单个参数，以下语句是真实的。

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

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

Cargo功能

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

许可协议

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