创建广告
需要携带 Token,详情看 Token
此接口可用于创建广告。
请求地址
https://ss-api.mintegral.com/api/open/v1/campaign
请求方法
POST
请求示例
json
POST /api/open/v1/campaign
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{
"campaign_name": "Test",
"is_coppa": "YES",
"promotion_type": "APP",
"alive_in_store": "YES",
"preview_url": "https://play.google.com/store/apps/details?id=xxxxxxx",
"product_name": "Test",
"package_name": "com.tencent.mm",
"description": "Test",
"icon": "f7c970d0d24c71d84d15a78f29042323",
"platform": "ANDROID",
"category": "BUSINESS",
"app_size": 12.13,
"min_version": "1.0.0"
}
请求参数
注:默认值为"—"表示当前字段无默认值
字段 | 类型 | 说明 | 默认值 | 例子 |
---|---|---|---|---|
campaign_name | string | 广告名称,唯一且字符长度最多为 100。 | — | "Test_campaign_name" |
promotion_type | string | 需要推广的产品类型。可选值:"APP" 、"WEBSITE" 。 | — | "APP" |
preview_url | string | 需要推广的产品的预览链接,不能有空格和特殊字符。 | 注:promotion_type=APP 且 alive_in_store=YES 时,系统会根据 preview_url 获取对应的 app 信息。App 信息字段包含 product_name、package_name、description、icon、platform、category、app_size、min_version。如果获取 app 信息成功,这些获取的字段信息优先级比传入的字段高,传入的字段只是作为兜底保证。 | android: "https://play.google.com/store/apps/details?id=com.tencent.mm&hl=zh" ios: "https://apps.apple.com/cn/guide/app/%E6%94%AF%E4%BB%98%E5%AE%9D-%E8%AE%A9%E7%94%9F%E6%B4%BB%E6%9B%B4%E7%AE%80%E5%8D%95/id333206289" |
is_coppa | string | 是否满足 coppa 要求。可选值:YES、NO | — | "YES" |
alive_in_store | string | 产品是否在 Google Play 或者 App Store 上架。可选值:YES、NO | — | "YES" |
icon | string | 产品的 icon 或者 logo。通过素材接口上传 icon 图片后返回的 md5 值。 注:图片格式要求为:jpg,、png、 jpeg、 bmp。尺寸: 512x512。大小: 5M 以内。 | — | "f7c970d0d24c71d84d15a78f29042323" |
product_name | string | 投放的产品的名称。注:最多 100 个字符。 | — | "product_name_test" |
package_name | string | 投放的产品的 android bundle id 或者 ios application store id。 | — | android: "com.tencent.mm" ios: "id414478124" |
app_size | number | 应用包体大小,单位为 MB,小数点后保留两位。promotion_type=WEBSITE 时,传空即可。 | — | 12.34 |
platform | string | 应用平台,可选值: "IOS" 和 "ANDROID" 。 | — | "IOS" |
category | string | App 的类别,IOS 和 Android 有所不同,类别详情参考附录。[枚举值 - IOS App 类别][枚举值 - ANDROID App 类别] | — | "GAMES" |
min_version | string | 应用要求的系统版本。格式为 x 或 x.x 或 x.x.x 或 x.x.x.x,且 x 必须为数字。promotion_type=WEBSITE 时,传空即可。 注:正则校验规则为/^(\d+.)?(\d+.)?(\d+.)?(*\d+)?$/ | — | "1.0.0" |
description | string | 产品描述。最多 4000 字符。 | — | "Test" |
响应结果
字段 | 类型 | 说明 |
---|---|---|
code | int | 200 表示成功,其他表示失败 |
msg | string | 成功,返回"success",失败返回相应的错误信息 |
data | json | 成功,返回广告信息,失败返回具体的错误信息 |
campaign_id | int | 广告 ID |
campaign_name | string | 广告名称 |
is_coppa | string | 是否满足 coppa 要求。(YES、NO) |
promotion_type | string | 产品类型 |
alive_in_store | string | 产品是否在 Google Play 或者 App Store 上架。(YES、NO) |
preview_url | string | 需要推广的产品的预览链接。 |
product_name | string | 需要推广的产品的名称(应用名称或者网页名称)。 |
package_name | string | 针对 app 类型的产品,需要推广的产品的包名,例如"com.xxx.xxx"、"idxxx" |
description | string | 需要推广的产品的简要描述。 |
icon | string | 需要推广的产品的 icon 或者 logo |
platform | string | 产品的应用平台 |
category | string | 针对 app 类型的产品,需要推广的产品在应用市场中的分类。[枚举值 - IOS App 类别] [枚举值 - ANDROID App 类别] |
app_size | string | 针对 app 类型的产品,需要推广的产品的包体大小 |
min_version | string | 针对 app 类型的产品,需要推广的产品的最低系统版本要求。 |
应答示例
json
{
"msg": "success",
"code": 200,
"data": {
"campaign_id": 1234,
"is_coppa": "YES",
"campaign_name": "Test",
"promotion_type": "APP",
"alive_in_store": "YES",
"preview_url": "https://play.google.com/store/apps/details?id=xxxxxxx",
"product_name": "Test",
"package_name": "com.tencent.mm",
"description": "Test",
"icon": "f7c970d0d24c71d84d15a78f29042323",
"platform": "ANDROID",
"category": "BUSINESS",
"app_size": "12.13",
"min_version": "1.0.0"
}
}