애드박스 애드월 연동 가이드

1. 개요

이 가이드는 애드박스 애드월 연동 방법을 기술한 가이드 문서입니다.


2. 애드월 동작 흐름

1. 회원이 애드월에서 홍보 링크를 발급받아 홍보 진행
2. 홍보 링크를 통해 설치 및 실행 발생
3. 회원 애드월의 '적립 내역' 페이지에 발생한 설치에 대한 적립금이 누적
4. 발생한 설치에 대하여 5일간 애드박스 검수팀에서 부정 설치 여부를 검수(부정 설치로 판별될 경우 해당 설치건 취소 및 삭제)
5. 검수 기간 종료 후 정상 설치건들의 적립금이 실제 서비스의 보상으로 전환(콜백 URL 호출)
6. 전환된 적립금은 회원 애드월의 '지급 내역' 페이지에서 확인 가능


3. SDK 공통 연동

SDK 공통 연동 가이드를 참고하여 SDK 공통 연동을 진행해주시기 바랍니다.
SDK 공통 연동 가이드 : http://www.adbox.co.kr/guide/sdk.php


4. 애드월 설정

아래의 항목들을 커스터마이징 가능하며 별도의 코드 수정 없이 실시간으로 적용이 가능합니다.
설정 요청은 메일로 부탁드립니다.

테마 색상 : 전체적인 테마 색상입니다. RGB Code로 전달 부탁드립니다. (ex. #123456)
상단 제목 표시 설정 : 상단 제목 표시 여부입니다. (ex. 표시, 미표시)
상단 제목 텍스트 : 상단 제목 텍스트를 설정하실 수 있습니다. (ex. 참여하기)
보상 단위명 : 지급되는 보상의 단위입니다. (ex. Point)
보상 비율 : 단가 대비 보상 비율입니다. 캠페인 단가가 300원일 경우 10%로 설정 시 회원에게 30원이 지급됩니다.
보상 버림 단위 : 보상 비율 적용 후 버림될 단위 입니다. 캠페인의 보상이 123이라면 10의 자리 설정시 캠페인 보상이 100으로 노출됩니다.(ex. 미설정, 10의 자리, 100의 자리)
상단 배너 : 상단 제목과 애드월 리스트 사이에 배너 삽입이 가능합니다. (ex. 첨부파일 또는 URL)
전환 메시지 표시 여부 : 설정시 회원에게 보상 전환 완료시에 '7월 25일 100 Point 전환이 완료되었습니다.'라는 기본 메시지가 노출됩니다.(ex. 설정, 미설정)
콜백 URL : 참여하기 1~3Day 미션 완료 시에 호출되는 콜백 URL입니다. 하단의 '7. 콜백 서버 연동' 확인 후 작성 부탁드립니다.

[담당자 연락처]
애드박스 운영 담당 황태경 매니저
hwangtg@monawa.com


5. 회원 아이디 설정

애드월 노출 전에 ADBoxAd.setUserId(context, userid) 메소드를 호출하여 회원 아이디를 SDK에 설정합니다.
userid에 회원의 고유 아이디값을 입력해주세요.
※ 회원마다 중복되지 않는 고유값이여야 하며, 아이디의 길이는 150자 내외로 설정해주시기 바랍니다.
※ SDK 초기화 후, 애드월 노출 전에 회원 아이디가 설정되어야 합니다.
ADBoxAd.setUserId(this, userid);


6. 애드월 노출

ADBoxAd.show(context, spotKey) 메소드를 호출합니다.
spotKey에 발급받으신 스팟 키를 입력해주세요.
ADBoxAd.show(this, spotKey);


7. 애드월 콜백 서버 연동

7-1. 애드월 콜백 URL 가이드

애드월에서 검수가 완료된 수익을 회원에게 지급 처리하기 위해 콜백 URL을 설정해야합니다.
콜백 URL은 다음 파라미터들을 포함하여 설정하실 수 있습니다.
URL에 포함된 파라미터들은 보상 전환 시에 각 파라미터에 해당되는 실제 값으로 치환됩니다.

파라미터 설명
{change_id} 전환 아이디(중복 전환 방지를 위해 사용)
{app_key} APP Key
{spot_key} 스팟 키
{userid} 회원 아이디
{reward} 보상 금액

콜백 URL 예제
http://server.com/callback.php?change_id={change_id}&app_key={app_key}&spot_key={spot_key}&userid={userid}&reward={reward}

7-2. 애드월 콜백 보상 지급 및 응답

설정된 콜백 서버에서 회원에게 보상을 지급한 뒤에, 처리 결과를 JSON 타입으로 회신하여야 합니다.
아래에 내용을 참고하시어 적절한 응답을 회신 처리 부탁드립니다.

보상 지급 성공
{"result":"1","msg":"7월 25일 100 포인트 전환이 완료되었습니다."}
※ msg는 optional한 값입니다. 전환 메시지 표시 여부를 설정하셨다면 msg값을 회신하지 않아도 기본 설정된 메시지가 노출됩니다.

보상 지급 실패
{"result":"0","msg":"7월 25일 100 포인트 전환을 실패하였습니다.\n소문내기 창을 종료 후 다시 실행해주세요."}
※ msg는 optional한 값입니다. 전환 메시지 표시 여부를 설정하셨다면 msg값을 회신하지 않아도 기본 설정된 메시지가 노출됩니다.

PHP 예제
<?
//$change_id : 전환 아이디
//$userid : 회원 아이디
//$reward : 보상 금액

if(/*이미 지급 처리된 change_id일 경우*/){
   echo "{\"result\":\"0\",\"msg\":\"이미 포인트가 전환되었습니다.\"}";
}else{
   //$userid, $reward 값으로 보상 지급 처리
   echo "{\"result\":\"1\",\"msg\":\"7월 25일 100 포인트가 전환되었습니다.\"}";
}
?>