# Offer 创建 API

```
POST https://api.offer18.com/api/m/offer_create
```

:link: [<mark style="color:蓝色;">**点击测试 Offer Create API**</mark>](https://offer18.readme.io/reference/offers-api)

### 通用参数

| **查询**     | **类型** | **描述**    |
| ---------- | ------ | --------- |
| mid        | 整数     | 网络账户 ID   |
| api-key    | 字符串    | 网络 API 密钥 |
| secret-key | 字符串    | 网络密钥      |

**操作**

<table data-header-hidden><thead><tr><th width="207.16379474883627"></th><th width="194.99924751175493"></th><th></th></tr></thead><tbody><tr><td><strong>查询</strong></td><td><strong>类型</strong></td><td><strong>描述</strong></td></tr><tr><td>type</td><td>字符串</td><td><strong>允许的值：</strong><br>create / update</td></tr><tr><td>oid</td><td>整数</td><td>在更新 Offer 时必需</td></tr></tbody></table>

***

### **字段**&#x20;

<table data-header-hidden data-full-width="false"><thead><tr><th width="329.1820791993198"> </th><th width="124"> </th><th width="293.1921073532865"> </th></tr></thead><tbody><tr><td><strong>主体</strong></td><td><strong>类型</strong></td><td><strong>描述</strong></td></tr><tr><td>offer_name</td><td>字符串</td><td>活动名称</td></tr><tr><td>advertiser_id</td><td>整数</td><td>广告主 ID </td></tr><tr><td>offer_url</td><td>URL</td><td>活动的 URL</td></tr><tr><td>external_offer_id</td><td>字符串</td><td>外部活动 ID（如果有）</td></tr><tr><td>app_id</td><td>字符串</td><td>应用 ID（如果有）</td></tr><tr><td>logo</td><td>URL</td><td>活动徽标的 URL</td></tr><tr><td>category</td><td>字符串</td><td>活动类别</td></tr><tr><td>preview_url</td><td>URL</td><td>活动的预览 URL</td></tr><tr><td>currency</td><td>字符串</td><td><p>Offer 的货币</p><p><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#currency"><mark style="color:蓝色;">查看货币</mark></a></p></td></tr><tr><td>price_advertiser</td><td>小数</td><td>广告主为活动提供的价格</td></tr><tr><td>price_affiliate</td><td>小数</td><td>给予联盟的活动价格</td></tr><tr><td>model_advertiser</td><td>字符串</td><td>活动的广告主模型<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#models"><mark style="color:蓝色;">查看模型</mark></a></td></tr><tr><td>model_affiliate</td><td>字符串</td><td>活动的广告主模型<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#models"><mark style="color:蓝色;">查看模型</mark> </a></td></tr><tr><td>hide_affiliate_payout</td><td>整数</td><td>允许的值 <br><strong>1:</strong> 隐藏联盟支付</td></tr><tr><td>start_datetime</td><td>UTC 时间戳</td><td>开始日期/时间<br>(YYYY-MM-DD HH:MM:SS) </td></tr><tr><td>end_datetime</td><td>UTC 时间戳</td><td>结束日期/时间<br>(YYYY-MM-DD HH:MM:SS )</td></tr><tr><td>visibility</td><td>字符串</td><td><strong>允许的值：</strong><br>public, permission, private</td></tr><tr><td>status</td><td>字符串</td><td><strong>允许的值：</strong> approve, pending</td></tr><tr><td>deep_links</td><td>整数</td><td>允许的值<br><strong>1:</strong> 启用 Offer 中的深度链接</td></tr><tr><td>offer_terms</td><td>字符串</td><td>活动条款</td></tr><tr><td>offer_kpi</td><td>字符串</td><td>活动的 KPI 条款</td></tr><tr><td>private_note</td><td>字符串</td><td>活动的私人备注</td></tr><tr><td>imps_url</td><td>URL</td><td>展示 URL</td></tr><tr><td>landing_page_name_1</td><td>字符串</td><td>第一着陆页的名称 </td></tr><tr><td>landing_page_url_1</td><td>URL</td><td>活动第一着陆页的 URL</td></tr><tr><td>landing_page_name_2</td><td>字符串</td><td>第二着陆页的名称</td></tr><tr><td>landing_page_url_2</td><td>URL</td><td>活动第二着陆页的 URL</td></tr><tr><td>creatives</td><td>URL</td><td>活动素材的 URL</td></tr><tr><td>fallback</td><td>布尔值</td><td>允许的值：<br><strong>1:</strong> 启用回退</td></tr><tr><td>fallback_offer_id</td><td>整数</td><td>回退的 Offer ID</td></tr><tr><td>fallback_url</td><td>URL</td><td>回退的 URL</td></tr><tr><td>fraud_conv_speed</td><td>整数</td><td>以秒为单位的时间</td></tr><tr><td>proxy_block</td><td>整数</td><td>允许的值：<br><strong>1:</strong> 阻止代理</td></tr><tr><td>blank_ref_block</td><td>整数</td><td>允许的值：<br><strong>1:</strong> 阻止空引用</td></tr><tr><td>hide_referral</td><td>整数</td><td>允许的值：<br><strong>1:</strong> 隐藏推荐</td></tr><tr><td>assign_affiliates</td><td>整数</td><td>将联盟分配到此活动<br>（逗号分隔的值）</td></tr><tr><td>capping_rule_id</td><td>字符串</td><td>如果用户想更新现有封顶规则</td></tr><tr><td>capping[0][capping_rule_name]</td><td>字符串</td><td>封顶规则名称 </td></tr><tr><td>capping[0][capping_rule_type]</td><td>字符串</td><td>封顶规则类型 <br>1. <strong>advertiser_capping</strong><br>2. <strong>affiliate_capping</strong></td></tr><tr><td>capping[0][capping_timezone]</td><td>时间戳</td><td>封顶时区</td></tr><tr><td>capping[0][capping_events]</td><td>字符串</td><td>封顶事件</td></tr><tr><td>capping[0][capping_type]</td><td>字符串</td><td>封顶类型<br>1. <strong>gross_conversions</strong><br>2. <strong>approved_conversions</strong><br>3. <strong>gross_revenue</strong><br>4. <strong>approved_revenue</strong><br>5. <strong>gross_payout</strong><br>6. <strong>approved_payout</strong><br>7. <strong>gross_clicks</strong><br>8. <strong>approved_clicks</strong></td></tr><tr><td>capping[0][capping_period]</td><td>字符串</td><td>封顶周期<br>1. <strong>daily</strong><br>2. <strong>weekly</strong><br>3. <strong>monthly</strong><br>4. <strong>hourly</strong></td></tr><tr><td>capping[0][capping_value]</td><td>整数</td><td>封顶值</td></tr><tr><td>capping[0][overcap_action]</td><td>字符串</td><td>超限操作<br>1. <strong>stop</strong><br>2. <strong>fallback</strong><br>3. <strong>fallback_conversion_accept</strong><br>4. <strong>conversion_accept</strong><br>5. <strong>conversion_reject</strong><br>6. <strong>conversion_pending</strong></td></tr><tr><td>capping[0][capping_notification_email]</td><td>字符串</td><td>封顶通知邮箱</td></tr><tr><td>capping[0][capping_affiliate_visibility]</td><td>整数</td><td><strong>1:</strong> 向联盟显示封顶规则</td></tr><tr><td>capping[0][capping_affiliate_id]</td><td>字符串</td><td>联盟 ID（逗号分隔）</td></tr><tr><td>target_country</td><td>字符串</td><td>允许特定国家 <br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#countries"><mark style="color:蓝色;">查看国家</mark></a></td></tr><tr><td>block_country</td><td>字符串</td><td>阻止特定国家 <br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#countries"><mark style="color:蓝色;">查看国家</mark></a></td></tr><tr><td>target_os</td><td>字符串</td><td>允许特定操作系统<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#operating-systems"><mark style="color:蓝色;">查看操作系统</mark></a></td></tr><tr><td>block_os</td><td>字符串</td><td>阻止特定操作系统<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#operating-systems"><mark style="color:蓝色;">查看操作系统</mark></a></td></tr><tr><td>target_device</td><td>字符串</td><td>允许特定设备<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span><a href="../../../tong-yong/chang-yong-zhi#devices"> <mark style="color:蓝色;">查看设备</mark></a></td></tr><tr><td>block_device</td><td>字符串</td><td>阻止特定设备<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span><a href="../../../tong-yong/chang-yong-zhi#devices"> <mark style="color:蓝色;">查看设备</mark></a></td></tr><tr><td>target_browser</td><td>字符串</td><td>允许特定浏览器<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#browsers"><mark style="color:蓝色;">查看浏览器</mark></a></td></tr><tr><td>block_browser</td><td>字符串</td><td>阻止特定浏览器<br><span data-gb-custom-inline data-tag="emoji" data-code="1f517">🔗</span> <a href="../../../tong-yong/chang-yong-zhi#browsers"><mark style="color:蓝色;">查看浏览器</mark></a></td></tr><tr><td>target_isp</td><td>字符串</td><td>允许特定 ISP</td></tr><tr><td>block_isp</td><td>字符串</td><td>阻止特定 ISP</td></tr><tr><td>events[0][event_name]</td><td>字符串</td><td>事件名称 </td></tr><tr><td>events[0][event_token]</td><td>字符串</td><td>事件令牌</td></tr><tr><td>capping_conversion_period</td><td>字符串</td><td><mark style="color:橙色;"><strong>已弃用</strong></mark></td></tr><tr><td>capping_budget</td><td>整数</td><td><mark style="color:橙色;"><strong>已弃用</strong></mark></td></tr><tr><td>capping_conversion</td><td>整数</td><td><mark style="color:橙色;"><strong>已弃用</strong></mark></td></tr><tr><td>capping_budget_period</td><td>字符串</td><td><mark style="color:橙色;"><strong>已弃用</strong></mark></td></tr></tbody></table>

**封顶规则（说明）**&#x20;

{% hint style="info" %}

1. 如果您想设置多个封顶规则，可以通过将规则分配给不同的编号来实现\
   **示例 1：** \
   &#x20; capping\[**1**]\[capping\_rule\_name] \
   &#x20; capping\[**1**]\[capping\_rule\_type]\
   **示例 2：**\
   &#x20; capping\[**2**]\[capping\_rule\_name] \
   &#x20; capping\[**2**]\[capping\_rule\_type]
2. 如果您想更新现有封顶规则，您必须提交 **capping\_rule\_id** 在 API 请求中以及新的数据到 **0**（零）编号\
   **示例：**\
   &#x20; capping\[**0**]\[capping\_rule\_name] \
   &#x20; capping\[**0**]\[capping\_rule\_type]
   {% endhint %}

**事件（说明）**&#x20;

{% hint style="info" %}

1. 如果您想创建多个事件，可以通过将事件分配给不同的编号来实现\
   **示例 1：** \
   &#x20; events\[1]\[event\_name] \
   &#x20; events\[1]\[event\_token]\
   **示例 2：**\
   &#x20; events\[2]\[event\_name] \
   &#x20; events\[2]\[event\_token]
   {% endhint %}

***

### 示例 API 请求

**创建 Offer**

![](https://2550316299-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2Fdx5QTRNVdSSn89Lmib9O%2Fimage.png?alt=media\&token=855f8e50-bbf1-4c8d-998d-2a0bf3133d67)

**API 响应**

```
{
    "status": "200",
    "response": "offer_created_successfully",
    "offer_id": 000012    
}
```

**更新 Offer**

![](https://2550316299-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F41f2EboJipeUA6flsLGK%2Fuploads%2Fp9ZW5G3rU3gMmESmYWwY%2Fimage.png?alt=media\&token=ba10f54b-9203-4576-b029-139456429b94)

**API 响应**

```
{
    "status": "200",
    "response": "offer_updated_successfully",
    "offer_id": "000001"
}
```

***

{% hint style="info" %}
**为保证交互安全，请始终从服务器端调用 API。**
{% endhint %}