#google #web #protocols #google-api #web-api #api #mybusinessplaceactio

google-mybusinessplaceactions1

一个完整的库,用于与我的商业场所操作(协议 v1)交互

8 个版本 (稳定版)

5.0.5+20240625 2024年6月27日
5.0.4+20240304 2024年3月5日
5.0.3+20230124 2023年8月24日
5.0.2+20230124 2023年3月16日
3.0.0+20220305 2022年3月8日

#2601 in 网页编程


google-mybusinessplaceact… 中使用

MIT 许可协议

170KB
2K SLoC

google-mybusinessplaceactions1 库允许访问 Google My Business Place Actions 服务(协议 v1)的所有功能。

本文档是根据 My Business Place Actions 库版本 5.0.5+20240625 生成的,其中 20240625 是由 mako 代码生成器 v5.0.5 构建的 mybusinessplaceactions:v1 方案的精确修订。

有关 My Business Place Actions v1 API 的其他信息,请参阅 官方文档站点

功能

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

本库的结构

API 被组织成以下主要项目

  • 枢纽
    • 一个中心对象,用于维护状态并允许访问所有 活动
    • 创建 方法构建器,这些构建器反过来允许访问单个 调用构建器
  • 资源
    • 主要类型,您可以将其应用于 活动
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 永远不会直接用于 活动
  • 活动
    • 应用于 资源 的操作

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

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

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

或者具体来说...

let r = hub.locations().place_action_links_create(...).doit().await
let r = hub.locations().place_action_links_get(...).doit().await
let r = hub.locations().place_action_links_patch(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_mybusinessplaceactions1 as mybusinessplaceactions1;
use mybusinessplaceactions1::api::PlaceActionLink;
use mybusinessplaceactions1::{Result, Error};
use std::default::Default;
use mybusinessplaceactions1::{MyBusinessPlaceActions, 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 = MyBusinessPlaceActions::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 = PlaceActionLink::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.locations().place_action_links_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() 方法的调用方式。在最终调用 doit() 之前,将调用相应的方法来提供进度信息,并确定系统在失败时应否重试。

代理特质 默认实现,您可以用最少的努力进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~342K SLoC