目录

导入内容

功能介绍

应用服务端调用此接口后,能够同步内容信息,用于创建受众群组。

场景描述

当您的应用服务器自行收集了一些内容,而不是在App端侧直接上报的内容,同时您又希望将这些内容应用到高级分析提供的各种分析报告中,您可以在其应用服务器调用此接口,通过服务端上报其自行收集的内容。

使用约束

接口原型

承载协议

HTTPS POST

接口方向

开发者回调接口服务器->分析服务服务器

接口URL

{rootUrl}/analytics/datacollection/import/item

说明:

{rootUrl}:请参见接口访问路径获取。

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

Request Header

参数

是否必选

参数类型

描述

x-product-id

是

String

用户在AppGallery Connect上的Product ID。

x-app-id

是

String

用户在AppGallery Connect上的App ID。

Authorization

是

String

鉴权信息。请参见基于OAuth 2.0开放鉴权。

说明:

Bearer后面拼接空格,再拼接获取的access_token。

Request Body

参数

是否必选

参数类型

描述

data_type

是

Integer

数据类型,标记是否为内容。

固定填写为2。

item_set

是

List<item>

待导入的内容列表。

item数据结构说明

参数

是否必选

参数类型

描述

id

是

String

内容ID。

type

是

String

内容的类型,包括:

  • image
  • audio
  • video
  • article
  • item

status

否

int

内容是否可推荐,默认值为1。

  • 1:可推荐
  • 0:不可推荐

name

否

String

内容名称或者标题。

category

否

String

内容所属分类。如音乐,减压。

section

否

String

内容所属版块或频道。

weight

否

int

内容权重,权重越高,被优先推荐的概率越高,取值范围:1-100。如不设置,默认值为1。

duration

否

int

内容时长,单位为秒。

author

否

String

作者,多位作者使用英文逗号分隔。

brief

否

String

内容描述信息,例如简介、摘要、正文等关键片段,最长支持5000个中英文字符,超过则截断处理。

keyword

否

String

多个关键字使用英文逗号分隔。

language

否

String

使用ISO_639-1语言编码标准,如zh、en。

publish_time

否

long

发布时间,1970年到现在的毫秒数。

expire_time

否

long

失效时间,1970年到现在的毫秒数。如不设置,代表永不失效。

last_modify_time

否

long

最后修改时间,1970年到现在的毫秒数。

ext_info

否

Map<String, Object>

扩展字段,由用户指定扩展字段的key和value。

pv_cnt

否

long

一个月内曝光次数。

click_cnt

否

long

一个月内点击次数。

like_cnt

否

long

一个月内点赞次数。

unlike_cnt

否

long

一个月内踩次数。

comment_cnt

否

long

一个月内评论次数。

collect_cnt

否

long

一个月内收藏次数。

share_cnt

否

long

一个月内分享次数。

download_cnt

否

long

一个月内下载次数。

tip_cnt

否

long

一个月内打赏次数。

subscribe_cnt

否

long

一个月内关注次数。

请求示例

POST /analytics/datacollection/import/item HTTP/1.1
Content-Type: application/json; charset=UTF-8
Content-Length: xxxx
Accept: application/json
Authorization: Bearer 78C2395236BBF4262CAE4F1172E327C2929AD63EAA0395961A49DEBC3B6F8339 
x-product-id: sample-productid
x-app-id: sample-appid
 
{
    "data_type":2,
    "item_set":[
        {
            "id":"123",
            "type":"video",
            "status":1,
            "name":"sea",
            "category":"减压",
            "section":"XXX",
            "weight":1,
            "duration":200,
            "author":"Jack,Rose",
            "brief":"a love story",
            "keyword":"sea,jump,boat",
            "language":"en",
            "publish_time":1623841189000,
            "expire_time":1623841189000,
            "last_modify_time":1623841189000,
            "ext_info":{
                "brand":"huawei",
                "source":"vmall",
                "price":200
            },
            "pv_cnt":100,
            "click_cnt":100,
            "like_cnt":100,
            "unlike_cnt":100,
            "comment_cnt":100,
            "collect_cnt":100,
            "share_cnt":100,
            "download_cnt":100,
            "tip_cnt":100,
            "subscribe_cnt":100
        },
        {
            "id":"456",
            "type":"video",
            "status":1,
            "name":"cat",
            "category":"减压",
            "section":"XXX",
            "weight":1,
            "duration":200,
            "author":"Tom,Jerry",
            "brief":"a love story",
            "keyword":"cat,mouse",
            "language":"en",
            "publish_time":1623841189000,
            "expire_time":1623841189000,
            "last_modify_time":1623841189000,
            "ext_info":{
                "brand":"huawei",
                "source":"vmall",
                "price":200
            },
            "pv_cnt":100,
            "click_cnt":100,
            "like_cnt":100,
            "unlike_cnt":100,
            "comment_cnt":100,
            "collect_cnt":100,
            "share_cnt":100,
            "download_cnt":100,
            "tip_cnt":100,
            "subscribe_cnt":100
        }
    ]
}

响应参数

状态码为200时:

Response Header

参数

是否必选

参数类型

描述

Content-Type

是

application/json

响应消息的数据格式。

Response Body

参数

是否必选

参数类型

描述

result_code

是

String

响应码,请参见错误码。

result_msg

是

String

响应描述。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Connection:  Close
Content-Length: xxxx
 
{          
  "result_code":"0",
  "result_msg":"success"
}

错误码

状态码

错误码

描述

解决方法

200

0

请求成功。

-

400

10020

非法参数。

请修改填写错误的参数值。

400

19910

  • 鉴权请求超时,请稍后重试。
  • 鉴权服务器内部错误,请稍后重试。

请稍后重试。

Postman调试

您可以使用Postman在线调试此接口。