Bid Specification

kakao RTB Bid 요청과 응답 상세 스펙입니다.

1. Bid Request Specification

circle-check

1-1. Object Specifications

Object : Bid Request

Attribute
Type
Description
kakao Description

id

string; required

BidRequest의 고유 ID값

해당 값은 Bid Response의 “id”와 매핑

imp

object array; required

site

object; recommended

app

object; recommended

device

object; recommended

user

object; recommended

test

integer

0=live mode, 1= test mode

0

at

integer

1 = First Price

tmax

integer

Maximum time in milliseconds to submit a bid to avoid timeout.

180

(별도 협의 사항)

cur

string array

Array of allowed currencies for bids on this bid request using ISO-4217 alpha codes.

KRW, USD (별도 협의 사항)

bcat

string array

Blocked advertiser categories using the IAB content categories.

badv

string array

Block list of advertisers by their domains (e.g., “ford.com”)

source

object

ext

object

Object : Source

Attribute
Type
Description
kakao Description

fd

Integer; recommended

Entity responsible for the final impression sale decision, where 0 = exchange, 1 = upstream source.

tid

string; recommended

Transaction ID that must be common across all participants in this bid request (e.g., potentially multiple exchanges).

schain

object; recommended

This object represents both the links in the supply chain as well as an indicator whether or not the supply chain is complete. Details via the SupplyChain object

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

Object : Regs

Attribute
Type
Description
kakao Description

coppa

integer

Flag indicating if this request is subject to the COPPA regulations established by the USA FTC, where 0 = no, 1 = yes.

coppa=1인 앱의 경우 adid 전달되지 않음

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

Object : Imp

Attribute
Type
Description
kakao Description

id

string; required

A unique identifier for this impression within the context of the bid request

단일 imp.id를 통해 Multi-Ad-Format을 지원 가능 (Banner Object & Native Object)

banner

object

native

object

1.2

displaymanager

string

Name of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).

카카오 SDK를 심은 경우 “adfit”으로 전달함

displaymanagerver

string

Version of ad mediation partner, SDK technology, or player responsible for rendering ad (typically video or mobile).

tagid

string

Identifier for specific ad placement of ad tag that was used to initiate the auction

bidfloor

float

Minimum bid for this impression expressed in CPM.

bidfloorcur

string

Currency specified using ISO-4217 alpha codes.

KRW, USD (cur와 동일)

secure

integer

0=non-secure, 1=secure.

rwdd

integer; default 0

Indicates whether the user receives a reward for viewing the ad, where 0 = no, 1 = yes.

보상형 동영상 상품의 경우, 1로 전달함

ext

object

Placeholder for exchange-specific extensions to OpenRTB.

보상형 동영상 상품의 경우, "rewarded": 1도 추가 전달함

Object : Banner

Attribute
Type
Description
kakao Description

format

object array; recommended

다중 사이즈 송출 가능한 지면 요청 시 사용

w

integer

Exact width in device independent pixels.

h

integer

Exact height in device independent pixels

battr

Integer array

Block creative attributes.

6,7

id

string

Unique identifier for this banner object.

vcm

integer

Relevant only for Banner objects used with a Video object in an array of companion ads. Indicates the companion banner rendering mode relative to the associated video, where 0 = concurrent, 1 = end-card.

보상형 동영상 상품의 경우 1로 전달함

ext

object

Object : Video

triangle-exclamation
Attribute
Type
Description
kakao Description

mimes

string array

Content MIME types supported

video/mp4

minduration

integer

Minimum video ad duration in seconds

>=0

maxduration

integer

Maximum video ad duration in seconds

>0

protocols

integer array

Array of supported video protocols. Refer to List: Creative Subtypes - Audio/Videoarrow-up-right in AdCOM 1.0.

2,3 지원

w

integer

Width of the video player in device independent pixels (DIPS)

h

integer

Height of the video player in device independent pixels (DIPS)

plcmt

integer

Video placement type for the impression. Refer to List: Plcmt Subtypes - Videoarrow-up-right in AdCOM 1.0.

