Index
1. 광고 목록 조회
퍼블리셔가 받아볼 수 있는 광고 목록을 조회합니다.
항목 | 내용 | |
---|---|---|
1 | 요청 방향 | 매체사 → BuzzAd |
2 | HTTP Request method | GET |
3 | HTTP Request URL | |
4 | HTTP Request parameters | Field 설명
|
5 | Response |
|
2) Response Fields
Field | Type | Description |
---|---|---|
| list | 광고 목록
|
| String | 처리 결과 코드
|
| String | 처리 결과 메세지 |
ads
세부 항목 (Response Fields - ads)
Field | Type | Description |
---|---|---|
| Integer | 광고 아이디 (식별값) |
| String | 광고 제목 |
| String | 광고 설명 |
| String | 광고 적립방법 설명 |
| String | 아이콘 이미지 주소 |
| Decimal | 매체사 단가 |
| String | 광고 타입. 추후 새로운 타입이 추가될 수 있으므로 연동시 이를 고려해야 합니다.
예제) “cpc” |
| String | 안드로이드 package_name |
| String | 아이폰 url scheme |
| String | 광고가 지원되는 플랫폼
해당 파라미터는 광고운영단에서 세팅되는 값이며 W로 내려가는 값을 매체사 측에서 다시 필터링 하여 내리는 경우 올바른 유닛에 광고가 내려가지 않을 수 있음 |
| Integer | 나이 하한 타게팅. 타게팅이 없는 경우 |
| Integer | 나이 상한 타게팅. 타게팅이 없는 경우 |
| JSON | 다 구간 나이 타게팅. age_ranges를 사용하는 경우 age_from, age_to 값은 무시해도 된다.
|
| String | 성별 타게팅. 타게팅이 없는 경우
|
| String | 결혼 유무 타게팅. 타게팅이 없는 경우
|
| String | 통신사 타게팅. 타게팅이 없는 경우
|
| Bool |
|
| String | 디바이스 모델 타게팅
|
| String | 앱 타게팅 (안드로이드만 지원)
|
| String | 지역 타게팅
|
| list | creative 목록
|
| Bool | 멀티 미션 포함 여부 (True: 멀티 미션 광고 / False: 일반 CPA 광고) 멀티 미션 캠페인은 광고에 단 한 번 참여해도 여러 개의 미션을 동시에 완료할 수 있는 구조입니다. 이처럼 보상을 여러 번 지급해야 하는 특성상 보상 횟수(프리퀀시)를 무제한으로 설정해야 정상적으로 동작합니다. 만약 보상 횟수에 제한이 있으면 멀티 미션 캠페인을 연동하기 어렵습니다. |
| list | missions 목록 해당 필드는 |
creative
세부 항목 (Response Fields - ads - creative)
Field | Type | Description |
---|---|---|
| Integer | creative ID |
| String | 짧은 참여방법/주의사항 기재 |
| integer | native creative 가 세팅 되어 있는 경우 627 (고정값), 없는 경우 0 |
| integer | native creative 가 세팅 되어 있는 경우 1200 (고정값), 없는 경우 0 |
| String | 참여방법 및 주의사항이 기재 |
| String | ex) 팔로워 누르러 가기 |
| String | Native creative가 세팅되어 있을 경우에만 native 타입의 이미지 파일 url이 담김 |
| String | 오퍼월 리스트내에 볼수 있는 아이콘 이미지 |
missions
세부 항목 (Response Fields - ads - missions)신규(25.02~)
Field | Type | Description |
---|---|---|
| Integer | 멀티 미션 광고 식별값(ID) |
| String | 멀티 미션 광고유형 현재는 "multi_event" "screenshot" "quiz" |
| String | 멀티 미션 광고명 |
| String | 멀티 미션 광고 설명 |
| Decimal | 멀티 미션 광고 당 지급되는 매체 수수료 |
신규(25.02~) 멀티 미션 완료 여부 상태는 포인트 적립 시 https://buzzvil.atlassian.net/wiki/spaces/BDG/pages/404684961/7.+S2S+API#4.-%ED%8F%AC%EC%9D%B8%ED%8A%B8-%EC%A0%81%EB%A6%BD-%ED%8F%AC%EC%8A%A4%ED%8A%B8%EB%B0%B1-API-%EC%97%B0%EB%8F%99 API 응답값에서 mission_id
필드로 미션 완료 상태 관리를 하시길 바랍니다. API 응답값에는 완료 여부 상태와 관계없이 멀티 미션 캠페인 정보를 전달합니다.
신규(25.02~) 멀티 미션 노출 순서는 응답값으로 전달하는 리스트 객체 순서 그대로입니다. 참고 부탁드립니다.
4. 포인트 적립 포스트백 API 연동
BuzzAd에서 유저가 목표한 액션을 수행 시 매체사로 보내주는 리퀘스트입니다.
버즈애드에서 포인트 적립이 발생했을 때 버즈애드에서 직접 매체사 유저들에게 포인트를 지급하는 것이 아닙니다. 버즈애드 서버에서 매체사 서버로 포인트 적립 요청을 보낼 뿐이고, 실제 지급은 매체사 서버에서 처리합니다.
매체사 포인트 적립 포스트백 API 연동 문서를 참고하여 API 연동 후, endpoint url을 버즈빌 매니저에게 전달해주세요.
신규(25.02~) 멀티 미션 광고일 경우 기존 포스트백 API에서 extra
필드에 mission_id
데이터를 전송할 예정입니다. 포인트 적립 연동 시 해당 mission_id 필드로 특정 미션에 대한 적립을 핸들링하실 수 있습니다. 참고 부탁드려요.
{ "user_id": "12345", "point": 1, "transaction_id": "126905422_10000001", "event_at": 1641452397, "unit_id": 5539189976900000, "action_type": "l", "title": "타이틀", "mission": "{\"id\": 1}" }