推广链接列表
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>获取推广链接列表</li>
</ul>
<h5>请求 URL</h5>
<ul>
<li><code>/promotion/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;">promotionId </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Long </td>
<td>推广 ID </td>
</tr>
<tr>
<td style="text-align: left;">promotionName </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>推广名称 </td>
</tr>
<tr>
<td style="text-align: left;">promotionIdsStr</td>
<td style="text-align: left;">否</td>
<td style="text-align: left;">String</td>
<td>推广 ID 集合字符串,逗号分隔</td>
</tr>
<tr>
<td style="text-align: left;">contentId </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Long </td>
<td>内容 ID </td>
</tr>
<tr>
<td style="text-align: left;">contentName </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>内容名称 </td>
</tr>
<tr>
<td style="text-align: left;">contentType </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">Integer </td>
<td>内容类型:</br>1-小说;</br>2-短剧;</br>4-短篇。 </td>
</tr>
<tr>
<td style="text-align: left;">createTimeStart </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>起始创建时间,<br/>格式“yyyy-MM-dd HH:mm:ss”,</br>例如:“2023-09-04 19:11:56”<br/>或者“yyyy-MM-dd”,</br>例如:“2023-09-04”,包含起始创建时间</td>
</tr>
<tr>
<td style="text-align: left;">createTimeEnd </td>
<td style="text-align: left;">否 </td>
<td style="text-align: left;">String </td>
<td>结束创建时间,<br/>格式“yyyy-MM-dd HH:mm:ss”,</br>例如:“2023-09-04 19:11:56”<br/>或者“yyyy-MM-dd”,</br>例如:“2023-09-04”,包含结束创建时间 </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>{
&quot;code&quot;: 0,
&quot;data&quot;: {
&quot;current&quot;: 1,
&quot;pages&quot;: 7,
&quot;records&quot;: [
{
&quot;contentId&quot;: 523996228159148032,
&quot;contentName&quot;: &quot;xxx&quot;,
&quot;contentType&quot;: 0,
&quot;minitorUrl&quot;: null,
&quot;orderNum&quot;: 0,
&quot;pagePath&quot;: &quot;xxx&quot;,
&quot;promotionId&quot;: &quot;16949989645754368&quot;,
&quot;promotionName&quot;: &quot;测试&quot;,
&quot;readUv&quot;: 0,
&quot;rechargeAmount&quot;: 0,
&quot;rechargeUv&quot;: 0,
&quot;subscribeUv&quot;: 0,
&quot;adUv&quot;: 4,
&quot;adPv&quot;: 177,
&quot;adEstimateAmount&quot;: 11745,
&quot;adRealAmount&quot;: 11745,
&quot;estimateAllAmount&quot;: 11786,
&quot;realAllAmount&quot;: 11786,
&quot;keyBehaviorsUv&quot;: 0,
&quot;keyBehaviorsUvRate&quot;: 0,
&quot;schemeUrl&quot;: &quot;https://nm-client-redirect-test.zwlab.cn/video/schema?shortId=ZZJN3y&quot;
},
{
&quot;contentId&quot;: 523996228159148032,
&quot;contentName&quot;: &quot;xxx&quot;,
&quot;contentType&quot;: 0,
&quot;minitorUrl&quot;: null,
&quot;orderNum&quot;: 0,
&quot;pagePath&quot;: &quot;xxx&quot;,
&quot;promotionId&quot;: &quot;16949627564072960&quot;,
&quot;promotionName&quot;: &quot;测试&quot;,
&quot;readUv&quot;: 0,
&quot;rechargeAmount&quot;: 0,
&quot;rechargeUv&quot;: 0,
&quot;subscribeUv&quot;: 0,
&quot;adUv&quot;: 4,
&quot;adPv&quot;: 177,
&quot;adEstimateAmount&quot;: 11745,
&quot;adRealAmount&quot;: 11745,
&quot;estimateAllAmount&quot;: 11786,
&quot;realAllAmount&quot;: 11786,
&quot;keyBehaviorsUv&quot;: 0,
&quot;keyBehaviorsUvRate&quot;: 0,
&quot;schemeUrl&quot;: &quot;https://nm-client-redirect-test.zwlab.cn/video/schema?shortId=ZZJN3y&quot;
}
],
&quot;size&quot;: 2,
&quot;total&quot;: 13
},
&quot;msg&quot;: &quot;OK&quot;,
&quot;traceId&quot;: &quot;51ea9c07-a782-40e7-9742-e16c4b9fe9fb&quot;
}</code></pre>
<h5>返回参数说明</h5>
<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;">promotionId </td>
<td style="text-align: left;">String </td>
<td>推广 ID </td>
</tr>
<tr>
<td style="text-align: left;">promotionName </td>
<td style="text-align: left;">String </td>
<td>推广名称 </td>
</tr>
<tr>
<td style="text-align: left;">keywords</td>
<td style="text-align: left;">String</td>
<td>推广链接口令</td>
</tr>
<tr>
<td style="text-align: left;">contentId </td>
<td style="text-align: left;">Long </td>
<td>内容 ID </td>
</tr>
<tr>
<td style="text-align: left;">contentName </td>
<td style="text-align: left;">String </td>
<td>内容名称 </td>
</tr>
<tr>
<td style="text-align: left;">contentType </td>
<td style="text-align: left;">Integer </td>
<td>内容类型:</br>1-小说;</br>2-短剧;</br>4-短篇。 </td>
</tr>
<tr>
<td style="text-align: left;">readUv </td>
<td style="text-align: left;">Long </td>
<td>uv 阅读人数 </td>
</tr>
<tr>
<td style="text-align: left;">subscribeUv </td>
<td style="text-align: left;">Long </td>
<td>关注人数 </td>
</tr>
<tr>
<td style="text-align: left;">rechargeUv </td>
<td style="text-align: left;">Long </td>
<td>付费人数 </td>
</tr>
<tr>
<td style="text-align: left;">orderNum </td>
<td style="text-align: left;">Long </td>
<td>下单笔数 </td>
</tr>
<tr>
<td style="text-align: left;">rechargeAmount </td>
<td style="text-align: left;">Long </td>
<td>充值金额(单位分) </td>
</tr>
<tr>
<td style="text-align: left;">registers</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;">pagePath </td>
<td style="text-align: left;">String </td>
<td>推广链接 url </td>
</tr>
<tr>
<td style="text-align: left;">minitorUrl </td>
<td style="text-align: left;">String </td>
<td>监测链接 </td>
</tr>
<tr>
<td style="text-align: left;">shortUrl</td>
<td style="text-align: left;">String</td>
<td>推广短链</td>
</tr>
<tr>
<td style="text-align: left;">sumMemberNum</td>
<td style="text-align: left;">Long</td>
<td>累计加桌人数</td>
</tr>
<tr>
<td style="text-align: left;">sumExposureNum</td>
<td style="text-align: left;">Long</td>
<td>累计曝光人数</td>
</tr>
<tr>
<td style="text-align: left;">adUv</td>
<td style="text-align: left;">Long</td>
<td>广告观看人数</td>
</tr>
<tr>
<td style="text-align: left;">adPv</td>
<td style="text-align: left;">Long</td>
<td>广告曝光次数</td>
</tr>
<tr>
<td style="text-align: left;">adEstimateAmount</td>
<td style="text-align: left;">Long</td>
<td>广告预估收入(单位分)</td>
</tr>
<tr>
<td style="text-align: left;">adRealAmount</td>
<td style="text-align: left;">Long</td>
<td>广告实际收入(单位分)</td>
</tr>
<tr>
<td style="text-align: left;">estimateAllAmount</td>
<td style="text-align: left;">Long</td>
<td>预估总收入(单位分)</td>
</tr>
<tr>
<td style="text-align: left;">realAllAmount</td>
<td style="text-align: left;">Long</td>
<td>实际总收入(单位分)</td>
</tr>
<tr>
<td style="text-align: left;">keyBehaviorsUv</td>
<td style="text-align: left;">Long</td>
<td>关键行为达成人数</td>
</tr>
<tr>
<td style="text-align: left;">keyBehaviorsUvRate</td>
<td style="text-align: left;">Double</td>
<td>关键行为达成比率</td>
</tr>
<tr>
<td style="text-align: left;">schemeUrl</td>
<td style="text-align: left;">String</td>
<td>urlScheme链接</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> "错误响应")页面描述</li>
</ul>