野象新媒体接口文档

新媒体对外接口文档


创建推广链接

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>创建推广链接</li> </ul> <h5>请求URL</h5> <ul> <li><code>/promotion/add</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST<strong>(注意要使用POST+Json类型)</strong></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 和应用 ID 至少有一个不为 null</td> </tr> <tr> <td style="text-align: left;">appId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Long</td> <td>应用 ID,注意:子分销商 ID 和应用 ID 至少有一个不为 null</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;">promotionType      </td> <td style="text-align: left;">是  </td> <td style="text-align: left;">Integer</td> <td>推广方式:&lt;/br&gt;1-媒体投放;&lt;/br&gt;2-达人挂载。    </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;">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;">chapterId          </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Long    </td> <td>章节 ID                                                    </td> </tr> <tr> <td style="text-align: left;">chapterType        </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;3-链接维度</td> </tr> <tr> <td style="text-align: left;">chapterPriceType        </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;3-链接维度</td> </tr> <tr> <td style="text-align: left;">chapterPrice      </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Integer</td> <td>单章价格                                                    </td> </tr> <tr> <td style="text-align: left;">chapterPriceNo    </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Integer</td> <td>起始收费章节                                                </td> </tr> <tr> <td style="text-align: left;">rechargeGrTempId  </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Long    </td> <td>充值模板 ID                                                </td> </tr> <tr> <td style="text-align: left;">rechargeGrTempName</td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Stirng  </td> <td>充值模板名称                                                </td> </tr> <tr> <td style="text-align: left;">adBackId          </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Long    </td> <td>回传配置 ID,推广方式为媒体投放时必填                                                </td> </tr> <tr> <td style="text-align: left;">adBackName        </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">String  </td> <td>回传配置名称                                                </td> </tr> <tr> <td style="text-align: left;">followWindowState</td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Stirng  </td> <td>引导关注弹窗:0不展示 1展示                                                </td> </tr> <tr> <td style="text-align: left;">followChapterType  </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;3-链接维度</td> </tr> <tr> <td style="text-align: left;">followChapterNo    </td> <td style="text-align: left;">否  </td> <td style="text-align: left;">Integer</td> <td>关注章节编号                                                </td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{     &amp;quot;code&amp;quot;: 0,     &amp;quot;data&amp;quot;: {         &amp;quot;promotionId&amp;quot;: 10055235410333677,         &amp;quot;keywords&amp;quot;: &amp;quot;2pk&amp;quot;,         &amp;quot;miniAppUrl&amp;quot;: &amp;quot;pages/index/index?max_app_id=10055235410333696&amp;amp;max_pid=80354051485081600&amp;amp;contentId=523996228159148032&amp;amp;chapterId=523996281615552512&amp;quot;,         &amp;quot;monitorUrl&amp;quot;: null,         &amp;quot;pagePath&amp;quot;: &amp;quot;pages/index/index?max_app_id=10055235410333696&amp;amp;contentId=523996228159148032&amp;amp;chapterId=523996281615552512&amp;amp;max_pid=80354051485081600&amp;quot;,         &amp;quot;shortUrl&amp;quot;: &amp;quot;https://nm-client-redirect-test.zwlab.cn/video/link?shortId=ZZJN3y&amp;quot;, &amp;quot;schemeUrl&amp;quot;:&amp;quot;https://nm-client-redirect-test.zwlab.cn/video/scheme?shortId=ZZJN3y&amp;quot;     },     &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;,     &amp;quot;traceId&amp;quot;: &amp;quot;c5c89708-dba4-4f0d-9551-afaa70103cea&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>创建推广链接响应结构</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;">Long    </td> <td>推广链接 ID              </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;">miniAppUrl</td> <td style="text-align: left;">String    </td> <td>小程序 url                </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;">minitorUrl</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;">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