# SFTP 回传方案

# 方案说明

相对于 pushlog 方案,sftp 方案对上传的文件大小无要求,满足大量数据的回传。
方案流程为:

  1. 依据回传字段整理为 json 数据组
  2. 文件为 text 文件,命名为年月日(回传哪天的数据就用那天的日期) 如 20190509;如果文件过大,可以分文件提供,在年月日后添加后缀即可,如 20190509-1
  3. 报告每日回传 1 次,当日回传前一天的数据
  4. 将报告写入的 SFTP 地址中指定的目录下(联系商务)
  5. 我方会定期在 SFTP 的此目录下取数据

# 回传案例

{"assetId":"T10022844685","rate":128,"playTime":56,"useTime":"2019-07-08 10:55:03","playType":"1","sourceType":"2",country":"CHN",province":"SHANDONG","deviceModel":"Iphone XS","terminalType":"ios 12.2.3","userId":"13687882777","resourceId":"782837","deviceId":"89sgh780styo"}
{"assetId":"T10022844685","rate":128,"playTime":56,"useTime":"2019-07-08 10:51:56","playType":"1","sourceType":"2",country":"CHN",province":"SHANDONG","deviceModel":"Iphone XS","terminalType":"ios 12.2.3","userId":"13687882777","resourceId":"782837","deviceId":"89sgh780styo"}
1
2

# 输入参数

| 回传字段 | **

类型** 是否必传 说明 示例
assetId string DMH 歌曲唯一编号

如何获取该字段,DMH 通过两种方式为客户提供音乐,DDEX 和 API,两种方式中获取该字段信息的方式为:

  1. DDEX__中  ResourceList->SoundRecording->SoundRecordingId->ProprietaryId(属性为 Namespace="DPID:PADPIDA2017121203R">)
    2. API 中的 assetId 字段 | T10022844685 |
    | rate | int | 否 | 播放歌曲的码率,包括 64、128、320(无损传接口提供的值) | 128 |
    | playTime | int | 否 | 播放歌曲的播放时长,单位秒 | 220 |
    | useTime | string | 是 | 歌曲的播放时间
    必须日期时间格式 | 2019-05-03 12:23:10 |
    | playType | string | 是 | 请查看“PlayType 可选值及其注释” | 1 |
    | sourceType | string | 否 | 歌曲播放的来源,如在专辑中播放歌曲。来源包括:
    1,资源(歌单/电台/榜单);2,专辑; 3,单曲;4,艺人;5,搜索;6,推荐
    使用 API 的客户传此值,DDEX 客户忽略 | 2 |
    | country | string | 是 | 歌曲播放时所在的国家(ISO 3166-1  三位国家代码) | CHN |
    | province | string | 否 | 歌曲播放时所在的地区(省)(格式为地区英文或拼音) | SHANDONG |
    | deviceModel | string | 否 | 歌曲播放的终端型号 | iPhone XS |
    | terminalType | string | 否 | 终端系统版本号 | ios 12.2.3 |
    | userId | string | 否 | 用户 Id 编码,建议给手机号
    当在使用推荐功能时,我们可以通过 userId 做更精准的个性化推荐 | 13600996666 |
    | resourceId | string | 否 | 歌曲附件 Id,如短音频,表示此次使用的对象为附件
    使用短音频片段的渠道,必须传该值 | 767899 |
    | deviceId | string | 否 | 设备激活码,当使用硬件相关服务时必传此字段 | 89sgh780styo |
    | source | string | 否 | 数据来源,用于标记数据的来源
    请标记数据来源,如果旗下有多个产品,请分别标记;此字段说明前,请与商务人员进行联系 | 129 |

# playType 可选值及其注释

注释
1 广告用户免费在线播放
2 广告用户免费下载
3 歌曲付费下载
4 短音频播放
5 短音频合成
6 短音频合成播放
7 公播在线播放
8 公播离线播放
9 设备激活
10 包月会员用户在线播放
11 包月会员下载(或缓存)
Last Updated: 12/25/2020, 2:41:19 PM