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

本文档是根据 Essentialcontacts 软件包版本 5.0.5+20240623 生成的，其中 20240623 是由 mako 代码生成器 v5.0.5 构建的 essentialcontacts:v1 架构的确切修订版。

关于 Essentialcontacts v1 API 的其他所有信息，请参阅 官方文档网站。

功能

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

• 文件夹
• 联系人计算、创建联系人、删除联系人、获取联系人、列出联系人、更新联系人 和 发送测试消息
• 组织
• 联系人计算，创建联系人，删除联系人，获取联系人，列出联系人，修改联系人以及发送测试消息
• 项目
• 联系人计算，创建联系人，删除联系人，获取联系人，列出联系人，修改联系人以及发送测试消息

本库的结构

API 结构如下主要项目

• 中心
  • 一个中央对象，用于维护状态并允许访问所有 活动
  • 创建 方法构建器，进而允许访问单个 调用构建器
• 资源
  • 你可以将其应用于 活动 的主要类型
  • 一组属性和 部分
  • 部分
    • 一组属性
    • 从未在 活动 中直接使用
• 活动
  • 应用于 资源 的操作

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

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

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

或者具体地说...

let r = hub.folders().contacts_create(...).doit().await
let r = hub.folders().contacts_get(...).doit().await
let r = hub.folders().contacts_patch(...).doit().await
let r = hub.organizations().contacts_create(...).doit().await
let r = hub.organizations().contacts_get(...).doit().await
let r = hub.organizations().contacts_patch(...).doit().await
let r = hub.projects().contacts_create(...).doit().await
let r = hub.projects().contacts_get(...).doit().await
let r = hub.projects().contacts_patch(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_essentialcontacts1 as essentialcontacts1;
use essentialcontacts1::api::GoogleCloudEssentialcontactsV1Contact;
use essentialcontacts1::{Result, Error};
use std::default::Default;
use essentialcontacts1::{Essentialcontacts, 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 = Essentialcontacts::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 = GoogleCloudEssentialcontactsV1Contact::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.folders().contacts_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(...)。

定制和回调

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

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

服务器请求的可选部分

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

构建器参数

通过使用方法构建器，你可以通过重复调用它的方法来准备一个操作调用。这些方法始终只接受一个参数，以下陈述对它都是真实的。

• PODs通过复制传递
• 字符串作为&str传递
• request values被移动

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

Cargo功能

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

许可证

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