오퍼를 관리하려면 Mintegral 토큰을 사용해야 합니다. 자세한 내용은 Token을 확인하세요.
광고 오퍼 목록을 조회합니다. campaign_id, campaign_name, offer_id, offer_name, offer_uuid, status, package_name, ext_fields 기준의 조회를 지원합니다.
https://ss-api.mintegral.com/api/open/v1/offers
GET
GET /api/open/v1/offers
HTTP/1.1 Host: ss-api.mintegral.com
Content-Type: application/json
{ "page": 1, "campaign_id": "12,13,15", "limit": 10 }
| Fields | Type | Explanations | Default Value | Examples |
|---|---|---|---|---|
campaign_id Optional |
string | 캠페인 ID입니다. 여러 ID는 쉼표로 구분합니다. | — | "12,13,15" |
campaign_name Optional |
string | 캠페인명입니다. 퍼지 검색을 지원합니다. | "" | "campaign_test" |
offer_id Optional |
string | 오퍼 ID입니다. 여러 ID는 쉼표로 구분합니다. | — | "123,124,125" |
offer_name Optional |
string | 오퍼명입니다. 퍼지 검색을 지원합니다. | "" | "offer_test" |
offer_uuid Optional |
string | 자동 생성된 고유 오퍼명입니다. | — | "ss_offer_test" |
package_name Optional |
string | 프로모션 애플리케이션의 패키지명입니다. 퍼지 검색을 지원합니다. | "" | "test" |
ext_fields Optional |
string | 확장 조회 필드입니다. 여러 조회 항목은 쉼표로 구분합니다. 지원 항목: bid_rate_by_mtgid => 특정 퍼블리셔의 입찰가 target_app => 특정 앱 차단 또는 타기팅에 사용되는 필드 |
"" | "bid_rate_by_mtgid" |
page Optional |
int | 페이지 | 1 | 1 |
limit Optional |
int | 페이지당 제한 수 최대값: 50 >50이면 50을 반환합니다. |
10 | 15 |
status Optional |
string | 선택 필드이며 여러 상태를 지원합니다. 다음을 확인하세요. [ENUM-Offer Status] |
"" | "RUNNING" |
| Fields | Type | Explanations |
|---|---|---|
| code | int | 200이면 성공입니다. 그 외 코드는 실패를 의미합니다. |
| msg | string | 성공 시 “success”를 반환합니다. 실패 시 상세 오류 정보를 반환합니다. |
| data | json | 성공 시 “Offer”를 반환합니다. 실패 시 상세 오류 정보를 반환합니다. |
| page | int | 현재 페이지 |
| limit | int | 수량 제한 |
| total | int | 총 개수 |
| list | array<json> | |
| campaign_id | int | 캠페인의 고유 ID |
| campaign_name | string | 캠페인명 |
| offer_id | int | 오퍼의 고유 ID |
| uuid | string | 자동 생성된 고유 오퍼명입니다. 일반적으로 tracking URL 설정에 사용됩니다. |
| offer_name | string | 설정한 오퍼명 |
| promote_timezone | number | 프로모션 기간의 시간대 설정입니다. 예: -5 |
| start_time | string | 프로모션 시작 시간의 타임스탬프 |
| end_time | string | 프로모션 종료 시간의 타임스탬프 |
| status | string | 오퍼 상태입니다. 열거 값은 [ENUM-Offer Status]를 참고하세요. |
| country_code | string | 프로모션 타깃 지역입니다. 예: "US,CN" |
| stage | string | 오퍼 차원의 콜드 스타트 단계 |
| bid_type | string | 과금 모델 |
| bid_rate | float | 모든 오퍼 타깃 지역에 적용되는 기본 입찰가입니다. 특정 지역 또는 앱 입찰가가 설정되지 않은 경우에만 적용됩니다. |
| bid_rate_by_location | array<json> | 특정 지역의 입찰가입니다. 예: [{"target_geo":"US","bid_rate":"8.010"},{"country_code":"CN","bid_rate":"3.920"}] |
| budget | array<json> | 예산 정보 |
| offer_stop_reason | string | 오퍼가 일시 중지된 사유입니다. 예: 계정 잔액 부족, 사용 가능한 크리에이티브 없음, 클릭 트래킹 링크 유효하지 않음 |
| settlement_event | string | CPE 프로모션의 정산 이벤트 |
| tracking_method | string | 트래킹 방식입니다. 열거 값은 [ENUM-Tracking Method]를 참고하세요. |
| click_url | string | 클릭 어트리뷰션 트래킹 URL |
| impression_url | string | 뷰스루 어트리뷰션 트래킹 URL |
| os_version_min | string | 최소 OS 버전 |
| custom_ad_schedule | string | 프로모션 스케줄 |
| network | string | 디바이스 네트워크 상태 타깃 |
| target_ad_type | string | 광고 유형 |
| currency | string | 정산 통화입니다. 열거 값: "CNY", "USD" |
| target_device | string | 타깃 디바이스 유형 |
| click_url_status | string | 클릭 어트리뷰션 트래킹 URL의 테스트 상태입니다. 열거 값: PENDDING => Click URL이 테스트 대기 중이거나 통과하지 못해 계속 테스트 중입니다. PASS => Click URL을 사용할 수 있습니다. NOT_EXIST => Click URL이 null입니다. |
| target_app | array<json> | 차단 또는 타기팅된 앱의 상세 정보 |
| switch | int | 1=> 타깃 앱, 2=> 차단 앱, 0=> 제한 없음 |
| mtg_id | array<string> | mtgid |
| package | array<string> | 패키지명 |
| bid_rate_for_mtgid | array<json> | 특정 퍼블리셔의 입찰가 |
| apply_in_area | string | 타깃 지역 |
| mtgid | string | 퍼블리셔의 고유 ID |
| bid_rate | string | 특정 지역 내 특정 퍼블리셔의 입찰가 |
| maintain_by | string | 오퍼 수정 권한입니다. maintain_by="AM"이면 캠페인 또는 오퍼의 세부 정보만 확인할 수 있습니다. maintain_by="ADV"이면 캠페인 또는 오퍼 설정을 자유롭게 변경할 수 있습니다. |
| include_ta_id | array<int> | 포함할 타깃 오디언스 ID |
| exclude_ta_id | array<int> | 제외할 타깃 오디언스 ID |
| target_mtg_event | array<string> | 최적화할 목표입니다. Target-ROAS 또는 Target-CPE인 경우에만 반환됩니다. |
| target_original_event | string | 최적화할 원본 이벤트입니다. Target-CPE인 경우에만 반환됩니다. |
| target_goal_window | string | 최적화 목표의 시간 윈도우입니다. 열거 값: D0, D7. Target-ROAS 또는 Target-CPE인 경우에만 반환됩니다. |
| target_goal | double | 오퍼 차원의 최적화 목표값입니다. Target-ROAS 또는 Target-CPE인 경우에만 반환됩니다. |
| target_goal_by_geo | array<json> | 지역 차원의 최적화 목표값입니다. Target-ROAS 또는 Target-CPE인 경우에만 반환됩니다. |
| geo | string | geo |
| target_goal | double | 최적화 목표값 |
{
"msg": "success",
"code": 200,
"data": {
"page": 1,
"limit": 10,
"total": 520,
"list": [
{
"campaign_id": 111,
"campaign_name": "campaign_test",
"offer_id": 10010,
"uuid": "campaign_test",
"offer_name": "campaign_test_1",
"promote_timezone": 8,
"start_time": "2019-10-01",
"end_time": "2019-11-02",
"status": "RUNNING",
"country_code": "US,CN",
"bid_type": "CPI",
"bid_rate": "5.200",
"currency": "CNY",
"include_ta_id": [
1,
2,
3
],
"exclude_ta_id": [],
"bid_rate_by_location": [
{ "country_code": "US", "bid_rate": "8.010" },
{ "country_code": "CN", "bid_rate": "3.920" }
],
"budget": [
{
"country_code": "US",
"total_budget": "OPEN"
"daily_cap_type": "BUDGET",
"daily_cap": "OPEN"
},
{
"country_code": "CN",
"total_budget": 5000
"daily_cap_type": "CONVERSION",
"daily_cap": "OPEN"
}
],
"maintain_by": "ADV"
},
{
"campaign_id": 112,
"campaign_name": "campaign_test",
"offer_id": 10011,
"uuid": "campaign_test",
"offer_name": "campaign_test_2",
"promote_timezone": 8,
"start_time": "2019-10-01",
"end_time": "2019-11-02",
"status": "RUNNING",
"country_code": "US,CN",
"bid_type": "CPI",
"bid_rate": "5.200",
"currency": "CNY",
"include_ta_id": [
1,
2,
3
],
"exclude_ta_id": [],
"bid_rate_by_location": [
{ "country_code": "US", "bid_rate": "8.010" },
{ "country_code": "CN", "bid_rate": "3.920" }
],
"budget": [
{
"country_code": "ALL",
"total_budget": "OPEN"
"daily_cap_type": "BUDGET",
"daily_cap": "OPEN"
}
],
"maintain_by": "ADV"
}
]
}
}