요청 방향

매체사 → Buzzvil

HTTP Request method

GET

HTTP Request URL

https://screen.buzzvil.com/api/s2s/ads

HTTP Request parameters

아래 '1) HTTP Request parameters' 참고

Response

• JSON 형식

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

필수app_id

Integer
(MAX 20)

매체 앱 아이디

필수unit_id

Integer
(MAX 20)

매체 지면 아이디

필수ifa

String
(MAX 64)

사용자의 광고식별자. 광고 타게팅 및 어뷰징 필터링, CS 처리를 위해 필요합니다. 광고식별자 수집이 불가능할 경우 uuid 포맷을 모두 0으로 채워 요청해야 합니다.

예제) ab4ade35-1c8a-4405-acda-10ca1ad1abe1

광고식별자 수집이 불가능할 경우 전달 값) 00000000-0000-0000-0000-000000000000

필수user_id

String
(MAX 65)

사용자 고유 식별자입니다. 서비스 도중 변하지 않는 고정 값이며, 광고 할당을 위한 필수 정보입니다. 최대 65자까지만 전달이 가능합니다.

필수client_ip

String
(MAX 45)

광고에 참여한 유저의 ip

실제 유저의 ip 값을 전달해 주어야 합니다. 그러지 않을 경우 CPA 유형의 광고 송출이 불가합니다.

예제) 123.123.123.123

권장ifv

string
(MAX 64)

iOS 앱 벤더식별자(IDFV). iOS에서 유저가 앱 추적 허용을 하지 않아 광고식별자 수집이 불가능할 경우엔 필수로 전달해주어야 하는 값입니다. 사용자 식별을 위한 대체식별자로 사용됩니다.

예제) ab4ade35-1c8a-4405-acda-10ca1ad1abe1

권장birthday

String
(MAX 10)

유저의 생년월일

생년월일 정보가 없을 경우 일부 광고가 할당에서 제외됩니다.

예제) 1993-01-09 ( O ) 19930109 ( X )

권장gender

String
(MAX 20)

성별 타게팅을 위한 정보.

성별 정보가 없을 경우 일부 광고가 할당에서 제외됩니다.

• M: 남자

• F: 여자

권장revenue_types

String
(MAX 255)

할당 받을 광고 상품 타입. 값이 비어있을 경우, 노출형 광고(cpm, cpc)만 할당됩니다.

할당을 원하지 않는 상품타입이 있다면, 상품타입값 앞에 음수기호(-)를 추가하면 됩니다.

예제) [“cpc”, “cpm”, “cpq”, “cpinsta”, “cpa”, “cpk”, “cpl”, “cpcquiz”]

인코딩 주의 %5B%22cpm%22%2C%22cpa%22%2C%22cpq%22%2C%22cpinsta%22%2C%22cpk%22%2C%22cpl%22%2C%22cpc%22%5D

액션형 광고만 할당받는 예제) [“-cpc”, “-cpm”]

권장platform

String

기기의 OS 정보

• A: Android

• I: iOS

권장country

String

요청 IP의 국가 정보.

현재는 국내 광고만 송출되고 있기 때문에 KR로 고정해서 호출해 주세요.

권장carrier

String
(MAX 20)

통신사 정보.

통신사 정보가 없을 경우 일부 광고가 할당에서 제외됩니다.

• kt: KT 통신사

• skt: SKT 통신사

• lgt: LGT 통신사

권장device_name

String
(MAX 255)

디바이스 모델명

디바이스 모델명이 없을 경우 일부 광고가 할당에서 제외됩니다.

예제) SHV-E250S,SHV-E275K,SM-G928L → SHV-E250S 또는 SHV-E275K 또는 SM-G928L 인 유저에게 타게팅

권장latitude

Float
(MAX 32)

위도 와 경도. 지역별 광고 타게팅에 사용됩니다.

정보가 없을 경우 일부 광고가 할당에서 제외됩니다.

권장longitude

Float
(MAX 32)

권장user_agent

String
(MAX 255)

User Agent.

정보가 없을 경우 일부 광고가 할당에서 제외됩니다.

권장 target_fill

Int
(MAX 4)

할당받을 광고갯수. 한번에 할당 가능한 최대 target_fill은 20 입니다.

권장 cursor

String

(MAX 3000)

할당에서 제외할 광고 데이터

할당 요청에 대한 response에 cursor가 포함되어 있습니다. 이후의 request parameter에 포함하면 기존에 할당받은 광고가 제외된 광고 목록을 받을 수 있습니다.

