获取广告
需要携带 Token,详情看 Token
通过该接口可以获取当前账户里所有自投产品的内容详情,另外,支持通过 campaign_id、campaign_name、package_name、offer_id、offer_uuid、offer_name 条件查询特定的产品信息。
请求地址
https://ss-api.mintegral.com/api/open/v1/campaign
请求方法
GET
请求示例
json
GET /api/open/v1/campaign
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{ "page": 1, "campaign_id": "1230,1231,1532", "limit": 10 }
请求参数
字段 | 类型 | 说明 | 默认值 | 例子 |
---|---|---|---|---|
campaign_id 选填 | string | 广告 ID 。多个用,隔开。最多支持 50 个。 | — | |
campaign_name 选填 | string | 广告名称 offer_uuid | — | "campaign_test" |
package_name 选填 | string | 包名 | — | "test" |
offer_id 选填 | int | 广告单元 ID 名 | — | 1234" |
offer_name 选填 | string | 广告单元名称 | — | "offer_test" |
offer_uuid 选填 | string | 系统自动生成的广告单元名称 | — | "ss_offer_test" |
page 选填 | int | 页数 | 1 | 1 |
limit 选填 | int | 每页数量 最大值:50;大于 50 时,接口只返回 50 个 | 10 | 15 |
响应结果
字段 | 类型 | 说明 |
---|---|---|
code | int | 200 表示成功,其他表示失败 |
msg | string | 成功,返回"success",失败返回相应的错误信息 |
data | json | 成功,返回广告信息,失败返回具体的错误信息 |
page | int | 当前在第几页 |
limit | int | 数量限制 |
total | int | 总数量 |
list | array<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 类型的产品,需要推广的产品的最低系统版本要求。 |
maintain_by | string | 表示广告单元的管理权限。当该值为AM时,广告单元由账户经理管理、维护,您只能查看广告详情,无修改权限;当该值为ADV时,除了查看详情,您可根据需要编辑、调整广告下的对应配置 |
status | string | 可选值 [枚举值-广告状态] |
应答示例
json
{
"msg": "success",
"code": 200,
"data": {
"page": 1,
"limit": 10,
"total": 2,
"list": [
{
"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",
"maintain_by": "ADV"
},
{
"campaign_id": 1235,
"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",
"maintain_by": "ADV"
}
]
}
}