Charboost API — 广告方法

上次更新:
某些端点需要广告活动 ID。我的广告活动 ID 在哪里?

 

 

端点为指定广告活动提供信息,否则会返回所有广告活动,无论状态。

在此提供的 bid_id 可以用于下方端点。

HTTP 方法 GET
端点 https://api.chartboost.com/campaigns
示例请求 https://api.chartboost.com/campaigns/?user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}

参数
参数 请求类型 是否必填? 描述 默认
campaign_id 字符串 可选 唯一广告活动 ID 全部

回复字段
参数 描述 返回用作…
app_id 广告应用 ID 广告主
投标 广告投标 ID; bid_id 用于下方端点 所有人
campaign_type marketplace, directdeal, crosspromotion 所有人
date_created 广告活动创建日期 (UNIX 时间戳) 所有人
date_max 广告活动结束日期 (UNIX 时间戳) 所有人
date_min 广告活动开始日期 (UNIX 时间戳) 所有人
date_modified 广告活动上次更改日期 (UNIX 时间戳) 所有人
id 广告活动 ID 所有人
名称 广告活动名称 所有人
platform ios, google_play, amazon 所有人
优先级 当前广告活动显示优先级 所有人
promote_in 发布应用 ID 媒体
状态 当前广告活动状态: 活跃, 暂停, 已存档 所有人

▲ 返回顶部

 

如指定广告活动,端点返回投标信息详情,否则返回所有广告活动的投标。/bid 端点用于获取投标信息和以下所有方法。


HTTP 方法 GET
端点 https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
示例请求 https://api.chartboost.com/campaigns/?{{Campaign ID}}/bid/{{Bid ID}}?campaign_id={{Campaign ID}}&bid_id={{Bid ID}}&user_id={{Chartboost customer's user ID}}&user_signature={{CB customer's user signature}}


参数
参数 请求类型 是否必填? 描述 默认
bid_id 字符串 可选 单一 (对象) 投标 ID 全部
campaign_id 字符串 必填 唯一广告活动 ID 不适用

回复字段
参数 描述 返回用作…
app_filter 已弃用 所有人
app_toggle 已弃用 所有人
bid_amount $USD 投标金额 广告主
bid_id 投标 ID 所有人
bid_type 广告投标类型
了解投标类型详情 ▶
广告主
预算 投标每日总预算 (定位) 广告主
device_filter 定位中按系列或型号选定的设备 所有人
device_toggle true = 包括; false = 排除 所有人
expire_date 直接交易投标过期日 (UNIX 时间戳) 所有人
is_enabled 决定投标 (定位) 是否已启用: true, false 所有人
location_filter 定位中选择的国家 所有人
location_toggle true = 包括; false = 排除 所有人
os_filter 定位所选操作系统: max = 最大版本; min = 最小版本 所有人
标题 目标 (定位) 名称 所有人

▲ 返回顶部

 

此方法允许编辑已有投标。每个请求仅可编辑一个投标。


HTTP 方法 PUT
端点 https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}
示例请求 查看下方代码

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid/{{Bid ID}}

