본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

Related sites
  • Docs
  • Kakao Moment
  • Type information

사이드 메뉴

Search

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

ValueDescription
LINKShortcuts
MORELearn
RESERVATIONMake a reservation
PURCHASEPurchase
REQUESTApply
INQUIREInquire
INSTALLInstall
RUNExecute
DOWNLOADDownload
LAUNCHUse
ADD_FRIENDAdd channel
SUBSCRIBEGet news
MORE_VIDEOView more videos
JOINSign up
COUPONGet coupons
PLAYPlay a game
NameTypeDescription
idLongAd group ID
nameStringAd group name
adGroupStatusEnum: Status[]Ad group status
ValueDescription
DISPLAYDisplay
DIRECT_MESSAGEMessage
NameTypeDescription
idLongAd View ID
nameStringAd View name
typeStringAd View type
templateTypeStringAd View template type
NameTypeDescription
idLongAd View ID
NameTypeDescription
RETARGETINGStringRetargeting
CONVERSIONStringConversion
BOTHStringBoth retargeting and conversion
NameTypeDescription
assetGroupIdLongSlide number
orderingIntegerSlide order
imageImageSlide image
titleStringTitle
descriptionStringPromotional text
priceAmountStringPrice information
priceCurrencyCodeEnum: CurrencyCodePrice currency unit
discountedPriceAmountStringDiscounted price information
rspvLandingUrlStringRepresentative landing URL
pcLandingUrlStringLanding URL for PC
mobileLandingUrlStringLanding URL for mobile
NameTypeDescription
adGroupAdGroupAd group
campaignCampaignCampaign
operationEnum: OperationOperation type
  • ONLY: ONLY
  • MINUS: MINUS
  • AND: AND

Note: Refer to Available operation and engagement types by Type X Goal.
firstIndicatorEnum: IndicatorType of the first response

Note: Refer to Available operation and engagement types by Type X Goal.
secondIndicatorEnum: IndicatorType of the second response
  • PLAY: Video play
  • CLICK: Click
  • CONVERSION: Conversion

Note: Refer to Available operation and engagement types by Type X Goal.
messageAdMessageAdMessage
NameTypeDescription
typeStringAutomatic bidding options
  • TARGET_CPC: CPC cost targeting
  • TARGET_CPA: CPA cost targeting
  • TARGET_ROAS: ROAS targeting
  • MAXIMIZE_CONVERSION_VALUE: Maximizing the value of conversions
valueLongTarget value
The cost target value of the Automatic bidding, pass 0 if type is MAXIMIZE_CONVERSION_VALUE
NameTypeDescription
orderingLongSort order number
titleStringButton name
rspvLandingUrlStringResponsive landing URL
mobileLandingUrlStringMobile landing URL
pcLandingUrlStringPC landing URL
adViewIdLongAd View ID
bizFormIdLongBusiness Form ID
channelPostIdLongChannel post ID
channelCouponIdLongChannel coupon ID
thumbnailStringThumbnail image
highlightedBooleanWhether to use highlighted button
landingTypeEnumLanding type
  • LANDING_URL: URL landing
  • CHANNEL_COUPON: Coupon landing
  • CHANNEL_POST: Post landing
  • AD_VIEW: Ad View
  • BIZ_FORM: Business Form
NameTypeDescription
idLongBusiness Form ID linked to Moment
Used when creating a Message creative.
adAccountIdLongAd account ID
bizFormIdLongBusiness Form ID
titleStringBusiness Form title
flowTypeStringBusiness Form type
  • APPLY: 바로응모형
  • SURVEY: 설문조사형
  • RESERV: 신청예약형
linkedDateStringDate and time when the Business Form is linked to Moment in yyyy-MM-dd'T'HH:mm:ss format
beginDateStringDate and time when the Business Form starts in yyyy-MM-dd'T'HH:mm:ss format
endDateStringDate and time when the Business Form ends in yyyy-MM-dd'T'HH:mm:ss format
NameTypeDescription
titleStringButton name
pcLandingUrlStringPC landing URL for the button. If used, a separate URL is used for PC Kakao Talk.
Must be a valid URL starting with http:// or https://.
mobileLandingUrlStringMobile landing URL for the button.
Must be a valid URL starting with http:// or https://.
channelPostIdLongPost ID.
Used when the landing type is CHANNEL_POST.
Must be obtained from the Channel Post List API.
channelCouponIdLongCoupon ID.
Used when the landing type is CHANNEL_COUPON.
Must be obtained from the Coupon List API.
bizFormIdLongBusiness Form ID.
Used when the landing type is BIZ_FORM.
Must be obtained from the Business Form List API.
adViewIdLongAd View ID.
Used when the landing type is AD_VIEW.
Must be obtained from the Ad View List API.
webembedChannelUrlStringWeb embed channel URL.
The URL set for the web embed channel is displayed.
NameTypeDescription
titleStringCarousel title
descriptionStringCarousel promotional text
imageUrlStringCarousel promotional area image URL
pcLandingUrlStringPC landing URL for the carousel. If used, a separate URL is used for PC Kakao Talk.
Must be a valid URL starting with http:// or https://.
mobileLandingUrlStringMobile landing URL for the carousel.
Must be a valid URL starting with http:// or https://.
shareFlagBooleanWhether to use the share option for the carousel.
  • true: Use share
  • false: Do not use share

Important: Cannot be used if ageVerification is true.
buttonsButton[]Carousel button information
priceAmountIntegerCarousel price information
priceCurrencyCodeEnum: CurrencyCodeCarousel currency information.
discountedPriceAmountIntegerCarousel discounted price information.
Must be at least 1% less than priceAmount.
NameTypeDescription
idLongCampaign ID
adAccountIdLongAd account ID
nameStringCampaign name
campaignTypeGoalCampaignTypeGoalCampaign Type X Goal
objectiveObjectiveObjective of the advertising goal
dailyBudgetAmountLongDaily budget
If omitted, the budget is not limited.
configEnum: ConfigCampaign status
isDailyBudgetAmountOverBooleanWhether or not the daily budget is exceeded
statusDescriptionStringStatus of the campaign
trackIdStringConversion tracking ID
ValueDescription
TALK_BIZ_BOARDKakao Biz Board
DISPLAYDisplay
VIDEOVideo
PRODUCT_CATALOGProduct catalog
TALK_BIZ_BOARD_RESERVEDKakao Biz Board CPT
FOCUS_FULL_VIEWFocus full view
PC_TALK_RICH_POPRich Pop All Day
PROFILE_FULL_VIEWProfile full view
PC_TALK_BOTTOMFocus board
DAUM_SHOPPINGDaum Shopping
TALK_CHANNELKakao Talk Channel
PERSONAL_MESSAGEPersonalized message
NameTypeDescription
campaignTypeEnum: CampaignTypeCampaign type
goalEnum: GoalCampaign goal
NameTypeDescription
idStringCategory code
Use "targeting.ufoInterests(Interest)" or "targeting.ufoBusinessTypes(Industry)" when creating or editing an ad group.
nameStringCategory name
childrenCategoryData[]Sub-category data
NameTypeDescription
idLongPost ID
titleStringTitle
statusStringStatus
adultBooleanWhether it is an age verification post
  • true: Age verification post
  • false: General post
