광고주를 위한 API 세팅 가이드 for CPS

1. 광고 목록 조회

버즈빌에서 광고주의 상품 목록을 조회하기 위해서는 상품 list 정보를 담고있는 api 호출이 필요합니다.

항목

내용

항목

내용

1

요청 방향

BuzzAd → 광고주

2

HTTP Request method

GET

3

HTTP Request URL

광고주의 상품 리스트

4

HTTP Request parameters

Field 설명

  • channel_id (Integer): optional 매체사 식별을 위한 아이디. 버즈빌이 광고를 받아 오는 것을 확인하기 위한 ID 를 담는 파라미터

5

Response

  • JSON 형식으로 반환

  • Field 설명은 아래 ‘5) Response Fields' 표 참고

5) Response Fields

Field

Type

Description

Field

Type

Description

list

list

상품 목록

  • 자세한 아이템은 아래 'list 세부 항목' 표 참고

code

String

처리 결과 코드

  • 200인 경우에만 정상

msg

String

처리 결과 메세지

 

list 세부 항목 (Response Fields - list)

Field

Type

Description

Field

Type

Description

id

Integer

필수 상품 아이디 (식별값)

title

String

필수 상품명

description

String

필수 상품 설명

icon

String

필수 상품 아이콘 이미지 url

아이콘의 이미지 사이즈는 320* 320 이어야 합니다.

landing_url

String

필수 상품 랜딩페이지 url

unit_price

Integer

필수 상품 판매당 버즈빌에 지급되는 수수료. 해당 수수료에는 매체비, 유저 리워드가 포함됩니다.

full_price

Integer

필수 상품의 정가
discounted_price를 주지 않는 경우, full_price가 실제 유저가 결제하는 금액이 됩니다.

discounted_price

Integer

optional (할인이 들어간 경우) 실제 유저가 지불하는 금액

category

Integer

필수 해당 상품의 카테고리
상품 카테고리명 각각에 대해 id값을 정하여 integer 형태로 전달이 필요합니다. 연동 커뮤니케이션 진행시 카테고리가 어떻게 구분되어지는지 정리된 목록 공유 부탁드립니다.

예: 패션&뷰티 : 100, 패션&뷰티 → 여성 성인 패션 : 101, 패션&뷰티 → 남성 성인 : 102

revenue_type

String

필수 광고 타입. 추후 새로운 타입이 추가될 수 있으므로 연동시 이를 고려해야 합니다.

  • cps: 쇼핑 적립형 광고

images

list

필수 image 목록

  • 자세한 아이템은 아래 'images 세부 항목' 표 참고

 

images 세부 항목 (Response Fields - list - images)

Field

Type

Description

Field

Type

Description

type

Integer

images type

  • 1: native (height: 627 px, width: 1200 px)

  • 2: lock (height: 2340 px, width: 1080 px)

image_url

String

상품 이미지를 받아올 수 있는 url

 

api 호출 실패를 대비하여, 가능하시다면 서버응답 코드 역시 공유해주시길 부탁드립니다.
상품 리스트가 존재하지 않는 경우 혹은 종료된 상품을 포함하고 있는 경우 포스트백 에러가 발생 할 수 있습니다.
상품 상태가 항상 판매가능 할 수 있도록 세팅 부탁드리며 에러 케이스에 대한 에러코드 세팅 후 공유 부탁드립니다.

2. 상품 구매 완료 시 필요한 연동 프로세스

사용자가 광고상품 구매를 완료하면 BuzzAd 서버로 액션이 수행 되었음을 알려주어야 합니다. 이를 위한 연동 프로세스는 하단의 링크에서 확인 가능하십니다.

상단의 연동 과정을 진행하셨다면, 하단의 링크 속 페이지에서 반드시 자바스크립트 연동이 아닌,
server to server API 연동으로 진행 부탁드립니다.
https://buzzvil.atlassian.net/wiki/spaces/BDG/pages/1050476879/3.+CPS+Web#2.-Server-to-Server-%EC%97%B0%EB%8F%99---%EC%95%A1%EC%85%98-%EB%8B%AC%EC%84%B1-API