예제) EvTIfLfbEUk7O_ylo5_rVBaEmt0jvIZvbI4o47azTNLDwGwbz2OoO522T4-9AzrlDwxo4ucwZ7pFg6LD-ReBNI8Yi9TKxWurSDIPvAhkqWuzY07jI_ej4Lngk_YeehlipFFV0ZfL8dnAY00xs6ydXTllkP_g_UOhHoyxxgyr3Qldp53TLXwTiv-7asYPa5H8

code

Integer

처리결과 코드

• 200인 경우에만 참여 가능: 자세한 내용은 아래 상태코드 참고

msg

String

처리결과 메세지

ads

List<Object>

광고 목록 : 가변 길이입니다.

아래의 Ads 필드 값에 따라 결정됩니다.

cursor

String

할당받은 광고 데이터

id

Integer

광고 아이디

예제) 10075328

name

String

광고 설명

예제) "11번가 신선밥상"

impression_urls

List<String>

사용자에게 광고를 노출시 호출되는 URL

예제) https://ad-staging.buzzvil.com/api/impression?data=ReOJjkH6mus-sxbys_1F2Bg9EHwkoGAAfb86yWB

reward

Integer

광고 참여 시 적립되는 포인트 금액

예제) 100

reward_condition

String

리워드 지급을 위한 조건

• 클릭시 적립: click

• 특정 액션 수행시 적립: action

예제)

노출형 광고상품: “click”

액션형 광고상품: “action”

노출형 광고상품이지만 특정 액션을 수행해야 적립되는 광고: “action”

check_participation_url

String

reward_condition이 “action”일 때, 캠페인 참여 여부를 확인하는 API URL 주소. check_participation_url을 호출해 사용자에게 참여완료 여부를 알려줄 수 있습니다. 사용자가 광고를 참여한 후 지면에 복귀했을 때, 호출합니다.

예제)

reward_condition이 "click"일 때: ""

reward_condition이 "action"일 때: “https://ad.buzzvil.com/api/check_conversion?data=ReOJjkH6mus"

type

String

광고 타입

노출형 상품

• cpc: 클릭형 상품

• cpm: 노출형 상품

액션형 상품

• cpa: 일반 참여형 상품

• cpk: 카카오톡 채널 추가 상품

• cpq: 퀴즈 상품

• cpqlite: 퀴즈 상품

• cpl: 페이스북 좋아요 상품

• cpyoutube: 유튜브 구독 상품

• cps: 쇼핑형 상품

• cptiktok: 틱톡 팔로우 상품

• cpnstore: 네이버 스토어 알림설정 상품

• cpe: 앱내 이벤트 참여 상품

• cpylike: 유튜브 구독+좋아요 상품

• cpinsta: 인스타그램 팔로우 상품

• cpcquiz : 퀴즈 적립 컨텐츠

예제) “cpc”

creative

Object

광고 소재

• 자세한 사항은 하단 'creative 세부 항목' 표 참고

payload

String

액션형 광고 참여시 필요한 콜백 파라미터를 인코딩한 문자열

노출형 광고 예제) ““

액션형 광고 예제) “zh8qPfFDUycs3d_p_4kIv_8P1Q8etYu1xDtf4VDmTYyxzwqSdiPGXPXeVQGPD"

external_browser

Boolean

광고 클릭 시 랜딩 페이지가 외부 브라우저에서 열려야하는지 여부

예제) true, false

title

String

광고 소재 제목

예제) “LG전자 베스트샵 카카오톡 채널추가”

description

String

광고에 대한 상세 설명

예제) “LG전자 베스트샵 이벤트, 풍성한 혜택 정보까지! 가장 먼저 만나보세요!”

click_url

String

광고 클릭 시 호출되는 URL. cpc, cpm 광고만 값이 채워짐.

노출형 광고 예제) “https://screen.buzzvil.com/api/s2s/click_redirect/?payload=eytY9sky7fy45qys84KAzTqBAQeSDSKtvTolx1-Zy9Y8ND9t1hE1Mn”

액션형 광고 예제) ““

call_to_action

String

광고의 참여를 유도하는 CTA 버튼의 UI 텍스트

예제) 참여하기

width

Integer

광고 소재의 가로 길이. 값은 1200으로 고정

예제) 1200

height

Integer

광고 소재의 세로 길이. 값은 627으로 고정

예제) 627

icon_url

String

광고주 아이콘 이미지 URL

예제) https://d3aulf22blzf9p.cloudfront.net/uploads/1662458645-S98R6.png

image_url

String

광고소재 이미지 URL

