野象新媒体接口文档

新媒体对外接口文档


回传策略列表

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>获取回传策略列表</li> </ul> <h5>请求 URL</h5> <ul> <li><code>/report/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;">appId        </td> <td style="text-align: left;">是  </td> <td style="text-align: left;">Long        </td> <td>应用 ID (分销商管理-获取子分销商专员列表-接口获取)                    </td> </tr> <tr> <td style="text-align: left;">id      </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Long        </td> <td>策略 ID                      </td> </tr> <tr> <td style="text-align: left;">name    </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]            </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;82090546776248320&amp;quot;, &amp;quot;id&amp;quot;: &amp;quot;108522122473123840&amp;quot;, &amp;quot;name&amp;quot;: &amp;quot;网关策略测试&amp;quot;, &amp;quot;amountRuleJson&amp;quot;: &amp;quot;[{\&amp;quot;less\&amp;quot;:1,\&amp;quot;max\&amp;quot;:2000,\&amp;quot;meet\&amp;quot;:2,\&amp;quot;min\&amp;quot;:1000,\&amp;quot;type\&amp;quot;:3},{\&amp;quot;less\&amp;quot;:0,\&amp;quot;max\&amp;quot;:3000,\&amp;quot;meet\&amp;quot;:0,\&amp;quot;min\&amp;quot;:2000,\&amp;quot;type\&amp;quot;:2}]&amp;quot;, &amp;quot;appName&amp;quot;: &amp;quot;zt4-dpks11&amp;quot;, &amp;quot;createDateTime&amp;quot;: &amp;quot;2024-04-09 11:08:12&amp;quot;, &amp;quot;leastOrderTrackCount&amp;quot;: 2, &amp;quot;leastOrderTrackTimes&amp;quot;: 1, &amp;quot;lessOrderTrackCount&amp;quot;: 0, &amp;quot;meetOrderTrackCount&amp;quot;: 0, &amp;quot;memberType&amp;quot;: 0, &amp;quot;missStrategy&amp;quot;: 2, &amp;quot;orderAmountFilter&amp;quot;: 1, &amp;quot;rechargeType&amp;quot;: 0, &amp;quot;reportGap&amp;quot;: 5, &amp;quot;reportMinAmount&amp;quot;: 1000, &amp;quot;reportStrategy&amp;quot;: 1, &amp;quot;reportTarget&amp;quot;: &amp;quot;&amp;quot;, &amp;quot;reportTimeType&amp;quot;: 8, &amp;quot;reportType&amp;quot;: 4, &amp;quot;roiType&amp;quot;: 0, &amp;quot;startStrategy&amp;quot;: 1, &amp;quot;updateDateTime&amp;quot;: &amp;quot;2024-04-09 15:16:45&amp;quot;, &amp;quot;vipTrackState&amp;quot;: 1 } ], &amp;quot;size&amp;quot;: 20, &amp;quot;total&amp;quot;: 1 }, &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;, &amp;quot;traceId&amp;quot;: &amp;quot;484dc382-0ba3-436e-9cb3-9af6dfb87a0a&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;">appId          </td> <td style="text-align: left;">是  </td> <td>Long    </td> <td>应用 ID (分销商管理-获取子分销商专员列表-接口获取)                                              </td> </tr> <tr> <td style="text-align: left;">id          </td> <td style="text-align: left;">是  </td> <td>Long    </td> <td>策略 ID                                              </td> </tr> <tr> <td style="text-align: left;">name      </td> <td style="text-align: left;">是  </td> <td>String  </td> <td>策略名称 (自行根据业务需要设置)                                                  </td> </tr> <tr> <td style="text-align: left;">reportTarget      </td> <td style="text-align: left;">否  </td> <td>String</td> <td>激活回传目标                                                 </td> </tr> <tr> <td style="text-align: left;">reportGap          </td> <td style="text-align: left;">否  </td> <td>Integer    </td> <td>用户染色期: 0关闭; 大于0开启,间隔小时数                                                    </td> </tr> <tr> <td style="text-align: left;">reportStrategy        </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>上报策略: 0默认; 1自定义; 2累积金额                                                    </td> </tr> <tr> <td style="text-align: left;">reportTimeType          </td> <td style="text-align: left;">否  </td> <td>Integer    </td> <td>上报时间类型,新用户指定小时内,0代表当天                                                    </td> </tr> <tr> <td style="text-align: left;">rechargeType        </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>充值类型: 0全部;1首充</td> </tr> <tr> <td style="text-align: left;">reportMinAmount      </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>最低上报金额: 分                                                    </td> </tr> <tr> <td style="text-align: left;">memberType    </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>仅回传新用户: 0全部用户 1新用户                                                </td> </tr> <tr> <td style="text-align: left;">missStrategy  </td> <td style="text-align: left;">否  </td> <td>Integer    </td> <td>漏单策略: 0全部上报; 1:自定义循环; 2:自定义金额                                                </td> </tr> <tr> <td style="text-align: left;">meetOrderTrackCount</td> <td style="text-align: left;">否  </td> <td>Integer  </td> <td>连续XX单                                                </td> </tr> <tr> <td style="text-align: left;">lessOrderTrackCount          </td> <td style="text-align: left;">否  </td> <td>Integer    </td> <td>空XX单                                                </td> </tr> <tr> <td style="text-align: left;">amountRuleJson        </td> <td style="text-align: left;">否  </td> <td>string  </td> <td>按金额大小逻辑json串, min:最小值(包含) max:最大值(不包含) type: 1全上报 2全不上报 3自定义 meet:连续几单 less:空几单 示例: [{&quot;min&quot;:1,&quot;max&quot;:10,&quot;type&quot;:3,&quot;meet&quot;:2,&quot;less&quot;:1}]</td> </tr> <tr> <td style="text-align: left;">vipTrackState  </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>会员金额是否上报: 0不上报;1上报          </td> </tr> <tr> <td style="text-align: left;">startStrategy    </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>起量策略: 0关闭; 1开启                                                </td> </tr> <tr> <td style="text-align: left;">leastOrderTrackCount    </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>每日先上报XX单                                                </td> </tr> <tr> <td style="text-align: left;">leastOrderTrackTimes    </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>轮数                                                </td> </tr> <tr> <td style="text-align: left;">orderAmountFilter    </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>先回传订单是否按金额过滤: 0不过滤; 1过滤                                                </td> </tr> <tr> <td style="text-align: left;">roiType    </td> <td style="text-align: left;">否  </td> <td>Integer</td> <td>ROI全量上报: 0不开启; 1开启                                                </td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML