페이지 이동경로
  • Docs>
  • Kakao Moment>
  • Type information

Kakao Moment

Type info

This document provides the data type information used for Kakao Moment APIs.

A

ActionButton
Name Description
LINK Shortcuts
MORE Learn
RESERVATION Make a reservation
PURCHASE Purchase
REQUEST Apply
INQUIRE Inquire
INSTALL Install
RUN Execute
DOWNLOAD Download
LAUNCH Use
ADD_FRIEND Add channel
SUBSCRIBE Get news
MORE_VIDEO View more videos
JOIN Sign up
COUPON Get coupons
AdGroup
Name Type Description
id Long Ad group ID
name String Ad group name
adGroupStatus Status[] Ad group status
AdGroupType
Name Description
DISPLAY Display
DIRECT_MESSAGE Message
AdView
Name Type Description
id Long Ad View ID
name String Ad View name
type String Ad View type
templateType String Ad View template type
AdViewItem
Name Type Description
id Long Ad View ID
AppTrackingType
Name Type Description
RETARGETING String Retargeting
CONVERSION String Conversion
BOTH String Both retargeting and conversion
AssetGroup
Name Type Description
assetGroupId Long Slide number
ordering Integer Slide order
image Image Slide image
title String Title
price AssetPrice Price
rspvLandingUrl String Representative landing URL
AssetPrice
Name Type Description
amount String Price
currencyCode CurrencyCode Currency type

B

BaseAd
Name Type Description
adGroup AdGroup Ad group
campaign Campaign Campaign
operation Operation Operation type
Refer to Available operation and engagement types by Type X Goal.
firstIndicator Indicator Type of the first response
Refer to Available operation and engagement types by Type X Goal.
secondIndicator Indicator Type of the second response
Refer to Available operation and engagement types by Type X Goal.
BidStrategyTarget
Name Type Description
value Long Cost target value
The cost target value of the Automatic bidding.
type String Automatic bidding options
One of TARGET_CPC (CPC cost targeting) or TARGET_CPA (CPA cost targeting)
ButtonAssetGroup
Name Type Description
ordering Long Sort order number
title String Button name
rspvLandingUrl String Responsive landing URL
mobileLandingUrl String Mobile landing URL
pcLandingUrl String PC landing URL
adViewId Long Ad View ID
bizFormId Long Business Form ID
channelPostId Long Channel post ID
channelCouponId Long Channel coupon ID
thumbnail String Thumbnail image
highlighted Boolean Whether to use highlighted button
landingType String Landing type
One of the followings:
LANDING_URL: URL landing
CHANNEL_COUPON: Coupon landing
CHANNEL_POST: Post landing
AD_VIEW: Ad View
BIZ_FORM: Business Form
BusinessForm
Name Type Description
id Long Business Form ID linked to Moment
Used when creating a Message creative.
adAccountId Long Ad account ID
bizFormId Long Business Form ID
title String Business Form title
flowType String Business Form type
linkedDate String Date and time when the Business Form is linked to Moment in yyyy-MM-dd'T'HH:mm:ss format
beginDate String Date and time when the Business Form starts in yyyy-MM-dd'T'HH:mm:ss format
endDate String Date and time when the Business Form ends in yyyy-MM-dd'T'HH:mm:ss format

C

Campaign
Name Type Description
id Long Campaign ID
adAccountId Long Ad account ID
name String Campaign name
campaignTypeGoal CampaignTypeGoal Campaign Type X Goal
objective Objective Objective of the advertising goal
dailyBudgetAmount Long Daily budget
If not specified, no limitation on the budget.
config String Campaign status
One of ON, OFF, or DEL (Deleted)
isDailyBudgetAmountOver Boolean Whether or not the daily budget is exceeded
statusDescription String Status of the campaign
trackId String Conversion tracking ID
CampaignType
Name Description
TALK_BIZ_BOARD Kakao Talk Bizboard
DISPLAY Display
TALK_CHANNEL Kakao Talk Channel
DAUM_SHOPPING Daum Shopping
VIDEO Video
PERSONAL_MESSAGE Personalized message
CampaignTypeGoal
Name Type Description
campaignType CampaignType Campaign type
goal Goal Campaign goal
CategoryData
Name Type Description
id String Category code
Use "targeting.ufoInterests(Interest)" or "targeting.ufoBusinessTypes(Industry)" when creating or editing an ad group.
name String Category name
children CategoryData[] Sub-category data
ChannelPost
Name Type Description
id Long Post ID
title String Title
status String Status
adult Boolean Whether it is an age verification post
true: Age verification post
false: General post
permalink String Post URL
media Media[] Media information
createdDate String Date and time of post creation
publishedDate String Date and time of post publication
Clip
Name Type Description
id Long Clip ID
duration Double Video duration
thumbnailUrl String Thumbnail image URL
isOpen Boolean Whether or not the clip is public
ClipLink
Name Type Description
id Long Clip Link ID
displayTitle String Clip Link title
playCount Int Number of video plays
likeCount Int Number of likes
commentCount Int Number of comments
createTime DateTime Created time
updateTime DateTime Updated time
clip Clip Detailed information of the Clip Link
linkUrl String URL of the Clip Link
code: Categories of Network for placements
code name Description
IAB1 예술 및 엔터테인먼트 Arts and entertainment
IAB10 홈/정원 Home/Gardening
IAB11 법, 정부와 정치 Law, government and politics
IAB12 언론 Press
IAB13 개인금융 Personal finance
IAB14 사회 Society
IAB15 과학 Science
IAB16 애완동물 Pets
IAB17 스포츠 Sports
IAB18 스타일/패션 Style/Fashion
IAB19 컴퓨터/기술 Computer/Technology
IAB2 자동차 Car
IAB20 여행 Travel
IAB21 부동산 Real estate
IAB22 쇼핑 Shopping
IAB23 종교 Religion
IAB24 미분류 Unclassified
IAB3 산업 Industry
IAB4 직업 Occupation
IAB5 교육 Education
IAB6 가족 및 육아 Family and parenting
IAB7 건강 및 운동 Health and exercise
IAB8 식음료 Food
IAB9 취미 Hobby
code: Section categories of Kakao Talk for placements
code name Description
KKO99-0 오픈채팅탭 노출 제외 Exclude displaying in Open Chat tab
KKO99-1 채팅탭에만 노출 Only displayed in Chat tab
CohortTargeting
Name Type Description
id Long Engagement target ID
name String Engagement target name
cohortId Long Registered engagement target number
inclusionType InclusionType Whether to include or exclude the information extracted through engagement targeting for ad group targeting
Company
Name Type Description
businessRegistrationNumber String Business registration number
name String Business name
Config
Name Description
ON Activated
OFF Inactivated
DEL Deleted
CouponBookAssetGroup
Name Type Description
couponBookTitle String Title of coupon book
couponBookTitleType String Type of coupon book
title String Detailed description of coupon book
channelCoupons ChannelCoupons Information of channel coupon
mobileLandingUrl String Mobile landing URL
pcLandingUrl String PC landing URL
ordering Integer Sort order
ChannelCoupons
Name Type Description
id String Channel coupon ID
ChannelCoupon
Name Type Description
id Long Coupon ID
title String Coupon's title
content String Coupon's content
statusCode String Coupon's status
permalink String Coupon's link
entryImage EntryImage Coupon's detailed image
createdAt String Date and time of coupon creation
CurrencyCode
Name Description
KRW
USD $
JPY ¥
EUR
CustomerFileStatus
Name Description
WAITING Waiting for extracting target population from a customer file
COMPLETE Target population has been extracted from a customer file
DELETE Already deleted or deleting
ERROR Other abnormal case
MODIFYING Preparing for the modified target population
CustomerFileTargeting
Name Type Description
id Long Customer file registration ID
inclusionType InclusionType Whether to include or exclude the information extracted from a customer file for ad group targeting
name String Customer file name
status Enum of CustomerFileStatus Customer file status

