Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Buzzvil’s Publisher Offerwall S2S API allows you to directly request Buzzvil servers for ads. It is designed to use standard HTTP protocols and return JSON payloads in response to the HTTP requests.

...

Field

Type

Description

id

Integer

Ad ID (identifier)

title

String

Ad title

description

String

Ad description

action_description

String

Description of the action required to participate in the ad

icon

String

Icon image address

revenue

String

Publisher rate

revenue_type

String

Type of ad. Consider additional types in the future.

  • cpi: App install

  • cpe: App launch or post-launch action

  • cpa: Action

  • cpl: Facebook Like

  • cpinsta: Instagram Follow

  • cps: Shopping

  • cpyoutube: YouTube Ad

  • cpq: Quiz

  • cpk: KakaoTalk channel subscription

  • cpylike: YouTube Subscribe + Like

  • cptiktok: TikTok Follow

  • cpnstore : Naver SmartStore Like

  • cpqlite : Quiz

  • cpcquiz : Quiz with contents

i.e. "cpicpl"

package_name

String

Android package_name

url_scheme

String

iPhone URL scheme

platform

String

Supported platforms

  • A: Android

  • I: iPhone

  • W: Both platforms

Note

Note: Platform parameters are set by ad operators at Buzzvil. If you manually change this value of an ad, it may not target the intended users.

age_from

Integer

Used to target users from a specified age.

  • When no age_from targeting:

    • null

age_to

Integer

Used to target users to a specified age.

  • When no age_to targeting:

    • null

age_ranges

JSON

Used to target multiple ranges of age.

If using the age_ranges parameter, age_from and age_to values can be ignored.

  • When there is age_ranges targeting:

    • [{"from":10, "to":20}, {"from":30, "to":40}]

  • When no age_ranges targeting:

    • []

sex

String

Used to target sex.

  • M: Male

  • F: Female

When there is no sex targeting:

  • null

relationship

String

Used to target marital status.

  • S: Single

  • M: Married

When there is no relationship targeting:

  • null

carrier

String

Used to target mobile carrier.

  • kt: KT

  • skt: SKT

  • lgt: LGT

When there is no carrier targeting:

  • null

udid_required

Bool

  • When udid value is required for Ad Participation Request and Conversion APIs

    • true

  • When udid value is not required for Ad Participation Request and Conversion APIs

    • false

device_name

String

Used to target device models.

  • Each device model is separated by a comma.

  • ex) SHV-E250S,SHV-E275K,SM-G928L

    • SHV-E250S OR SHV-E275K OR SM-G928L device model is targeted.

target_app

String

Used to target users with specific Android apps

  • Each app is separated by a comma.

  • To not target specific apps, add a dash ( - ) in front of the package names.

  • ex) Pl.idreams.skyforcehd,com.imangi.templerun2

    • Pl.idreams.skyforcehd OR com.imangi.templerun2 app is targeted

  • ex) com.thinkreals.couponmoa,-com.supercell.clashofclans

    • Target users who installed the com.thinkreals.couponmoa app or don’t target users with the com.supercell.clashofclans app

region

String

Used to target regions.

  • Each region is separated by a comma.

  • Can target 도/시

  • ex) 서울특별시 강남구,경상남도

    • 서울특별시 강남구 OR 경상남도 users are targeted.

creative

list

List of creatives

  • Detailed fields can be found in the 'creative Fields' table.

...

Field

Type

Description

unit_id

Integer

Publisher Unit ID

campaign_id

Integer

Ad ID

ifa

String

  • Android: Advertising ID(GAID)

  • iOS: Identifier for Advertiser(IDFA)

custom

String

Publisher app’s User ID

client_ip

String

IP address of the user who participated in the ad

ex) 123.123.123.123

udid

Status
colourYellow
titleRecommended

String

Android IMEI

Note

udid is not collectible since the release of Android 10

android_id

Status
colourYellow
titleRecommended

String

Android ID

udid_sha1

Status
colourYellow
titleRecommended

String

SHA1-applied Android IMEI

Note

udid is not collectible since the release of Android 10

android_id_sha1

Status
colourYellow
titleRecommended

String

SHA1-applied Android ID

sub_publisher_id

Status
title선택

String

Sub-publisher’s unit ID

sub_publisher_user_id

Status
title선택

String

Sub-publisher app’s user Id

device_name

Status
colourYellow
titleRecommended

String

Device model name

carrier

Status
colourYellow
titleRecommended

String

Mobile carrier

google_account_sha1

Status
colourYellow
titleRecommended

String

SHA1-applied Google account on the Android device

  • Only the first account is transmitted for multiple accounts

  • Can be retrieved by using the getAccountsByType("com.google") function.

    • Refer to 3) “How to Retrieve Google Accounts”

custom2

Status
title선택

String

Custom value specified by the publisher

  • value transmitted to the publisher by Buzzvil when making a postback request

  • Max length is 255

  • custom2~4 can be transmitted

custom3

Status
title선택

String

Custom value specified by the publisher

  • value transmitted to the publisher by Buzzvil when making a postback request

  • Max length is 255

  • custom2~4 can be transmitted

custom4

Status
title선택

String

Custom value specified by the publisher

  • value transmitted to the publisher by Buzzvil when making a postback request

  • Max length is 255

  • custom2~4 can be transmitted

...