数据集成


动态替换作品内容,可实现动态数据/内容填充,实现制作提效或访客千人千面的应用需求;

在动态替换作品内容时,要替换的数据来源支持两种:接口方式和Excel导入方式。

接口方式

制作流程

  1. 开发接口,按照《查询动态数据》接口规范开发获取动态数据的接口。
  2. 配置接口,在控制台-集成管理-数据集成中配置开发的接口。
  3. 制作作品,创建作品,并配置动态替换的内容。
  4. 访客打开作品,根据接口返回的内容动态展示作品内容。

配置接口

在控制台-集成管理-数据集成中添加接口。

  • 接口地址:第1步开发好的接口地址。
  • 接口入参:在请求接口时携带的参数。
    • 填充模式:分为自动填充和手动填充。自动填充是在访客端动态渲染数据,手动填充是在编辑器端动态替换数据。
    • 名称:设置请求接口时携带的入参字段,包括:
      (1)访客相关,访问作品的用户相关信息。访客访问方式为“授权登录”时有效。
      (2)作品相关,访问作品的信息。访客访问方式为“授权登录”时有效。
      (3)其他,自定义字段。访客访问方式为“授权登录”时有效。
      (4)自定义。包括“访客填写”和“研发增加参数”,访客填写是在表单上输入的字段,研发增加参数是在作品访问链接上携带的参数。访客访问方式分别为“访客输入某字段”和“访问链接带参数”时有效。
    • 字段:请求接口时的字段名。
  • 接口出参:接口返回的参数。
    • 字段:响应的字段名,在配置作品时动态替换的名字,注意遵循一般代码的字段命名规则,不要添加一些特殊符号,如@、&等。
    • 类型:字段的类型,包含文本、图片和图表,其中图表应用于图表组件。

制作作品

(1)创建作品
(2)开启数据集成

选择玩法-数据集成-自动填充-开启。

  • 访客访问方式。不同的访问方式在请求接口时携带的入参不一样:
    • 授权登录:在自动填充模式下,且设置了访客相关字段会携带。
    • 访客输入某字段:会携带访客在作品中填写的表单参数。
    • 访问连接携带:为携带作品连接上的入参参数。
  • 参与用户类型。访客访问方式选择授权登录时需要设置授权方式。
  • 字段名称。访客访问方式选择“访客输入某字段”和“访问连接携带”时需要选择携带的字段。注意这里选择的字段分别对应控制台-数据集成-接口入参字段中“访客填写”和“研发增加参数”。
(3)配置字段
  • 设置入参字段

  • 设置显示文本字段

    注意:如果接口字段返回数据为0或者空时,可以设置字段显示方式。

  • 设置显示图表

  • 设置组合组件

  • 设置视频组件

  • 设置轮播图组件

    接口规范

  • 接口描述:查询动态数据

  • 请求方式:POST

  • Content-Type:application/json

  • 接口入参(开启加密):

    参数名 是否必须 参数类型 参数说明
    timestamp 必须 String 请求时的时间戳
    nonce 必须 String 随机字符串
    signature 必须 String 请求签名
    msgEncrypt 必须 String 加密后的消息,解密后的参数同不开启加密的参数
  • 接口入参(不开启加密)

    参数名 必须 参数类型 参数说明
    openId String 微信openId,微信授权有效
    thirdUserId String 自定义授权的userId,自定义授权有效
    creationId Long 作品id

    注意:以上未列举所有字段,所有字段参照数据集成接口入参的所有字段。只有配置了入参字段才会在请求接口时携带。

  • 请求示例

    {
      "openId": "oYy90xOy-sGx2_kiOYb2E2KcOIvA",
      "thirdUserId": "d0c8e4a470aa482b9720075d0859cdc2"
    }
    
  • 返回示例

    {
       "name":"XXX",
       "age":"A0001",
       "sex":"A0001",
       "chartXAxis": ['1月份', '2月份', '3月份', '4月份数据'], // 图表字段设置的“横轴数据”格式,即图表的维度字段。
       "chartYAxisData1": ["110","80","80","80"], // 图表字段返回的“图例”格式,即图表的数值字段,其中1、2、3分别对应图例1、图例2、图例3...
       "chartYAxisData2": ["90","80","80","80"],
       "chartYAxisData3": ["50","50","50","50"],
       "groupField1": { // 组合组件出参字段配置方式一
        "name": "name",
        "age": "age"
        },
      "groupField2": { // 组合组件出参字段配置方式二,__EQX_DYN_TYPE和data是固定属性,生成循环组件
      "__EQX_DYN_TYPE": "list",
      "data": 
          [
              {
              "name": "name",
              "age": "age"
              },
              {    
              "name": "name",
              "age": "age"
              }
          ]
      },
      "video1": "http://test-asset.eqxiu.cn/transcode/fe275256ce5b4bf5bc73d04ad3cb531c.mp4", // 视频出参字段配置方式一,参数类型【String】:只会修改视频链接
      "video2": { // 视频出参字段配置方式二,参数类型【Object】src和poster是固定属性,修改视频链接和视频封面,poster是封面字段
      "src": "http://test-asset.eqxiu.cn/transcode/c4bc513fa0f349c594bd1d9d9f450a0a.mp4",
      "poster": "https://test-asset.eqxiu.cn/8834deeb66184a81bd5345c1c0062f3e/2d95a624cfc24aa9895ce8fcd7082eea.png?imageMogr2/format/webp/quality/80/thumbnail/204x"
      }
    }
    
  • 稿件数据
    以下数据格式为稿件任务获取稿件数据的数据规范。

    • 入参:
      参数名 是否必须 参数类型 参数说明
      pageNo 必须 Integer 第几页
      pageSize 必须 Integer 每页多少条数据
      其他自定义入参
    • 出参:
      {
       "total": 5, //总条数
       "pageNo": 1, //当前第几页
       "pageSize": 5, //每页多少条数据
       "end": false
       "records": [ //数据
           {
               "id": 14651993, //数据唯一标识,必须返回且字段名为id,其他字段可以自定义
               "title": "新闻",
               "linkUrl": "https://www.eqxiu.cn/article/14651993",
               "imgUrl": "https://asset.eqxiu.cn/article/14651993.png",
               "taskCompleted": "已完成"
           },
           {
               "id": 14651994,
               "title": "新闻",
               "linkUrl": "https://www.eqxiu.cn/article/14651994",
               "imgUrl": "https://asset.eqxiu.cn/article/14651994.png",
               "taskCompleted": "已完成"
           }
       ],
      }
      
  • 错误返回示例

    {
      "EQS_REQ_CODE":-1
    }
    

Excel导入方式

采用接口的方式需要开发接口。有时候有固定的数据,希望直接在这些数据里动态替换数据,而不想开发接口。就可以采取Excel导入的方式。

导入数据

设置字段。在资源-我的数据-新建

导入数据。设置好字段后点击保存-下载Excel示例模板-填写数据-上传Excel文件,上传后就可以看到数据

制作作品

制作作品的流程和接口的方式一样。


强子 2025年4月9日 15:30 5116 收藏文档