permalinkStringPost URL
createdDateStringDate and time of post creation
publishedDateStringDate and time of post publication
NameTypeDescription
idLongClip ID
durationDoubleVideo duration
thumbnailUrlStringThumbnail image URL
isOpenBooleanWhether or not the clip is public
NameTypeDescription
idLongClip Link ID
displayTitleStringClip Link title
playCountIntegerNumber of video plays
likeCountIntegerNumber of likes
commentCountIntegerNumber of comments
createTimeDatetimeCreated time
updateTimeDatetimeUpdated time
clipClipDetailed information of the Clip Link
linkUrlStringURL of the Clip Link
codenameDescription
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
codenameDescription
KKO99-1채팅지면 노출Displayed in Chat section
KKO99-2오픈채팅지면 노출Displayed in Open Chat section
KKO99-4친구지면 노출Displayed in Friends section
KKO99-5친구소식지면 노출Displayed in Friend News section
KKO99-6숏폼지면 노출Displayed in Shorts section
KKO99-7기타지면 노출Displayed in other sections
KKO99-8카카오쇼핑지면 노출Displayed in Kakao Shopping section
NameTypeDescription
idLongEngagement target ID
nameStringEngagement target name
cohortIdLongRegistered engagement target number
inclusionTypeEnum: InclusionTypeWhether to include or exclude the information extracted through engagement targeting for ad group targeting
NameTypeDescription
businessRegistrationNumberStringBusiness registration number
nameStringBusiness name
ValueDescription
ONActivated
OFFInactivated
DELDeleted
NameTypeDescription
couponBookTitleStringTitle of coupon book
couponBookTitleTypeStringType of coupon book
titleStringDetailed description of coupon book
channelCouponsChannelCouponsInformation of channel coupon
mobileLandingUrlStringMobile landing URL
pcLandingUrlStringPC landing URL
orderingIntegerSort order
NameTypeDescription
idStringChannel coupon ID
NameTypeDescription
idLongCoupon ID
titleStringCoupon's title
contentStringCoupon's content
statusCodeStringCoupon's status
permalinkStringCoupon's link
entryImageEntryImageCoupon's detailed image
createdAtStringDate and time of coupon creation
NameTypeDescription
couponBookTitleTypeEnumCoupon type.
  • DISCOUNT_PRICE: Discount amount
  • DISCOUNT_RATE: Discount rate
  • FREE_SHIPPING: Free shipping
  • FREE_GIFT: Free gift
  • UPGRADE: Upgrade
couponBookTitleStringCoupon title. Entered according to the value of couponBookTitleType.
  • DISCOUNT_PRICE: Maximum 8 digits
  • DISCOUNT_RATE: Maximum 2 digits
  • FREE_SHIPPING: Not allowed
  • FREE_GIFT, UPGRADE: Varies by message type

Important: Maximum 7 characters for Basic text, Carousel commerce, and Carousel feed, and maximum 12 characters for Wide image, Wide list, and Premium video
titleStringDetailed description of the coupon

Important: Maximum 12 characters for Basic text, Carousel commerce, and Carousel feed, and maximum 18 characters for Wide image, Wide list, and Premium video
pcLandingUrlStringPC landing URL for the coupon. If used, a separate URL is used for PC Kakao Talk.
Must be a valid URL starting with http:// or https://.
mobileLandingUrlStringMobile landing URL for the coupon.
Must be a valid URL starting with http:// or https://.
ValueDescription
KRW
USD$
JPY¥
EUR
ValueDescription
WAITINGWaiting for extracting target population from a customer file
COMPLETETarget population has been extracted from a customer file
DELETEAlready deleted or deleting
ERROROther abnormal case
MODIFYINGPreparing for the modified target population
NameTypeDescription
idLongCustomer file registration ID
inclusionTypeEnum: InclusionTypeWhether to include or exclude the information extracted from a customer file for ad group targeting
nameStringCustomer file name
statusEnum: CustomerFileStatusCustomer file status
NameTypeDescription
typeCustomTargetTypeCustom targeting type.
  • PLUSFRIENDGROUP: Friend group
  • PLUSFRIEND: Kakao Talk Channel friend
  • COHORT: Ad response target
  • SYNCAPP: Kakao Login user
referenceIdStringCustom target ID
inclusionTypeTargetingInclusionTypeWhether to include or exclude.
  • INCLUDE: Include
  • EXCLUDE: Exclude
nameStringName
NameTypeDescription
startStringStart date in yyyyMMdd format
endStringEnd date in yyyyMMdd format
dimensionsDimensionsReport criteria and values
metricsMetricsReport metrics and values
ValueDescription
TODAYToday, from 00:00 to the hour right before the current
YESTERDAYYesterday, from 00:00 to 24:00
LAST_7DAYFor the last 7 days until 24:00 yesterday, not including today
LAST_14DAYFor the last 14 days until 24:00 yesterday, not including today
LAST_30DAYFor the last 30 days until 24:00 yesterday, not including today
THIS_MONTHThis month, from the 1st day of this month to today
LAST_MONTHLast month, from the 1st day of last month to the last day

For the complete list, refer to Depth2Location table in Type information of location CSV file (Download).

NameTypeDescription
valueStringCode that indicates the corresponding location
descriptionStringName of -si/-do and gun/gu.
Passed in Korean only.
depth1NameStringName of -si (city) or -do (province)
depth2NameStringName of -si (city), -gun (county), or -gu (district)
deprecatedBooleanWhether the administrative district is deleted.
If the value is true, the district has been deleted.
If not deleted, this field is not included.

For the complete list, refer to Depth3Location table in Type information of location CSV file (Download).

NameTypeDescription
valueStringCode that indicates the corresponding location
descriptionStringName of -si/-do and gun/gu
depth1NameStringName of -si (city) or -do (province)
depth2NameStringName of -si (city), -gun (county), or -gu (district)
depth3NameStringName of -dong (neighborhood), -eup (town), or -myeon (townships)
deprecatedBooleanWhether the administrative district is deleted.
If the value is true, the district has been deleted.
If not deleted, this field is not included.
NameTypeDescription
genderTypeEnumGender selection type.
  • ALL: Select all (Default)
  • NOT_ALL: Partial selection
gendersString[]Gender.
  • M: Male
  • F: Female

Important: Only allowed if genderType is NOT_ALL.
ageTypeEnumAge selection type.
  • ALL: Select all
  • NOT_ALL: Partial selection
agesString[]Age range.
  • 15: 15 to 19
  • 20: 20 to 24
  • 25: 25 to 29
  • 30: 30 to 34
  • 35: 35 to 39
  • 40: 40 to 44
  • 45: 45 to 49
  • 50: 50 to 54
  • 55: 55 to 59
  • 60: 60 to 64
  • 65: 65 to 69
  • 70: Over 70

Important: Only allowed if ageType is NOT_ALL.
locationTypeEnumLocation selection type.
  • ALL: All (domestic and overseas)
  • Domestic: Domestic only
  • AREA: Select area

Important: Only allowed if locationType is AREA.
depth1LocationsDepth1Location[]Demographics > Location > City/Province
See View city/province

Important: Only allowed if locationType is AREA.

Important: You can request all or individual of depth1Locations, depth2Locations, depth3Locations.
depth2LocationsDepth2Location[]Demographics > Location > City/County/District
See View city/county/district

Important: Only allowed if locationType is AREA.

Important: You can request all or individual of depth1Locations, depth2Locations, depth3Locations.
depth3LocationsDepth3Location[]Demographics > Location > Neighborhood/Town/Township
See View dong/eup/myeon

Important: Only allowed if locationType is AREA.

Important: You can request all or individual of depth1Locations, depth2Locations, depth3Locations.
ValueDescription
ANDROIDAndroid
IOSiOS
PCPC
ValueDescription
AD_ACCOUNTad_account_id: Ad account
CAMPAIGNcampaign_id: Campaign
AD_GROUPad_group_id: Ad group
CREATIVEcreative_id: Creative
ValueDescription
CREATIVE_FORMATCreative format
Creative type: Display
  • IMAGE_BANNER: Image banner
  • IMAGE_NATIVE: Image native
  • VIDEO_NATIVE: video native
  • IMAGE_BOX: Image box
  • CATALOG_DYNAMIC: Dynamic catalog
  • SERVICE_CONTENT: Contents
Creative type: Message
  • BASIC_TEXT_MESSAGE: Basic text
  • WIDE_LIST_MESSAGE: Wide list
  • WIDE_MESSAGE: Wide message
  • CAROUSEL_COMMERCE_MESSAGE: Carousel commerce
  • CAROUSEL_FEED_MESSAGE: Carousel feed
  • PREMIUM_VIDEO_MESSAGE: Premium video
  • CATALOG_MESSAGE: Catalog
  • SPOTLIGHT_MESSAGE: Spotlight
PLACEMENTPlacement
  • total: All
  • KAKAO_TALK: Kakao Talk
  • DAUM: Daum
  • KAKAO_STORY: Kakao Story
  • KAKAO_SERVICE: Kakao service
  • NETWORK: Network
AGE(Old) Age range
  • total: All
  • 15: 15 to 19
  • 20: 20 to 25
  • 26: 26 to 30
  • 31: 31 to 40
  • 41: 41 to 50
  • 51: 51 to 70
  • -1: Unknown
AGE_BANDAge range
  • total: All
  • 15: 15 to 19
  • 20: 20 to 25
  • 25: 25 to 29
  • 30: 30 to 34
  • 35: 35 to 39
  • 40: 40 to 44
  • 45: 45 to 49
  • 50: 50 to 54
  • 55: 55 to 59
  • 60: 60 to 64
  • 65: 65 to 69
  • 70: Over 70
  • 0: Unknown
GENDERGender
  • total: All
  • M: Male
  • F: Female
  • N: Unknown
AGE_GENDER(Old) Age range+gender
AGE_BAND_GENDERAge range+gender
LOCATIONLocation
  • total: All
  • A: Gangwon Special Self-Governing Province
  • B: Gyeonggi-do
  • C: Gyeongsangnam-do
  • D: Gyeongsangbuk-do
  • E: Gwangju
  • F: Daegu
  • G: Daejeon
  • H: Busan
  • I: Seoul
  • Q: Sejong Special Self-Governing City
  • J: Ulsan
  • K: Incheon
  • R: Jeonnam-Gwangju Integrated Special City
  • L: Jeollanam-do
  • M: Jeonbuk Special Self-Governing Province
  • N: Jeju Special Self-Governing Province
  • O: Chungcheongnam-do
  • P: Chungcheongbuk-do
  • Z: Overseas
  • U: Unknown
DEVICE_TYPEDevice type
  • total: All
  • PC: PC
  • Android: Android
  • iOS: iOS
  • N/A: Others
HOURHour
  • total: All
  • 00: 00:00 to 00:59
  • 01: 01:00 to 01:59
  • 02: 02:00 to 02:59
  • 03: 03:00 to 03:59
  • 04: 04:00 to 04:59
  • 05: 05:00 to 05:59
  • 06: 06:00 to 06:59
  • 07: 07:00 to 07:59
  • 08: 08:00 to 08:59
  • 09: 09:00 to 09:59
  • 10: 10:00 to 10:59
  • 11: 11:00 to 11:59
  • 12: 12:00 to 12:59
  • 13: 13:00 to 13:59
  • 14: 14:00 to 14:59
  • 15: 15:00 to 15:59
  • 16: 16:00 to 16:59
  • 17: 17:00 to 17:59
  • 18: 18:00 to 18:59
  • 19: 19:00 to 19:59
  • 20: 20:00 to 20:59
  • 21: 21:00 to 21:59
  • 22: 22:00 to 22:59
  • 23: 23:00 to 23:59

An object containing report level and criteria values. The keys and values included in the response depend on the report level and report criteria.

The following example shows a response grouped by creative format at the ad account level.

{
"creative_format": "IMAGE BANNER",
"ad_account_id": "1234"
}
NameTypeDescription
typeStringMedia type, such as image, video and others
urlStringImage URL
thumbnailStringThumbnail image
previewImageStringIn the case of video type, thumbnail image
playUrlStringIn the case of video type, video URL
nameStringName
NameTypeDescription
startDateStringStart date, in yyyy-MM-dd format
endDateStringEnd date, in yyyy-MM-dd format
ValueDescription
VISITINGVisit
CONVERSIONConversion
REACHReach
VIEWView
NameTypeDescription
titleStringContent
hashStringhash value of the group
orderingIntegerSort order
isHighlightedBooleanWhether button is highlighted
landingTypeEnumGroup landing type
  • CHANNEL_POST: Post landing
  • CHANNEL_COUPON: Coupon landing
  • AD_VIEW: Ad View
  • BIZ_FORM: Business Form
  • LANDING_URL: URL landing
imageImageInfoGroup image information
pcLandingUrlStringPC landingURL
mobileLandingUrlStringMobile landingURL
channelPostIdLongChannel post ID selected as a group landing
channelPostTitleStringChannel post title selected as a group landing
channelCouponIdLongChannel coupon ID selected as a group landing
channelCouponTitleStringChannel coupon title selected as a group landing
adViewIdLongAd View ID selected as a group landing
bizFormIdLongBusiness Form ID selected as a group landing
NameTypeDescription
sizeLongFile size
urlStringImage URL
fileNameStringImage file name
widthIntegerImage width
heightIntegerImage height
mimeTypeStringMime type
NameTypeDescription
urlStringImage URL
imageWidthIntegerImage width
imageHeightIntegerImage height
fileSizeLongFile size
fileNameStringFile name
ValueDescription
INCLUDEIncluded
EXCLUDEExcluded
ValueDescription
PLAYVideo play
CLICKClick
CONVERSIONConversion
OPENOpen
NameTypeDescription
titleStringIntro title (Maximum: 25 characters)
descriptionStringIntro promotional text (Maximum: 50 characters)
imageUrlStringIntro promotional area image URL
pcLandingUrlStringPC landing URL for the intro. If used, a separate URL is used for PC Kakao Talk.
Must be a valid URL starting with http:// or https://.
mobileLandingUrlStringMobile landing URL for the intro.
Must be a valid URL starting with http:// or https://.
NameTypeDescription
imageUrlStringItem image URL, promotional image to be included in the message

Important: When using a Kakao Talk Channel video in Basic Text, Wide Image, or Wide List Item, send the request with only video.mediaId instead of imageUrl. (Reference: Body when requesting a Kakao Talk Channel video)
titleStringItem promotional text
landingLanding[]Landing information
NameTypeDescription
thumbnailStringThumbnail URL
landingTypeEnumLanding type
  • LANDING_URL: URL
  • CHANNEL_COUPON: Coupon
  • CHANNEL_POST: Post
orderingIntegerSort order
titleStringPromotional 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, CATALOG_MESSAGE types.
descriptionStringPromotional text for CAROUSEL_FEED_MESSAGE
priceAmountStringPrice for CAROUSEL_COMMERCE_MESSAGE
priceCurrencyCodeEnum: CurrencyCodeCurrency
discountedPriceAmountStringDiscounted price for CAROUSEL_COMMERCE_MESSAGE
mobileLandingUrlStringMobile landing URL
Passed if landing type is set to LANDING_URL.
pcLandingUrlStringPC landing URL
Passed if landing type is set to LANDING_URL.
imageImageImage 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, CATALOG_MESSAGE types.
thumbnailThumbnailRepresentative image.
NameTypeDescription
pcLandingUrlStringPC landing URL
mobileLandingUrlStringMobile landing URL
webembedChannelUrlStringWeb embed landing URL
channelPostIdLongChannel post ID
channelCouponIdLongChannel coupon ID
NameTypeDescription
landingTypeStringLanding type
  • PF_BOT: Chatbot
  • AD_VIEW: Ad View
  • MESSAGE: Message
  • CHANNEL_WEBVIEW: Channel web view
  • BIZ_FORM: Business Form
  • BIZ_FORM_PLUS: Business Form Plus
  • PAY_BUY: Purchase using Kakao Pay
profileIdStringKakao Talk Channel profile ID.

Important: Used if landingType (Landing type) is PF_BOT (Chatbot) or CHANNEL_WEBVIEW (Channel web view).

Note: Pass the Kakao Talk Channel profile ID obtained through the View list of Kakao Talk Channel profiles API.
actionStringKeyword.

Important: Used if landingType (Landing type) is PF_BOT (Chatbot).
adViewItemAdViewItemAd View object.

Important: Used if landingType (Landing type) is AD_VIEW (Ad View).
urlStringURL.

Important: Used if landingType (Landing type) is CHANNEL_WEBVIEW (Channel web view).
bizFormIdLongBusiness Form ID.