D

Data
Name Type Description
start String Start date in yyyyMMdd format
end String End date in yyyyMMdd format
dimensions Dimension Report criteria and values
metrics Metrics Report metrics and values
DatePreset (Enum)
Name Description
TODAY Today, from 00:00 to the hour right before the current
YESTERDAY Yesterday, from 00:00 to 24:00
LAST_7DAY For the last 7 days until 24:00 yesterday, not including today
LAST_14DAY For the last 14 days until 24:00 yesterday, not including today
LAST_30DAY For the last 30 days until 24:00 yesterday, not including today
THIS_MONTH This month, from the 1st day of this month to today
LAST_MONTH Last month, from the 1st day of last month to the last day
Depth2Location

To see all detailed information of Depth2Location, refer to Depth2Location (Enum).

Name Type Description
value String Code that indicates the corresponding location
description String Name of -si/-do and gun/gu
Passed in Korean only.
depth1Name String Name of -si (city) or -do (province)
depth2Name String Name of -si (city), -gun (county), or -gu (district)
Depth3Location

To see all detailed information of Depth3Location, refer to Depth3Location (Enum).

Name Type Description
value String Code that indicates the corresponding location
description String Name of -si/-do and gun/gu
depth1Name String Name of -si (city) or -do (province)
depth2Name String Name of -si (city), -gun (county), or -gu (district)
depth3Name String Name of -dong (neighborhood), -eup (town), or -myeon (townships)
DeviceType
Name Description
ANDROID Android
IOS IOS
PC PC
Dimension: Level to retrieve report (Enum)
Value Description Code
AD_ACCOUNT Ad account ad_account_id
CAMPAIGN Campaign campaign_id
AD_GROUP Ad group ad_group_id
CREATIVE Creative creative_id
Dimension: Criteria to retrieve report (Enum)
Value Description Code
CREATIVE_FORMAT Creative type:
Display
- Image banner
- Image native
- video native
- Image box
- Image catalog
- Dynamic catalog
- Contents
Message
- Basic text
- Wide list
- Wide message
- Carousel commerce
- Carousel feed
- Premium video

Display
- IMAGE_BANNER
- IMAGE_NATIVE
- VIDEO_NATIVE
- IMAGE_BOX
- CATALOG_MANUAL
- CATALOG_DYNAMIC
- SERVICE_CONTENT
Message
- BASIC_TEXT_MESSAGE
- WIDE_LIST_MESSAGE
- WIDE_MESSAGE
- CAROUSEL_COMMERCE_MESSAGE
- CAROUSEL_FEED_MESSAGE
- PREMIUM_VIDEO_MESSAGE
PLACEMENT Placement
- All
- Kakao Talk
- Daum
- Kakao Story
- Kakao service
- Network

- total
- KAKAO_TALK
- DAUM
- KAKAO_STORY
- KAKAO_SERVICE
- NETWORK
AGE (Old) Age range
- All
- 15 to 19
- 20 to 25
- 26 to 30
- 31 to 40
- 41 to 50
- 51 to 70
- Unknown

- total
- 15
- 20
- 26
- 31
- 41
- 51
- -1
AGE_BAND Age range
- All
- 15 to 19
- 20 to 25
- 25 to 29
- 30 to 34
- 35 to 39
- 40 to 44
- 45 to 49
- 50 to 54
- 55 to 59
- 60 to 64
- 65 to 69
- Over 70
- Unknown

- total
- 15
- 20
- 25
- 30
- 35
- 40
- 45
- 50
- 55
- 60
- 65
- 70
- 0
GENDER Gender
- All
- Male
- Female
- Unknown

- total
- M
- F
- N
AGE_GENDER (Old) Age range+gender
AGE_BAND_GENDER Age range+gender
LOCATION Location
- All
- Seoul
- Incheon
- Gyeonggi-do
- Gangwon-do
- Sejong Special Self-Governing City
- Daejeon
- Chungcheongbuk-do
- Chungcheongnam-do
- Gwangju
- Jeollabuk-do
- Jeollanam-do
- Daegu
- Ulsan
- Gyeongsangbuk-do
- Gyeongsangnam-do
- Busan
- Jeju Special Self-Governing Province
- Overseas
- Unknown

- total
- I
- K
- B
- A
- Q
- G
- P
- O
- E
- M
- L
- F
- J
- D
- C
- H
- N
- Z
- U
DEVICE_TYPE Device type
- All
- PC
- Android
- iOS
- Others

- total
- PC
- Android
- iOS
- N/A
HOUR Hour
- All
- 00:00 to 00:59
- 01:00 to 01:59
- 02:00 to 02:59
- 03:00 to 03:59
- 04:00 to 04:59
- 05:00 to 05:59
- 06:00 to 06:59
- 07:00 to 07:59
- 08:00 to 08:59
- 09:00 to 09:59
- 10:00 to 10:59
- 11:00 to 11:59
- 12:00 to 12:59
- 13:00 to 13:59
- 14:00 to 14:59
- 15:00 to 15:59
- 16:00 to 16:59
- 17:00 to 17:59
- 18:00 to 18:59
- 19:00 to 19:59
- 20:00 to 20:59
- 21:00 to 21:59
- 22:00 to 22:59
- 23:00 to 23:59

- total
- 00
- 01
- 02
- 03
- 04
- 05
- 06
- 07
- 08
- 09
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23

E

EntryImage
Name Type Description
type String Media type, such as image, video and others
url String Image URL
thumbnail String Thumbnail image
previewImage String In the case of video type, thumbnail image
playUrl String In the case of video type, video URL
name String Name

G

Goal
Name Description
VISITING Visit
CONVERSION Conversion
REACH Reach
VIEW View
GroupInfo
Name Type Description
title String Content
hash String hash value of the group
ordering Integer Sort order
isHighlighted Boolean Whether button is highlighted
landingType String Group landing type
One of CHANNEL_POST, CHANNEL_COUPON, AD_VIEW, BIZ_FORM, or LANDING_URL
image ImageInfo Group image information
video VideoInfo Group video information
pcLandingUrl String PC landingURL
mobileLandingUrl String Mobile landingURL
channelPostId Long Channel post ID selected as a group landing
channelPostTitle String Channel post title selected as a group landing
channelCouponId Long Channel coupon ID selected as a group landing
channelCouponTitle String Channel coupon title selected as a group landing
adViewId Long Ad View ID selected as a group landing
bizFormId Long Business Form ID selected as a group landing

I

Image
Name Type Description
size Long File size
url String Image URL
fileName String Image file name
width Integer Image width
height Integer Image height
mimeType String Mime type
ImageInfo
Name Type Description
url String Image URL
imageWidth Integer Image width
imageHeight Integer Image height
fileSize Long File size
fileName String File name
InclusionType
Name Description
INCLUDE Included
EXCLUDE Excluded
Indicator
Name Type Description
PLAY String Video play
CLICK String Click
CONVERSION String Conversion
OPEN String Open
ItemAssetGroup
Name Type Description
thumbnail Long Thumbnail URL
landingType Image Landing type
In the case of the Kakao TV Video creative, null is returned.
In the other cases, one of the followings is returned:
LANDING_URL (URL),
CHANNEL_COUPON (Coupon),
CHANNEL_POST (Post)
ordering Integer Sort order
title String Promotional text or title
Promotional text in the item asset group is passed only for WIDE_LIST_MESSAGE, CAROUSEL_COMMERCE_MESSAGE(Except for the intro card), CAROUSEL_FEED_MESSAGE types.
description String Promotional text for CAROUSEL_FEED_MESSAGE
priceAmount Integer Price for CAROUSEL_COMMERCE_MESSAGE
priceCurrencyCode String Currency
One of KRW, USD, JPY, and EUR
discountedPriceAmount Integer Discounted price for CAROUSEL_COMMERCE_MESSAGE
mobileLandingUrl String Mobile landing URL
Passed if landing type is set to LANDING_URL.
pcLandingUrl String PC landing URL
Passed if landing type is set to LANDING_URL.
image Image Image creative
Image in the item asset group is returned for WIDE_MESSAGE, WIDE_LIST_MESSAGE, CAROUSEL_COMMERCE_MESSAGE(Except for the intro card), CAROUSEL_FEED_MESSAGE types.
video Video Kakao TV Video creative
Video in the item asset group is passed only for a wide image or wide list type of message.
thumbnail Thumbnail Representative image
In the case of Kakao TV Video creatives, image information used for a representative image is passed.

K

KakaoTvChannelInfo
Name Type Description
id Long Kakao TV channel ID
name String Kakao TV channel name
description String Kakao TV channel description
totalClipCount Integer Number of video clips uploaded in the Kakao TV channel
openClipCount Integer Number of open video clips in a playlist
subscriberCount Integer Number of subscribers
visitCount Integer Number of views of Kakao TV channel videos
isOpen Boolean Whether Kakao TV channel is public or private
createTime DateTime Creation time of the Kakao TV channel
updateTime DateTime Update time of the Kakao TV channel
clipCount Integer Number of video clips in a playlist
linkUrl String URL of the Kakao TV channel page

L

LandingInfo
Name Type Description
landingType String Landing type
One of the followings:
PF_BOT: Chatbot
AD_VIEW: Ad View
MESSAGE: Message
CHANNEL_WEBVIEW: Channel web view
BIZ_FORM: Business Form
TALK_CALENDAR: Talk Calandar
PAY_BUY: Purchase using Kakao Pay
profileId String Kakao Talk Channel's profile ID if a Chatbot or Channel web view is used for a landing
Pass the Kakao Talk Channel's profile ID obtained through the Viewing Kakao Talk Channel profile API.
action String Keyword if PF_BOT is used for a landing
adViewItem AdViewItem Ad View object if AD_VIEW is used for a landing
url String URL if CHANNEL_WEBVIEW is used for a landing
bizFormId Long Business Form ID if BIZ_FORM landing is used for a landing
talkCalendarEventId String Talk Calendar ID if TALK_CALENDAR landing is used for a landing
channelPostId Long Channel post ID if CHANNEL_POST is used for a landing
shopKey String Store key used to purchase using Kakao Pay if PAY_BUY for a landing
productId String Product ID used to purchase using Kakao Pay if PAY_BUY is used for a landing
Location

To see all detailed information of Location, refer to Depth1Location (Enum).

Name Type Description
value String Code that indicates the corresponding location
description String Name of -si (city) or -do (province)
depth1Name String Name of -si (city) or -do (province)

M

Media
Name Type Description
type String Media type
url String Representative URL
thumbnail String Thumbnail URL
previewImage String Preview image URL
playUrl String Video URL
name String Name
MemberType
Name Description
MASTER Master role
MEMBER Member role
MessageElement
Name Type Description
id Long Message creative ID
adAccountId Long Ad account ID
profileId String Kakao Talk Channel profile ID
profileName String Kakao Talk Channel profile name
name String Message creative name
shareFlag Boolean Sharing
adFlag Boolean Advertising message
creativeFormat String Message creative's type.
One of the followings:
BASIC_TEXT_MESSAGE
WIDE_MESSAGE
WIDE_LIST_MESSAGE
CAROUSEL_COMMERCE_MESSAGE
CAROUSEL_FEED_MESSAGE
title Title Promotional text or title
Displayed on the different locations by the creative format.
BASIC_TEXT_MESSAGE: Promotional text
WIDE_MESSAGE: Promotional text
WIDE_LIST_MESSAGE: Title
CAROUSEL_COMMERCE_MESSAGE: Title of the intro card
description String Promotional text for the intro card of CAROUSEL_COMMERCE_MESSAGE
image Image Image creative
Only returned for the BASIC_TEXT_MESSAGE and CAROUSEL_COMMERCE_MESSAGE types.
video Video Kakao TV Video creative
Only returned for the BASIC_TEXT_MESSAGE or PREMIUM_VIDEO_MESSAGE type.
buttonAssetGroups ButtonAssetGroup Button item
itemAssetGroups ItemAssetGroup List of items
Only returned for the following types
WIDE_MESSAGE
WIDE_LIST_MESSAGE
CAROUSEL_COMMERCE_MESSAGE
CAROUSEL_FEED_MESSAGE
thumbnailUrl String Thumbnail image URL
csInfo String Phone number of customer support
couponBookAssetGroups CouponBookAssetGroup Coupon book information
createdDate String Date and time of the Message creative creation in yyyy-MM-dd'T'HH:mm:ss format
lastModifiedDate String Date and time of the Message creative modification in yyyy-MM-dd'T'HH:mm:ss format
hasIntro Boolean Whether the CAROUSEL_COMMERCE_MESSAGE creative has the intro card
introLandingType String Landing type of the CAROUSEL_COMMERCE_MESSAGE intro card
introMobileLandingUrl String Landing URL of the CAROUSEL_COMMERCE_MESSAGE intro card for mobile
introPcLandingUrl String Landing URL of the CAROUSEL_COMMERCE_MESSAGE intro card for PC
MessageSendingInfo
Name Type Description
contractCount Integer Available number of sending messages
Not allowed to set this value less than the estimated target population for sending a message.
longTerm Boolean Whether to use the '전체발송 후 새 친구에게도 보내기(Send to new friends after sending all messages)' option
true: Send.
false: Not send.
If you set it to true, you must pass beginDate (Start date), beginTime (Start time), endDate (End date), and endTime (End time) for the schedule field.
price Long Price for sending a message
pushAlarm Boolean Whether to use the '푸시알림 보내지 않기(Not send push notifications)' option
true: Not send push notifications
false: Send push notifications
sendRate Integer Option to send distributed messages
One of the following integers:
100, 500, 1000, 1500, 2000: Set the number of messages that are sent at once.
0: Not use the Distributed sending option
status String Status of sending a message
One of READY, SENDING, PAUSE, FINISHED, STOPPED, EXPIRED, or SAVE
syncStatus String Sync status with the sending system
One of READY, SUCCESS, or FAILED
startedAT String Time when message delivery has started
finishedAT String Time when message delivery has been completed
ageVerification Boolean Whether to use age verification messages
true: Age verification message used
false: General message used
MetricsGroup (Enum)
Value Description Code
BASIC Basic metrics
- Number of impressions
- Number of clicks
- Click-through rate
- Cost
- Number of plays

- imp
- click
- ctr
- cost
- video_play_3s
ADDITION Additional metrics
- Number of people who see ads (Reach)
- Cost per impression
- Cost per click
- Cost per reach
- Cost per play

- reach
- cost_per_imp
- cost_per_click
- cost_per_reach
- cost_per_video_play_3s
MESSAGE Message basic metrics
- Number of messages sent
- Number of views
- Total number of clicks
- Cost
- Sending failure count

- msg_send
- msg_open
- msg_click
- cost
- msg_send_fail
MESSAGE_ADDITION Message additional metrics
- Cost per sending a message
- Cost per view
- Total cost per click

- cost_per_msg_send
- cost_per_msg_open
- cost_per_msg_click
PIXEL_SDK_CONVERSION Pixel & SDK conversion metrics
- Complete a signup (1 day)
- Complete a signup (7 days)
- View cart (1 day)
- View cart (7 days)
- Purchase (1 day)
- Purchase (7 days)
- Purchase price (1 day)
- Purchase price (7 days)
- Potential customer (1 day)
- Potential customer (7 days)
- Service registration (1 day)
- Service registration (7 days)
- Install app (1 day)
- Install app (7 days)
- Cost per sign up (1 day)
- Cost per sign up (7 days)
- Signup rate (1 day)
- Signup rate (7 days)
- Adding to wishlist (1 Day)
- Cost per adding wishlist (1 Day)
- Rate of adding to wishlist (1 Day)
- Adding to wishlist (7 Days)
- Cost per adding wishlist (7 Days)
- Rate of adding to wishlist (7 Days)
- Adding to cart (1 Day)
- Cost per adding to cart (1 Day)
- Rate of adding to cart (1 Day)
- Adding to cart (7 Days)
- Cost per adding to cart(7 Days)
- Rate of adding to cart (7 Days)
- Cost per cart viewing (1 day)
- Cost per cart viewing (7 days)
- Cart viewing rate (1 day)
- Cart viewing rate (7 days)
- Cost per purchase (1 day)
- Cost per purchase (7 days)
- Purchase rate (1 day)
- Purchase rate (7 days)
- Cost per potential customer (1 day)
- Cost per potential customer (7 days)
- Potential customer rate (1 day)
- Potential customer rate (7 days)
- Cost per service registration (1 day)
- Cost per service registration (7 days)
- Service registration rate (1 day)
- Service registration rate (7 days)
- Cost per app installation (1 day)
- Cost per app installation (7 days)
- App installation rate (1 day)
- App installation rate (7 days)

- conv_cmpt_reg_1d
- conv_cmpt_reg_7d
- conv_view_cart_1d
- conv_view_cart_7d
- conv_purchase_1d
- conv_purchase_7d
- conv_purchase_p_1d
- conv_purchase_p_7d
- conv_participation_1d
- conv_participation_7d
- conv_signup_1d
- conv_signup_7d
- conv_app_install_1d
- conv_app_install_7d
- cost_per_conv_cmpt_reg_1d
- cost_per_conv_cmpt_reg_7d
- conv_cmpt_reg_1d_rate
- conv_cmpt_reg_7d_rate
- conv_add_to_wishlist_1d
- cost_per_conv_add_to_wishlist_1d
- conv_add_to_wishlist_1d_rate
- conv_add_to_wishlist_7d
- cost_per_conv_add_to_wishlist_7d
- conv_add_to_wishlist_7d_rate
- conv_add_to_cart_1d
- cost_per_conv_add_to_cart_1d
- conv_add_to_cart_1d_rate
- conv_add_to_cart_7d
- cost_per_conv_add_to_cart_7d
- conv_add_to_cart_7d_rate
- cost_per_conv_view_cart_1d
- cost_per_conv_view_cart_7d
- conv_view_cart_1d_rate
- conv_view_cart_7d_rate
- cost_per_conv_purchase_1d
- cost_per_conv_purchase_7d
- conv_purchase_1d_rate
- conv_purchase_7d_rate
- cost_per_conv_participation_1d
- cost_per_conv_participation_7d
- conv_participation_1d_rate
- conv_participation_7d_rate
- cost_per_conv_signup_1d
- cost_per_conv_signup_7d
- conv_signup_1d_rate
- conv_signup_7d_rate
- cost_per_conv_app_install_1d
- cost_per_conv_app_install_7d
- conv_app_install_1d_rate
- conv_app_install_7d_rate
PLUS_FRIEND Kakao Talk friends metrics
- Number of friends added (1 day)
- Number of friends added (7 days)
- Cost per number of friends added (1 day)
- Cost per number of friends added (7 days)
- Adding friends rate (1 day)
- Adding friends rate (7 days)

- conv_kf_pf_add_1d
- conv_kf_pf_add_7d
- cost_per_conv_kf_pf_add_1d
- cost_per_conv_kf_pf_add_7d
- conv_kf_pf_add_1d_rate
- conv_kf_pf_add_7d_rate
VIDEO Video metrics
- Number of plays
- Cost per plays
- Number of autoplays
- Number of plays by touching video
- Sound ON count
- Number of plays for 5 seconds
- Number of plays for 10 seconds
- Number of plays for 15 seconds
- Number of plays for 30 seconds
- Number of plays for 60 seconds
- Number of plays watching 25% of video
- Number of plays watching 50% of video
- Number of plays watching 75% of video
- Number of plays watching 100% of video

- video_play
- cost_per_video_play_3s
- video_play_auto
- video_play_touch
- video_unmute
- video_play_5s
- video_play_10s
- video_play_15s
- video_play_30s
- video_play_60s
- video_play_25p
- video_play_50p
- video_play_75p
- video_play_100p
SLIDE_CLICK Slide metrics
- Number of clicks on slide1
- Number of clicks on slide2
- Number of clicks on slide3
- Number of clicks on slide4
- Number of clicks on slide5
- Number of clicks on slide6
- Number of clicks on slide7
- Number of clicks on slide8
- Number of clicks on slide9
- Number of clicks on slide10
- Number of clicks on others

- slide1_click
- slide2_click
- slide3_click
- slide4_click
- slide5_click
- slide6_click
- slide7_click
- slide8_click
- slide9_click
- slide10_click
- slide_others_click
MESSAGE_CLICK Message click metrics
- Number of clicks on 'Share'
- Number of clicks on image or video
- Number of clicks on title
- Number of clicks on text
- Number of clicks on video
- Number of video plays for 3 seconds
- Number of video plays for 5 seconds
- Number of video plays for 10 seconds
- Number of video plays for 15 seconds
- Number of video plays for 30 seconds
- Number of video plays for 60 seconds
- Number of clicks on list1
- Number of clicks on list2
- Number of clicks on list3
- Number of clicks on list4
- Number of plays of list1
- Number of plays of list1 for 3 seconds
- Number of plays of list1 for 5 seconds
- Number of plays of list1 for 10 seconds
- Number of plays of list1 for 15 seconds
- Number of plays of list1 for 30 seconds
- Number of plays of list1 for 60 seconds
- Number of plays of list2
- Number of plays of list2 for 3 seconds
- Number of plays of list2 for 5 seconds
- Number of plays of list2 for 10 seconds
- Number of plays of list2 for 15 seconds
- Number of plays of list2 for 30 seconds
- Number of plays of list2 for 60 seconds
- Number of plays of list3
- Number of plays of list3 for 3 seconds
- Number of plays of list3 for 5 seconds
- Number of plays of list3 for 10 seconds
- Number of plays of list3 for 15 seconds
- Number of plays of list3 for 30 seconds
- Number of plays of list3 for 60 seconds
- Number of plays of list4
- Number of plays of list4 for 3 seconds
- Number of plays of list4 for 5 seconds
- Number of plays of list4 for 10 seconds
- Number of plays of list4 for 15 seconds
- Number of plays of list4 for 30 seconds
- Number of plays of list4 for 60 seconds
- Number of clicks on button1
- Number of clicks on button2
- Number of clicks on button1 of carousel1
- Number of clicks on button1 of carousel2
- Number of clicks on button1 of carousel3
- Number of clicks on button1 of carousel4
- Number of clicks on button1 of carousel5
- Number of clicks on button1 of carousel6
- Number of clicks on button2 of carousel1
- Number of clicks on button2 of carousel2
- Number of clicks on button2 of carousel3
- Number of clicks on button2 of carousel4
- Number of clicks on button2 of carousel5
- Number of clicks on button2 of carousel6
- Number of clicks on carousel1 coupon
- Number of clicks on carousel2 coupon
- Number of clicks on carousel3 coupon
- Number of clicks on carousel4 coupon
- Number of clicks on carousel5 coupon
- Number of clicks on carousel6 coupon
- Number of clicks on 'View more'
- Number of clicks on coupon button
- Number of clicks on other elements

- msg_click_share
- msg_click_media
- msg_click_title
- msg_click_text
-msg_play_start
-msg_play_3s
-msg_play_5s
-msg_play_10s
-msg_play_15s
-msg_play_30s
-msg_play_60s
- msg_click_list1
- msg_click_list2
- msg_click_list3
- msg_click_list4-msg_play_list1_start
- msg_play_list1_3s
- msg_play_list1_5s
- msg_play_list1_10s
- msg_play_list1_15s
- msg_play_list1_30s
- msg_play_list1_60s
- msg_play_list2_start
- msg_play_list2_3s
- msg_play_list2_5s
- msg_play_list2_10s
- msg_play_list2_15s
- msg_play_list2_30s
- msg_play_list2_60s
- msg_play_list3_start
- msg_play_list3_3s
- msg_play_list3_5s
- msg_play_list3_10s
- msg_play_list3_15s
- msg_play_list3_30s
- msg_play_list3_60s
- msg_play_list4_start
- msg_play_list4_3s
- msg_play_list4_5s
- msg_play_list4_10s
- msg_play_list4_15s
- msg_play_list4_30s
- msg_play_list4_60s
- msg_click_button1
- msg_click_button2
- msg_click_carousel_button1
- msg_click_carousel_button2
- msg_click_carousel_button3
- msg_click_carousel_button4
- msg_click_carousel_button5
- msg_click_carousel_button6
- msg_click_carousel_share1
- msg_click_carousel_share2
- msg_click_carousel_share3
- msg_click_carousel_share4
- msg_click_carousel_share5
- msg_click_carousel_share6
- msg_click_carousel1_coupon
- msg_click_carousel2_coupon
- msg_click_carousel3_coupon
- msg_click_carousel4_coupon
- msg_click_carousel5_coupon
- msg_click_carousel6_coupon
- msg_click_carousel_more
- msg_click_coupon
- msg_click_others
ADVIEW Ad View metrics
- Number of clicks on button1
- Number of clicks on button2
- Number of clicks on 'Share'
- Number of impressions for image/video1
- Number of autoplays for video1
- Number of plays by touching video1
- Number of plays of video1 for 3 seconds
- Number of impressions for image/video2
- Number of autoplays for video2
- Number of plays by touching video2
- Number of plays of video3 for 3 seconds
- Number of impressions for image/video3
- Number of autoplays for video3
- Number of plays by touching video3
- Number of plays of video3 for 3 seconds
- Number of impressions for image/video4
- Number of autoplays for video4
- Number of plays by touching video4
- Number of plays of video4 for 3 seconds
- Number of impressions for image/video5
- Number of plays by touching video5
- Number of autoplays of video5 for video
- Number of plays of video5 by touching video
- Number of impressions for image/video6
- Number of autoplays of video6
- Number of plays by touching video6
- Number of plays of video6 for 3 seconds
- Number of impressions for image/video7
- Number of autoplays of video7 for video
- Number of plays of video7 by touching video
- Number of plays of video7 for 3 seconds
- Number of impressions for image/video8
- Number of autoplays of video8 for video
- Number of plays by touching video8
- Number of plays of video8 for 3 seconds
- Number of impressions for image/video9
- Number of autoplays of video9
- Number of plays of video9 by touching video
- Number of plays of video9 for 3 seconds
- Number of impressions for image/video10
- Number of autoplays of video10 for video
- Number of plays of video10 by touching video
- Number of plays of video10 for 3 seconds

- ADV_CLICK_BUTTON1
- ADV_CLICK_BUTTON2
- ADV_CLICK_BUTTON_SHARE
- ADV_TH1_VIEW
- ADV_TH1_VIDEO_PLAY_AUTO
- ADV_TH1_VIDEO_PLAY_TOUCH
- ADV_TH1_VIDEO_PLAY_3S
- ADV_TH2_VIEW
- ADV_TH2_VIDEO_PLAY_AUTO
- ADV_TH2_VIDEO_PLAY_TOUCH
- ADV_TH2_VIDEO_PLAY_3S
- ADV_TH3_VIEW
- ADV_TH3_VIDEO_PLAY_AUTO
- ADV_TH3_VIDEO_PLAY_TOUCH
- ADV_TH3_VIDEO_PLAY_3S
- ADV_TH4_VIEW
- ADV_TH4_VIDEO_PLAY_AUTO
- ADV_TH4_VIDEO_PLAY_TOUCH
- ADV_TH4_VIDEO_PLAY_3S
- ADV_TH5_VIEW
- ADV_TH5_VIDEO_PLAY_AUTO
- ADV_TH5_VIDEO_PLAY_TOUCH
- ADV_TH5_VIDEO_PLAY_3S
- ADV_TH6_VIEW
- ADV_TH6_VIDEO_PLAY_AUTO
- ADV_TH6_VIDEO_PLAY_TOUCH
- ADV_TH6_VIDEO_PLAY_3S
- ADV_TH7_VIEW
- ADV_TH7_VIDEO_PLAY_AUTO
- ADV_TH7_VIDEO_PLAY_TOUCH
- ADV_TH7_VIDEO_PLAY_3S
- ADV_TH8_VIEW
- ADV_TH8_VIDEO_PLAY_AUTO
- ADV_TH8_VIDEO_PLAY_TOUCH
- ADV_TH8_VIDEO_PLAY_3S
- ADV_TH9_VIEW
- ADV_TH9_VIDEO_PLAY_AUTO
- ADV_TH9_VIDEO_PLAY_TOUCH
- ADV_TH9_VIDEO_PLAY_3S
- ADV_TH10_VIEW
- ADV_TH10_VIDEO_PLAY_AUTO
- ADV_TH10_VIDEO_PLAY_TOUCH
- ADV_TH10_VIDEO_PLAY_3S
BIZ_BOARD Bizboard metrics
- Number of impressions
- Number of autoplays for video (Motion)
- Number of autoplays for video (Expandable)
- Number of video plays for 3 seconds (Motion)
- Number of video plays for 3 seconds (Expandable)
- Number of call-to-action clicks
- Number of clicks for image
- Number of impressions for image1
- Number of impressions for image2
- Number of impressions for image3
- Number of impressions for image4
- Number of impressions for image5
- Number of clicks for image1
- Number of clicks for image2
- Number of clicks for image3
- Number of clicks for image4
- Number of clicks for image5

- EXPANDABLE_IMP
- MOTION_VIDEO_PLAY_AUTO
- EXPANDABLE_VIDEO_PLAY_AUTO
- MOTION_VIDEO_PLAY_3S
- EXPANDABLE_VIDEO_PLAY_3S
- EXPANDABLE_CLICK_CTA
- EXPANDABLE_CLICK_IMAGE1
- EXPANDABLE_VIEWABLE_GOODS_1
- EXPANDABLE_VIEWABLE_GOODS_2
- EXPANDABLE_VIEWABLE_GOODS_3
- EXPANDABLE_VIEWABLE_GOODS_4
- EXPANDABLE_VIEWABLE_GOODS_5
- EXPANDABLE_CLICK_GOODS_1
- EXPANDABLE_CLICK_GOODS_2
- EXPANDABLE_CLICK_GOODS_3
- EXPANDABLE_CLICK_GOODS_4
- EXPANDABLE_CLICK_GOODS_5
SPB Board metrics
- Number of clicks on channel home
- Number of clicks on 'Add channel'
- Number of clicks on article1
- Number of clicks on article2
- Number of clicks on article3
- Number of clicks on article4
- Number of clicks on article5
- Number of clicks on article6
- Number of clicks on article7
- Number of clicks on article8
- Number of clicks on article9
- Number of clicks on article10

- channel_home_click
- channel_add_click
- article1_click
- article2_click
- article3_click
- article4_click
- article5_click
- article6_click
- article7_click
- article8_click
- article9_click
- article10_click
MESSAGE_ADDITION - Message open rate
- Message click-through rate
-msg_open_rate
-msg_click_rate

O

Objective
Name Description
type Refer to ObjectiveType.
value Ad goal setting ID
If ObjectiveType is set to TALK_CHANNEL, this value is id obtained through the Viewing list of KakaoTalk Channel profiles API.
If ObjectiveType is set to PIXEL_AND_SDK, this value is id obtained through the Viewing Pixel & SDK API.
detailType ObjectiveDetailType
ObjectiveType
Name Description
TALK_CHANNEL Kakao Talk Channel
PIXEL_AND_SDK Pixel & SDK
ObjectiveDetailType
Name Description
PURCHASE Purchase
APP_INSTALL Install app
COMPLETE_REGISTRATION Sign up
SIGN_UP Apply for a service
CART Add to a cart
PARTICIPATION Potential customer
ADD_FRIEND Add Kakao Talk Channel Friends

Note: Only provided in the response when ObjectiveType is TALK_CHANNEL. Not supported for the request.
Operation
Name Type Description
ONLY String ONLY
AND String AND
MINUS String MINUS
OR String OR
OpinionFile
Name Type Description
id Long ID of the material for ad verification
originalFileName String Name of the uploaded material
downloadUrl String URL of the material for ad verification
OptimizationStatus
Value Description
LEVEL_1 Level 1 Limited Machine Learning
LEVEL_2 Level 2 Basic Machine Learning
LEVEL_3 Level 3 Advanced Machine Learning
LEVEL_4 Level 4 Optimized Machine Learning
INVALID Cannot retrieve status
READY Ready for Machine Learning
null No value. optimizationStatus is only available when the Goal of the campaign is Conversion.

P

Pacing
Name Description
NONE Inactivated
QUICK Quick spending
This spending method increases ad impression by using your budget as quickly as possible to reach your goal.
NORMAL Normal spending
This spending method controls ad impression by dividing the daily budget for each time period not to exceed the daily budget.
PeriodUnit
Name Description
WEEK Weekly
MONTH Monthly
Placement
Name Description
KAKAO_TALK Kakao Talk
KAKAO_STORY Kakao Story
DAUM Daum
KAKAO_SERVICE Kakao Service
NETWORK Network
PricingType
Name Description
CPC Cost per Click
Type to charge every time your ad is clicked. You can run your ads more flexibly by participating in the ad bidding competition in real-time.
CPM Cost per Mille
Type to charge per 1,000 impressions. You can participate in bidding based on the impressions.
CPA Cost per Action
Type to charge for each conversion (Friend added) within 24 hours after clicking your ad If the ad goal is set to '카카오 친구 늘리기'(Making more Kakao friends).

R

RejectedReason
Name Type Description
rejectedTitle String Title of reason why a review is rejected
rejectedContent String Content of reason why a review is rejected

S

SystemConfig
Name Description
ON Activated
VOID Impossible to run (System invalidated)
ADMIN_STOPPED Administrator suspended
EXTERNAL_SERVICE_STOP Linked service restricted
Schedule
Name Type Description
beginDate String Start date in yyyy-MM-dd'T'HH:mm:ss format
Set it to today or the day after today.
endDate String End date in yyyy-MM-dd'T'HH:mm:ss format
Set it to the start date or the day after the start date.
lateNight Boolean Late night targeting
It it is set to true, there is no need to set a specific time for each day.
detailTime Boolean Whether a specific time is set or not
If lateNight (Late night targeting) is set to true, you must set detailTime to false.
mondayTime String[] Set a specific time for Monday
1: Make the corresponding hour exposed
0: Make the corresponding hour not exposed
Array that contains "0" or "1" with an array length of 24
Example: ["1","1", "0",....]

Required if detailTime is set to true.
tuesdayTime String[] Set a specific time for Tuesday
1: Make the corresponding hour exposed
0: Make the corresponding hour not exposed
Array that contains "0" or "1" with an array length is 24
Example: ["1","1", "0",....]

