#google #protocols #google-api #web #web-api #api #photos-library

google-photoslibrary1

一个完整的库,用于与照片库(协议 v1)交互

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

5.0.5+20240626 2024年6月27日
5.0.4+20240223 2024年3月5日
5.0.3+20230117 2023年8月24日
5.0.2+20230117 2023年3月16日
1.0.8+20181004 2018年10月14日

#2443 in 网页编程


google-photoslibrary1-cli 中使用

MIT 许可证

405KB
5K SLoC

google-photoslibrary1 库允许访问 Google 照片库服务的所有功能。

本文档是根据 照片库 包版本 5.0.5+20240626 生成的,其中 20240626 是由 mako 代码生成器 v5.0.5 构建的 photoslibrary:v1 架构的确切修订版本。

有关 照片库 v1 API 的其他信息,请参阅 官方文档网站

功能

从中央 枢纽 简单地处理以下 资源...

库的结构

API 结构如下几个主要元素

  • 中心对象
  • 资源
    • 主要类型,可以将 活动 应用到这些类型上
    • 属性和 部分 的集合
    • 部分
      • 属性的集合
      • 从未在 活动 中直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体来说...

let r = hub.albums().add_enrichment(...).doit().await
let r = hub.albums().batch_add_media_items(...).doit().await
let r = hub.albums().batch_remove_media_items(...).doit().await
let r = hub.albums().create(...).doit().await
let r = hub.albums().get(...).doit().await
let r = hub.albums().list(...).doit().await
let r = hub.albums().patch(...).doit().await
let r = hub.albums().share(...).doit().await
let r = hub.albums().unshare(...).doit().await
let r = hub.shared_albums().get(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_photoslibrary1 as photoslibrary1;
use photoslibrary1::{Result, Error};
use std::default::Default;
use photoslibrary1::{PhotosLibrary, 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 = PhotosLibrary::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.albums().list()
             .page_token("et")
             .page_size(-33)
             .exclude_non_app_created_data(true)
             .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")

支持上传的方法可以使用最多两种协议:简单可恢复。每种协议的独特性通过自定义的doit(...)方法来体现,这些方法分别命名为upload(...)upload_resumable(...)

定制和回调

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

代理特质具有默认实现,让您可以以最小的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

通过方法构建器,您可以通过反复调用其方法来准备一个动作调用。这些方法始终接受单个参数,以下语句对此适用。

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

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

Cargo功能

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

许可证

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

依赖关系

~12–23MB
~346K SLoC