Important: Used if landingType (Landing type) is BIZ_FORM (Business Form).
bizFormplusIdLongBusiness Form+ ID.

Important: Used if landingType (Landing type) is BIZ_FORM_PLUS (Business Form Plus).
channelPostIdLongChannel post ID.

Important: Used if landingType (Landing type) is CHANNEL_POST (Channel post).
shopKeyStringKakao Pay purchase store key.

Important: Used if landingType (Landing type) is PAY_BUY (Kakao Pay purchase).
productIdStringKakao Pay purchase product ID.

Important: Used if landingType (Landing type) is PAY_BUY (Kakao Pay purchase).

For the complete list, refer to Depth1Location table in Type information of location CSV file (Download).

NameTypeDescription
valueStringCode that indicates the corresponding location
descriptionStringName of -si (city) or -do (province)
depth1NameStringName of -si (city) or -do (province)
deprecatedBooleanWhether the administrative district is deleted.
If the value is true, the district has been deleted.
If not deleted, this field is not included.
NameTypeDescription
typeEnumMessage type (required)
  • BASIC_TEXT_MESSAGE: Basic text
  • WIDE_MESSAGE: Wide image
  • WIDE_LIST_MESSAGE: Wide list
  • CAROUSEL_COMMERCE_MESSAGE: Carousel commerce
  • CAROUSEL_FEED_MESSAGE: Carousel feed
  • CATALOG_MESSAGE: Catalog
  • SPOTLIGHT_MESSAGE: Spotlight
titleStringMessage promotional text
itemsItem[]Item information
buttonsButton[]Button information
couponBookCouponBook[]Coupon information
introCarouselIntroCarouselIntro information
carouselsCarousel[]Carousel information
catalogCatalog[]Catalog information
buttonTitleStringSpotlight message button name
landingUrlStringSpotlight message landing URL
adFlagBooleanAdvertising message
  • true: Advertising message
  • false: Informational message
shareFlagBooleanWhether to use the share option
  • true: Use share
  • false: Do not use share

Important: Cannot be used if ageVerification is true.
NameTypeDescription
idStringMessage creative ID
nameStringMessage creative name
opStatusEnum: Status[]Message status
ValueDescription
MASTERMaster role
MEMBERMember role
NameTypeDescription
idLongMessage creative ID
adAccountIdLongAd account ID
profileIdStringKakao Talk Channel profile ID
profileNameStringKakao Talk Channel profile name
nameStringMessage creative name
shareFlagBooleanSharing
adFlagBooleanAdvertising message
creativeFormatStringMessage creative's type.
  • BASIC_TEXT_MESSAGE
  • WIDE_MESSAGE
  • WIDE_LIST_MESSAGE
  • CAROUSEL_COMMERCE_MESSAGE
  • CAROUSEL_FEED_MESSAGE
  • CATALOG_MESSAGE
titleTitlePromotional 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
descriptionStringPromotional text for the intro card of CAROUSEL_COMMERCE_MESSAGE
imageImageImage creative
Only returned for the BASIC_TEXT_MESSAGE and CAROUSEL_COMMERCE_MESSAGE types.
buttonAssetGroupsButtonAssetGroupButton item
itemAssetGroupsItemAssetGroupList of items
Only returned for the following types
  • WIDE_MESSAGE
  • WIDE_LIST_MESSAGE
  • CAROUSEL_COMMERCE_MESSAGE
  • CAROUSEL_FEED_MESSAGE
  • CATALOG_MESSAGE
thumbnailUrlStringThumbnail image URL
csInfoStringPhone number of customer support
couponBookAssetGroupsCouponBookAssetGroupCoupon book information
createdDateStringDate and time of the Message creative creation in yyyy-MM-dd'T'HH:mm:ss format
lastModifiedDateStringDate and time of the Message creative modification in yyyy-MM-dd'T'HH:mm:ss format
hasIntroBooleanWhether the CAROUSEL_COMMERCE_MESSAGE creative has the intro card
introLandingTypeStringLanding type of the CAROUSEL_COMMERCE_MESSAGE intro card
introMobileLandingUrlStringLanding URL of the CAROUSEL_COMMERCE_MESSAGE intro card for mobile
introPcLandingUrlStringLanding URL of the CAROUSEL_COMMERCE_MESSAGE intro card for PC
NameTypeDescription
contractCountIntegerAvailable number of sending messages
Not allowed to set this value less than the estimated target population for sending a message.
longTermBooleanWhether 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.
priceLongPrice for sending a message
pushAlarmBooleanWhether to use the '푸시알림 보내지 않기(Not send push notifications)' option
  • true: Not send push notifications
  • false: Send push notifications
sendRateIntegerOption to send distributed messages
Set the number of messages that are sent at once
  • 100
  • 500
  • 1000
  • 1500
  • 2000
  • 0: Not use the distributed sending option
statusEnumStatus of sending a message
  • READY: Ready to send
  • SENDING: Sending
  • PAUSE: Paused
  • FINISHED: Finished
  • STOPPED: Stopped
  • EXPIRED: Expired
  • SAVE: Saved
syncStatusEnumSync status with the sending system
  • READY: Waiting for sync
  • SUCCESS: Synced
  • FAILED: Sync failed
startedATStringTime when message delivery has started
finishedATStringTime when message delivery has been completed
ageVerificationBooleanWhether to use age verification messages
  • true: Age verification message used
  • false: General message used

An object containing report metrics and their aggregated values. The keys are the detailed metric names listed in MetricsGroup, and the values are the aggregation results for those metrics. The keys included in the response depend on the requested metric group.

The following example shows a response for the BASIC metric group.

{
"imp": 4,
"click": 0,
"ctr": 0.0,
"cost": 0.0
}
ValueDescription
BASICBasic metrics
  • imp: Number of impressions
  • click: Number of clicks
  • ctr: Click-through rate
  • cost: Cost
  • video_play_3s: Number of plays
  • vtr: Rate of plays
ADDITIONAdditional metrics
  • reach: Number of people who see ads (Reach)
  • cost_per_imp: Cost per impression
  • cost_per_click: Cost per click
  • cost_per_reach: Cost per reach
  • cost_per_video_play_3s: Cost per play
MESSAGEMessage basic metrics
  • msg_send: Number of messages sent
  • msg_open: Number of views
  • msg_click: Total number of clicks
  • cost: Cost
  • msg_send_fail: Sending failure count
MESSAGE_ADDITIONMessage additional metrics
  • cost_per_msg_send: Cost per sending a message
  • cost_per_msg_open: Cost per view
  • cost_per_msg_click: Total cost per click
  • msg_open_rate: Message open rate
  • msg_click_rate: Message click-through rate
PIXEL_SDK_CONVERSIONPixel & SDK conversion metrics
  • conv_cmpt_reg_1d: Complete a signup (1 day)
  • conv_cmpt_reg_7d: Complete a signup (7 days)
  • conv_view_cart_1d: View cart (1 day)
  • conv_view_cart_7d: View cart (7 days)
  • conv_purchase_1d: Purchase (1 day)
  • conv_purchase_7d: Purchase (7 days)
  • conv_purchase_p_1d: Purchase price (1 day)
  • conv_purchase_p_7d: Purchase price (7 days)
  • conv_purchase_p_per_cost_1d: ROAS (1 day)
  • conv_purchase_p_per_cost_7d: ROAS (7 days)
  • conv_estimated_purchase_p_per_cost_1d: Estimated ROAS (1 day)
  • conv_estimated_purchase_p_per_cost_7d: Estimated ROAS (7 days)
  • conv_participation_1d: Potential customer (1 day)
  • conv_participation_7d: Potential customer (7 days)
  • conv_signup_1d: Service registration (1 day)
  • conv_signup_7d: Service registration (7 days)
  • conv_app_install_1d: Install app (1 day)
  • conv_app_install_7d: Install app (7 days)
  • cost_per_conv_cmpt_reg_1d: Cost per sign up (1 day)
  • cost_per_conv_cmpt_reg_7d: Cost per sign up (7 days)
  • conv_cmpt_reg_1d_rate: Signup rate (1 day)
  • conv_cmpt_reg_7d_rate: Signup rate (7 days)
  • conv_add_to_wishlist_1d: Adding to wishlist (1 Day)
  • cost_per_conv_add_to_wishlist_1d: Cost per adding wishlist (1 Day)
  • conv_add_to_wishlist_1d_rate: Rate of adding to wishlist (1 Day)
  • conv_add_to_wishlist_7d: Adding to wishlist (7 Days)
  • cost_per_conv_add_to_wishlist_7d: Cost per adding wishlist (7 Days)
  • conv_add_to_wishlist_7d_rate: Rate of adding to wishlist (7 Days)
  • conv_add_to_cart_1d: Adding to cart (1 Day)
  • cost_per_conv_add_to_cart_1d: Cost per adding to cart (1 Day)
  • conv_add_to_cart_1d_rate: Rate of adding to cart (1 Day)
  • conv_add_to_cart_7d: Adding to cart (7 Days)
  • cost_per_conv_add_to_cart_7d: Cost per adding to cart(7 Days)
  • conv_add_to_cart_7d_rate: Rate of adding to cart (7 Days)
  • cost_per_conv_view_cart_1d: Cost per cart viewing (1 day)
  • cost_per_conv_view_cart_7d: Cost per cart viewing (7 days)
  • conv_view_cart_1d_rate: Cart viewing rate (1 day)
  • conv_view_cart_7d_rate: Cart viewing rate (7 days)
  • cost_per_conv_purchase_1d: Cost per purchase (1 day)
  • cost_per_conv_purchase_7d: Cost per purchase (7 days)
  • conv_purchase_1d_rate: Purchase rate (1 day)
  • conv_purchase_7d_rate: Purchase rate (7 days)
  • cost_per_conv_participation_1d: Cost per potential customer (1 day)
  • cost_per_conv_participation_7d: Cost per potential customer (7 days)
  • conv_participation_1d_rate: Potential customer rate (1 day)
  • conv_participation_7d_rate: Potential customer rate (7 days)
  • cost_per_conv_signup_1d: Cost per service registration (1 day)
  • cost_per_conv_signup_7d: Cost per service registration (7 days)
  • conv_signup_1d_rate: Service registration rate (1 day)
  • conv_signup_7d_rate: Service registration rate (7 days)
  • cost_per_conv_app_install_1d: Cost per app installation (1 day)
  • cost_per_conv_app_install_7d: Cost per app installation (7 days)
  • conv_app_install_1d_rate: App installation rate (1 day)
  • conv_app_install_7d_rate: App installation rate (7 days)
PLUS_FRIENDKakao Talk friends metrics
  • conv_kf_pf_add_1d: Number of friends added (1 day)
  • conv_kf_pf_add_7d: Number of friends added (7 days)
  • cost_per_conv_kf_pf_add_1d: Cost per number of friends added (1 day)
  • cost_per_conv_kf_pf_add_7d: Cost per number of friends added (7 days)
  • conv_kf_pf_add_1d_rate: Adding friends rate (1 day)
  • conv_kf_pf_add_7d_rate: Adding friends rate (7 days)
VIDEOVideo metrics
  • video_play: Number of plays
  • cost_per_video_play_3s: Cost per plays
  • video_play_auto: Number of autoplays
  • video_play_touch: Number of plays by touching video
  • video_unmute: Sound ON count
  • video_play_5s: Number of plays for 5 seconds
  • video_play_10s: Number of plays for 10 seconds
  • video_play_15s: Number of plays for 15 seconds
  • video_play_30s: Number of plays for 30 seconds
  • video_play_60s: Number of plays for 60 seconds
  • video_play_25p: Number of plays watching 25% of video
  • video_play_50p: Number of plays watching 50% of video
  • video_play_75p: Number of plays watching 75% of video
  • video_play_100p: Number of plays watching 100% of video
SLIDE_CLICKSlide metrics
  • slide1_click: Number of clicks on slide1
  • slide2_click: Number of clicks on slide2
  • slide3_click: Number of clicks on slide3
  • slide4_click: Number of clicks on slide4
  • slide5_click: Number of clicks on slide5
  • slide6_click: Number of clicks on slide6
  • slide7_click: Number of clicks on slide7
  • slide8_click: Number of clicks on slide8
  • slide9_click: Number of clicks on slide9
  • slide10_click: Number of clicks on slide10
  • slide_others_click: Number of clicks on others
MESSAGE_CLICKMessage click metrics
  • msg_click_share: Number of clicks on 'Share'
  • msg_click_media: Number of clicks on image or video
  • msg_click_title: Number of clicks on title
  • msg_click_text: Number of clicks on text
  • msg_play_start: Number of clicks on video
  • msg_play_3s: Number of video plays for 3 seconds
  • msg_play_5s: Number of video plays for 5 seconds
  • msg_play_10s: Number of video plays for 10 seconds
  • msg_play_15s: Number of video plays for 15 seconds
  • msg_play_30s: Number of video plays for 30 seconds
  • msg_play_60s: Number of video plays for 60 seconds
  • msg_click_list1: Number of clicks on list1
  • msg_click_list2: Number of clicks on list2
  • msg_click_list3: Number of clicks on list3
  • msg_click_list4: Number of clicks on list4
  • msg_play_list1_start: Number of plays of list1
  • msg_play_list1_3s: Number of plays of list1 for 3 seconds
  • msg_play_list1_5s: Number of plays of list1 for 5 seconds
  • msg_play_list1_10s: Number of plays of list1 for 10 seconds
  • msg_play_list1_15s: Number of plays of list1 for 15 seconds
  • msg_play_list1_30s: Number of plays of list1 for 30 seconds
  • msg_play_list1_60s: Number of plays of list1 for 60 seconds
  • msg_play_list2_start: Number of plays of list2
  • msg_play_list2_3s: Number of plays of list2 for 3 seconds
  • msg_play_list2_5s: Number of plays of list2 for 5 seconds
  • msg_play_list2_10s: Number of plays of list2 for 10 seconds
  • msg_play_list2_15s: Number of plays of list2 for 15 seconds
  • msg_play_list2_30s: Number of plays of list2 for 30 seconds
  • msg_play_list2_60s: Number of plays of list2 for 60 seconds
  • msg_play_list3_start: Number of plays of list3
  • msg_play_list3_3s: Number of plays of list3 for 3 seconds
  • msg_play_list3_5s: Number of plays of list3 for 5 seconds
  • msg_play_list3_10s: Number of plays of list3 for 10 seconds
  • msg_play_list3_15s: Number of plays of list3 for 15 seconds
  • msg_play_list3_30s: Number of plays of list3 for 30 seconds
  • msg_play_list3_60s: Number of plays of list3 for 60 seconds
  • msg_play_list4_start: Number of plays of list4
  • msg_play_list4_3s: Number of plays of list4 for 3 seconds
  • msg_play_list4_5s: Number of plays of list4 for 5 seconds
  • msg_play_list4_10s: Number of plays of list4 for 10 seconds
  • msg_play_list4_15s: Number of plays of list4 for 15 seconds
  • msg_play_list4_30s: Number of plays of list4 for 30 seconds
  • msg_play_list4_60s: Number of plays of list4 for 60 seconds
  • msg_click_button1: Number of clicks on button1
  • msg_click_button2: Number of clicks on button2
  • msg_click_carousel_button1: Number of clicks on button1 of carousel1
  • msg_click_carousel_button2: Number of clicks on button1 of carousel2
  • msg_click_carousel_button3: Number of clicks on button1 of carousel3
  • msg_click_carousel_button4: Number of clicks on button1 of carousel4
  • msg_click_carousel_button5: Number of clicks on button1 of carousel5
  • msg_click_carousel_button6: Number of clicks on button1 of carousel6
  • msg_click_carousel_share1: Number of clicks on button2 of carousel1
  • msg_click_carousel_share2: Number of clicks on button2 of carousel2
  • msg_click_carousel_share3: Number of clicks on button2 of carousel3
  • msg_click_carousel_share4: Number of clicks on button2 of carousel4
  • msg_click_carousel_share5: Number of clicks on button2 of carousel5
  • msg_click_carousel_share6: Number of clicks on button2 of carousel6
  • msg_click_carousel1_coupon: Number of clicks on carousel1 coupon
  • msg_click_carousel2_coupon: Number of clicks on carousel2 coupon
  • msg_click_carousel3_coupon: Number of clicks on carousel3 coupon
  • msg_click_carousel4_coupon: Number of clicks on carousel4 coupon
  • msg_click_carousel5_coupon: Number of clicks on carousel5 coupon
  • msg_click_carousel6_coupon: Number of clicks on carousel6 coupon
  • msg_click_catalog_item1: Number of clicks on item1
  • msg_click_catalog_item2: Number of clicks on item2
  • msg_click_catalog_item3: Number of clicks on item3
  • msg_click_catalog_item4: Number of clicks on item4
  • msg_click_catalog_item5: Number of clicks on item5
  • msg_click_catalog_item6: Number of clicks on item6
  • msg_click_catalog_item7: Number of clicks on item7
  • msg_click_carousel_more: Number of clicks on 'View more'
  • msg_click_coupon: Number of clicks on coupon button
  • msg_click_others: Number of clicks on other elements