Required if detailTime is set to true.
wednesdayTime String[] Set a specific time for Wednesday
1: Make the corresponding hour exposed
0: Make the corresponding hour not exposed
Array that contains "0" or "1" with an array length is 24
Example: ["1","1", "0",....]

Required if detailTime is set to true.
thursdayTime String[] Set a specific time for Thursday
1: Make the corresponding hour exposed
0: Make the corresponding hour not exposed
Array that contains "0" or "1" with an array length is 24
Example: ["1","1", "0",....]

Required if detailTime is set to true.
fridayTime String[] Set a specific time for Friday
1: Make the corresponding hour exposed
0: Make the corresponding hour not exposed
Array that contains "0" or "1" with an array length is 24
Example: ["1","1", "0",....]

Required if detailTime is set to true.
saturdayTime String[] Set a specific time for Saturday
1: Make the corresponding hour exposed
0: Make the corresponding hour not exposed
Array that contains "0" or "1" with an array length is 24
Example: ["1","1", "0",....]

Required if detailTime is set to true.
sundaytime String[] Set a specific time for Sunday
1: Make the corresponding hour exposed
0: Make the corresponding hour not exposed
Array that contains "0" or "1" with an array length is 24
Example: ["1","1", "0",....]

Required if detailTime is set to true.
Schedule
Name Type Description Required
detailTime Boolean Whether a specific time is set or not O
beginDate String Start date O
beginTime String Start time X
endDate String End date X
endTime String End time X
mondayTime String[] Delivery time on Monday X
tuesdayTime String[] Delivery time on Tuesday X
wednesdayTime String[] Delivery time on Wednesday X
thursdayTime String[] Delivery time on Thursday X
fridayTime String[] Delivery time on Fridya X
saturdayTime String[] Delivery time on Saturday X
sundayTime String[] Delivery time on Sunday X
lateNight Boolean Whether to apply the Late night targeting O
periodUnit PeriodUnit Weekly or monthly basis X

Status: Campaign
Key Description
READY Campaign is ready to run
LIVE Campaign is running
FINISHED Campaign has finished running
OFF User status is OFF
DELETED Campaign is deleted
EXCEED_DAILY_BUDGET Campaign's daily budget exceeded
PAUSED Campaign is paused
NO_AVAILABLE_CREATIVE There is no available creative
CANCELED Contract is canceled
SYSTEM_CONFIG_EXTERNAL_SERVICE_STOP Campaign is unavailable to run because some linked service is restricted
SYSTEM_CONFIG_ADMIN_STOP Administrator is suspended
ADACCOUNT_UNAVAILABLE Ad account is unavailable to run
Status: Ad group
Key Description
READY Ad group is ready to run
LIVE Ad group is running
FINISHED Ad group has finished running
OFF User status is OFF
DELETED Ad group is deleted
EXCEED_DAILY_BUDGET Ad group's daily budget exceeded
PAUSED Ad group is paused
NO_AVAILABLE_CREATIVE There is no available creative
CANCELED Contract is canceled
CAMPAIGN_UNAVAILABLE Campaign is unavailable to run
SYSTEM_CONFIG_EXTERNAL_SERVICE_STOP Campaign is unavailable to run because some linked services are restricted
SYSTEM_CONFIG_ADMIN_STOP Administrator is suspended
Status: Creative
Key Description
OPERATING Creative is available to run.
UNAPPROVED Review is not approved. (Including review pending or suspension case)

Not applicable for Message creative.
INVALID_DATE Delivery period has not started or is overdue.
MONITORING_REJECTED Monitoring is pending because the administrator is suspected.

Not applicable for Message creative.
OFF User status is OFF.
DELETED Creative is deleted.
ADGROUP_UNAVAILABLE Ad group that includes ads is not available to run.

Not applicable for Message creative.
SYSTEM_CONFIG_VOID Creative cannot be run due to error in creative content.

Not applicable for Message creative.
SYSTEM_CONFIG_ADMIN_STOP Administrator is suspended

statusDescription: Ad account