linearity

integer

Indicates if the impression must be linear, nonlinear, etc. If none specified, assume all are allowed.

Refer to List: Linearity Modesarrow-up-right in AdCOM 1.0.

1

skip

integer

Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes.

startdelay

integer

Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements.

Pre-roll, mid-roll만 지원됨

battr

integer array

Blocked creative attributes. Refer to List: Creative Attributesarrow-up-right in AdCOM 1.0.

minbitrate

integer

Minimum bit rate in Kbps.

maxbitrate

integer

Maximum bit rate in Kbps

playbackmethod

integer array

Playback methods that may be in use. If none are specified, any method may be used. Refer to List: Playback Methods arrow-up-rightin AdCOM 1.0.

2

delivery

integer array

Supported delivery methods. If none specified, assume all are supported. Refer to List: Delivery Methodsarrow-up-right in AdCOM 1.0

2

pos

integer

Ad position on screen. Refer to List: Placement Positionsarrow-up-right in AdCOM 1.0.

companionad

object array

Array of Banner objects if companion ads are available.

companiontype

integer array

Supported VAST companion ad types. Refer to List: Companion Typesarrow-up-right in AdCOM 1.0. Recommended if companion Banner objects are included via the companionad array. If one of these banners will be rendered as an end-card, this can be specified using the vcm attribute with the particular banner.

ext

object

Object : Native

Attribute
Type
Description
kakao Description

request

string;

required

Request payload complying with the Native Ad Specification.

ver

string;

recommended

Version of the Dynamic Native Ads API to which request complies

eventtrackers응답에 따라 1.1과 1.2로 구분 필요

ext

object

Object : Format

Attribute
Type
Description
kakao Description

w

integer

Width in device independent pixels

h

integer

Height in device independent pixels

Object : Site

circle-exclamation
Attribute
Type
Description
kakao Description

id

string

Exchange-specific site Id.

domain

string

Domain of the site (e.g., “mysite.foo.com”).

cat

string array

Array of IAB content categories of the site.

page

string

URL of the page where the impression will be shown

publisher

object

content

object

ext

object

Object : App

circle-exclamation
Attribute
Type
Description
kakao Description

id

string

Exchange-specific site Id.

bundle

string

A platform-specific application identifier intended to be unique to the app and independent of the exchange ( Android: bundle or package name/ iOS : typically a numeric ID)

storeurl

string

App store URL for an installed app

cat

string array

Array of IAB content categories of the app.

publisher

object

content

object

ext

object

Object : Publisher

Attribute
Type
Description
kakao Description

id

string

Exchange-specific publisher ID

Partner User ID, partner_id

name

string

Publisher name

One of the following

  • “DAUM”: daum.net

  • “TALK”: Kakao Talk

  • “KAKAO_SERVICE”: Kakao Story, Other kakao Service

  • “GENERAL”: Other publishers that joined to kakao’s SSP server, “ADFIT”

domain

string

Highest level domain of the publisher

ext

object

Object : Content

Attribute
Type
Description
kakao Description

id

string

ID uniquely identifying the content

title

string

Content Title

livestream

integer

0=not live 1=content is live

len

integer

Length of content in seconds

영상 길이 (live인 경우 null)

cat

string array

IAB content category

Object : Device

Attribute
Type
Description
kakao Description

ua

string; recommended

Browser user agent string

sua

UserAgent object

Structured user agent information defined by a UserAgent object (Object : UserAgent 참조)

dnt

integer; recommended

0= tracking is unrestricted, 1=do not track

lmt

integer; recommended

0=tracking is unrestricted, 1=tracking must be limited per commercial guidelines

ip

string; recommended

IPv4 address closet to device

Ip는 3옥텟까지 제공

(e.g., "xxx.xx.xx")

make

string

Device make (e.g., “Apple”).

model

string

Device model (e.g., “iPhone”).

os

string

Device operating system (e.g., “iOS”).

osv

string

Device operating system version (e.g., “3.1.2”)

hwv

string

Hardware version of the device (e.g., “5S” for iPhone 5S).