ADVIEWAd View metrics
  • ADV_CLICK_BUTTON1: Number of clicks on button1
  • ADV_CLICK_BUTTON2: Number of clicks on button2
  • ADV_CLICK_BUTTON_SHARE: Number of clicks on 'Share'
  • ADV_TH1_VIEW: Number of impressions for image/video1
  • ADV_TH1_VIDEO_PLAY_AUTO: Number of autoplays for video1
  • ADV_TH1_VIDEO_PLAY_TOUCH: Number of plays by touching video1
  • ADV_TH1_VIDEO_PLAY_3S: Number of plays of video1 for 3 seconds
  • ADV_TH2_VIEW: Number of impressions for image/video2
  • ADV_TH2_VIDEO_PLAY_AUTO: Number of autoplays for video2
  • ADV_TH2_VIDEO_PLAY_TOUCH: Number of plays by touching video2
  • ADV_TH2_VIDEO_PLAY_3S: Number of plays of video3 for 3 seconds
  • ADV_TH3_VIEW: Number of impressions for image/video3
  • ADV_TH3_VIDEO_PLAY_AUTO: Number of autoplays for video3
  • ADV_TH3_VIDEO_PLAY_TOUCH: Number of plays by touching video3
  • ADV_TH3_VIDEO_PLAY_3S: Number of plays of video3 for 3 seconds
  • ADV_TH4_VIEW: Number of impressions for image/video4
  • ADV_TH4_VIDEO_PLAY_AUTO: Number of autoplays for video4
  • ADV_TH4_VIDEO_PLAY_TOUCH: Number of plays by touching video4
  • ADV_TH4_VIDEO_PLAY_3S: Number of plays of video4 for 3 seconds
  • ADV_TH5_VIEW: Number of impressions for image/video5
  • ADV_TH5_VIDEO_PLAY_AUTO: Number of plays by touching video5
  • ADV_TH5_VIDEO_PLAY_TOUCH: Number of autoplays of video5 for video
  • ADV_TH5_VIDEO_PLAY_3S: Number of plays of video5 by touching video
  • ADV_TH6_VIEW: Number of impressions for image/video6
  • ADV_TH6_VIDEO_PLAY_AUTO: Number of autoplays of video6
  • ADV_TH6_VIDEO_PLAY_TOUCH: Number of plays by touching video6
  • ADV_TH6_VIDEO_PLAY_3S: Number of plays of video6 for 3 seconds
  • ADV_TH7_VIEW: Number of impressions for image/video7
  • ADV_TH7_VIDEO_PLAY_AUTO: Number of autoplays of video7 for video
  • ADV_TH7_VIDEO_PLAY_TOUCH: Number of plays of video7 by touching video
  • ADV_TH7_VIDEO_PLAY_3S: Number of plays of video7 for 3 seconds
  • ADV_TH8_VIEW: Number of impressions for image/video8
  • ADV_TH8_VIDEO_PLAY_AUTO: Number of autoplays of video8 for video
  • ADV_TH8_VIDEO_PLAY_TOUCH: Number of plays by touching video8
  • ADV_TH8_VIDEO_PLAY_3S: Number of plays of video8 for 3 seconds
  • ADV_TH9_VIEW: Number of impressions for image/video9
  • ADV_TH9_VIDEO_PLAY_AUTO: Number of autoplays of video9
  • ADV_TH9_VIDEO_PLAY_TOUCH: Number of plays of video9 by touching video
  • ADV_TH9_VIDEO_PLAY_3S: Number of plays of video9 for 3 seconds
  • ADV_TH10_VIEW: Number of impressions for image/video10
  • ADV_TH10_VIDEO_PLAY_AUTO: Number of autoplays of video10 for video
  • ADV_TH10_VIDEO_PLAY_TOUCH: Number of plays of video10 by touching video
  • ADV_TH10_VIDEO_PLAY_3S: Number of plays of video10 for 3 seconds
BIZ_BOARDBizboard metrics
  • EXPANDABLE_IMP: Number of impressions
  • MOTION_VIDEO_PLAY_AUTO: Number of autoplays for video (Motion)
  • EXPANDABLE_VIDEO_PLAY_AUTO: Number of autoplays for video (Expandable)
  • MOTION_VIDEO_PLAY_3S: Number of video plays for 3 seconds (Motion)
  • EXPANDABLE_VIDEO_PLAY_3S: Number of video plays for 3 seconds (Expandable)
  • EXPANDABLE_CLICK_CTA: Number of call-to-action clicks
  • EXPANDABLE_CLICK_IMAGE1: Number of clicks for image
  • EXPANDABLE_VIEWABLE_GOODS_1: Number of impressions for image1
  • EXPANDABLE_VIEWABLE_GOODS_2: Number of impressions for image2
  • EXPANDABLE_VIEWABLE_GOODS_3: Number of impressions for image3
  • EXPANDABLE_VIEWABLE_GOODS_4: Number of impressions for image4
  • EXPANDABLE_VIEWABLE_GOODS_5: Number of impressions for image5
  • EXPANDABLE_CLICK_GOODS_1: Number of clicks for image1
  • EXPANDABLE_CLICK_GOODS_2: Number of clicks for image2
  • EXPANDABLE_CLICK_GOODS_3: Number of clicks for image3
  • EXPANDABLE_CLICK_GOODS_4: Number of clicks for image4
  • EXPANDABLE_CLICK_GOODS_5: Number of clicks for image5
SPBBoard metrics
  • channel_home_click: Number of clicks on channel home
  • channel_add_click: Number of clicks on 'Add channel'
  • article1_click: Number of clicks on article1
  • article2_click: Number of clicks on article2
  • article3_click: Number of clicks on article3
  • article4_click: Number of clicks on article4
  • article5_click: Number of clicks on article5
  • article6_click: Number of clicks on article6
  • article7_click: Number of clicks on article7
  • article8_click: Number of clicks on article8
  • article9_click: Number of clicks on article9
  • article10_click: Number of clicks on article10
TRIGGERFrontal induction indicator
  • trigger_viewable: Number of induction area impressions
NameTypeDescription
pcLandingUrlStringPC landing URL
mobileLandingUrlStringMobile landing URL
webembedChannelUrlStringWeb embed landing URL
channelPostIdLongChannel post ID
channelCouponIdLongChannel coupon ID
NameTypeDescription
typeEnum: ObjectiveTypeType of the ad goal setting
valueStringAd goal setting ID
If type is TALK_CHANNEL, this value is id obtained through the View list of Kakao Talk Channel profiles API.
If type is PIXEL_AND_SDK, this value is id obtained through the View Pixel & SDK API.
detailTypeEnum: ObjectiveDetailTypeType of the conversion to be optimized, used if type is PIXEL_AND_SDK
ValueDescription
TALK_CHANNELKakao Talk Channel
PIXEL_AND_SDKPixel & SDK
ValueDescription
PURCHASEPurchase
APP_INSTALLInstall app
COMPLETE_REGISTRATIONSign up
SIGN_UPApply for a service
CARTAdd to a cart
PARTICIPATIONPotential customer
ADD_FRIENDAdd Kakao Talk Channel Friends

