野象新媒体接口文档

新媒体对外接口文档


用户画像配置列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>获取用户画像配置列表</li> </ul> <h5>请求URL</h5> <ul> <li><code>/portrait/list</code></li> </ul> <h5>请求方式</h5> <ul> <li>GET</li> </ul> <h5>参数</h5> <table> <thead> <tr> <th style="text-align: left;">参数名    </th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明            </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">partnerId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Long</td> <td>分销商 ID(子分销商 ID)</td> </tr> <tr> <td style="text-align: left;">portraitName</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>画像名称</td> </tr> <tr> <td style="text-align: left;">pageIndex</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>页码:最小值 1  </td> </tr> <tr> <td style="text-align: left;">pageSize  </td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>页大小范围:[1, 100],即最小值为1,最大值为100</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{ &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;: { &amp;quot;current&amp;quot;: 1, &amp;quot;pages&amp;quot;: 1, &amp;quot;records&amp;quot;: [ { &amp;quot;appId&amp;quot;: &amp;quot;19743565588729856&amp;quot;, &amp;quot;config&amp;quot;: &amp;quot;[{\&amp;quot;key\&amp;quot;:\&amp;quot;product\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;gender\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;suffixUserId\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[],\&amp;quot;type\&amp;quot;:2}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;mobileSystem\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;registerTimeInfo\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;favoriteTimeInfo\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;interactTimeInfo\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;isCharge\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;isVIp\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[],\&amp;quot;type\&amp;quot;:1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;lastChargeDayAmount\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;lastChargeDayDiffNow\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;noChargeDayDiffNow\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;totalChargeAmount\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;totalChargeCount\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}, {\&amp;quot;key\&amp;quot;:\&amp;quot;readChapterNums\&amp;quot;,\&amp;quot;value\&amp;quot;:{\&amp;quot;list\&amp;quot;:[\&amp;quot;\&amp;quot;,\&amp;quot;\&amp;quot;],\&amp;quot;type\&amp;quot;:-1}}]&amp;quot;, &amp;quot;contentType&amp;quot;: 1, &amp;quot;createBy&amp;quot;: 19743565408374784, &amp;quot;createDateTime&amp;quot;: &amp;quot;2023-11-08 14:28:04&amp;quot;, &amp;quot;id&amp;quot;: 13, &amp;quot;name&amp;quot;: &amp;quot;尾号偶数vip用户&amp;quot;, &amp;quot;portraitItems&amp;quot;: [ { &amp;quot;key&amp;quot;: &amp;quot;product&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;gender&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;suffixUserId&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [], &amp;quot;type&amp;quot;: 2 } }, { &amp;quot;key&amp;quot;: &amp;quot;mobileSystem&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;registerTimeInfo&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;favoriteTimeInfo&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;interactTimeInfo&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;isCharge&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;isVIp&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [], &amp;quot;type&amp;quot;: 1 } }, { &amp;quot;key&amp;quot;: &amp;quot;lastChargeDayAmount&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;lastChargeDayDiffNow&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;noChargeDayDiffNow&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;totalChargeAmount&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;totalChargeCount&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } }, { &amp;quot;key&amp;quot;: &amp;quot;readChapterNums&amp;quot;, &amp;quot;value&amp;quot;: { &amp;quot;list&amp;quot;: [ &amp;quot;&amp;quot;, &amp;quot;&amp;quot; ], &amp;quot;type&amp;quot;: -1 } } ], &amp;quot;type&amp;quot;: 2, &amp;quot;updateDateTime&amp;quot;: &amp;quot;2023-11-08 14:28:04&amp;quot; } ], &amp;quot;size&amp;quot;: 100, &amp;quot;total&amp;quot;: 1 }, &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;, &amp;quot;traceId&amp;quot;: &amp;quot;f9d692d9-c624-4c56-88c0-e34ed6273327&amp;quot; }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名  </th> <th style="text-align: left;">类型    </th> <th>说明            </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code    </td> <td style="text-align: left;">Integer</td> <td>返回码          </td> </tr> <tr> <td style="text-align: left;">msg    </td> <td style="text-align: left;">String  </td> <td>返回消息        </td> </tr> <tr> <td style="text-align: left;">traceId</td> <td style="text-align: left;">String  </td> <td>链路追踪 ID      </td> </tr> <tr> <td style="text-align: left;">data    </td> <td style="text-align: left;">Object  </td> <td>分页用户画像配置列表响应</td> </tr> </tbody> </table> <h6>data 数据结构说明</h6> <table> <thead> <tr> <th style="text-align: left;">参数名  </th> <th style="text-align: left;">类型</th> <th>说明        </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">current</td> <td style="text-align: left;">Long</td> <td>分页-页码  </td> </tr> <tr> <td style="text-align: left;">pages  </td> <td style="text-align: left;">Long</td> <td>分页-总页数</td> </tr> <tr> <td style="text-align: left;">records</td> <td style="text-align: left;">List</td> <td>用户画像配置列表    </td> </tr> <tr> <td style="text-align: left;">size    </td> <td style="text-align: left;">Long</td> <td>分页-页大小</td> </tr> <tr> <td style="text-align: left;">total  </td> <td style="text-align: left;">Long</td> <td>分页-总行数</td> </tr> </tbody> </table> <h6>用户画像配置列表项结构说明</h6> <table> <thead> <tr> <th style="text-align: left;">参数名      </th> <th style="text-align: left;">类型    </th> <th>说明                  </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id          </td> <td style="text-align: left;">Integer</td> <td>用户画像 ID              </td> </tr> <tr> <td style="text-align: left;">name        </td> <td style="text-align: left;">String  </td> <td>用户画像名称              </td> </tr> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">Integer</td> <td>业务类型:2-MVP</td> </tr> <tr> <td style="text-align: left;">contentType</td> <td style="text-align: left;">Integer</td> <td>内容类型:&lt;/br&gt;0-全部;&lt;/br&gt;1-小说;&lt;/br&gt;2-短剧;&lt;/br&gt;4-短篇。</td> </tr> <tr> <td style="text-align: left;">config</td> <td style="text-align: left;">String</td> <td>用户画像配置 JSON 字符串</td> </tr> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">Long</td> <td>应用 ID</td> </tr> <tr> <td style="text-align: left;">createBy</td> <td style="text-align: left;">Long</td> <td>创建者</td> </tr> <tr> <td style="text-align: left;">createDateTime</td> <td style="text-align: left;">DateTime</td> <td>创建时间</td> </tr> <tr> <td style="text-align: left;">updateDateTime</td> <td style="text-align: left;">DateTime</td> <td>最后更新时间</td> </tr> <tr> <td style="text-align: left;">portraitItems</td> <td style="text-align: left;">List</td> <td>用户画像配置项列表</td> </tr> </tbody> </table> <h6><code>portraitItems</code> 用户画像配置项列表项结构说明</h6> <table> <thead> <tr> <th style="text-align: left;">参数名      </th> <th style="text-align: left;">类型    </th> <th>说明                  </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">key</td> <td style="text-align: left;">String</td> <td>配置项 Key</td> </tr> <tr> <td style="text-align: left;">value</td> <td style="text-align: left;">Object</td> <td>配置项 Value</td> </tr> </tbody> </table> <h6>配置项 <code>Value</code> 结构说明</h6> <table> <thead> <tr> <th style="text-align: left;">参数名      </th> <th style="text-align: left;">类型    </th> <th>说明                  </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">type</td> <td style="text-align: left;">Integer</td> <td>画像值类型,每个具体的配置项代表的含义不同</td> </tr> <tr> <td style="text-align: left;">list</td> <td style="text-align: left;">List&lt;Object&gt;</td> <td>类型的附属值列表</td> </tr> </tbody> </table> <h6>现有用户画像配置项说明</h6> <table> <thead> <tr> <th style="text-align: left;">配置项 Key      </th> <th style="text-align: left;">说明    </th> <th style="text-align: left;">type 值类型取值范围          </th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">product</td> <td style="text-align: left;">厂商,可以选择 -1-全部,或者自定义,支持多选,<code>list</code> 类型附属值列表的列表项为具体的厂商</td> <td style="text-align: left;">&amp;nbsp;1-华为;&lt;br/&gt;&amp;nbsp;2-荣耀;&lt;br/&gt;&amp;nbsp;3-oppo;&lt;br/&gt;&amp;nbsp;4-vivo;&lt;br/&gt;&amp;nbsp;5-小米;&lt;br/&gt;&amp;nbsp;6-meizu;&lt;br/&gt;&amp;nbsp;7-苹果;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">gender</td> <td style="text-align: left;">用户性别,单选</td> <td style="text-align: left;">&amp;nbsp;0-未知;&lt;br/&gt;&amp;nbsp;1-男;&lt;br/&gt;&amp;nbsp;2-女;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">suffixUserId</td> <td style="text-align: left;">用户尾号,单选</td> <td style="text-align: left;">&amp;nbsp;1-奇数用户;&lt;br/&gt;&amp;nbsp;2-偶数用户;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">mobileSystem</td> <td style="text-align: left;">手机系统,单选</td> <td style="text-align: left;">&amp;nbsp;1-IOS;&lt;br/&gt;&amp;nbsp;2-安卓;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">registerTimeInfo</td> <td style="text-align: left;">注册时间,单选</td> <td style="text-align: left;">&amp;nbsp;1-新用户;&lt;br/&gt;&amp;nbsp;2-老用户;&lt;br/&gt;&amp;nbsp;3-24小时以内;&lt;br/&gt;&amp;nbsp;4-大于多少天用户;&lt;br/&gt;&amp;nbsp;5-小于多少天用户;&lt;br/&gt;&amp;nbsp;6-自定义注册时间;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">favoriteTimeInfo</td> <td style="text-align: left;">关注时间,单选</td> <td style="text-align: left;">&amp;nbsp;1-自定义关注时间;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">interactTimeInfo</td> <td style="text-align: left;">互动时间,单选</td> <td style="text-align: left;">&amp;nbsp;1-大于等于;&lt;br/&gt;&amp;nbsp;2-小于等于;&lt;br/&gt;&amp;nbsp;3-自定义互动时间;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">isCharge</td> <td style="text-align: left;">充值属性,单选</td> <td style="text-align: left;">&amp;nbsp;1-未充值用户;&lt;br/&gt;&amp;nbsp;2-已充值用户;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">isVIp</td> <td style="text-align: left;">VIP 用户,单选</td> <td style="text-align: left;">&amp;nbsp;1-是;&lt;br/&gt;&amp;nbsp;2-否;&lt;br/&gt;-1-全部</td> </tr> <tr> <td style="text-align: left;">lastChargeDayAmount</td> <td style="text-align: left;">最近一笔充值金额,单选</td> <td style="text-align: left;">1-自定义充值金额;-1-全部</td> </tr> <tr> <td style="text-align: left;">lastChargeDayDiffNow</td> <td style="text-align: left;">最近一笔充值距今天数</td> <td style="text-align: left;">1-自定义天数;-1-全部</td> </tr> <tr> <td style="text-align: left;">noChargeDayDiffNow</td> <td style="text-align: left;">未付费天数</td> <td style="text-align: left;">1-自定义未付费天数;-1-全部</td> </tr> <tr> <td style="text-align: left;">totalChargeAmount</td> <td style="text-align: left;">累计充值金额</td> <td style="text-align: left;">1-自定义累计充值金额;-1-全部</td> </tr> <tr> <td style="text-align: left;">totalChargeCount</td> <td style="text-align: left;">累计充值次数</td> <td style="text-align: left;">1-自定义累计充值次数;-1-全部</td> </tr> <tr> <td style="text-align: left;">readChapterNums</td> <td style="text-align: left;">阅读章节数</td> <td style="text-align: left;">1-自定义阅读章节数;-1-全部</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>返回错误代码请查看[错误响应](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10903560257841502">https://www.showdoc.com.cn/gatewaypartnerv1/10903560257841502</a> &quot;错误响应&quot;)页面描述</li> </ul>

页面列表

ITEM_HTML