h

integer

Physical height of the screen in pixels

w

integer

Physical width of the screen in pixels

ppi

integer

Screen size as pixels per linear inch

pxratio

float

The ratio of physical pixels to device independent pixels

language

string

Browser language using ISO-639-1-alpha-2.

ifa

string

ID sanctioned for advertiser use in the clear

ext

object

Object : User

Attribute
Type
Description
kakao Description

id

string; recommended

Exchange-specific ID for the user.

Partner User ID, partner-uid (cookie matching)

ext

object

Object : Supply Chain

Attribute
Type
Description
kakao Description

complete

integer; required

Flag indicating whether the chain contains all nodes involved in the transaction leading back to the owner of the site, app or other medium of the inventory, where 0 = no, 1 = yes.

nodes

object array; required

Array of SupplyChainNode objects in the order of the chain. In a complete supply chain, the first node represents the initial OpenRTB 2.6 © 2021 IAB Technology Laboratory iabtechlab.com/openrtb Page 34 of 85 advertising system and seller ID involved in the transaction, i.e. the owner of the site, app, or other medium. In an incomplete supply chain, it represents the first known node. The last node represents the entity sending this bid request.

ver

string; required

Version of the supply chain specification in use, in the format of “major.minor”. For example, for version 1.0 of the spec, use the string “1.0”.

ext

object

Placeholder for advertising-system specific extensions to this object

Object : SupplyChainNode

Attribute
Type
Description
kakao Description

asi

string; required

The canonical domain name of the SSP, Exchange, Header Wrapper, etc system that bidders connect to. This may be the operational domain of the system, if that is different than the parent corporate domain, to facilitate WHOIS and reverse IP lookups to establish clear ownership of the delegate system. This should be the same value as used to identify sellers in an ads.txt file if one exists..

sid

string; required

The identifier associated with the seller or reseller account within the advertising system. This must contain the same value used in transactions (i.e. OpenRTB bid requests) in the field specified by the SSP/exchange. Typically, in OpenRTB, this is publisher.id. For OpenDirect it is typically the publisher’s organization ID.Should be limited to 64 characters in length.

rid

string

The OpenRTB RequestId of the request as issued by this seller.

hp

integer

Indicates whether this node will be involved in the flow of payment for the inventory. When set to 1, the advertising system in the asi field pays the seller in the sid field, who is responsible for paying the previous node in the chain. When set to 0, this node is not involved in the flow of payment for the inventory. For version 1.0 of SupplyChain, this property should always be 1. Implementers should ensure that they propagate this field onwards when constructing SupplyChain objects in bid requests sent to a downstream advertising system.

Object : UserAgent

Attribute
Type
Description
kakao Description

browsers

array of

BrandVersion objects;

recommended

Each BrandVersion object (Object : BrandVersion 참조) identifies a browser or similar software component. Implementers should send brands and versions derived from the Sec-CH-UA-Full-Version-List header*.

platform

BrandVersion object;

recommended

A BrandVersion object (Object : BrandVersion 참조) that identifies the user agent’s execution platform / OS. Implementers should send a brand derived from the Sec-CH-UA-Platform header, and version derived from the Sec-CH-UAPlatform-Version header *.

mobile

integer

1 if the agent prefers a “mobile” version of the content, if available, i.e. optimized for small screens or touch input. 0 if the agent prefers the “desktop” or “full” content. Implementers should derive this value from the Sec-CH-UAMobile header *.

model

string

Device model. Implementers should retrieve this value from the Sec-CH-UAModel header*.

source

integer

The source of data used to create this object, List: User-Agent Sourcearrow-up-right in AdCOM 1.0

Object : BrandVersion

Attribute
Type
Description
kakao Description

brand

string; required

A brand identifier, for example, “Chrome” or “Windows”. The value may be sourced from the User-Agent Client Hints headers, representing either the user agent brand (from the Sec-CH-UA-Full-Version header) or the platform brand (from the Sec-CH-UA-Platform header).

version

string array

A sequence of version components, in descending hierarchical order (major, minor, micro, …)

