offers を管理するには、Mintegral token を使用する必要があります。詳細は Token を確認してください。
promotion したい ad offers を作成する方法は以下のとおりです。ad offers は ad campaigns の配下に作成されます。たとえばアプリを promotion する場合、geo、offer ごとの price、creatives に応じて異なる ad offers を作成する必要があります。
https://ss-api.mintegral.com/api/open/v1/offer
POST
POST /api/open/v1/offer
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{
"campaign_id": "25",
"offer_name": "cqf_testtttt",
"promote_timezone": 7,
"start_time": 1578455012,
"target_geo": "ALL",
"bid_type": "CPI",
"bid_rate": 5,
"daily_cap_type": "BUDGET",
"daily_cap": "50",
"total_budget": "50",
"settlement_event": "",
"os_version_min": "8.8",
"custom_ad_schedule": {"1":"0,1,23","2":"3,4,5","3":"3,6,5"},
"custom_ad_schedule_timezone": 0,
"network": "WIFI",
"target_ad_type": "BANNER",
"creatives_sets": [
{"creative_set_name":"demo1","geos":["ALL"],"ad_outputs":[111],"creatives":[{"creative_name":"material1","creative_md5":"c09d944dcf2d6ded1acd6eb2237f8bad"},{"creative_name":"icon_512x512","creative_md5":"5a42fed89d97cfe253c2f7b6be86f8ed"},{"creative_name":"1200x627","creative_md5":"ea5c9ca2f16cace9c133bb327e1c83dd"}]}
],
"target_device": "PHONE"
}
| Fields | Type | Explanations | Default Value | Examples | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| campaign_id | int | 関連する Campaign id | — | 1234 |
||||||||||
| offer_name | string | offer の一意の名前。使用できるのは alphabets、underscores、numbers のみです。長さは 3〜95。 | "" | "offer_test" |
||||||||||
| promote_timezone | number | promotion period の timezone setting。 [ENUM-Timezone] |
"" | 5.5 |
||||||||||
| start_time | int | promotion start time の timestamp。end_time がある場合はそれより前である必要があります。 PS: start time は 946656000 より後である必要があります。 |
— | 1578455012 |
||||||||||
end_time Optional |
int | promotion end time の timestamp。start_time がある場合はそれより後である必要があります。 | 0 | 1578455169 |
||||||||||
| target_geo | string | promotion の target geos。global promotion の場合は "ALL" を設定します。複数 geos はカンマで区切ります。 | — | "CN" |
||||||||||
bid_type Deprecated |
string | Pricing model。Enum value: [ENUM-Pricing Model] Note: 利用可能な bid type は permission によって決まります。 "permission denied" が返る場合は、AM に連絡して access を取得してください。 |
"" | "CPC" |
||||||||||
| billing_type | string | Pricing model。Enum value: [ENUM-Pricing Model] Note: 利用可能な billing_type は permission によって決まります。 "permission denied" が返る場合は、AM に連絡して access を取得してください。 |
"" | "CPC" |
||||||||||
bid_goal When billing_type is set to OCPI, it is a must to fill in the required field. |
string | Optimized Target types: Target-ROAS, Target-CPE, Install, impression。billing_type との関係は以下のとおりです。
|
Target-ROAS |
|||||||||||
target_mtg_event When bid_goal is set as Target-ROAS or Target-CPE, it is mandatory to fill in. |
array<string> | 最適化対象。 [Update Target Goal] |
["Ad Revenue"] |
|||||||||||
target_original_event When bid_goal is set as Target-CPE, it is mandatory to fill in. |
string | 最適化する Original event。 [Update Target Goal] |
"ad_revenue" |
|||||||||||
target_goal_window When bid_goal is set as Target-ROAS or Target-CPE, it is mandatory to fill in. |
string | optimization goal の time window。enumeration value: D0, D7。bid_goal ごとの対応 window は以下のとおりです。 Target-ROAS: D0, D7 Target-CPES: D0, D7 |
D0 |
|||||||||||
target_goal When bid_goal is set as Target-ROAS or Target-CPE, it is required to be filled in. |
double | offer dimension で最適化する goal value。bid_goal ごとの範囲は以下のとおりです。 Target-ROAS: percentage で [1, 1000]、小数点以下 2 桁。 Target-CPE: percentage で [0.1, 2000]、小数点以下 3 桁。 |
80 |
|||||||||||
| target_goal_by_geo | array<json> | geo dimension で最適化する objective value | ||||||||||||
| geo | string | geo | ||||||||||||
| target_goal | double | target value を最適化します。 | ||||||||||||
| bid_rate | number | すべての target geos に対する default bidding price value。0 より大きい小数点以下 3 桁の float が使用できます。CPE/CPI/CPM bid type では 0.01 より大きい必要があり、CPC bid type では 0.001 より大きい必要があります。 | "" | 0.04 |
||||||||||
daily_cap_type Optional |
string | Daily budget setting type。Enum value:"BUDGET"、"CONVERSION"。 |
"BUDGET" | "CONVERSION" |
||||||||||
daily_cap Optional |
number | Daily budget value。open daily budget の場合は null を設定します。値は 50 より大きい必要があります。 | — | 100 |
||||||||||
total_budget Optional |
number | 小数点以下 3 桁の Total budget value。open total budget の場合は null を設定します。daily_cap_type= "BUDGET" の場合、値は 50 より大きい必要があります。 | — | 50.12 |
||||||||||
settlement_event Optional |
string | CPE promotion の Settlement event。使用できるのは alphabets、underscores、numbers のみです。最大長は 50。bid_type = CPE の場合は必須です。Ps: この field の minimum length は 3 です。 | "" | "purchase" |
||||||||||
os_version_min Optional |
string | /^[0-9](\.[0-9]){0,2}$/ 形式の minimum OS version。"x" は自然数です。null の場合、OS version requirement は campaign と同じになります。minimum version を指定しない場合、値は 0.0.0 に設定してください。 |
— | "9.0" |
||||||||||
os_version_max Optional |
string | /^[0-9](\.[0-9]){0,2}$/ 形式の maximum OS version。"x" は自然数です。null の場合、OS version requirement は campaign と同じになります。maximum version を指定しない場合、値は 99.0.0 に設定してください。 |
— | "9.0" |
||||||||||
custom_ad_schedule Optional |
json | Promotion schedule。Key は weekday(1-7)、value は hour(0-23)を意味します。null に設定するとすべての weekdays と all hours が選択されます。 | — | {"1":"0,1,23","2":"3,4,5"} |
||||||||||
custom_ad_schedule_timezone Deprecated |
number | promotion schedule の timezone setting。Enum value: [ENUM-Timezone] This field has been deprecated, use the 'promote_timezone' field instead. |
— | -5.5 |
||||||||||
network Optional |
string | device network status の target。Enum value: [ENUM-Network] |
— | "2G,3G,4G,5G" |
||||||||||
| target_ad_type | string | Target ad types。複数の ad types はカンマで区切ります。Enum value: [ENUM-ad type(static)] [ENUM-ad type(video)] |
— | "REWARDED_VIDEO,INTERSTITIAL_VIDEO" |
||||||||||
target_device Optional |
string | Target device type。ENUM value:"PHONE" 、"TABLET。 |
"PHONE,TABLET" | "PHONE,TABLET" |
||||||||||
| creatives | array<json> | Creative info。Obsolete のため creative_sets を使用してください。 |
— | [{"creative_name":"1200x627.jpg","creative_md5":"ad7667f1faf1c14d13c4e03ed8f08e6c","apply_in_area":"ALL"},{"creative_name":"512x512.png","creative_md5":"77c561b05d00559671a5a462c077fb5b", "apply_in_area":"ALL"}] |
||||||||||
| creatives_sets | array<json> | Creative Set info Api - Create Creative Set | — | [{"creative_set_name":"demo1","geos":["ALL"],"ad_outputs":[111],"creatives":[{"creative_md5":"c09d944dcf2d6ded1acd6eb2237f8bad"},{"creative_name":"icon_512x512","creative_md5":"5a42fed89d97cfe253c2f7b6be86f8ed"},{"creative_name":"1200x627","creative_md5":"ea5c9ca2f16cace9c133bb327e1c83dd"}]}] |
| Fields | Type | Explanations |
|---|---|---|
| code | int | 200 code は成功を示します。それ以外は失敗です。 |
| msg | string | 成功時は "success" を返します。失敗時は詳細なエラー情報を返します。 |
| data | json | 成功時は offer data を返します。失敗時は詳細なエラー情報を返します。 |
| campaign_id | int | campaign ごとの一意の id |
| offer_id | int | offer の一意の id |
| offer_name | string | offer の一意の名前 |
| promote_timezone | number | promotion period の timezone setting |
| start_time | int | promotion start time の timestamp |
| end_time | int | promotion end time の timestamp |
| target_geo | string | promotion の Target geos |
bid_type Deprecated |
string | Pricing model |
| bid_rate | string | すべての offer target geos に対する default bidding price value |
| daily_cap_type | string | Daily budget setting type |
| daily_cap | string | daily cap の値 |
| total_budget | string | total budget の値 |
| settlement_event | string | CPE promotion の Settlement event |
| os_version_min | string | Minimum OS version allowed |
| os_version_max | string | Maximum OS version allowed |
| custom_ad_schedule | string | Promotion schedule |
custom_ad_schedule_timezone Deprecated |
number | promotion schedule の timezone settingThis field has been deprecated, use the 'promote_timezone' field instead. |
| network | string | device network status の target |
| target_ad_type | string | Target ad types |
creatives Deprecated |
array<json> | Creative info。Obsolete のため creative_sets を使用してください。 |
| creative_sets | array<json> | Creative Set Info |
| target_device | string | Target device type |
{
"code": 200,
"msg": "success",
"data": {
"campaign_id": "25",
"offer_id": 18496,
"offer_name": "cqf_testtttt",
"promote_timezone": 7,
"start_time": "1578455012",
"end_time": "0",
"target_geo": "ALL",
"bid_type": "CPI",
"bid_rate": "5",
"daily_cap_type": "BUDGET",
"daily_cap": "50",
"total_budget": "50",
"settlement_event": "",
"os_version_min": "8.8",
"custom_ad_schedule": "{\"1\":\"0,1,23\",\"2\":\"3,4,5\",\"3\":\"3,6,5\"}",
"custom_ad_schedule_timezone": 0,
"network": "WIFI",
"target_ad_type": "BANNER",
"creative_sets": [
{
"creative_set_name": "demo1",
"geos": ["ALL"],
"ad_outputs": [111],
"creatives": [
{"creative_name":"material1","creative_md5": "c09d944dcf2d6ded1acd6eb2237f8bad"},
{"creative_name": "icon_512x512","creative_md5": "5a42fed89d97cfe253c2f7b6be86f8ed"},
{"creative_name": "1200x627","creative_md5": "ea5c9ca2f16cace9c133bb327e1c83dd"}
]
}
],
"target_device": "PHONE"
}
}