RelatedArticleV2 - 相关推荐--内容定制-火山引擎

文档中心

导航

RelatedArticleV2 - 相关推荐

最近更新时间：2024.05.28 18:13:35首次发布时间：2021.10.18 11:12:18

火山引擎提供的H5详情页默认自带了相关推荐，当您需要实现Native的相关推荐时，可以通过此接口获取相关推荐数据，并自主实现UI。

使用场景

相关推荐Native VS H5实现方案

实现方案	优点	缺点	整体建议
Native	1.相关推荐列表页UI自定义能力更强； 2. 能够上报的信息更全	1. 开发成本相比h5高一些	建议
h5	1. 开发成本低一些	1.UI样式不支持自定义； 2. 上报的场景不全，比如home返回等，影响推荐效果 3.影响详情页停留时长统计，进而影响数据分析	不建议

请求说明

请求方式：GET/POST(Content-Type: application/x-www-form-urlencoded)
请求地址：https://mercury.volcengineapi.com/?Action=RelatedArticleV2&Version=2021-01-01
请求头：ServiceName:content

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	RelatedArticleV2	要执行的操作，取值：RelatedArticleV2。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
Partner	String	是	xxx_default_content	渠道号
AccessToken	String	是	AT6zTZuXzffxxxrBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12	用户唯一标识。
GroupId	String	是	7304704552752808499	内容id，获取此内容的相关推荐内容。
Os	String	是	iOS	操作系统，如 Android、iOS，主要用于推荐分析，提升推荐效果。注意 IOS系统如果没有正确传入此参数，返回的封面图可能为webp格式，导致图片解析失败。
ClientVersion	String	是	1.0.1	应用的版本号，比如1.0.1，主要用于数据排查，提升业务指标。
Count	String	否	10	指定返回的相关推荐内容条数，最多支持20条。说明由于算法后置过滤等逻辑，可能会存在返回条数不足的情况。
Dt	String	否	iphone15	设备型号，如iphone15、Galaxy，主要用于推荐分析，提升推荐效果。
DeviceBrand	String	否	Apple	设备厂商，如Apple、Samsung，主要用于推荐分析，提升推荐效果。
OsVersion	String	否	4.0.4	操作系统版本，如4.0.4，主要用于推荐分析，提升推荐效果。火山引擎侧内容详情页会根据此参数进行适配。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Result	Array of RelatedArticleInfo		相关推荐内容列表

请求示例

GET /?Action=RelatedArticleV2&Version=2021-01-01&Partner=xxx_default_content&AccessToken=AT6zTZuXzff******rBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&GroupId=7304704552752808499&Os=iOS&ClientVersion=1.0.1 HTTP/1.1
Host: https://mercury.volcengineapi.com/?Action=RelatedArticleV2&Version=2021-01-01
X-Date: 20240523T040612Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240523/cn-north-1/content/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240523141431029103053123A37E4B",
    "Action": "RelatedArticleV2",
    "Version": "2021-01-01",
    "Service": "content",
    "Region": "cn-north-1"
  },
  "Result": [
    {
      "Abstract": "-",
      "ArticleUrl": "https://open.toutiao.com/a7339733780258947636/?a_t=AT6zTZuXzffKpQa******v8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&biz_log=B35nBn1******WzN&channel_id=59503555988&form_scen=FROM_RELATED_ARTICLE&from_gid=7304704552752808499&group_id=7339733780258947636&isNews=1&item_id=7339733780258947636&label=related_news&req_id=20240523115316BBC15AF9F14222E4A7F8&utm_campaign=open&utm_medium=webview&utm_source=******_default_content",
      "GroupId": "7339733780258947636",
      "Title": "标题",
      "PublishTime": 1708914940,
      "ShareUrl": "https://open.toutiao.com/a7339733780258947636/?a_t=AT6zTZu******QamerBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&biz_log=BAC6******zRx&form_scen=FROM_RELATED_ARTICLE&group_id=7339733780258947636&isNews=1&label=share&req_id=20240523115316BBC15AF9F14222E4A7F8&utm_campaign=open&utm_medium=webview&utm_source=******_default_content",
      "ShareCount": 1000,
      "HasVideo": "true",
      "ArticleReadCount": 1000,
      "VideoWatchCount": 1000,
      "VideoDetail": {
        "VideoDuration": 2230.115,
        "VideoList": [
          {
            "Definition": "360p",
            "Height": 360,
            "Width": 640,
            "Url": "http://mercury.snssdk.com/video/url/?param=ZvBxCXxxxyK2je&partner=xxx_default_content&version=2&trans_vdata_to_content=1"
          }
        ]
      },
      "DiggCount": 1000,
      "CommentUrl": "https://open.toutiao.com/a7339733780258947636/comment/?a_t=AT6zTZuXzf******rBKVv8mp94LR2ARdNJBp2BT86GrLpa3brqLmscGCUipuJNh2piKTT12&biz_log=B35nBn1T******uWzN&form_scen=FROM_RELATED_ARTICLE&group_id=7339733780258947636&isNews=1&label=related_news&req_id=20240523115316BBC15AF9F14222E4A7F8&utm_source=******_default_content",
      "CommentCount": 1000,
      "CoverMode": 1,
      "ArticleType": "图文",
      "CoverImages": [
        {
          "Url": "https://p6-open-sign.byteimg.com/tos-cn-i-pk90l89vgd/1c6a1776374c4486a46a5a5cbb145ffa~tplv-tt-cut:3216:1810.jpeg?scene=content&x-expires=1747815830&x-signature=ElLytAjeIfSe2O2WkFMqOBY2VUw%3D",
          "Width": 3216,
          "Height": 1810
        }
      ],
      "UserInfo": {
        "AvatarUrl": "-",
        "Description": "-",
        "HomePage": "-",
        "Name": "-",
        "Follow": true,
        "FollowerCount": 0,
        "UserId": "-",
        "UserVerified": true,
        "VerifiedContent": "-"
      }
    }
  ]
}

错误码

您可访问公共错误码，获取更多错误码信息。