오퍼를 관리하려면 Mintegral 토큰을 사용해야 합니다. 자세한 내용은 Token을 확인하세요.
홍보하려는 광고 오퍼를 생성하는 방법은 다음과 같습니다. 광고 오퍼는 광고 캠페인 하위에 속합니다. 예를 들어 앱을 홍보하는 경우, 지역, 오퍼별 가격, 크리에이티브에 따라 서로 다른 광고 오퍼를 생성해야 할 수 있습니다.
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 | 연결된 캠페인 ID | — | 1234 |
||||||||||
| offer_name | string | 오퍼의 고유 이름입니다. 영문자, 밑줄, 숫자만 사용할 수 있으며 길이는 3-95자여야 합니다. | "" | "offer_test" |
||||||||||
| promote_timezone | number | 프로모션 기간의 시간대 설정입니다. [ENUM-Timezone] |
"" | 5.5 |
||||||||||
| start_time | int | 프로모션 시작 시간의 타임스탬프입니다. end_time이 있는 경우 그보다 앞서야 합니다. PS: start_time은 946656000 이후여야 합니다. |
— | 1578455012 |
||||||||||
end_time Optional |
int | 프로모션 종료 시간의 타임스탬프입니다. start_time이 있는 경우 그보다 뒤여야 합니다. | 0 | 1578455169 |
||||||||||
| target_geo | string | 프로모션 타깃 지역입니다. 글로벌 프로모션은 "ALL"로 설정합니다. 여러 지역은 쉼표로 구분합니다. | — | "CN" |
||||||||||
bid_type Deprecated |
string | 과금 모델입니다. 열거 값은 다음을 참고하세요. [ENUM-Pricing Model] 참고: 사용 가능한 bid type은 권한에 따라 결정됩니다. "permission denied"가 반환되면 AM에게 접근 권한을 요청하세요. |
"" | "CPC" |
||||||||||
| billing_type | string | 과금 모델입니다. 열거 값은 다음을 참고하세요. [ENUM-Pricing Model] 참고: 사용 가능한 billing_type은 권한에 따라 결정됩니다. "permission denied"가 반환되면 AM에게 접근 권한을 요청하세요. |
"" | "CPC" |
||||||||||
bid_goal When billing_type is set to OCPI, it is a must to fill in the required field. |
string | 최적화 타깃 유형입니다: 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 | 최적화할 원본 이벤트입니다. [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 | 최적화 목표의 시간 윈도우입니다. 열거 값: D0, D7. bid_goal별 지원 시간 윈도우는 다음과 같습니다. 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 | 오퍼 차원의 최적화 목표값입니다. bid_goal별 범위는 다음과 같습니다. Target-ROAS: 백분율 기준 [1, 1000] 범위이며 소수점 둘째 자리까지 지원합니다. Target-CPE: 백분율 기준 [0.1, 2000] 범위이며 소수점 셋째 자리까지 지원합니다. |
80 |
|||||||||||
| target_goal_by_geo | array<json> | 지역 차원의 최적화 목표값입니다. | ||||||||||||
| geo | string | geo | ||||||||||||
| target_goal | double | 최적화 목표값 | ||||||||||||
| bid_rate | number | 모든 타깃 지역에 적용되는 기본 입찰가입니다. 0보다 큰 소수점 셋째 자리까지의 float 값을 사용할 수 있습니다. CPE/CPI/CPM 입찰 유형은 0.01보다 커야 하며, CPC 입찰 유형은 0.001보다 커야 합니다. | "" | 0.04 |
||||||||||
daily_cap_type Optional |
string | 일일 예산 설정 유형입니다. 열거 값: "BUDGET", "CONVERSION". |
"BUDGET" | "CONVERSION" |
||||||||||
daily_cap Optional |
number | 일일 예산 값입니다. 일일 예산을 열어두려면 null로 설정합니다. 값은 50보다 커야 합니다. | — | 100 |
||||||||||
total_budget Optional |
number | 소수점 셋째 자리까지 지원되는 총예산 값입니다. 총예산을 열어두려면 null로 설정합니다. daily_cap_type= "BUDGET"인 경우 값은 50보다 커야 합니다. | — | 50.12 |
||||||||||
settlement_event Optional |
string | CPE 프로모션의 정산 이벤트입니다. 영문자, 밑줄, 숫자만 사용할 수 있으며 최대 길이는 50자입니다. bid_type = CPE인 경우 필수입니다. PS: 이 필드의 최소 길이는 3자입니다. | "" | "purchase" |
||||||||||
os_version_min Optional |
string | 허용되는 최소 OS 버전이며 형식은 /^[0-9](\.[0-9]){0,2}$/입니다. "x"는 자연수를 의미합니다. null로 설정하면 기본적으로 캠페인과 동일한 OS 버전 요건이 적용됩니다. 최소 버전을 지정하지 않는 경우 값은 0.0.0으로 설정해야 합니다. |
— | "9.0" |
||||||||||
os_version_max Optional |
string | 허용되는 최대 OS 버전이며 형식은 /^[0-9](\.[0-9]){0,2}$/입니다. "x"는 자연수를 의미합니다. null로 설정하면 기본적으로 캠페인과 동일한 OS 버전 요건이 적용됩니다. 최대 버전을 지정하지 않는 경우 값은 99.0.0으로 설정해야 합니다. |
— | "9.0" |
||||||||||
custom_ad_schedule Optional |
json | 프로모션 스케줄입니다. key는 요일(1-7), value는 시간(0-23)을 의미합니다. null로 설정하면 모든 요일과 모든 시간이 선택됩니다. | — | {"1":"0,1,23","2":"3,4,5"} |
||||||||||
custom_ad_schedule_timezone Deprecated |
number | 프로모션 스케줄의 시간대 설정입니다. 열거 값은 [ENUM-Timezone]을 참고하세요. 이 필드는 더 이상 사용되지 않으며, 대신 'promote_timezone' 필드를 사용하세요. |
— | -5.5 |
||||||||||
network Optional |
string | 디바이스 네트워크 상태 타깃입니다. 열거 값은 [ENUM-Network]을 참고하세요. |
— | "2G,3G,4G,5G" |
||||||||||
| target_ad_type | string | 타깃 광고 유형입니다. 여러 광고 유형은 쉼표로 구분합니다. 열거 값은 다음을 참고하세요. [ENUM-ad type(static)] [ENUM-ad type(video)] |
— | "REWARDED_VIDEO,INTERSTITIAL_VIDEO" |
||||||||||
target_device Optional |
string | 타깃 디바이스 유형입니다. ENUM 값: "PHONE", "TABLET". |
"PHONE,TABLET" | "PHONE,TABLET" |
||||||||||
| creatives | array<json> | 크리에이티브 정보입니다. 더 이상 사용되지 않으므로 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> | 크리에이티브 세트 정보입니다. 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이면 성공입니다. 그 외 코드는 실패를 의미합니다. |
| msg | string | 성공 시 "success"를 반환합니다. 실패 시 상세 오류 정보를 반환합니다. |
| data | json | 성공 시 오퍼 데이터를 반환합니다. 실패 시 상세 오류 정보를 반환합니다. |
| campaign_id | int | 각 캠페인의 고유 ID |
| offer_id | int | 오퍼의 고유 ID |
| offer_name | string | 오퍼의 고유 이름 |
| promote_timezone | number | 프로모션 기간의 시간대 설정 |
| start_time | int | 프로모션 시작 시간의 타임스탬프 |
| end_time | int | 프로모션 종료 시간의 타임스탬프 |
| target_geo | string | 프로모션 타깃 지역 |
bid_type Deprecated |
string | 과금 모델 |
| bid_rate | string | 모든 오퍼 타깃 지역에 적용되는 기본 입찰가 |
| daily_cap_type | string | 일일 예산 설정 유형 |
| daily_cap | string | 일일 한도 값 |
| total_budget | string | 총예산 값 |
| settlement_event | string | CPE 프로모션의 정산 이벤트 |
| os_version_min | string | 허용되는 최소 OS 버전 |
| os_version_max | string | 허용되는 최대 OS 버전 |
| custom_ad_schedule | string | 프로모션 스케줄 |
custom_ad_schedule_timezone Deprecated |
number | 프로모션 스케줄의 시간대 설정이 필드는 더 이상 사용되지 않으며, 대신 'promote_timezone' 필드를 사용하세요. |
| network | string | 디바이스 네트워크 상태 타깃 |
| target_ad_type | string | 타깃 광고 유형 |
creatives Deprecated |
array<json> | 크리에이티브 정보입니다. 더 이상 사용되지 않으므로 creative_sets를 사용하세요. |
| creative_sets | array<json> | 크리에이티브 세트 정보 |
| target_device | string | 타깃 디바이스 유형 |
{
"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"
}
}