Skip to content

YZNotice 详解

Vajra Sheng edited this page Sep 5, 2023 · 10 revisions

YZNotice

YZNotice 是 AppSDK 提供给商家的一种事件通知,用来告知特定事件的发生,并提供相关参数,以便商家针对特定事件进行二次开发。

YZNotice 类型

目前所提供的类型如下:

YZNoticeTypeLogin

登录通知

收到该通知时代表需要登陆,请调用有赞云登陆态接口进行登陆,并将返回值通过 SDK 的接口设置给 YZSDK。

YZNoticeTypeShare

接收到分享结果的通知

回调数据:

{
  "imgurl" : "https:\/\/img.yzcdn.cn\/upload_files\/2018\/05\/22\/FrDnpHsNrKRZZL8PtVdWt6WHs0d-.png!200x200.jpg",
  "img_url" : "https:\/\/img.yzcdn.cn\/upload_files\/2018\/05\/22\/FrDnpHsNrKRZZL8PtVdWt6WHs0d-.png!200x200.jpg",
  "title" : "AppSDK测试-勿动勿删",
  "desc" : "AppSDK测试-勿动勿删 ¥0.01 会员折扣 0.01 运费: ¥0.00~3.00 剩余: 973 销量: 25 全程护航,请放心购买 Qi码是家馆子 线",
  "link" : "https:\/\/shop255245.youzan.com\/v2\/goods\/3ewlegud0qcjp?step=2"
}

说明

字段 说明
img_url 图片链接
imgurl 图片链接(为了兼容老版本微页面,新增imgurl字段,内容与img_url保持一致)
title 标题
desc 描述
link 页面链接

YZNoticeTypeReady

Web页面已准备好,可以调用分享接口,但不表示该页面本身是否支持分享。分享接口有返回数据的,该页面可分享;分享接口没有返回数据,则该页面不可分享

YZNoticeTypeAddToCart

商品被添加到购物车时的通知

{
  "sku_id" : "36200306",
  "alias" : "3ewlegud0qcjp",
  "pay_price" : "1",
  "title" : "AppSDK测试-勿动勿删",
  "num" : "1",
  "goods_cover" : "https:\/\/img.yzcdn.cn\/upload_files\/2018\/05\/22\/FrDnpHsNrKRZZL8PtVdWt6WHs0d-.png?imageView2\/2\/w\/100\/h\/100\/q\/75\/format\/png",
  "item_id" : "418975152"
}

说明

字段 说明
sku_id sku 的id
alias 商品别名
pay_price 商品价格,单位为分
title 商品标题
num 商品数量
goods_cover 商品大图 url
item_id 商品 id
title 商品标题

YZNoticeTypeBuyNow

用户点击立即购买时的通知

{
  "sku_id" : "36200306",
  "alias" : "3ewlegud0qcjp",
  "pay_price" : "1",
  "title" : "AppSDK测试-勿动勿删",
  "num" : "1",
  "goods_cover" : "https:\/\/img.yzcdn.cn\/upload_files\/2018\/05\/22\/FrDnpHsNrKRZZL8PtVdWt6WHs0d-.png?imageView2\/2\/w\/100\/h\/100\/q\/75\/format\/png",
  "item_id" : "418975152"
}
字段 说明
sku_id sku 的id
alias 商品别名
pay_price 商品价格,单位为分
title 商品标题
num 商品数量
goods_cover 商品大图 url
item_id 商品 id
title 商品标题

YZNoticeTypeAddUp

在购物车中点击结算时通知

回调数据:

{
    "goodsList": "" //value 是 json string
}

json string 内的数据如下:

[
    {
        "item_id":421736048,
        "sku_id":36197022,
        "alias":"2xlbwimcwfr39",
        "title":"【史上最强灭蟑神器】日本 安速小黑帽环保无毒灭蟑螂药12枚 家用强效灭蟑螂环保无毒无味",
        "num":1,
        "pay_price":14800,
        "selected":true
    },
    {
        "item_id":418975152,
        "sku_id":36200306,
        "alias":"3ewlegud0qcjp",
        "title":"AppSDK测试-勿动勿删",
        "num":3,
        "pay_price":1,
        "selected":true
    }
]
字段 说明
sku_id sku 的id
item_id 商品 id
alias 商品别名
pay_price 商品价格,单位为分
title 商品标题
num 商品数量
selected 是否勾选

YZNoticeTypePaymentFinished

付款完成时,进入支付结果页时回调

{
    "pay_type": 0,
    "status": 1,
    "tid": "E20180712171142040900001"
}
字段 说明
pay_type 支付类型,枚举值见下方
status 支付状态,枚举值见下方。注意:由于支付结果回调机制,目前只有成功的时候才会有回调。
tid 订单编号。可以通过有赞云上的开放接口查询订单相关信息。
pay_type 枚举值 说明
0 其他
1 微信支付
2 支付宝支付
3 储蓄卡支付
4 信用卡支付
5 储值支付(E卡 礼品卡 储值卡等)
6 他人代付
status 枚举值 说明
0 支付失败
1 支付成功

YZNoticeTypeAuthorizationSucceed

用户操作一键授权成功

YZNoticeTypeAuthorizationFailed

用户操作一键授权失败,response 中获取一键授权失败的 code 及 msg

示例代码:

case YZNoticeTypeAuthorizationFailed: {
    id response = notice.response;
    if (!response || ![response isKindOfClass:[NSDictionary class]]) {
        return;
    }
    NSDictionary *dict = (NSDictionary *)response;
    id message = [dict valueForKey:@"msg"];
    if (message && [message isKindOfClass:[NSString class]]) {
        NSString *msg = (NSString *)message;
        NSLog(@"授权失败====================> %@", msg);
    }
    break;
}
code 错误码 说明
1001 当前App不支持授权
1002 未开启手机号授权
1003 未找到手机号
1004 点击授权失败

YZNoticeTypeAccountCancellationSucceed

有赞账户注销成功

YZNoticeTypeAccountCancellationFailed

有赞账户注销失败

YZNoticeCustomAction

有赞自定义事件

示例代码:

- (void)webView:(YZWebView *)webView didReceiveNotice:(YZNotice *)notice {
  switch (notice.type) {
    case YZNoticeCustomAction:
      {
          NSLog(@"自定义事件----- %@", notice.response);
          break;
      }
  }
}

YZNoticeTypeAfterCreateOrder

订单创建后回调

{
  "orderNo": "E20230828190226044400013", // 订单号
  "orderFinalPrice": "0.00", // 订单最终支付金额
  "goodsList": [ // 商品列表
    {
      "goodsId": 970129100, // 商品ID
      "itemId": 100000, // 商品级 itemId
      "alias": "26yz19d3tvesy", // 商品别名
      "skuId": 37345205, // SKU ID
      "title": "尼莫的0.01商品(勿动勿动勿动勿动勿动勿动勿动勿动🙏🏻)", // 商品名称
      "num": 1, // 商品数量
      "isPresent": false, // 是否为赠品
      "goodsType": "normal" // 商品类型 normal = 实物商品; virtual = 普通虚拟商品; ecard = 电子卡券商品
    }
  ]
}

YZNoticeTypeOther = 0

其他通知,用户无需关心