野象新媒体接口文档

新媒体对外接口文档


推广链接列表

<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>内容类型:&lt;/br&gt;1-小说;&lt;/br&gt;2-短剧;&lt;/br&gt;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>起始创建时间,&lt;br/&gt;格式“yyyy-MM-dd HH:mm:ss”,&lt;/br&gt;例如:“2023-09-04 19:11:56”&lt;br/&gt;或者“yyyy-MM-dd”,&lt;/br&gt;例如:“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>结束创建时间,&lt;br/&gt;格式“yyyy-MM-dd HH:mm:ss”,&lt;/br&gt;例如:“2023-09-04 19:11:56”&lt;br/&gt;或者“yyyy-MM-dd”,&lt;/br&gt;例如:“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>{     &amp;quot;code&amp;quot;: 0,     &amp;quot;data&amp;quot;: {         &amp;quot;current&amp;quot;: 1,         &amp;quot;pages&amp;quot;: 7,         &amp;quot;records&amp;quot;: [             {                 &amp;quot;contentId&amp;quot;: 523996228159148032,                 &amp;quot;contentName&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;contentType&amp;quot;: 0,                 &amp;quot;minitorUrl&amp;quot;: null,                 &amp;quot;orderNum&amp;quot;: 0,                 &amp;quot;pagePath&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;promotionId&amp;quot;: &amp;quot;16949989645754368&amp;quot;,                 &amp;quot;promotionName&amp;quot;: &amp;quot;测试&amp;quot;,                 &amp;quot;readUv&amp;quot;: 0,                 &amp;quot;rechargeAmount&amp;quot;: 0,                 &amp;quot;rechargeUv&amp;quot;: 0,                 &amp;quot;subscribeUv&amp;quot;: 0, &amp;quot;adUv&amp;quot;: 4, &amp;quot;adPv&amp;quot;: 177, &amp;quot;adEstimateAmount&amp;quot;: 11745, &amp;quot;adRealAmount&amp;quot;: 11745, &amp;quot;estimateAllAmount&amp;quot;: 11786, &amp;quot;realAllAmount&amp;quot;: 11786, &amp;quot;keyBehaviorsUv&amp;quot;: 0, &amp;quot;keyBehaviorsUvRate&amp;quot;: 0, &amp;quot;schemeUrl&amp;quot;: &amp;quot;https://nm-client-redirect-test.zwlab.cn/video/schema?shortId=ZZJN3y&amp;quot;             },             {                 &amp;quot;contentId&amp;quot;: 523996228159148032,                 &amp;quot;contentName&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;contentType&amp;quot;: 0,                 &amp;quot;minitorUrl&amp;quot;: null,                 &amp;quot;orderNum&amp;quot;: 0,                 &amp;quot;pagePath&amp;quot;: &amp;quot;xxx&amp;quot;,                 &amp;quot;promotionId&amp;quot;: &amp;quot;16949627564072960&amp;quot;,                 &amp;quot;promotionName&amp;quot;: &amp;quot;测试&amp;quot;,                 &amp;quot;readUv&amp;quot;: 0,                 &amp;quot;rechargeAmount&amp;quot;: 0,                 &amp;quot;rechargeUv&amp;quot;: 0,                 &amp;quot;subscribeUv&amp;quot;: 0, &amp;quot;adUv&amp;quot;: 4, &amp;quot;adPv&amp;quot;: 177, &amp;quot;adEstimateAmount&amp;quot;: 11745, &amp;quot;adRealAmount&amp;quot;: 11745, &amp;quot;estimateAllAmount&amp;quot;: 11786, &amp;quot;realAllAmount&amp;quot;: 11786, &amp;quot;keyBehaviorsUv&amp;quot;: 0, &amp;quot;keyBehaviorsUvRate&amp;quot;: 0, &amp;quot;schemeUrl&amp;quot;: &amp;quot;https://nm-client-redirect-test.zwlab.cn/video/schema?shortId=ZZJN3y&amp;quot;             }         ],         &amp;quot;size&amp;quot;: 2,         &amp;quot;total&amp;quot;: 13     },     &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;,     &amp;quot;traceId&amp;quot;: &amp;quot;51ea9c07-a782-40e7-9742-e16c4b9fe9fb&amp;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>内容类型:&lt;/br&gt;1-小说;&lt;/br&gt;2-短剧;&lt;/br&gt;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> &quot;错误响应&quot;)页面描述</li> </ul>

页面列表

ITEM_HTML