예제) https://d3aulf22blzf9p.cloudfront.net/uploads/1677571904-JZ8YB.jpg

is_deeplink

Boolean

리다이렉트 될 최종 URL의 Deeplink 여부

예제) true, false

필수 title

String

광고 소재 제목

• 최대 10자

• 생략 부호로 일정 길이 이상은 생략 가능

필수image_url

String

URL 형태로 전달받는 광고 이미지

• 종횡비 유지 필수

• 여백 추가 가능

• 이미지 너비: width / 이미지 높이: height

필수 description

String

광고에 대한 상세 설명

• 생략 부호로 일정 길이 이상은 생략 가능

• 최대 40자

필수 icon_url

String

광고주 아이콘 이미지

• 종횡비 유지 필수

필수 call_to_action

String

광고의 참여를 유도하는 CTA 버튼의 UI 텍스트

• 최대 7자

• 생략 부호로 일정 길이 이상은 생략 가능

필수 reward

Integer

광고 참여 시 적립되는 포인트 금액

200

정상

1000

시스템 에러

9001

존재하지 않는 unit_id

9004

유효하지 않은 파라미터 (요청에 required field가 누락됐을 경우 발생)

9011

요청 unit이 inactive 상태인 경우

GET

https://screen.buzzvil.com/api/s2s/click_redirect/?payload=Zx786y9pnCkUYZfeL1PHHodk8Ae80CPEw%3D%3D&custom=%7B%22clickId%22%3A%20%22sample-clickId%22%7D

필수 payload

string

광고 할당 시 버즈빌 서버에서 부여하는 암호화된 파라미터입니다. 사용자에게 포인트를 지급하기 위해 필요한 광고 정보가 들어 있습니다.

옵션 custom

json (url-encoded)

포스트백 콜백 시 받고자 하는 추가 정보를 설정하기 위한 인코딩된 파라미터입니다.

요청 방향

매체사 → Buzzvil

HTTP Request method

POST

Content-Type

application/x-www-form-urlencoded

HTTP Request URL

https://ad.buzzvil.com/api/v1/participate

HTTP Request parameters

• Field 설명은 아래 ‘1) HTTP Request parameters’ 표 참고

Response

• JSON 형식으로 반환

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

필수 unit_id

Integer

매체 아이디

필수 campaign_id

Integer

광고 아이디

필수 ifa

String

• 안드로이드 광고 아이디(GAID)

• 또는 iOS Identifier for Advertiser(IDFA)

예제) ab4ade35-1c8a-4405-acda-10ca1ad1abe1

광고식별자 수집이 불가능할 경우 예제) 00000000-0000-0000-0000-000000000000

필수 custom

String

사용자 고유 식별자입니다. 서비스 도중 변하지 않는 고정 값이며, 광고 할당을 위한 필수 정보입니다.

필수 client_ip

String

광고에 참여한 유저의 ip

실제 유저의 ip 값을 전달해 주어야 합니다. 그러지 않을 경우 CPE, CPA 유형의 광고 송출이 불가합니다.

예제) 123.123.123.123

필수 payload

String

광고 할당 시 응답받았던 payload

예제) “zh8qPfFDUycs3d_p_4kIv_8P1Q8etYu1xDtf4VDmTYyxzwqSdiPGXPXeVQGPD"

권장 ifv

String

iOS 앱 벤더식별자(IDFV). iOS에서 유저가 앱 추적 허용을 하지 않아 광고식별자 수집이 불가능할 경우엔 필수로 전달해주어야 하는 값입니다. 사용자 식별을 위한 대체식별자로 사용됩니다.

예제) ab4ade35-1c8a-4405-acda-10ca1ad1abe1

권장 user_id

String

사용자 고유 식별자

최대 65자까지만 전달 가능합니다.

권장 device_name

String

디바이스 모델 이름

권장 carrier

String

해당하는 통신사

예제) kt , skt, lgt

custom2 선택

String

매체사에서 지정하는 커스텀 파라미터

• 버즈빌에서 매체사로 포스트백 request 시 전달 되는 값

• 최대 길이는 255

• custom2~4까지 전달 가능

custom3 선택

String

매체사에서 지정하는 커스텀 파라미터

• 버즈빌에서 매체사 로 포스트백 request 시 전달 되는 값

• 최대 길이는 255

• custom2~4까지 전달 가능

custom4 선택

String

매체사에서 지정하는 파라미터

• 버즈빌에서 매체사로 포스트백 request 시 전달 되는 값

• 최대 길이는 255

• custom2~4까지 전달 가능

code

Integer

처리결과 코드

