野象新媒体接口文档

新媒体对外接口文档


创建活动V2

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>创建活动接口第二版</li> </ul> <h5>请求URL</h5> <ul> <li><code>/activity/addV2</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</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;">name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>活动名称,仅在后台展示</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>活动标题,前端活动标题</td> </tr> <tr> <td style="text-align: left;">activityType</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;">showPersonType</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>展示人群类型:&lt;br/&gt;0-全部用户;&lt;br/&gt;1-按用户画像</td> </tr> <tr> <td style="text-align: left;">startDate</td> <td style="text-align: left;">是</td> <td style="text-align: left;">DateTime</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;">endDate</td> <td style="text-align: left;">是</td> <td style="text-align: left;">DateTime</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;">limitType</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-活动每天参与上限;&lt;br/&gt;4-活动累计参与上限</td> </tr> <tr> <td style="text-align: left;">limitTimes</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>限制次数,-1为不限制,不能为0,最大不得超过999999</td> </tr> <tr> <td style="text-align: left;">feShowPeriodState</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>前端展示活动有效期:&lt;br/&gt;0-不展示;&lt;br/&gt;1-展示</td> </tr> <tr> <td style="text-align: left;">toastStat</td> <td style="text-align: left;">是</td> <td style="text-align: left;">Integer</td> <td>是否展示弹窗:&lt;br/&gt;0-关闭;&lt;br/&gt;1-开启</td> </tr> <tr> <td style="text-align: left;">toastPositionList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Array</td> <td>弹窗位置列表,当开启弹窗时赋值:&lt;br/&gt;弹窗位置,多选,分&lt;br/&gt;<strong>小程序(短剧):</strong>&lt;br/&gt;1-小程序首页;&lt;br/&gt;2-追剧页;&lt;br/&gt;4-个人中心;&lt;br/&gt;8-继续观看;&lt;br/&gt;16-播放页。&lt;br/&gt;&lt;br/&gt;<strong>H5(小说):</strong>&lt;br/&gt;1-男频;&lt;br/&gt;2-女频;&lt;br/&gt;4-最近阅读;&lt;br/&gt;8-个人中心;&lt;br/&gt;16-分类;&lt;br/&gt;32-阅读页。&lt;br/&gt;&lt;br/&gt;请根据所传子分销商 ID,确定所属产品线,选择对应的弹窗位置值。</td> </tr> <tr> <td style="text-align: left;">activityTemplateId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>活动模板 ID,[获取活动模板列表](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10907643980188243">https://www.showdoc.com.cn/gatewaypartnerv1/10907643980188243</a> &quot;获取活动模板列表&quot;)</td> </tr> <tr> <td style="text-align: left;">productId</td> <td style="text-align: left;">否</td> <td style="text-align: left;">String</td> <td>商品 ID,<code>showPersonType</code> 为 0-全部用户时,赋值该参数</td> </tr> <tr> <td style="text-align: left;">portraitList</td> <td style="text-align: left;">否</td> <td style="text-align: left;">Array</td> <td>画像商品关系列表,<code>showPersonType</code> 为 1-按用户画像时,赋值该数组</td> </tr> </tbody> </table> <h6>画像商品关系列表 <code>portraitList</code> 项参数</h6> <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;">portraitId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>画像 ID,[用户画像配置列表](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10907070386792303">https://www.showdoc.com.cn/gatewaypartnerv1/10907070386792303</a> &quot;用户画像配置列表&quot;)</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;">productId</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>商品 ID, [获取商品列表](<a href="https://www.showdoc.com.cn/gatewaypartnerv1/10905852578950762">https://www.showdoc.com.cn/gatewaypartnerv1/10905852578950762</a> &quot;获取商品列表&quot;)</td> </tr> <tr> <td style="text-align: left;">productName</td> <td style="text-align: left;">是</td> <td style="text-align: left;">String</td> <td>商品名称</td> </tr> </tbody> </table> <h5>请求示例</h5> <pre><code class="language-cURL">curl --location 'https://gateway-partner.nm-serv.cn/activity/addV2' --header 'Auth-Id: 16190087260012544' --header 'Authorization: 2Zibib8vgS6PdBfm' --header 'Content-Type: application/json' --data '{ &amp;quot;appId&amp;quot;: 197435649763xx472, &amp;quot;name&amp;quot;: &amp;quot;赠送金币-接口创建&amp;quot;, &amp;quot;title&amp;quot;: &amp;quot;赠送金币&amp;quot;, &amp;quot;activityType&amp;quot;: 2, &amp;quot;showPersonType&amp;quot;: 1, &amp;quot;startDate&amp;quot;: &amp;quot;2024-01-29T16:00:00.000Z&amp;quot;, &amp;quot;endDate&amp;quot;: &amp;quot;2024-02-28T16:00:00.000Z&amp;quot;, &amp;quot;limitType&amp;quot;: 4, &amp;quot;limitTimes&amp;quot;: 5, &amp;quot;feShowPeriodState&amp;quot;: 1, &amp;quot;toastStat&amp;quot;: 1, &amp;quot;toastPositionList&amp;quot;: [ 4, 1, 2, 8, 16, 32 ], &amp;quot;portraitList&amp;quot;: [ { &amp;quot;portraitId&amp;quot;: 13, &amp;quot;portraitName&amp;quot;: &amp;quot;尾号偶数vip用户&amp;quot;, &amp;quot;productId&amp;quot;: &amp;quot;28417527273226240&amp;quot;, &amp;quot;productName&amp;quot;: &amp;quot;赠币商品名称&amp;quot; }, { &amp;quot;portraitId&amp;quot;: 98, &amp;quot;portraitName&amp;quot;: &amp;quot;自定义厂商&amp;quot;, &amp;quot;productId&amp;quot;: &amp;quot;28120505995501568&amp;quot;, &amp;quot;productName&amp;quot;: &amp;quot;赠币&amp;quot; } ], &amp;quot;activityTemplateId&amp;quot;: &amp;quot;20554954553163776&amp;quot; }'</code></pre> <h5>返回示例</h5> <pre><code>{     &amp;quot;code&amp;quot;: 0,     &amp;quot;data&amp;quot;: {         &amp;quot;activityId&amp;quot;: 101982148181377024,         &amp;quot;appId&amp;quot;: 19743565588729856,         &amp;quot;contentType&amp;quot;: 1,         &amp;quot;name&amp;quot;: &amp;quot;赠送金币-接口创建V2&amp;quot;,         &amp;quot;pageUrl&amp;quot;: &amp;quot;https://test-pond.zwlab.cn/activity/101982148181377024?max_app_id=19743565588729856&amp;quot;,         &amp;quot;title&amp;quot;: &amp;quot;赠送金币-接口创建&amp;quot;     },     &amp;quot;msg&amp;quot;: &amp;quot;OK&amp;quot;,     &amp;quot;traceId&amp;quot;: &amp;quot;bc72838f-b5d7-4b1f-9c1f-7c0bd5d2a7c3&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;">activityId  </td> <td style="text-align: left;">Long</td> <td>活动 ID    </td> </tr> <tr> <td style="text-align: left;">title    </td> <td style="text-align: left;">String</td> <td>活动标题  </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;">pageUrl    </td> <td style="text-align: left;">String</td> <td>活动页面  </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;">contentType</td> <td style="text-align: left;">Integer  </td> <td>内容类型:&lt;/br&gt;1-小说;&lt;/br&gt;2-短剧;&lt;/br&gt;4-短篇。  </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