statusDescription (Current status of ad account) is determined according to config (Ad account's status), isAdminStop (Admin's suspension status), and isOutOfBalance (Ad account's balance).

statusDescription* config isAdminStop isOutOfBalance
운영중
(Meaning "Active")
ON false false
잔액부족
(Meaning "Insufficient balance")
ON false true
관리자정지
(Meaning "Admin suspended")
ON true false
관리자정지, 잔액부족
(Meaning "Admin suspended, Insufficient balance")
ON true true
사용자OFF
(Meaning "User OFF")
OFF false false
사용자OFF, 잔액부족
(Meaning "User OFF, Insufficient balance")
OFF false true
사용자OFF, 관리자정지
(Meaning "User OFF, Admin suspended")
OFF true false
사용자OFF, 잔액부족, 관리자정지
(Meaning "User OFF, Insufficient balance, Admin suspended")
OFF true true
삭제됨
(Meaning "Deleted")
DEL - -

* The values of statusDescription are passed in Korean.


statusDescription: Campaign

statusDescription (Current status of campaign) is determined according to config (campaign's status), dailyBudgetAmountOver (Whether or not the daily budget is exceeded).

statusDescription* config dailyBudgetAmountOver
운영중
(Meaning "Active")
ON false
일예산초과(Daily budget exceeded) ON true
사용자OFF
(Meaning "User OFF")
OFF false
사용자OFF,일예산초과
(Meaning "User OFF, Daily budget exceeded")
OFF true
삭제됨
(Meaning "Deleted")
DEL -

* The values of statusDescription are passed in Korean.

statusDescription: Ad creative

statusDescription (Current status of ad creative) is determined according to reviewStatus (creative's review status), config (creative's status), and the review status of original creative and modified creative.

There are five types of review status for creatives:

  • APPROVED
  • WAITING
  • REJECTED: indicates the status of review pending or admin suspended.
  • MODIFICATION_WAITING: Only when the review for the original creative is approved or its administrator is suspended, the creative has this status.
  • MODIFICATION_REJECTED: Only when the review for the original creative is approved or its administrator is suspended, the creative has this status.

If the review status of the original creative is REJECTED or WAITING, and the creative is changed, its status becomes APPROVED, WAITING, or REJECTED.

| statusDescription* | reviewStatus | config | Review status of original creative | Review status of modified creative | | --- | --- | --- | --- | --- | | 운영중
(Meaning "Active") | APPROVED | ON | Review approved | - | 운영중(수정사항 심사중)
(Meaning "Active(Review for modification in progress)") | MODIFICATION_WAITING | ON | Review approved | In review | 운영중(수정사항 심사보류)
(Meaning "Active(Review for modification rejected)")| MODIFICATION_REJECTED | ON | Review approved | Pending review | 심사중
(Meaning "Review in progress") | WAITING | ON | In review | - | 심사보류
(Meaning "Review rejected) | REJECTED | ON | Pending review | - | 관리자정지
(Meaning "Admin suspended") | REJECTED | ON | Admin suspended | - | 관리자정지(수정사항 심사중)
(Meaning "Admin suspended(Review for modification in progress)") | MODIFICATION_WAITING | ON | Admin suspended | In review | 관리자정지(수정사항 심사보류)
(Meaning "Admin suspended(Review for modification rejected)") | MODIFICATION_REJECTED | ON | Admin suspended | Pending review | 사용자OFF
(Meaning "User OFF") | APPROVED | OFF | Review approved | - | 사용자OFF,수정사항 심사중
(Meaning "User OFF, Review for modification in progress") | MODIFICATION_WAITING | OFF | Review approved | In review | 사용자OFF,수정사항 심사보류
(Meaning "User OFF, Review for modification rejected") | MODIFICATION_REJECTED | OFF | Review approved | Pending review | 사용자OFF,심사중
(Meaning "User OFF, Review in progress") | WAITING | OFF | In review | - | 사용자OFF,심사보류중
(Meaning "User OFF, Review rejected") | REJECTED | OFF | Pending review | - | 사용자OFF,관리자정지
(Meaning "User OFF, Admin suspended") | REJECTED | OFF | Admin suspended | - | 사용자OFF,관리자정지(수정사항 심사중)
(Meaning "User OFF, Review for modification in progress") | MODIFICATION_WAITING | OFF | Admin suspended | In review | 사용자OFF,관리자정지(수정사항 심사보류)
(Meaning "User OFF, Review for modification rejected") | MODIFICATION_REJECTED | OFF | Admin suspended | Pending review | 삭제됨
(Meaning "Deleted") | - | DEL | - | -

* The values of statusDescription are passed in Korean.

statusDescription: Display Ad group

statusDescription (Current status of Display ad group) is determined according to config (Ad group's status), isDailyBudgetAmountOver (Whether or not the daily budget is exceeded), and isValidPeriod (Whether delivery period is valid.)

statusDescription* config isDailyBudgetAmountOver isValidPeriod
운영중
(Meaning "Active")
ON false true
일예산초과
(Meaning "Daily budget exceeded")
ON true true
기간외
(Meaning "Period elapsed")
ON false false
일예산초과,기간외
(Meaning "Daily budget exceeded, Period elapsed")
ON true false
사용자OFF
(Meaning "User OFF")
OFF false true
사용자OFF,일예산초과
(Meaning "User OFF, Daily budget exceeded")
OFF true true
사용자OFF,기간외
(Meaning "User OFF, Period elapsed")
OFF false false
사용자OFF,일예산초과,기간외
(Meaning "User OFF, Daily budget exceeded, Period elapsed")
OFF true false
삭제됨
(Meaning "Deleted")
DEL - -

* The values of statusDescription are passed in Korean.

SyncAppTargeting
Name Type Description
profileId String Kakao Talk Channel profile ID
inclusionType String Whether or not it is included
Either INCLUDE or EXCLUDE

T

TalkChannelTargeting
Name Type Description
id Long Kakao Talk Channel targeting ID
inclusionType InclusionType Whether to include or exclude the information extracted from a Kakao Talk Channel for ad group targeting
profileId Integer Encoded profile ID
profileName String Profile name
TalkChannelGroupTargeting
Name Type Description
id Long Friend group ID
name String Friend group name
inclusionType InclusionType Whether to include or exclude the information extracted from a Friend group file for ad group targeting
talkChannelGroupFileId Long Friend group file ID
fileType String File type
One of the followings: APP_USER_ID, PHONE_NUMBER, MESSAGE_RETARGET
groupKey String Friend group file's group key
Targeting
Name Type Description
id Long Audience ID
Not provided in the case of general targeting
name String Audience name
Not provided in the case of general targeting
type String Whether to use Audience.
One of the followings:
- NORMAL: General targeting.
- DISPLAY: Use the set Display Audience.
- MESSAGE: Use the set Message Audience.
ageType String Selection type for age range
Either All (Select all age ranges) or NOT_ALL (Select some age ranges)
ages Set of String Age range
genderType String Selection type for gender
Either All (Select all genders) or NOT_ALL (Select a specific gender)
genders Set of String Gender
locations Set of Location City/Province
Refer to View city/province.
depth2Locations Set of Depth2Location City/County/District
Refer to View city/county/district.
depth3Locations Set of Depth3Location Neighborhood/Town/Townships
Refer to View dong/eup/myeon.
ufoInterests EnumSet of UfoInterest Interest targeting
Refer to View categories of Network for placements.
ufoBusinessTypes EnumSet of UfoBusinessType Business type targeting
Refer to View categories of Network for placements.
talkChannelTargetings Set of TalkChannelTargeting Kakao Talk Channel targeting
syncAppTargetings Set of SyncAppTargeting Kakao Login user targeting
customerFileTargetings Set of CustomerFileTargeting Customer targeting
cohortTargetings Set of CohortTargeting Engagement targeting
trackerTargetings Set of TrackerTargeting Pixel & SDK targeting
talkChannelGroupTargetings Set of TalkChannelGroupTargeting Information of friends group targeting.
Thumbnail
Name Type Description
fileSize Long File size
url String Representative Thumbnail image URL
fileName String Representative Thumbnail file name
imageWidth Integer Image width
imageHeight Integer Image height
mimeType String Mime type
TimeUnit
Name Description
DAY day
Report counting unit Maximum period to be retrieved
DAY 1 month
TrackerTargeting
Name Type Description
id Long Tracker number
inclusionType InclusionType Whether to include or exclude the information extracted from a Pixel & SDK event for ad group targeting
trackId String Tracker ID
eventCode String Event code
trackRuleId String Tracker rule number
trackRuleName String Tracker rule name
term Integer Targeting period. (Min: 1, Max: 180)
TrackRule
Name Type Description
trackRuleId String Tracker information ID
trackId String Tracker ID
eventCode String Event code
name String Tracker information name
ruleSetStr String[] Rule set definition

U

UfoBusinessType
Name Type Description
value String Key that indicates detailed business type
For detailed keys and descriptions, refer to UfoBusinessType (Enum).
UfoInterest
Name Type Description
value String Key for interests
For detailed keys and descriptions, refer to UfoInterest (Enum).

V

Video: Display creative
Name Type Description
url String Video creative URL
Video: Message creative
Name Type Description
vid String Unique ID of Kakao TV video
name String Kakao TV video name
previewImage String Preview image URL
thumbnail String Thumbnail URL
duration Double Video duration
clipId String Mime type
clipLinkId Long Clip link ID
liveLinkId Long Live link ID
channelId Long Channel ID
channelName String Channel name
isVertical Boolean Whether or not the video is vertical
videoType String Video type
One of UPLOAD, PREUPLOAD, LINK, or NONE
isOwner Boolean Whether or not it is owner
VideoInfo
Name Type Description
vid String Kakao TV video ID
name String Kakao TV video name
duration Integer Kakao TV video duration
clipId Long Kakao TV video clip ID
clipLinkId Long Kakao TV video clip link ID
liveLinkId Long Kakao TV live link ID
channelName String Kakao TV channel name
videoType String Video type
One of UPLOAD (Uploaded video), PREUPLOAD (Loaded video), or LINK (Linked video)
Kakao Moment> Type information