创建活动
<p>[TOC]</p>
<h5>简要描述</h5>
<ul>
<li>创建活动</li>
</ul>
<h5>请求URL</h5>
<ul>
<li><code>/activity/add</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>活动类型：<br/>1-充值活动；<br/>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>展示人群类型：<br/>0-全部用户；<br/>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>活动开始时间，<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;">endDate</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">DateTime</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;">limitType</td>
<td style="text-align: left;">是</td>
<td style="text-align: left;">Integer</td>
<td>参与限制条件：<br/>1-单用户每天参与上限；<br/>2-单用户累计参与上限；<br/>3-活动每天参与上限；<br/>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>前端展示活动有效期：<br/>0-不展示；<br/>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>是否展示弹窗：<br/>0-关闭；<br/>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>弹窗位置列表，当开启弹窗时赋值：<br/>弹窗位置，多选，分<br/><strong>小程序（短剧）：</strong><br/>1-小程序首页；<br/>2-追剧页；<br/>4-个人中心；<br/>8-继续观看；<br/>16-播放页。<br/><br/><strong>H5（小说）:</strong><br/>1-男频；<br/>2-女频；<br/>4-最近阅读；<br/>8-个人中心；<br/>16-分类；<br/>32-阅读页。<br/><br/>请根据所传子分销商 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> "获取活动模板列表")</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> "用户画像配置列表")</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> "获取商品列表")</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/add'
--header 'Auth-Id: 16190087260012544'
--header 'Authorization: 2Zibib8vgS6PdBfm'
--header 'Content-Type: application/json'
--data '{
&quot;partnerId&quot;: 197435649763xx472,
&quot;name&quot;: &quot;赠送金币-接口创建&quot;,
&quot;title&quot;: &quot;赠送金币&quot;,
&quot;activityType&quot;: 2,
&quot;showPersonType&quot;: 1,
&quot;startDate&quot;: &quot;2024-01-29T16:00:00.000Z&quot;,
&quot;endDate&quot;: &quot;2024-02-28T16:00:00.000Z&quot;,
&quot;limitType&quot;: 4,
&quot;limitTimes&quot;: 5,
&quot;feShowPeriodState&quot;: 1,
&quot;toastStat&quot;: 1,
&quot;toastPositionList&quot;: [
4,
1,
2,
8,
16,
32
],
&quot;portraitList&quot;: [
{
&quot;portraitId&quot;: 13,
&quot;portraitName&quot;: &quot;尾号偶数vip用户&quot;,
&quot;productId&quot;: &quot;28417527273226240&quot;,
&quot;productName&quot;: &quot;赠币商品名称&quot;
},
{
&quot;portraitId&quot;: 98,
&quot;portraitName&quot;: &quot;自定义厂商&quot;,
&quot;productId&quot;: &quot;28120505995501568&quot;,
&quot;productName&quot;: &quot;赠币&quot;
}
],
&quot;activityTemplateId&quot;: &quot;20554954553163776&quot;
}'</code></pre>
<h5>返回示例</h5>
<pre><code>{
&quot;code&quot;:0,
&quot;data&quot;:true,
&quot;msg&quot;:&quot;OK&quot;,
&quot;traceId&quot;:&quot;6882f602-b4ab-4510-81e9-e055f78ca6e5&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;">Boolean </td>
<td>是否创建成功 </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>