google-people1 库允许访问 Google People 服务所有功能。

此文档是从 People 服务 版本 5.0.5+20240625 生成的，其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 people:v1 架构的确切修订版本。

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

特性

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

• 联系人组
• 批量获取、创建、删除、获取、列表、成员修改 和 更新
• 其他联系人
• 将其他联系人复制到我的联系人组、列表 和 搜索
• 人员
• 批量创建联系人，批量删除联系人，批量更新联系人，联系人列表，创建联系人，删除联系人，删除联系人照片，获取，批量获取，列出目录人员，搜索联系人，搜索目录人员，更新联系人以及更新联系人照片

本库的结构

API结构如下主要项目

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

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

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

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

或者具体...

let r = hub.contact_groups().members_modify(...).doit().await
let r = hub.contact_groups().batch_get(...).doit().await
let r = hub.contact_groups().create(...).doit().await
let r = hub.contact_groups().delete(...).doit().await
let r = hub.contact_groups().get(...).doit().await
let r = hub.contact_groups().list(...).doit().await
let r = hub.contact_groups().update(...).doit().await

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

使用方法

设置你的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_people1 as people1;
use people1::{Result, Error};
use std::default::Default;
use people1::{PeopleService, 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 = PeopleService::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.contact_groups().list()
             .sync_token("et")
             .page_token("magna")
             .page_size(-11)
             .group_fields(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()方法的返回值，或者作为可能的中级结果传递给中心代理，或者认证代理。

当代表处理错误或中间值时，他们有机会指示系统重试。这使得系统对各种错误具有潜在的抗压性。

上传和下载

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

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

定制和回调

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

默认实现了 代理特质，允许你以最小的努力进行定制。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

people1 库由 Sebastian Thiel 创建，并置于 MIT 许可之下。您可以在存储库的 许可证文件 中阅读全文。