#google-api #google #protocols #web #web-api #mybusiness

google-mybusiness4

一个完整的库,用于与我的商业(协议v4)进行交互

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

5.0.5+0 2024年6月27日
5.0.4+0 2024年3月5日
5.0.3+0 2023年8月24日
5.0.2+0 2023年3月17日
1.0.12+0 2020年2月8日

#55 in #web-api


用于 google-mybusiness4-cli

MIT 许可证

1MB
13K SLoC

google-mybusiness4 库允许访问 Google My Business 服务的所有功能。

本文档由 My Business crate 版本 5.0.5+0 生成,其中 0 是由 mako 代码生成器 v5.0.5 构建的 mybusiness:v4 模式的确切修订版。

有关 My Business v4 API 的其他所有信息,请参阅 官方文档网站

功能

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

库的结构

API 结构如下主要项

  • 中心
  • 资源
    • 主要类型,您可以将 活动 应用到这些类型
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 活动 中永远不会直接使用
  • 活动
    • 应用于 资源 的操作

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

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

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

或具体...

let r = hub.accounts().admins_create(...).doit().await
let r = hub.accounts().admins_delete(...).doit().await
let r = hub.accounts().admins_list(...).doit().await
let r = hub.accounts().admins_patch(...).doit().await
let r = hub.accounts().invitations_accept(...).doit().await
let r = hub.accounts().invitations_decline(...).doit().await
let r = hub.accounts().invitations_list(...).doit().await
let r = hub.accounts().locations_admins_create(...).doit().await
let r = hub.accounts().locations_admins_delete(...).doit().await
let r = hub.accounts().locations_admins_list(...).doit().await
let r = hub.accounts().locations_admins_patch(...).doit().await
let r = hub.accounts().locations_followers_get_metadata(...).doit().await
let r = hub.accounts().locations_local_posts_create(...).doit().await
let r = hub.accounts().locations_local_posts_delete(...).doit().await
let r = hub.accounts().locations_local_posts_get(...).doit().await
let r = hub.accounts().locations_local_posts_list(...).doit().await
let r = hub.accounts().locations_local_posts_patch(...).doit().await
let r = hub.accounts().locations_local_posts_report_insights(...).doit().await
let r = hub.accounts().locations_media_customers_get(...).doit().await
let r = hub.accounts().locations_media_customers_list(...).doit().await
let r = hub.accounts().locations_media_create(...).doit().await
let r = hub.accounts().locations_media_delete(...).doit().await
let r = hub.accounts().locations_media_get(...).doit().await
let r = hub.accounts().locations_media_list(...).doit().await
let r = hub.accounts().locations_media_patch(...).doit().await
let r = hub.accounts().locations_media_start_upload(...).doit().await
let r = hub.accounts().locations_questions_answers_delete(...).doit().await
let r = hub.accounts().locations_questions_answers_list(...).doit().await
let r = hub.accounts().locations_questions_answers_upsert(...).doit().await
let r = hub.accounts().locations_questions_create(...).doit().await
let r = hub.accounts().locations_questions_delete(...).doit().await
let r = hub.accounts().locations_questions_list(...).doit().await
let r = hub.accounts().locations_questions_patch(...).doit().await
let r = hub.accounts().locations_reviews_delete_reply(...).doit().await
let r = hub.accounts().locations_reviews_get(...).doit().await
let r = hub.accounts().locations_reviews_list(...).doit().await
let r = hub.accounts().locations_reviews_update_reply(...).doit().await
let r = hub.accounts().locations_verifications_complete(...).doit().await
let r = hub.accounts().locations_verifications_list(...).doit().await
let r = hub.accounts().locations_associate(...).doit().await
let r = hub.accounts().locations_batch_get(...).doit().await
let r = hub.accounts().locations_batch_get_reviews(...).doit().await
let r = hub.accounts().locations_clear_association(...).doit().await
let r = hub.accounts().locations_create(...).doit().await
let r = hub.accounts().locations_delete(...).doit().await
let r = hub.accounts().locations_fetch_verification_options(...).doit().await
let r = hub.accounts().locations_find_matches(...).doit().await
let r = hub.accounts().locations_get(...).doit().await
let r = hub.accounts().locations_get_google_updated(...).doit().await
let r = hub.accounts().locations_list(...).doit().await
let r = hub.accounts().locations_patch(...).doit().await
let r = hub.accounts().locations_report_insights(...).doit().await
let r = hub.accounts().locations_transfer(...).doit().await
let r = hub.accounts().locations_verify(...).doit().await
let r = hub.accounts().create(...).doit().await
let r = hub.accounts().delete_notifications(...).doit().await
let r = hub.accounts().generate_account_number(...).doit().await
let r = hub.accounts().get(...).doit().await
let r = hub.accounts().get_notifications(...).doit().await
let r = hub.accounts().list(...).doit().await
let r = hub.accounts().list_recommend_google_locations(...).doit().await
let r = hub.accounts().update(...).doit().await
let r = hub.accounts().update_notifications(...).doit().await

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

用法

设置您的项目

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

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

一个完整的示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_mybusiness4 as mybusiness4;
use mybusiness4::{Result, Error};
use std::default::Default;
use mybusiness4::{MyBusiness, 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 = MyBusiness::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.accounts().locations_questions_list("parent")
             .page_token("magna")
             .page_size(-11)
             .order_by("ipsum")
             .filter("voluptua.")
             .answers_per_question(-27)
             .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")

支持上传的方法可以使用最多2种不同的协议:简单可恢复。每种方法的独特性由定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

自定义和回调

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

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

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖项

~12–23MB
~343K SLoC