For the complete documentation index, see llms.txt. This page is also available as Markdown.

Offer 创建 API

POST https://api.offer18.com/api/m/offers

🔗 点击测试 Offer 创建 API

通用参数

查询

类型

说明

mid

整数

网络账户 ID

api-key

字符串

网络 API Key

secret-key

字符串

网络 Secret Key

操作

查询

类型

说明

action

字符串

允许的值: create / update / delete

offer_id

整数

在 Offer 更新和删除时必填


字段

请求体

类型

说明

offer_name

字符串

活动名称

advertiser_id

整数

广告主 ID

offer_url

URL

活动的 URL

external_offer_id

字符串

外部活动 ID(如有)

app_id

字符串

App ID(如有)

logo

URL

活动 Logo 的 URL

category

字符串

活动类别

preview_url

URL

活动预览 URL

currency

字符串

Offer 的货币

🔗 查看货币

price_advertiser

小数

广告主为活动提供的价格

price_affiliate

小数

活动支付给联盟客的价格

model_advertiser

字符串

活动的广告主模型 🔗 查看模型

model_affiliate

字符串

活动的广告主模型 🔗 查看模型

hide_affiliate_payout

整数

允许的值 1: 隐藏联盟客分成

start_datetime

UTC 时间戳

开始日期 / 时间 (YYYY-MM-DD HH:MM:SS)

end_datetime

UTC 时间戳

结束日期 / 时间 (YYYY-MM-DD HH:MM:SS )

visibility

字符串

允许的值: public, permission, private

status

字符串

允许的值: approve, pending

deep_links

整数

允许的值 1: 在 Offers 中启用深度链接

offer_terms

字符串

活动条款

offer_kpi

字符串

活动的 KPI 条款

private_note

字符串

活动中的私密备注

imps_url

URL

展示 URL

landing_page_id_1

整数

用于用户想更新现有落地页的情况

landing_page_name_1

字符串

第一个落地页名称

landing_page_url_1

URL

活动第一个落地页的 URL

landing_page_id_2

整数

用于用户想更新现有落地页的情况

landing_page_name_2

字符串

第二个落地页名称

landing_page_url_2

URL

活动第二个落地页的 URL

creatives

URL

活动素材的 URL

fallback

布尔值

允许的值: 1: 启用 Fallback

fallback_offer_id

整数

Fallback 的 Offer ID

fallback_url

URL

Fallback 的 URL

fraud_conv_speed

整数

时间(秒)

proxy_block

整数

允许的值: 1: 阻止代理

blank_ref_block

整数

允许的值: 1: 阻止空白引用

hide_referral

整数

允许的值: 1: 隐藏推荐来源

assign_affiliates

整数

将联盟客分配给此活动 (逗号分隔的值)

capping_rule_id

整数

用于用户想更新现有封顶规则的情况

capping[0][capping_rule_name]

字符串

封顶规则名称

capping[0][capping_rule_type]

字符串

封顶规则类型 1. advertiser_capping 2. affiliate_capping

capping[0][capping_timezone]

时间戳

封顶时区

capping[0][capping_events]

字符串

封顶事件

capping[0][capping_type]

字符串

封顶类型 1. gross_conversions 2. approved_conversions 3. gross_revenue 4. approved_revenue 5. gross_payout 6. approved_payout 7. gross_clicks 8. approved_clicks

capping[0][capping_period]

字符串

封顶周期 1. daily 2. weekly 3. monthly 4. hourly

capping[0][capping_value]

整数

封顶值

capping[0][overcap_action]

字符串

超额处理动作 1. stop 2. fallback 3. fallback_conversion_accept 4. conversion_accept 5. conversion_reject 6. conversion_pending

capping[0][capping_notification_email]

Stirng

封顶通知邮箱

capping[0][capping_affiliate_visibility]

整数

1: 向联盟客展示封顶规则

capping[0][capping_affiliate_id]

Stirng

联盟客 ID(逗号分隔)

targeting_rule_id

整数

用于用户想更新现有定向规则的情况

target_country

字符串

允许指定国家 🔗 查看国家

block_country

字符串

屏蔽指定国家 🔗 查看国家

target_os

字符串

允许指定操作系统 🔗 查看操作系统

block_os

字符串

屏蔽指定操作系统 🔗 查看操作系统

target_device

字符串

允许指定设备 🔗 查看设备

block_device

字符串

屏蔽指定设备 🔗 查看设备

target_browser

字符串

允许指定浏览器 🔗 查看浏览器

block_browser

字符串

屏蔽指定浏览器 🔗 查看浏览器

target_isp

字符串

允许指定 ISP

block_isp

字符串

屏蔽指定 ISP

events[0][event_name]

字符串

事件名称

events[0][event_token]

字符串

事件令牌

capping_conversion_period

字符串

已弃用

capping_budget

整数

已弃用

capping_conversion

整数

已弃用

capping_budget_period

字符串

已弃用

封顶规则(说明)

  1. 如果你想设置多个封顶规则,可以通过将规则分配到不同的数字来实现 示例 1: capping[1][capping_rule_name] capping[1][capping_rule_type] 示例 2: capping[2][capping_rule_name] capping[2][capping_rule_type]

  2. 如果你想更新现有封顶规则,必须提交 capping_rule_id API 请求并携带新数据到 0(零)编号 示例: capping[0][capping_rule_name] capping[0][capping_rule_type]

事件(说明)

  1. 如果你想创建多个事件,可以通过将事件分配到不同的数字来实现 示例 1: events[1][event_name] events[1][event_token] 示例 2: events[2][event_name] events[2][event_token]


API 请求示例

Offer 创建

API 响应

Offer 更新

API 响应


为了安全交互,请始终从服务器端调用 API。

最后更新于