Note: Only provided in the response when ObjectiveType is TALK_CHANNEL.
Not supported for the request.
ValueDescription
ONLYONLY
ANDAND
MINUSMINUS
OROR
NameTypeDescription
idLongID of the material for ad verification
originalFileNameStringName of the uploaded material
downloadUrlStringURL of the material for ad verification
ValueDescription
LEVEL_1Level 1 Limited Machine Learning
LEVEL_2Level 2 Basic Machine Learning
LEVEL_3Level 3 Advanced Machine Learning
LEVEL_4Level 4 Optimized Machine Learning
INVALIDCannot retrieve status
READYReady for Machine Learning
nullNo value.
optimizationStatus is only available when the Goal of the campaign is Conversion.
ValueDescription
NONEInactivated
QUICKQuick spending
This spending method increases ad impression by using your budget as quickly as possible to reach your goal.
NORMALNormal spending
This spending method controls ad impression by dividing the daily budget for each time period not to exceed the daily budget.
ValueDescription
WEEKWeekly
MONTHMonthly
ValueDescription
KAKAO_TALKKakao Talk
DAUMDaum
KAKAO_SERVICEKakao Service
NETWORKNetwork
ValueDescription
CPCCost 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.
CPMCost per Mille
Type to charge per 1,000 impressions. You can participate in bidding based on the impressions.
CPACost 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).
CPVCost per View
Type to charge per video view.
CPMSCost per Message Send
Type to charge for each message sent. Used for message ad groups.
NameTypeDescription
rejectedTitleStringTitle of reason why a review is rejected
rejectedContentStringContent of reason why a review is rejected
NameTypeDescription
messageAdIdStringMessage ad ID, a unique identifier assigned when first created
nameStringMessage name (Maximum: 50 characters).
If not entered at creation, an automatically generated value is applied.
typeEnumMessage type.
  • BASIC_TEXT_MESSAGE: Basic text
  • WIDE_MESSAGE: Wide image
  • WIDE_LIST_MESSAGE: Wide list
  • CAROUSEL_COMMERCE_MESSAGE: Carousel commerce
  • CAROUSEL_FEED_MESSAGE: Carousel feed
  • PREMIUM_VIDEO_MESSAGE: Premium message
  • CATALOG_MESSAGE: Catalog
  • SPOTLIGHT_MESSAGE: Spotlight
titleStringMessage promotional text
itemsItem[]Item information
buttonsButton[]Button information
couponBookCouponBook[]Coupon information
introCarouselIntroCarouselIntro information
carouselsCarousel[]Carousel information
catalogCatalog[]Catalog information
buttonTitleStringSpotlight message button name
landingUrlStringSpotlight message landing URL
ageVerificationBooleanWhether the message requires age verification
  • true: Age verification message
  • false: General message
adFlagBooleanAdvertising message
  • true: Advertising message
  • false: Informational message
shareFlagBooleanWhether to use the share option
  • true: Use share
  • false: Do not use share

Important: Cannot be used if ageVerification is true.
ValueDescription
ONActivated
VOIDImpossible to run (System invalidated)
ADMIN_STOPAdministrator suspended
EXTERNAL_SERVICE_STOPLinked service restricted
NameTypeDescriptionRequired
beginDateStringStart date in yyyy-MM-dd'T'HH:mm:ss format
Set it to today or the day after today.
O
endDateStringEnd date in yyyy-MM-dd'T'HH:mm:ss format
Set it to the start date or the day after the start date.
X
lateNightBooleanLate night targetingO
detailTimeBooleanWhether a specific time is set or not
If lateNight (late night targeting) is true, and set this value to false, it will be set to the default value (22:00 to 06:59).
O
mondayTimeString[]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.
X
tuesdayTimeString[]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.
X
wednesdayTimeString[]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.
X
thursdayTimeString[]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.
X
fridayTimeString[]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.
X
saturdayTimeString[]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.
X
sundayTimeString[]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.
X
NameTypeDescriptionRequired
detailTimeBooleanWhether a specific time is set or notO
beginDateStringStart dateO
beginTimeStringStart timeX
endDateStringEnd dateX
endTimeStringEnd timeX
mondayTimeString[]Delivery time on MondayX
tuesdayTimeString[]Delivery time on TuesdayX
wednesdayTimeString[]Delivery time on WednesdayX
thursdayTimeString[]Delivery time on ThursdayX
fridayTimeString[]Delivery time on FridyaX
saturdayTimeString[]Delivery time on SaturdayX
sundayTimeString[]Delivery time on SundayX
lateNightBooleanWhether to apply the Late night targetingO
periodUnitEnum: PeriodUnitWeekly or monthly basisX
ValueDescription
READYCampaign is ready to run
LIVECampaign is running
FINISHEDCampaign has finished running
OFFUser status is OFF
DELETEDCampaign is deleted
EXCEED_DAILY_BUDGETCampaign's daily budget exceeded
PAUSEDCampaign is paused
NO_AVAILABLE_CREATIVEThere is no available creative
CANCELEDContract is canceled
SYSTEM_CONFIG_EXTERNAL_SERVICE_STOPCampaign is unavailable to run because some linked service is restricted
ADACCOUNT_UNAVAILABLEAd account is unavailable to run
ValueDescription
READYAd group is ready to run
LIVEAd group is running
FINISHEDAd group has finished running
OFFUser status is OFF
DELETEDAd group is deleted
EXCEED_DAILY_BUDGETAd group's daily budget exceeded
PAUSEDAd group is paused
NO_AVAILABLE_CREATIVEThere is no available creative
CANCELEDContract is canceled
CAMPAIGN_UNAVAILABLECampaign is unavailable to run
SYSTEM_CONFIG_ADMIN_STOPAdministrator is suspended
KeyApplicable to message creativesDescription
OPERATINGYesCreative is available to run.
UNAPPROVEDNoReview is not approved. (Including review pending or suspension case)
INVALID_DATEYesDelivery period has not started or is overdue.
MONITORING_REJECTEDNoMonitoring is pending.
SYSTEM_CONFIG_ADMIN_STOPNoCreative is suspended by the administrator.
OFFYesUser status is OFF.
DELETEDYesCreative is deleted.
ADGROUP_UNAVAILABLEYesAd group that includes ads is not available to run.
SYSTEM_CONFIG_VOIDNoCreative cannot be run due to error in creative content.

Message creatives can only have some of the operation statuses.

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*configisAdminStopisOutOfBalance
운영중
(Meaning "Active")
ONfalsefalse
잔액부족
(Meaning "Insufficient balance")
ONfalsetrue
관리자정지
(Meaning "Admin suspended")
ONtruefalse
관리자정지, 잔액부족
(Meaning "Admin suspended, Insufficient balance")
ONtruetrue
사용자OFF
(Meaning "User OFF")
OFFfalsefalse
사용자OFF, 잔액부족
(Meaning "User OFF, Insufficient balance")
OFFfalsetrue
사용자OFF, 관리자정지
(Meaning "User OFF, Admin suspended")
OFFtruefalse
사용자OFF, 잔액부족, 관리자정지
(Meaning "User OFF, Insufficient balance, Admin suspended")
OFFtruetrue
삭제됨
(Meaning "Deleted")
DEL--
* The values of statusDescription are passed in Korean.

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

