#content #google #google-api

google-content2

与购物内容(协议 v2)交互的完整库

48 个版本 (30 个稳定版)

5.0.5+20220303 2024年6月27日
5.0.4+20220303 2024年3月5日
5.0.3+20220303 2023年8月23日
5.0.2+20220303 2023年3月16日
0.1.2+20150317 2015年3月25日

#2005 in 网络编程

Download history 1/week @ 2024-05-17 59/week @ 2024-06-21 35/week @ 2024-06-28 8/week @ 2024-07-05

2,819 每月下载量
用于 google-content2-cli

MIT 许可证

1.5MB
21K SLoC

google-content2 库允许访问 Google 购物内容服务的所有功能。

本文档是根据 Shopping Content 组件版本 5.0.5+20220303 生成的,其中 20220303 是由 mako 代码生成器 v5.0.5 构建的 content:v2 架构的精确修订。

有关 Shopping Content v2 API 的其他信息,请参阅 官方文档网站

特性

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

本库的结构

API结构分为以下主要项

  • 中心
  • 资源
    • 您可以应用活动的主要类型
    • 属性和部分的集合
    • 部分
      • 属性的集合
      • 永远不会在活动中直接使用
  • 活动
    • 应用于资源的操作

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

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

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

或具体来说...

let r = hub.orders().acknowledge(...).doit().await
let r = hub.orders().advancetestorder(...).doit().await
let r = hub.orders().cancel(...).doit().await
let r = hub.orders().cancellineitem(...).doit().await
let r = hub.orders().canceltestorderbycustomer(...).doit().await
let r = hub.orders().createtestorder(...).doit().await
let r = hub.orders().createtestreturn(...).doit().await
let r = hub.orders().custombatch(...).doit().await
let r = hub.orders().get(...).doit().await
let r = hub.orders().getbymerchantorderid(...).doit().await
let r = hub.orders().gettestordertemplate(...).doit().await
let r = hub.orders().instorerefundlineitem(...).doit().await
let r = hub.orders().list(...).doit().await
let r = hub.orders().refund(...).doit().await
let r = hub.orders().rejectreturnlineitem(...).doit().await
let r = hub.orders().returnlineitem(...).doit().await
let r = hub.orders().returnrefundlineitem(...).doit().await
let r = hub.orders().setlineitemmetadata(...).doit().await
let r = hub.orders().shiplineitems(...).doit().await
let r = hub.orders().updatelineitemshippingdetails(...).doit().await
let r = hub.orders().updatemerchantorderid(...).doit().await
let r = hub.orders().updateshipment(...).doit().await

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

用法

设置您的项目

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

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

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_content2 as content2;
use content2::{Result, Error};
use std::default::Default;
use content2::{ShoppingContent, 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 = ShoppingContent::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.orders().list(79)
             .add_statuses("magna")
             .placed_date_start("no")
             .placed_date_end("ipsum")
             .page_token("voluptua.")
             .order_by("At")
             .max_results(93)
             .acknowledged(false)
             .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")

支持上传的方法可以使用最多两种不同的协议:简单可恢复。每种协议的独特之处体现在定制的doit(...)方法上,分别命名为upload(...)upload_resumable(...)

自定义和回调

您可以通过向 委托 提供一个 方法构建器 来修改调用 doit() 方法的方式,在执行最终的 doit() 调用之前。相应的方 法将被调用以提供进度信息,以及确定系统在失败时是否应该重试。

委托特质 默认实现,让您可以轻松地进行自定义。

服务器请求中的可选部分

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

构建器参数

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

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

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

Cargo 功能

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

许可证

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

依赖关系

~12–23MB
~345K SLoC