1-2. Native Ad Request Markup Details

circle-exclamation

Object : Native Markup Request

Attribute
Required
Type
Default
Description
kakao Description

ver

string

Version of the Native Markup version in use.

1.1 or 1.2

plcmtcnt

integer

1

The number of identical placements in this Layout.

assets

required

array of objects

assetslist

array of objects

multiasset을 지원하는 경우, assetslist 하위 array로 전달

eventtrackers

array of objects

Specifies what type of event tracking is supported - see Event Trackers Request Object

1.2 ver. 응답에 해당

ext

object

Object : Asset

Attribute
Required
Type
Default
Description
kakao Description

id

required

integer

Unique asset ID, assigned by exchange

required

integer

title

recommended

object

img

recommended

object

video

object

data

recommended

object

ext

object

Object : Title

Attribute
Required
Type
Default
Description
kakao Description

len

required

integer

Maximum length of the text in the title element

ext

object

Object : Image

Attribute
Required
Type
Default
Description
kakao Description

type

integer

Type ID of the image element supported by the publisher

1: 프로필 이미지 (300x300) 2 : Logo * 필수 에셋 중 안내된 프로필이미지, 메인 이미지 외 광고아이콘만 받고 있음 3 : Main Image 701 : 동영상 엔드캡 이미지 (1280x720) 702: 배너 이미지 (비즈보드 사용)

703 : Opt-Out

w

integer

Width of the image in pixels

h

integer

Height of the image in pixels

ext

object

Object : Video

Attribute
Required
Type
Default
Description
kakao Description

mimes

required

Array of string

Content MIME types supported

Video/mp4만 가능

minduration

required

integer

Minimum video ad duration in seconds

>=0

maxduration

required

integer

Maximum video ad duration in seconds

>0

protocols

required

integer[]

3.0

An array of video protocols the publisher can accept in the vid response.

Vast3.0만 지원

w

integer

Width of the video player in device independent pixels (DIPS).

h

integer

Height of the video player in device independent pixels (DIPS).

Object : Data

Attribute
Required
Type
Default
Description
kakao Description

type

required

integer

Type ID of the element supported by the publisher

  • 1: 프로필명 (20자)

  • 2: 광고 문구 (45자)

  • 12 : CTAtext (6자)

  • 701 : 소재 설명 (45자)

len

integer

Maximum length of the text in the elements response

ext

object

Object : Event Trackers

circle-exclamation

Attribute
Required
Type
Default
Description
kakao Description

event

required

integer

Type of event available for tracking. See Event Types table.

  • 1: imptrackers

  • 2: vimptrackers

  • 500: hidetrackers

methods

required

array of integers

Array of the types of tracking available for the given event. See Event Tracking Methods table.

ext

optional

object

This object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

2. Bid Response Specification

circle-check

2-1. Object Specification

Object : Bid Response

Attribute
Type
Description
kakao Description

id

string; required

ID of the bid request to which this is a response.

seatbid

object array

Array of seatbid objects; 1+ required if a bid is to be made.

단일 seatbid만 처리 가능

bidid

string

Bidder generated response ID to assist with logging/tracking.

cur

string

Bid currency using ISO-4217 alpha codes.

KRW, USD

nbr

integer

Reason for not bidding. Refer to List: No-Bid Reason Codesarrow-up-right in OpenRTB 3.0.

ext

object

Object : Seatbid

Attribute
Type
Description
kakao Description

bid

object array; required

Object : bid 참조 
Array of 1+ bid objects each related to an impression.

native.plcmtcnt 이하의 광고 응답 수에 대해 처리 가능

seat

string

ID of the buyer seat on whose behalf this bid is made.

ext

object

Object : Bid

Attribute
Type
Description
kakao Description

id

string; required

Bidder generated bid ID to assist with logging/tracking

impid

string; required

ID of the Imp object in the related bid request

price

float; required

Bid Price expressed as CPM although the actual transaction is for a unit impression only.

nurl

string

Win notice URL called by the exchange if the bid wins.

lurl