statusDescription*configdailyBudgetAmountOver
운영중
(Meaning "Active")
ONfalse
일예산초과(Daily budget exceeded)ONtrue
사용자OFF
(Meaning "User OFF")
OFFfalse
사용자OFF,일예산초과
(Meaning "User OFF, Daily budget exceeded")
OFFtrue
삭제됨
(Meaning "Deleted")
DEL-
* The values of statusDescription are passed in Korean.

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*reviewStatusconfigReview status of original creativeReview status of modified creative
운영중
(Meaning "Active")
APPROVEDONReview approved-
운영중(수정사항 심사중)
(Meaning "Active(Review for modification in progress)")
MODIFICATION_WAITINGONReview approvedIn review
운영중(수정사항 심사보류)
(Meaning "Active(Review for modification rejected)")
MODIFICATION_REJECTEDONReview approvedPending review
심사중
(Meaning "Review in progress")
WAITINGONIn review-
심사보류
(Meaning "Review rejected)
REJECTEDONPending review-
관리자정지
(Meaning "Admin suspended")
REJECTEDONAdmin suspended-
관리자정지(수정사항 심사중)
(Meaning "Admin suspended(Review for modification in progress)")
MODIFICATION_WAITINGONAdmin suspendedIn review
관리자정지(수정사항 심사보류)
(Meaning "Admin suspended(Review for modification rejected)")
MODIFICATION_REJECTEDONAdmin suspendedPending review
사용자OFF
(Meaning "User OFF")
APPROVEDOFFReview approved-
사용자OFF,수정사항 심사중
(Meaning "User OFF, Review for modification in progress")
MODIFICATION_WAITINGOFFReview approvedIn review
사용자OFF,수정사항 심사보류
(Meaning "User OFF, Review for modification rejected")
MODIFICATION_REJECTEDOFFReview approvedPending review
사용자OFF,심사중
(Meaning "User OFF, Review in progress")
WAITINGOFFIn review-
사용자OFF,심사보류중
(Meaning "User OFF, Review rejected")
REJECTEDOFFPending review-
사용자OFF,관리자정지
(Meaning "User OFF, Admin suspended")
REJECTEDOFFAdmin suspended-
사용자OFF,관리자정지(수정사항 심사중)
(Meaning "User OFF, Review for modification in progress")
MODIFICATION_WAITINGOFFAdmin suspendedIn review
사용자OFF,관리자정지(수정사항 심사보류)
(Meaning "User OFF, Review for modification rejected")
MODIFICATION_REJECTEDOFFAdmin suspendedPending review
삭제됨
(Meaning "Deleted")
-DEL--
* The values of statusDescription are passed in Korean.

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*configisDailyBudgetAmountOverisValidPeriod
운영중
(Meaning "Active")
ONfalsetrue
일예산초과
(Meaning "Daily budget exceeded")
ONtruetrue
기간외
(Meaning "Period elapsed")
ONfalsefalse
일예산초과,기간외
(Meaning "Daily budget exceeded, Period elapsed")
ONtruefalse
사용자OFF
(Meaning "User OFF")
OFFfalsetrue
사용자OFF,일예산초과
(Meaning "User OFF, Daily budget exceeded")
OFFtruetrue
사용자OFF,기간외
(Meaning "User OFF, Period elapsed")
OFFfalsefalse
사용자OFF,일예산초과,기간외
(Meaning "User OFF, Daily budget exceeded, Period elapsed")
OFFtruefalse
삭제됨
(Meaning "Deleted")
DEL--
* The values of statusDescription are passed in Korean.
NameTypeDescription
profileIdStringKakao Talk Channel profile ID
inclusionTypeEnum: InclusionTypeWhether or not it is included
NameTypeDescription
idLongKakao Talk Channel targeting ID
inclusionTypeEnum: InclusionTypeWhether to include or exclude the information extracted from a Kakao Talk Channel for ad group targeting
profileIdIntegerEncoded profile ID
profileNameStringProfile name
NameTypeDescription
idLongFriend group ID
nameStringFriend group name
inclusionTypeEnum: InclusionTypeWhether to include or exclude the information extracted from a Friend group file for ad group targeting
talkChannelGroupFileIdLongFriend group file ID
fileTypeEnumFile type
  • APP_USER_ID: Service user ID
  • PHONE_NUMBER: Phone number
  • MESSAGE_RETARGET: Message recipients
groupKeyStringFriend group file's group key
NameTypeDescription
idLongAudience ID
Not provided in the case of general targeting
nameStringAudience name
Not provided in the case of general targeting
typeEnumWhether to use Audience.
  • NORMAL: General targeting.
  • DISPLAY: Use the set Display Audience.
  • MESSAGE: Use the set Message Audience.
ageTypeEnumSelection type for age range
  • ALL: Select all age ranges
  • NOT_ALL: Select some age ranges
agesString[]Age range
genderTypeEnumSelection type for gender
  • ALL: Select all genders
  • NOT_ALL: Select a specific gender
gendersString[]Gender
locationsLocation[]City/Province
Refer to View city/province.
depth2LocationsDepth2Location[]City/County/District
Refer to View city/county/district.
depth3LocationsDepth3Location[]Neighborhood/Town/Townships
Refer to View dong/eup/myeon.
ufoInterestsUfoInterest[]Interest targeting
Refer to View categories of Network for placements API.
ufoDeprecatedInterestsUfoInterest[]Deprecated interest targeting
Refer to View categories of Network for placements API.
ufoBusinessTypesUfoBusinessType[]Business type targeting
Refer to View categories of Network for placements API.
ufoDeprecatedBusinessTypesUfoBusinessType[]Deprecated business type targeting
Refer to View categories of Network for placements API.
talkChannelTargetingsTalkChannelTargeting[]Kakao Talk Channel targeting
syncAppTargetingsSyncAppTargeting[]Kakao Login user targeting
customerFileTargetingsCustomerFileTargeting[]Customer targeting
cohortTargetingsCohortTargeting[]Engagement targeting
trackerTargetingsTrackerTargeting[]Pixel & SDK targeting
talkChannelGroupTargetingsTalkChannelGroupTargeting[]Information of friends group targeting.
NameTypeDescriptionRequired
typeStringTargeting type. Required for requests.
  • WHOLE: All friends
  • SMART: Recommended friends
  • DIRECT: Direct setting
O
devicesEnum: DeviceType[]Device selection type.
  • ANDROID: Android
  • IOS: iOS
X
demographicsDemographics[]Gender, age, and location informationX
customsCustomTargeting[]Custom targetingX
friendPeriodFriendPeriod[]Friend period setting.
Only users who became channel friends during the set period will receive the message.
X
ufoInterestsSet<UfoInterest>Custom targeting > Kakao data > Category > Interest
See View custom target category type

Note: View only.
X
ufoBusinessTypesSet<UfoBusinessType>Custom targeting > Kakao data > Category > Business type
See View custom target category type

Note: View only.
X
NameTypeDescription
fileSizeLongFile size
urlStringRepresentative Thumbnail image URL
fileNameStringRepresentative Thumbnail file name
imageWidthIntegerImage width
imageHeightIntegerImage height
mimeTypeStringMime type
ValueDescription
DAYday
ALLentire requested period
Report counting unitMaximum period to be retrieved
DAY1 month
ALL1 month
NameTypeDescription
idLongTracker number
inclusionTypeEnum: InclusionTypeWhether to include or exclude the information extracted from a Pixel & SDK event for ad group targeting
trackIdStringTracker ID
eventCodeStringEvent code
trackRuleIdStringTracker rule number
trackRuleNameStringTracker rule name
termIntegerTargeting period (Minimum: 1, Maximum: 180).
NameTypeDescription
trackRuleIdStringTracker information ID
trackIdStringTracker ID
eventCodeStringEvent code
nameStringTracker information name
ruleSetStrString[]Rule set definition
NameTypeDescription
valueStringKey that indicates detailed business type.
For the complete list, refer to UfoBusinessType table in Type information of business type CSV file (Download).
NameTypeDescription
valueStringKey for interests
For the complete list, refer to UfoInterest table in Type information of interest CSV file (Download).
NameTypeDescription
urlStringVideo URL
fileNameStringVideo file name
sizeLongVideo file size
durationStringVideo duration
NameTypeDescription
urlStringVideo creative URL
NameTypeDescription
urlStringVideo URL
autoThumbnailUrlStringAuto-extracted thumbnail URL
uploadThumbnailUrlStringUploaded thumbnail URL

Was this helpful?

    Kakao Moment > Type information - Kakao Developers | Docs