google-firebase1_beta1 库允许访问 Google Firebase 管理服务的所有功能。

本文档是从 Firebase 管理 crate 版本 5.0.5+20240624 生成的，其中 20240624 是由 mako 代码生成器 v5.0.5 构建的 firebase:v1beta1 架构的确切修订版。

有关 Firebase 管理 v1_beta1 API 的其他信息，请参阅 官方文档网站。

功能

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

• 可用项目
• 列表
• 操作
• 获取
• 项目
• 添加Firebase，添加Google Analytics，创建Android应用，获取Android应用，获取Android应用配置，列出Android应用，修改Android应用，删除Android应用，创建Android应用的SHA，删除Android应用的SHA，列出Android应用的SHA，恢复Android应用，列出可用位置，最终化默认位置，获取，获取管理SDK配置，获取分析详情，创建iOS应用，获取iOS应用，获取iOS应用配置，列出iOS应用，修改iOS应用，删除iOS应用，恢复iOS应用，列出，修改，移除分析，搜索应用，创建Web应用，获取Web应用，获取Web应用配置，列出Web应用，修改Web应用，删除Web应用以及恢复Web应用

库结构

API结构分为以下主要项目

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

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

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

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

或者具体...

let r = hub.operations().get(...).doit().await
let r = hub.projects().android_apps_create(...).doit().await
let r = hub.projects().android_apps_remove(...).doit().await
let r = hub.projects().android_apps_undelete(...).doit().await
let r = hub.projects().default_location_finalize(...).doit().await
let r = hub.projects().ios_apps_create(...).doit().await
let r = hub.projects().ios_apps_remove(...).doit().await
let r = hub.projects().ios_apps_undelete(...).doit().await
let r = hub.projects().web_apps_create(...).doit().await
let r = hub.projects().web_apps_remove(...).doit().await
let r = hub.projects().web_apps_undelete(...).doit().await
let r = hub.projects().add_firebase(...).doit().await
let r = hub.projects().add_google_analytics(...).doit().await

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

使用方法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_firebase1_beta1 as firebase1_beta1;
use firebase1_beta1::api::AndroidApp;
use firebase1_beta1::{Result, Error};
use std::default::Default;
use firebase1_beta1::{FirebaseManagement, 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 = FirebaseManagement::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 = AndroidApp::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.projects().android_apps_create(req, "parent")
             .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的一部分，您应该读取它以获取媒体。如果此方法还支持ResponseResult()，它将默认返回。您可以将它视为实际媒体的元数据。要触发媒体下载，您必须通过此调用设置构建器：.param("alt", "media")。

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

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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