항목 | 내용 | |
---|---|---|
1 | 요청 방향 | 매체사 → Buzzvil |
2 | HTTP Request method | GET |
3 | HTTP Request URL | |
4 | HTTP Request parameters | 아래 '1) HTTP Request parameters' 참고 |
5 | Response |
|
필드 | 유형 | 설명 |
---|---|---|
| Integer | 매체 앱 아이디 |
| Integer | 매체 지면 아이디 |
| String | 유저 개인 식별 정보. 어뷰징 필터링 및 CS 처리를 위해 필요합니다. 예제) ab4ade35-1c8a-4405-acda-10ca1ad1abe1 |
| String | 유저의 매체 아이디 |
| String | 클라이언트 아이피. 어뷰징 필터링을 위해 사용됩니다. 예제) 123.123.123.123 |
| String | 유저의 생년월일 생년월일 정보가 없을 경우 일부 광고가 할당에서 제외됩니다. 예제) 1993-01-09 |
| String | 성별 타게팅을 위한 정보. 성별 정보가 없을 경우 일부 광고가 할당에서 제외됩니다.
|
| String | 통신사 정보. 통신사 정보가 없을 경우 일부 광고가 할당에서 제외됩니다.
|
| String | 디바이스 모델명 디바이스 모델명이 없을 경우 일부 광고가 할당에서 제외됩니다. 예제) SHV-E250S,SHV-E275K,SM-G928L |
| Float | 위도 와 경도. 지역별 광고 타게팅에 사용됩니다. 정보가 없을 경우 일부 광고가 할당에서 제외됩니다. |
| Float | |
| String | User Agent. 정보가 없을 경우 일부 광고가 할당에서 제외됩니다. |
필드 | 유형 | 설명 |
---|---|---|
code | Integer | 처리결과 코드
|
msg | String | 처리결과 메세지 |
ads | List<Object> | 광고 목록 |
ads
세부 항목 (Response Fields - ads)필드 | 유형 | 설명 |
---|---|---|
| Integer | 광고 아이디 |
| String | 광고 설명 |
| List<String> | 사용자에게 광고를 노출시 호출되는 URL |
| Integer | 광고 참여 시 적립되는 포인트 금액 |
| String | 광고 타입
|
| Object | 광고 소재
|
creative
세부 항목 (Response Fields - ads - creative)필드 | 유형 | 설명 |
---|---|---|
| String | 광고 소재 제목 |
| String | 광고에 대한 상세 설명 |
| String | 광고 클릭 시 호출되는 URL |
| String | 광고의 참여를 유도하는 CTA 버튼의 UI 텍스트 예제) 참여하기 |
| Integer | 광고 소재의 가로 길이. 값은 1200으로 고정 |
| Integer | 광고 소재의 세로 길이. 값은 627으로 고정 |
| String | 광고주 아이콘 이미지 |
| String | URL 형태로 전달받는 광고 이미지 |
| Boolean | 리다이렉팅된 최종 URL의 Deeplink 여부 |
다음은 API를 호출한 결과로 얻는 Response parameter를 사용하여 광고 소재를 구성하고 사용자의 광고 참여 단계별로 필요한 구현을 하는 예시입니다.
1. Response parameter로 전달받은 필드를 사용하여 광고 레이아웃을 구성하세요.
필드 | 유형 | 설명 | 비고 |
---|---|---|---|
| String | 광고 소재 제목 |
|
| String | URL 형태로 전달받는 광고 이미지 |
|
| String | 광고에 대한 상세 설명 |
|
| String | 광고주 아이콘 이미지 |
|
| String | 광고의 참여를 유도하는 CTA 버튼의 UI 텍스트 |
|
| Integer | 광고 참여 시 적립되는 포인트 금액 |
2. 사용자에게 광고가 노출되면 impression_urls
로 전달한 URL을 호출합니다.
3. 사용자가 광고를 클릭하면 click_url
로 전달한 URL을 호출합니다.
4. 사용자가 정상적으로 광고 참여를 완료하면, 버즈빌 서버에서 매체사의 포스트백 URL으로 포인트 적립 요청을 시도합니다. 자세한 내용은 매체사 포인트 적립 포스트백 API 연동 가이드를 참고하세요.
|
아래 상태코드는 http status와 별개로, Response parameter 안에 code 라는 필드를 통해 내려갑니다.
코드 | 설명 |
---|---|
200 | 정상 |
1000 | 시스템 에러 |
9001 | 존재하지 않는 unit_id |
9004 | 유효하지 않은 파라미터 (요청에 required field가 누락됐을 경우 발생) |
9011 | 요청 unit이 inactive 상태인 경우 |
노출형 광고를 S2S API로 연동한 상태에서 커스텀 파라미터(Custom parameter)를 추가할 수 있습니다. 커스텀 파라미터를 추가하면 원하는 정보를 버즈빌로부터 포스트백 콜백(요청)과 함께 수신할 수 있습니다.
커스텀 파라미터를 추가하려면 사용자가 광고 클릭 시 호출되는 click_url
에 custom
파라미터를 추가하고 원하는 값을 설정하세요.
다음은 payload
값이 부여된 요청 URL에 가상의 clickID
key 값을 custom
파라미터로 추가한 예제입니다.
메서드 | 요청 URL |
---|---|
GET |
|
|
필드 | 유형 | 설명 | |
---|---|---|---|
| string | 광고 할당 시 버즈빌 서버에서 부여하는 암호화된 파라미터입니다. 사용자에게 포인트를 지급하기 위해 필요한 광고 정보가 들어 있습니다.
| |
| json (url-encoded) | 포스트백 콜백 시 받고자 하는 추가 정보를 설정하기 위한 인코딩된 파라미터입니다. |
커스텀 파라미터를 추가하면 버즈빌이 요청하는 포스트백에 custom
이 포함됩니다. 다음의 예제를 참고하세요.
{ ... "extra": { "custom": {"YOUR_KEY": "YOUR_VALUE"} }, ... } |
퍼블리셔 노출형 광고 S2S API는 광고 할당 수를 조정하는 |
광고가 보이는 시점에 |
응답 중 impression_urls key로 반환되는 값의 타입은 string list 인 것이 맞습니다. 다만 대부분 list의 길이가 1입니다. 반대로 말씀드리면 항상 1인 것은 아니라서, 해당 list 내의 모든 url을 호출해주시는 방식으로 구현을 부탁드립니다. |
|
|