• 200이면 정상 참여 가능

• 이 외 code는 아래 3) 'Status Code' 표 참고

msg

String

처리결과 메세지

action_description

String

액션형 광고 참여 안내 및 주의사항 문구

예제) "[참여방법]\n- '채널 추가' 후 대화창에 전송된 환영메시지를 복사해 입력해주세요.\n\n[주의사항]\n- 이미 추가한 카카오톡 채널은 포인트가 지급되지 않습니다.\n- 카카오톡 채널의 환영메시지를 정확히 입력 후 '환영메시지 제출하기' 버튼을 눌러야 포인트가 지급됩니다.\n- 동일인이 부정한 방법으로 여러번 참여를 시도할 경우, 포인트 지급 및 추후 광고 참여에 제재가 가해집니다.\n- 30일 이내 채널을 차단한 경우, 이후 캠페인 참여시 불이익을 받을수 있습니다."

landing_url

String

광고주 페이지 랜딩 URL

200

정상

401

블랙리스트 유저

402

잘못된 ip 주소 형식

1000

시스템 에러

9001

존재하지 않는 unit_id

9004

유효하지 않은 파라미터 (요청에 required field가 누락됐을 경우 발생)

9008

존재하지 않는 캠페인

9011

요청 unit이 inactive 상태인 경우

9013

비활성화된 캠페인

9014

현재 캠페인이 라이브 중이 아니거나, 해당 매체에 타게팅되어 있지 않은 경우

9020

이미 캠페인에 참여한 경우

9021

캠페인이 모두 소진된 경우

9022

광고식별자 수집이 불가한 사용자가 광고식별자 필수 캠페인을 클릭한 경우

9031

알 수 없는 애드네트워크 캠페인 에러

9037

클릭한 사용자가 타게팅 조건에 맞지 않아 참여가 불가능한 경우

9040

광고식별자 형식이 잘못됐거나, 추적이 불가한 식별유형일 경우(e.g. 0000…)

요청 방향

매체사 → Buzzvil

HTTP Request method

GET

HTTP Request URL

광고요청시 받은 check_participation_url

Response

• Field 설명은 아래 ‘1) Response’ 표 참고

result

Boolean

사용자의 캠페인 참여 여부

예제) true

요청 방향

매체사 → Buzzvil

HTTP Request method

GET

HTTP Request URL

https://ad.buzzvil.com/offerwall/inquiry

HTTP Request parameters

아래 '1) HTTP Request parameters' 참고

Response

HTML

필수 app_id

Integer

버즈빌 매니저로부터 발급받은 App ID

필수 ifa

String

• 안드로이드 광고 아이디(GAID)

• 또는 iOS Identifier for Advertiser(IDFA)

예제) ab4ade35-1c8a-4405-acda-10ca1ad1abe1

광고식별자 수집이 불가능할 경우 예제) 00000000-0000-0000-0000-000000000000

필수 user_id

String

사용자 고유 식별자

필수 platform

String

플랫폼 구분을 위해 필요한 Enum 구분값.

• iOS: I

• Android: A

iOS 예제) I

Android 예제) A

권장 ifv

String

iOS 앱 벤더식별자(IDFV). iOS에서 유저가 앱 추적 허용을 하지 않아 광고식별자 수집이 불가능할 경우엔 필수로 전달해주어야 하는 값입니다. 사용자 식별을 위한 대체식별자로 사용됩니다.

예제) ab4ade35-1c8a-4405-acda-10ca1ad1abe1

요청 방향

매체사 → Buzzvil

HTTP Request Method

GET

HTTP Request URL

https://screen.buzzvil.com/api/s2s/ads/meta

HTTP Request Parameters

광고 할당 요청 API와 동일*

Response

• JSON 형식

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

code

Integer

처리결과 코드

• 200이면 정상 응답

• 이 외 code는 아래 3) 'Status Code' 표 참고

message

String

처리결과 메세지

result

JSONObject

총 적립 가능 금액과 ifa의 변경 여부를 나타냅니다.

• 설명은 아래 3) "result Description” 표 참고

200

정상

1000

시스템 에러

9001

존재하지 않는 unit_id

9004

유효하지 않은 파라미터 (요청에 required field가 누락됐을 경우 발생)

9011

요청 unit이 inactive 상태인 경우

total_reward

Integer

최대로 적립 받을 수 있는 리워드입니다.

예제) “total_reward”: 97215

is_modified_ifa

Boolean

ifa 변경 여부를 확인합니다.

• true: ifa의 변경이 있었음

• false: ifa의 변경이 없었음