请求正文:
{
    "campaign_id": {{Campaign ID}},
    "bid_id": {{Bid ID}},
    "user_id": {{Chartboost customer's user ID}},
    "user_signature": {{CB customer's user signature}}
}
				

参数
参数 请求类型 是否必填? 描述 默认
bid_amount 数额 可选 $USD 投标数额 (e.g. "0.55")
Note: bid_type 在更新数额时必须同时设置。
不适用
bid_id 字符串 必填 单一 (对象) 投标 ID 不适用
bid_type 字符串 可选,但使用 bid_amount 时必填 投标类型 (CPC 或 CPI) 不适用
预算 数额 可选 $USD 本投标每日预算 不适用
campaign_id 字符串 必填 唯一广告活动 ID 不适用
device_filter 字符串 可选 设备类型的逗号分隔列表 (例如e.g. "iphone,ipod touch,ipad") 不适用
device_toggle 布尔逻辑 可选 device_filter 中列表运算符; 如排除则为
true,如包括则为
false不填
false (包括)
is_enabled 布尔逻辑 可选 切换启用/禁用投标;
true = 启用, false = 禁用
不适用
location_filter 字符串 可选 双字母国家代码 (例如,“US, CA”); 如空白则默认所有国家。
注意: location_toggle 必须在更新国家筛选条件时设置。
不适用
location_toggle 布尔逻辑 可选,但使用 location_filter 时必填 如果 location_filter 添加到白名单则为“TRUE” (例如,仅定为这些国家),如果 location_filter 列入黑名单则为
“FALSE” (例如,定为除这些国家外的所有国家)
不适用
os_filter_max 数额 可选 最高 OS 版本 (例如,8.0) 不适用
os_filter_min 数额 可选 最低 OS 版本 (例如,4.3) 不适用

回复字段
参数 描述 返回用作…
app_filter 已弃用 所有人
app_toggle 已弃用 所有人
bid_amount $USD 投标金额 广告主
bid_id 投标 ID 所有人
bid_type 投标类型 (CPC 或 CPI)
了解投标类型详情 ▶
广告主
预算 $USD 本投标每日预算 广告主
device_filter 设备类型列表 所有人
device_toggle true = 排除; false = 包括 所有人
expire_date 直接交易投标过期日 (UNIX 时间戳) 所有人
is_enabled 决定投标是否处于活跃状态;
true = 启用
false = 禁用
所有人
location_filter List of countries 所有人
location_toggle true = 包括; false = 排除 所有人
os_filter min = 最小 OS 版本; max = 最大 OS 版本 所有人
标题 定位 (投标) 名称 所有人

▲ 返回顶部

 

此方法仅用于广告活动,允许您在广告活动内创建新投标。此新投标的标题会匹配投标 ID,但可以在后台重命名。


HTTP 方法 POST
端点 https://api.chartboost.com/campaigns/{{Campaign ID}}/bid
示例请求 查看下方代码

https://api.chartboost.com/campaigns/{{Campaign ID}}/bid

Request Body:
{
 "campaign_id": {{Campaign ID}},
 "bid_amount": {{Bid Amount}},
 "bid_type": {{Bid Type}},
 "user_id": {{Chartboost customer's user ID}},
 "user_signature": {{CB customer's user signature}}
}

参数
参数 请求类型 是否必填? 描述 默认
bid_amount 数额 必填 $USD 投标数额 (e.g. "0.55")
Note: bid_type 在更新数额时必须同时设置
不适用
bid_type 字符串 必填 投标类型 (CPC 或 CPI) 不适用
预算 数额 必填 $USD 本投标每日预算 不适用
campaign_id 字符串 必填 唯一广告活动 ID 不适用
device_filter 字符串 可选 设备类型的逗号分隔列表 (例如e.g. "iphone,ipod touch,ipad") 不适用
device_toggle 布尔逻辑 可选 device_filter 中列表运算符; 如排除则为
true,如包括则为
false不填
false (包括)
is_enabled 布尔逻辑 可选 切换启用/禁用投标;
true = 启用, false = 禁用
不适用
location_filter 字符串 可选 双字母国家代码 (例如,“US, CA”); 如空白则默认所有国家。
注意: location_toggle 必须在更新国家筛选条件时设置
不适用
location_toggle 布尔逻辑 可选,但使用 location_filter 时必填 如果 location_filter 添加到白名单则为“TRUE” (例如,仅定为这些国家),如果 location_filter 列入黑名单则为
“FALSE” (例如,定为除这些国家外的所有国家)
不适用
os_filter_max 数额 可选 最高 OS 版本 (例如,8.0) 不适用
os_filter_min 数额 可选 最低 OS 版本 (例如,4.3) 不适用

回复字段
参数 描述 返回用作…
app_filter 已弃用 所有人
app_toggle 已弃用 所有人
bid_amount $USD 投标金额 广告主
bid_id 投标 ID 所有人
bid_type 投标类型 (CPC 或 CPI)
了解投标类型详情 ▶
广告主
预算 $USD 本投标每日预算 广告主
device_filter 设备类型列表 所有人
device_toggle true = 排除; false = 包括 所有人
expire_date 直接交易投标过期日 (UNIX 时间戳) 所有人
is_enabled 决定投标是否处于活跃状态;
true = 启用
false = 禁用
所有人
location_filter 国家列表 所有人
location_toggle true = 包括; false = 排除 所有人
os_filter min = 最小 OS 版本; max = 最大 OS 版本 所有人
标题 定位 (投标) 名称 所有人

▲ 返回顶部

 


您可能还希望…