string

Loss notice URL called by the exchange when a bid is known to have been lost.

${AUCTION_MIN_TO_WIN}, ${AUCTION_LOSS} 지원

adm

string; required

Optional means of conveying ad markup in case the bid wins.

완전한 HTML만 지원함

adid

string; required

ID of a preloaded ad to be served if the bid wins.

adomain

string arrary; required

Advertiser domain for block list checking

cid

string; required

Campaign ID to assist with ad quality checking

crid

string; required

Creative ID to assist with ad quality checking

cat

string arrary; required

IAB content categories of the creative.

w

integer; required

Width of the creative in device independent pixels

h

integer; required

Height of the creative in device independent pixels

ext

object

2-2. Native Ad Response Markup Details

Object : Native Markup Response

Attribute
Required
Type
Description
kakao Description

ver

recommended

string

Version of the Native Markup version in use.

1.1과 1.2에 따라 eventtrackers 응답을 달리하여야 함

assets

required

array of objects

link

required

object

Object : Link 참조 Destination Link. This is default link object for the ad. Individual assets can also have a link object which applies if the asset is activated. If the asset doesn’t have a link object , the parent link object applies

imptrackers

required

array of objects

Array of impression tracking URLs, expected to return a 1x1 image or 204 response - typically only passed when using 3rd party trackers. To be deprecated - replaced with eventtrackers.

  • 최대 5개까지만 응답 가능

  • 1.2ver 인 경우, eventtrackers.event=1로 응답해야 함

eventtrackers

optional

Array of objects

Array of tracking objects to run with the ad, in response to the declared supported methods in the request.

Replaces imptrackers and jstracker, to be deprecated.

1.2ver 로 응답하는 경우에 해당

ext

object

object : ext 참조

Object : Asset

Attribute
Required
Type
Description
kakao Description

id

required

integer

Unique asset ID, assigned by exchange, must match one of the asset IDs in request

title

object

img

object

request.native.assets.img.type : 703 (opt-out)이 필수로 요청 시, opt-out icon/link를 동일 id 하위에 포함하여 전달 주어야 함 <img.type:703 이 id:10 으로 필수 요청일 경우 sample>

{ \”id\”:10, \”img\”:{ \”url\”:\”admark- img.url\”, \”w\”:50, \”h\”:50 }, "link":{ \”url\”:\”admark- landing.url\” } }

link

object

video

object

data

object

ext

object

Object : Title

Attribute
Required
Type
Description
kakao Description

text

required

string

The text associated with the text element

ext

object

Object : Image

Attribute
Required
Type
Description
kakao Description

url

required

string

URL of the image asset.

w

required

integer

Width of the image in pixels

h

required

integer

Height of the image in pixels

ext

object

Object : Data

Attribute
Required
Type
Description
kakao Description

value

required

string

The formatted string of data to be displayed

ext

object

Object : Video

Attribute
Required
Type
Description
kakao Description

vasttag

required

string

vast xml

720p 영상 파일 응답 필요

Attribute
Required
Type
Description
kakao Description

url

required

string

Landing URL of the clickable link.

clicktrackers

Array of strings

List of Tracker URL to be fired on click of the URL

단일 Tracker URL만 응답 가능

ext

object

Object : Event Tracker

circle-exclamation
Attribute
Required
Type
Description
kakao Description

event

required

integer

Type of event to track. See Event Types table.

method

required

integer

Type of tracking requested. See Event Tracking Methods table.

url

text

The URL of the image or js. Required for image or js, optional for custom.

ext

optional

object

This object is a placeholder that may contain custom JSON agreed to by the parties to support flexibility beyond the standard defined in this specification

Object : Response.ext

circle-exclamation
Attribute
Required
Type
Description
kakao Description

hidetrackers

Array of strings

이 광고 숨김 처리

비즈보드의 응답에 대해서는 필수값.

숨김 처리 이벤트가 호출된 광고 단위에 대해 해당 소재의 광고 계정에 대해 24시간 동안 미 응답 처리 필요함

Last updated

Was this helpful?