kakao developers

Kakao Moment API Reference

This document provides the supported APIs of Kakao Moment and response information.

Supported APIs

• Host: apis.moment.kakao.com

Ad creation: Ad account

URL	Method	Name	Limit
/openapi/v4/adAccounts	GET	Viewing list of ad accounts
/openapi/v4/adAccounts	GET	Viewing ad account
/openapi/v4/adAccounts/balance	GET	Viewing real-time balance
/openapi/v4/adAccounts/bizRight	GET	Viewing business right
/openapi/v4/adAccounts/channel/profiles	GET	Viewing list of KakaoTalk Channel profiles
/openapi/v4/adAccounts/trackers	GET	Viewing Pixel & SDK
/openapi/v4/adAccounts	POST	Creating ad account	1 per second
/openapi/v4/adAccounts/onOff	PUT	Changing ad account status	1 per second

Ad creation: Campaign

URL	Method	Name	Limit
/openapi/v4/campaigns	GET	Viewing list of campaigns
/openapi/v4/campaigns/{id}	GET	Viewing campaigns
/openapi/v4/campaigns	POST	Creating campaign
/openapi/v4/campaigns	PUT	Editing campaign
/openapi/v4/campaigns/dailyBudgetAmount	PUT	Editing daily budget for Display campaign	1 per second
/openapi/v4/campaigns/onOff	PUT	Changing campaign status	1 per second
/openapi/v4/campaigns/{id}	DELETE	Deleting campaign
/openapi/v4/campaigns/{id}/adminStopHistory	GET	Viewing reason for system stop
/openapi/v4/campaigns/{id}/adminStopHistories	GET	Viewing list of reasons for system stop

Ad creation: Ad group

URL	Method	Name	Limit
/openapi/v4/adGroups	GET	Viewing list of ad groups
/openapi/v4/adGroups/{id}	GET	Viewing ad group
/openapi/v4/adGroups	POST	Creating Display ad group	1 per 5 seconds
/openapi/v4/adGroups	POST	Creating Message ad group	1 per 5 seconds
/openapi/v4/adGroups	PUT	Editing Display ad group	1 per 5 seconds
/openapi/v4/adGroups	PUT	Editing Message ad group	1 per 5 seconds
/openapi/v4/adGroups/dailyBudgetAmount	PUT	Editing daily budget for Display ad group	1 per second
/openapi/v4/adGroups/bidAmount	PUT	Editing maximum bid for Display ad group	1 per second
/openapi/v4/adGroups/pacing	PUT	Editing spending method for Display ad group	1 per second
/openapi/v4/targetings/populationScore	POST	Retrieving estimated target population for Message ad group
/openapi/v4/adGroups/onOff	PUT	Changing ad group status	1 per second
/openapi/v4/adGroups/cancel/{id}	PUT	Cancelling contract for Message ad group
/openapi/v4/adGroups/{id}	DELETE	Deleting ad group
/openapi/v4/adGroups/{id}/adminStopHistory	GET	Viewing reason for system stop
/openapi/v4/adGroups/{id}/adminStopHistories	GET	Viewing list of reasons for system stop

Targeting for ad group

URL	Method	Name	Limit
/openapi/v4/targetings/location/depth1	GET	Viewing city/province
/openapi/v4/targetings/location/depth2	GET	Viewing city/county/district
/openapi/v4/targetings/location/map	GET	Viewing neighborhood/town/township
/openapi/v4/targetings/placement/adServingCategories	GET	Viewing categories of Network for placements
/openapi/v4/targetings/placement/sectionCategories	GET	Viewing list of section categories
/openapi/v4/adGroups/targetings/cohort/availables	GET	Viewing targetable engagement targets
/openapi/v4/adGroups/targetings/trackers/eventCreatables/{trackId}	GET	Viewing targetable Pixel & SDK events
/openapi/v4/adGroups/targetings/customerFiles/availables	GET	Viewing list of targetable customer files
/openapi/v4/adGroups/targetings/talkChannels/availables	GET	Viewing list of targetable Kakao Talk Channels
/openapi/v4/adGroups/targetings/syncProfiles/availables	GET	Viewing list of targetable Kakao Login users
/openapi/v4/adGroups/targetings/talkChannelGroupFiles/availables	GET	Viewing list of targetable Friend groups

Custom audience targeting for ad group

URL	Method	Name	Limit
/openapi/v4/targetings/data/categories?type=INTEREST	GET	Viewing category data for custom audience targeting
/openapi/v4/targetings/location/map	GET	Viewing location for custom audience targeting

Ad creation: Creative

URL	Method	Name	Limit
/openapi/v4/creatives	GET	Viewing list of creatives
/openapi/v4/creatives/{id}	GET	Viewing creative
/openapi/v4/creatives	POST	Creating Display creative	1 per second
/openapi/v4/creatives	POST	Creating Message creative	1 per second
/openapi/v4/creatives/copy	POST	Copying Display creative	1 per 5 seconds
/openapi/v4/creatives/copy	POST	Copying Message creative	1 per 5 seconds
/openapi/v4/creatives	PUT	Editing Display creative	1 per second
/openapi/v4/creatives	PUT	Editing Message creative	1 per second
/openapi/v4/creatives/onOff	PUT	Changing creative status	1 per second
/openapi/v4/creatives/{id}/opinionProof	GET	Retrieving materials for Display ad verification
/openapi/v4/creatives/{id}	DELETE	Deleting creative
/openapi/v4/creatives/{id}/systemConfigHistory	GET	Viewing reason for system stop
/openapi/v4/creatives/{id}/systemConfigHistories	GET	Viewing list of reasons for system stop

Bizboard landing settings

URL	Method	Name	Limit
/openapi/v4/creatives/landing/talkBizForms	GET	Viewing list of Business Forms for landing settings
/openapi/v4/creatives/landing/adViews	GET	Viewing list of Ad Views for landing settings
/openapi/v4/creatives/landing/channelPosts/{profileId}	GET	Viewing list of Channel Posts for landing settings

Report

URL	Method	Name	Limit
/openapi/v4/adAccounts/report	GET	Viewing report on ad account	1 per 5 seconds
/openapi/v4/campaigns/report	GET	Viewing reports on campaigns	1 per 5 seconds
/openapi/v4/adGroups/report	GET	Viewing reports on ad groups	1 per 5 seconds
/openapi/v4/creatives/report	GET	Viewing reports on creatives	1 per 5 seconds

Message management

URL	Method	Name	Limit
/openapi/v4/messages/kakaotv/channels	GET	Viewing list of Kakao TV channels
/openapi/v4/messages/kakaotv/channels/{id}	GET	Viewing details of Kakao TV channel
/openapi/v4/messages/kakaotv/channels/{id}/clipLinks	GET	Viewing list of Kakao TV channel videos
/openapi/v4/messages/kakaotv/channels/ {channelId}/clipLinks/{clipLinkId}	GET	Viewing details of Kakao TV channel video
/openapi/v4/messages/coupons	GET	Viewing list of coupons
/openapi/v4/messages/coupons/{id}	GET	Viewing details of coupon
/openapi/v4/messages/adViews	GET	Viewing list of Ad Views
/openapi/v4/messages/posts/{profileId}	GET	Viewing list of posts
/openapi/v4/messages/bizForms	GET	Viewing list of Business Forms
/openapi/v4/messages/bizForms/{bizFormId}	GET	Viewing details of Business Form

Ad View management

URL	Method	Name	Limit
/openapi/v4/adViews	GET	Viewing list of Ad Views
/openapi/v4/adViews/{id}	GET	Viewing Ad View
/openapi/v4/adViews/{id}	DELETE	Deleting Ad View

Business Form linkage management

URL	Method	Name	Limit
/openapi/v4/talkBizForms/linkages	GET	Viewing list of linked Business Forms
/openapi/v4/talkBizForms/linkables	GET	Viewing list of linkable Business Forms
/openapi/v4/talkBizForms	POST	Linking Business Form

Pixel & SDK linkage management

URL	Method	Name	Limit
/openapi/v4/trackers/rights	GET	Viewing list of linked Pixel & SDKs	1 per 5 seconds
/openapi/v4/trackers/rightAvailables	GET	Viewing list of linkable Pixel & SDKs
/openapi/v4/trackers	POST	Linking Pixel & SDK
/openapi/v4/trackers/{id}	DELETE	Unlinking Pixel & SDK

Audience management

URL	Method	Name	Limit
/openapi/v4/targetings/audiences	GET	Viewing list of Audiences
/openapi/v4/targetings/{id}	GET	Viewing details of Audience
/openapi/v4/targetings	POST	Creating Audience
/openapi/v4/targetings	PUT	Editing Audience
/openapi/v4/targetings/{id}	DELETE	Deleting Audience
/openapi/v4/targetings	DELETE	Deleting multiple Audiences
/openapi/v4/targetings/{id}/adGroups	GET	Viewing usage of Audience
/openapi/v4/targetings/{id}/unlink?adGroupId={adGroupId}	PUT	Disabling use of Audience

Engagement targeting management

URL	Method	Name	Limit
/openapi/v4/targetings/cohort/list	GET	Viewing list of engagement targets
/openapi/v4/targetings/cohort/{id}	GET	Viewing engagement target
/openapi/v4/targetings/cohort/creatables	GET	Viewing creatable engagement targets
/openapi/v4/targetings/cohort	POST	Creating engagement target	1 per second
/openapi/v4/targetings/cohort/name	PUT	Editing name of engagement target	1 per second
/openapi/v4/targetings/cohort	PUT	Editing data of engagement target
/openapi/v4/targetings/cohort/{id}	DELETE	Deleting engagement target	1 per second
/openapi/v4/targetings/cohort	DELETE	Deleting multiple engagement targets	1 per second
/openapi/v4/targetings/cohort/usages/{id}	GET	Viewing usage of engagement target

Customer file management

URL	Method	Name	Limit
/openapi/v4/customerFiles	GET	Viewing list of customer files
/openapi/v4/customerFiles/{id}	GET	Viewing details of customer file	1 per 5 seconds
/openapi/v4/customerFiles	POST	Registering customer file	1 per 5 seconds
/openapi/v4/customerFiles	PUT	Editing customer file
/openapi/v4/customerFiles/name	PUT	Editing customer file name
/openapi/v4/customerFiles/{id}	DELETE	Deleting customer file
/openapi/v4/customerFiles	DELETE	Deleting multiple customer files
/openapi/v4/customerFiles/usages/{id}	GET	Viewing usage of customer file

Friend group management

URL	Method	Name	Limit
/openapi/v4/talkChannelGroupFiles	GET	Viewing list of Friend groups
/openapi/v4/talkChannelGroupFile	POST	Registering Friend group	1 per 5 seconds
/openapi/v4/talkChannelGroupFiles/name	PUT	Editing Friend group name
/openapi/v4/talkChannelGroupFiles/{id}	DELETE	Deleting Friend group
/openapi/v4/talkChannelGroupFiles	DELETE	Deleting multiple Friend groups
/openapi/v4/talkChannelGroupFiles/usages/{id}	GET	Viewing usage of Friend group

Ad account management

URL	Method	Name	Limit
/openapi/v4/companies	GET	Viewing business information

Payment management

URL	Method	Name	Limit
/openapi/v4/billing/virtualAccount	POST	Creating virtual account for direct deposit	1 per second

Response code

If you cannot find the error codes you encounter in the following lists, see REST API Reference.

HTTP status code

Status code	Status	Description
200	Success
400	Fail	General error Errors related to the required parameters for APIs
403	Fail	Permission Error
429	Fail	Quota error Errors that occurs when quota limit exceeds
500	Fail	System error
502	Fail	System error
503	Fail	Undergoing system maintenance

Error code

code	Description	HTTP status code
-2	Wrong parameter If some required parameters are not included, or if the argument value has the wrong data.	400
-3	If you call unsupported service APIs. If the required function for the API is not activated.	400
-5	If you have no permission to request the API.	403
-10	If you make a request over the number of allowed calls.	400
-101	If you call an API for a user who is not linked to your app. For the login-based APIs, the app must be linked with the user.	400
-813	If internal error of Kakao Moment occurs.	400
-813	If you have exceeded the allowed quota limit.	429

Sample

HTTP/1.1 400 Bad request
Content-Type: application/json;charset=UTF-8
{
    "code": -813,
    "msg": "KakaoMomentException",
    "extras": {
        "detailCode": 21006,
        "detailMsg": "존재하지 않는 광고계정입니다."
    }
}

Detailed Error code (detailCode)

Code	Description
2007	This bank code does not exist.
2010	The deposit amount must be between 1,000 won and 1 billion won (KRW).
5001	This business does not exist.
6003	This ad account does not exist.
7550	Enter a search term to retrieve its city/county/district information.
20023	This account is a guaranteed ad account for Kakao Talk Bizboard and Shopping Box.
21006	This ad account does not exist.
21400	This ad account is being deleted.
22086	You can set administrative areas up to 1,000.
22087	Your request includes some overlapped locations among -si/do, -si/gun/gu, and -dong/eup/myeon information.
22200	This engagement target does not exist.
22201	This engagement target has already been deleted.
22202	This engagement target is already being used.
22203	You can register up to 50 ad engagement targets per account.
22204	You can select up to 20 ad groups or messages.
22205	This name is already being used for engagement targeting.
22207	You cannot edit the name of the deleted or non-existent engagement target.
22209	This type is not supported for engagement targeting.
22211	There are some engagement data that is not supported by this campaign type.
22300	You cannot select the categories that include the deprecated values. After checking the changed targets and target population, save them again.
22400	You cannot register more Audiences due to the limit on the number of Audiences with an ad account. After deleting the existing Audience, proceed again.
22402	You must input the Audience targeting's name.
22403	Audience does not exist.
22405	You cannot edit the Audience that is used for an ad group under the Kakao Talk Channel x Reach(도달) of campaign. After disabling the Audience in the ad group, retry.
22406	Only available Audiences can be linked to an ad group. Because this Audience is unavailable, check and try again.
22407	There is no Audience in the corresponding ad group.
22409	This target option is not allowed to be set for the Audience type.
24003	No Customer file has been uploaded.
24004	There is an invalid file.
24007	This name is already being used for the Customer file.
24008	Some ad groups or messages are already using this target.
24010	This Customer file has already been deleted.
24012	You cannot retrieve the Customer file information.
24013	No Kakao Talk Channel group file has been uploaded.
24017	This name is already being used for a Kakao Talk Channel group.
24018	Some ad group is already using this Kakao Talk Channel group.
24020	This Kakao Talk Channel group file has already been deleted.
24029	You can register up to 50 Friend groups per account. Delete existing Friend groups, and then retry.
24033	There is no valid message ad group for the message recipient type of Friend group.
24034	For the message recipient type of Friend group, you can register up to 20 ad groups.
24035	For the message recipient type of Friend group, you can register only the ad groups registered within 30 days.
24036	For this Kakao Talk channel, you cannot create the app user ID type of Friend group.
24100	Failed to sync the number of friends of this Kakao Talk Channel.
25023	You cannot save more creatives due to the limit on the number of creatives per ad account.
30007	The advertising goal setting is invalid.
31001	Campaign does not exist.
31004	The start date must come before the end date.
31006	You must set the start date at some future date, not the present.
31007	You cannot save more ad groups due to the limit on the number of ad groups in a campaign. After deleting the existing ad group, proceed again.
31018	The campaign's daily budget is invalid.
31022	The campaign's type X goal is unavailable.
32001	Ad group does not exist.
32002	Some devices are not proper for this ad group.
32003	Some ad placements are not proper for this ad group.
32004	This pricing type is not proper for the ad goal.
32007	Targeting settings are incorrect.
32009	This pricing type is not supported.
32013	This ad group does not support the corresponding action.
32016	You cannot select the spending method.
32017	This spending method is not supported.
32019	The ad group's daily budget cannot exceed the campaign's daily budget.
32020	The maximum bid amount cannot exceed 50 % of the daily budget, or 100,000 won.
32021	Ad group's daily budget must be equal to or greater than 10,000 won (KRW).
32022	Ad group's daily budget must be equal to or less than 500 million won (KRW).
32032	You must enter the budget.
32034	The settings for the Smart messages are incorrect.
32040	The changes in the ad group cannot be applied.
32041	This ad group has already been finished or been canceled.
32043	You input the wrong value for the unit price.
32918	This input type is not supported for the bid amount.
32919	You entered the bid amount lower than the minimum value.
33112	Error in minimum bid amount for CPMS.
33300	There is no linked Business Form.
33002	The number of creatives in an ad group exceeded 200.
33003	Creative does not exist.
33004	If you do not use Smart messages for your ad group, you can register only one Message creative per ad group.
33006	If you use Smart messages for your ad group, you can register up to 10 Message creatives per ad group.
33009	This section category is not allowed to be set.
33104	Error in minimum bid amount for CPM
33107	Error in minimum bid amount for CPC
33108	Error in minimum bid amount for CPA
33116	The creative's bid amount you set is greater than the ad group's maximum bid amount. Set the creative's bid amount to equal or less than the ad group's maximum bid amount.
33124	You cannot edit the landing URL.
33132	You cannot register a creative with the deprecated landing type.
33133	The landing URL includes special characters that cause an error. Retry after encoding the URL.
33201	You cannot register this type of creative for the set Goal X Type of campaign.
33204	Error occurred while creating multiple creatives.
33208	This creative type is not supported.
33217	This image type is not supported.
33218	This is not an RGB color system image.
33225	You cannot set or edit the creative's bid amount. (with Creative Optimization function)
33241	Promotional text or promotional text at the bottom is not valid.
33245	This campaign type does not support copying a creative.
33251	The description of a creative is invalid.
33252	You must enter different text for the title, profile name, and promotional text.
33255	You cannot copy the creative in an administrator suspended state.
33256	You cannot edit some elements of the creative in an administrator suspended state.
33302	Failed to link to a Kakao Business Form.
34520	Failed to upload a video.
34534	Failed to process your request because the selected Kakao Talk channel is dormant, blocked, or deleted. Check the channel status in the Kakao Talk Channel Admin Center.
34570	You cannot set shareflag for age verification messages.
34571	You cannot save age verification messages into the message management list.
35002	This is an unavailable campaign type and goal.
38017	You cannot change the settings for adult targeting.
38022	If an ad group is running, has completed running, or is about to start running within less than 5 minutes, you cannot save the ad group.
38102	The bid amount for a creative is not supported anymore.
38103	The Creative optimization option is not supported anymore.
38104	The maximum bid amount is not supported anymore.
39020	You cannot delete this Ad View because some creative is using it as a landing.
39203	The Ad View you requested does not exist or has been deleted.
60005	The corresponding condition is not allowed to retrieve a report. (LEVEL)
60007	You input the period information twice.
60008	The start day and end date set for the search period are invalid.
75000	Creating a creative is only allowed for the DISPLAY campaign type.
75001	You cannot upload this image format.
75002	You cannot upload this image due to its image size.
75003	You cannot upload this image due to its file size.
75004	You cannot register due to a temporary error.
75005	If the ad group's bidding method is set to Automatic bidding, you cannot set the creative's bid amount manually.
75006	You cannot delete a campaign with Kakao Talk Channel_Reach type.
75007	You cannot delete a group with Kakao Talk Channel_Reach type.
75008	You cannot delete a creative with Kakao Talk Channel_Reach type.
75009	Promotional image URL is not specified.
75010	You must pass a profile image URL.
75011	You must pass one or more landingURL.
75012	The URL you requested has an invalid URL format.
75013	You cannot input space or special characters for the Creative description.
75014	Creative does not exist.
75015	You can edit a creative only with the DISPLAY campaign type.
75016	The corresponding creative does not exist under the ad group you requested.
75017	The creative's bid amount cannot be greater than the ad group's bid amount.
75018	The passed image URL is invalid, or the image format is unsupported.
75019	If the creative's bidding method is set to Automatic bidding, you cannot request the creative's bid amount.
75020	If the bidding method for your ad group is set to Manual bidding, you must pass the creative's bid amount.
75026	For a Bizboard type, you must set the mobile landing URL.
75200	With the corresponding type and goal, retrieving Pixel & SDKs is not allowed.
75201	Communication error with the Kakao Talk Channel server occurs.
75203	This is the wrong ad account ID.
75300	This campaign's ad account is invalid.
75301	You must pass a campaign ID.
75302	You must pass a campaign's daily budget.
75303	This campaign has no access right for the ad account.
75304	You must pass the campaign type and goal.
75305	This campaign type is not supported.
75307	Channel X Reach(도달) campaign must not have a daily budget value.
75400	Ad group has not been requested, or the requested ad group ID is not a number greater than 1.
75401	This ad group has no access right to the ad account.
75403	This custom audience target is not supported for the corresponding ad type and goal.
75404	This spending method is not supported for the corresponding ad type and goal.
75405	You must set smartMessage to true for the corresponding ad type and goal.
75406	Only CPC is allowed for the pricing type in an ad group under the Kakao Bizboard type of campaign.
75407	When you create or edit an ad group, only DISPLAY is allowed for a type.
75414	If your campaign type is 'Kakao Bizboard', or if you set the conversion goal to Kakao Talk Channel for your ad group under the 'Display type X Conversion(전환) goal' type of campaign, you cannot select PC for the device type.
75415	You cannot set allAvailablePlacement to true for an ad group under the Kakao Bizboard type of campaign.
75416	You cannot set allAvailablePlacement to true for an ad group under the Kakao Bizboard type of campaign.
75417	Only Automatic bidding is allowed for an ad group under the Kakao Bizboard type X Conversion(전환) goal of campaign.
75418	If you select the Manual bidding, you cannot use the Maximizing clicks option.
75419	You must set the delivery period.
75420	You must set detailed time for the delivery period by setting each hour for all 24 hours.
75421	You must pass either 0 (Used) or 1 (Not used) for each hour for the delivery period.
75423	The request for the detailed time settings is empty. For the ad schedule, you must specify the detailed times for all days, from Monday to Sunday.
75425	If the campaign type is Kakao Bizboard, you cannot request the Overseas option.
75427	If you set allAvailablePlacement to false, you must pass placements.
75429	For the ad group under the campaign with Kakao Bizboard type X Conversion(전환) goal, you cannot use the Manual bidding option, and you must set the maximum bid amount to 0 won.
75431	If gender is set to ALL for demographic targeting, you cannot pass genders.
75432	If gender is set to NOT_ALL for demographic targeting, you must pass genders that is used to select a gender.
75433	If ageType is set to ALL for demographic targeting, you cannot pass ages.
75434	If ageType is set to NOT_ALL for demographic targeting, you must pass ages that is used to set some age ranges.
75438	If you pass adServingCategories (categories under Network), you must also pass NETWORK through placements.
75439	If you pass NETWORK for ad placements, you must pass adServingCategories (categories under Network).
75440	If the maximum bid limit is specified, you cannot set the maximum bid amount to 0 won.
75441	If the maximum bid limit is not specified, you must set the maximum bid amount to 0 won.
75442	If a campaign's goal is Visit, you cannot use CPA fpr bidding method.
75443	If locationType is set to ALL to select all regions for the ad group under the Kakao Bizboard type of campaign, you must pass all regions except for Overseas.
75444	If locationType is set to ALL to select all regions for the ad group under the Kakao Bizboard type of campaign, you cannot pass depth2Locations (city/county/district) in your request.
75445	If locationType is set to ALL to select all regions for the ad group under the Kakao Bizboard type of campaign, you cannot pass Z (Overseas) in your request.
75447	If the detailed region is set for region targeting, you cannot pass U (Unknown) or Z (Overseas).
75448	If locationType is set to ALL to select all regions for the ad group under the Display type of campaign, you cannot pass Z (Overseas) in your request.
75449	If locationType is set to ALL for the ad group under the Display type of campaign, you must pass all regions except for Overseas.
75450	You cannot save this ad group because the estimated target population is insufficient.
75451	Only CPC is allowed if the pricing type is set to automatic bidding.
75452	If locationType is set to ALL to select all regions, you cannot pass depth1Name (-si/do), depth2Name (-si/gun/gu), or depth3Name (-dong/eup/myeon).
75453	The end date you requested when creating an ad group must be today or the day after today.
75454	You must pass the device information.
75455	If you set 'All devices' for an ad group under the campaign with Display X Visit(방문) goal, you must pass all of the PC, ANDROID, and IOS.
75456	You must set the targeting information, such as age range, gender, and region.
75457	You must set a bidding method.
75458	You cannot change the Creative Optimization option if it is set when creating an ad group.
75459	If the start date you requested when creating is today or the day before today, you must pass the same date as the requested date for the start date.
75460	You must pass the track ID.
75461	You must pass the targeting period for Pixel & SDK.
75462	Pixel & SDK event information does not exist, or error occurred while retrieving.
75463	You must pass the detailed region information when selecting a region.
75464	If the detailed region is set for region targeting, you must pass depth1Name (-si/do), depth2Name (-si/gun/gu), or depth3Name (-dong/eup/myeon).
75465	If you use adult targeting, you cannot pass 15 for age.
75466	To set ages, you must pass one or more age ranges out of the followings: 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65
75467	To set ages, you must pass one or more age ranges out of the followings: 20, 25, 30, 35, 40, 45, 50, 55, 60, 65
75468	If you use the late night targeting, you cannot set the hours from 7:00 to 21:00 to 1 (Used).
75469	This is not supported if the campaign type is Kakao Talk Channel.
75470	If the campaign type is not Kakao Bizboard, the 'Only displayed in Chat tab' option is not available.
75471	If Kakao Talk is not selected for ad placements, the 'Only displayed in Chat tab' option is not available.
75472	If all available placements are used for placements, the 'Only displayed in Chat tab' option is not available.
75473	If the campaign type is Kakao Talk Bizboard, and if you set ad placements to Network, you must pass all categories of the Network.
75476	This ad group has no access right for the ad account.
75478	You must pass the message setting information.
75479	The available number of sending messages you passed is invalid.
75480	If you set longTerm (Send to new friends after sending all messages option) to true, you must pass beginDate (Start date), beginTime (Start time), endDate (End date), and endTime (End time) for the schedule field.
75481	The distributed sending rate you passed is invalid.
75482	The message status you passed is invalid.
75483	You cannot use the Creative Optimization function or custom audience targeting for real-time targeting type.
75484	In the case of Message ad groups, you must set allAvailablePlacement (Whether to display ads on all available places) to false only.
75485	In the case of Message ad groups, you must set placements to KAKAO_TALK only.
75487	If using a Smart message, you must set longTerm (Send to new friends after sending all messages option) to false.
75491	For a Smart message, the number of Kakao Talk Channel profile friends must be 30 or more.
75498	If you set longTerm (Send to new friends after sending all messages option) to true, you must pass both ANDROID and IOS for deviceTypes.
75500	You must pass the value for age verification message.
75502	You must enter the detailed address.
75503	You must search with road name address including building number or with detailed address including -dong or lot number. (Example: Sampyeong-dong, Sampyeong-dong 681, Pangyoyeok-ro 235)
75504	You must pass the ad account ID.
75505	You must pass the engagement targeting ID.
75506	The search term for a campaign name must not exceed 50 characters.
75507	You must pass the engagement target name.
75508	The engagement target name must not exceed 50 characters.
75509	You must pass the engagement data.
75510	Some engagement data does not include ad groups.
75511	Some engagement data does not include campaigns.
75512	Some engagement data does not include operation (Operation type).
75513	Some engagement data does not include firstIndicator (First engagement type).
75515	Failed to retrieve target population.
75523	You can register up to 50 per account.
75522	You can upload only ADIDs for the Customer file.
75524	You must pass the Customer file name.
75525	You must pass the Customer file ID.
75526	The name of the Customer file must not exceed 50 characters.
75527	Some operation or engagement values in the engagement data are missing or incorrect.
75528	You must pass the keyword to retrieve the -dong/eup/myeon information.
75536	You must pass the Friend group name.
75537	The name of the Friend group must not exceed 50 characters.
75539	You must pass the Friend group ID.
75540	You must pass the track ID.
75541	The SEED of Customer file cannot be found.
75542	This SEED is already being used with the same ad account.
75543	This Kakao user is not added to the Kakao Talk Channel.
75544	The SEED information is incorrect.
75546	The SEED of Kakao Talk Channel profile cannot be found.
75548	You must pass the Business Form ID.
75549	This engagement target does not exist.
75550	This Customer file target does not exist.
75552	You must pass eventCode.
75553	You must pass trackRuleId.
75554	You must pass trackUrleName (track rule name).
75555	You must pass InclusionType.
75556	This Kakao Talk Channel friend target does not exist.
75557	This Kakao Talk Sync member target does not exist.
75558	This Pixel & SDK target does not exist.
75559	You must pass the Kakao Talk Channel profile ID.
75561	The target population for a Customer file should be 2,000 or more.
75562	The target population for Kakao users should be 1,000 or more.
75563	The requested eventCode is invalid.
75564	The requested trackRuleId is invalid.
75565	The requested trackUrleName is invalid.
75566	You must pass the campaign type and goal.
75567	You must pass the campaign name to search for.
75568	You cannot set targeting for this Pixel & SDK because it does not meet the targeting condition.
75571	You cannot set targeting for this engagement because it does not meet the targeting condition. .
75573	The Pixel & SDK corresponding to the track ID you passed does not exist.
75574	You must pass the ad group daily budget.
75575	You must pass the ad group's ID.
75576	You cannot set the maximum bid amount for this ad group.
75577	You must pass the price in multiples of 10 won.
75578	This targeting type is not allowed to edit.
75579	Keyword targeting is not supported anymore.
75580	When setting the Audience, individual targeting is not supported.
75583	You cannot delete this Customer file.
75584	The Audience name must not exceed 50 characters.
75586	You must pass the value to target a Friend group.
75587	The value used to target a Friend group is invalid.
75588	If the campaign type is not Kakao Channel, you cannot target a Friend group in the ad group.
75589	As a result of the file analysis, there is no registered case due to wrong file format.
75601	This creative has no access right to the ad account.
75602	This creative is not allowed to copy.
75603	You can set the landing type only under the Kakao Bizboard type of campaigns.
75604	You cannot request both the landing URLs (pcLandingUrl, mobileLandingUrl, or rspvLandingUrl) and the landing types other than the landing URLs at the same time.
75605	You cannot edit the landing type that has been set when creating a creative, but only can edit the values set for the landing.
75608	You must pass the Kakao Talk Channel ID for chatbot landing and the chatbot keyword.
75609	You must input the chatbot keywords up to 50 characters. Only question marks and exclamation points are allowed for special characters.
75610	You must pass the Ad View ID.
75612	You must pass the Kakao Talk Channel's profile ID.
75613	There is no Kakao Talk Channel profile information available to be retrieved with the passed Kakao Talk Channel's profile ID, or there is no message information.
75614	You must pass both the Kakao Talk Channel profile ID and the URL of the corresponding Channel web view.
75615	You must pass the Business Form ID.
75616	You must request the Talk Calendar event ID.
75617	For the Talk Calendar event ID, only numbers and English are allowed, except for Korean, spaces, and special characters. Up to 24 characters are allowed.
75618	You must pass the profile ID and channel post ID.
75619	Failed to retrieve a list of Ad Views temporally.
75620	The requested Channel post landing type information is not available with this account or does not exist.
75621	The requested Business Form landing type information is not available with this account or does not exist.
75622	The requested Ad View landing type information is not available with this account or does not exist.
75624	The requested Channel web view landing type information is not available with this account or does not exist
75625	If a landing type is set to Channel web view, the landingURL must not exceed 1000 characters.
75626	If a landing type is set to Channel web view, you must pass the landingURL under the landing information.
75627	You must pass pcLandingUrl, mobileLandingUrl, or rspvLandingUrl, or pass the information corresponding the landing type.
75628	This creative type is not allowed to copy.
75631	You must pass the Kakao Talk Channel profile's message ID.
75632	You must pass the creative ID.
75636	The requested landing type information is not available with this account or does not exist.
75637	There is no information about materials for verification.
75639	This landing type is not supported.
75640	The creative that includes expendable elements is not supported.
75644	You must pass the Message creative type.
75645	This type is not supported for the Message creative.
75646	You must pass the promotional text.
75647	The promotional text must not exceed the maximum length.
75648	For Wide list message type, you must pass three or four list items.
75649	For Wide image or Wide list message type, you can pass up to one button item.
75650	For Basic text message type, you can pass one or two button items.
75651	This message type is not allowed to pass an item list.
75652	You must pass the Business Form ID.
75653	The passed Business Form information does not comply with the landing policy on the buttons corresponding message type.
75654	You must pass the Ad View ID.
75655	The passed Ad View information does not comply with the Ad View policy on the button corresponding to each message type.
75656	The passed post information does not comply with the post policy on the button corresponding to each message type.
75657	The passed landing information does not comply with the landing policy on the button corresponding to each message type.
75658	You must pass the coupon ID.
75659	You must pass the post ID.
75660	You must pass the button name.
75661	The button name must not exceed the maximum length.
75662	You must pass the promotional text for a list.
75663	Coupon information does not exist.
75664	Post information does not exist.
75665	Kakao TV information does not exist.
75666	You must attach an image creative or must pass Kakao TV video information to be linked.
75667	If you set landingType to LANDING_URL, you cannot use highlighted button.
75669	Ad View information does not exist.
75671	You must pass the contact information of customer support. Up to 255 characters are allowed.
75672	You must pass one of URL, post, and coupon for the list item landing of Wide image or Wide list message type.
75673	The button name of the Business Form you passed is not valid.
75674	You cannot request the same button order for Basic text message type.
75675	You cannot use the highlighted button for Basic text message type.
75676	You must pass the button order.
75677	You must pass the Kakao TV video ID meta information.
75678	You must pass the Kakao TV video thumbnail meta information.
75679	You must pass Kakao TV video meta information such as isLive, isLoad, and isLink.
75680	For Wide image and Wide list message type, you must pass a Kakao TV video through the videoMeta object in itemAssetGroups.
75681	You must pass only one list item for Wide image message type.
75682	You must pass a phone number.
75683	There is no message information to be sent for a test.
75685	You must set isLoad and isLink to true, and set isLive to false for Kakao TV video meta information.
75686	Message creatives only support MULTIPART_FORMDATA for content type.
75687	Carousel type is not supported.
75688	Sending messages for a test is allowed only for Message creatives.
75689	There are too many line breaks in the promotional text or title.
75690	You can set the promotional text of itemAssetGroup only for WIDE_LIST_MESSAGE (Wide list message type).
75691	Some phrases or images do not comply with the message delivery guideline.
75692	Unsupported property value is included.
78000	You must pass bankcode.
78001	You must pass amount (deposit amount).
78002	The Business Form you requested has already been linked.
78003	You have exceeded the allowed number.
78004	You must pass the number to be retrieved.
79000	There is no Kakao Talk Channel profile information.
79001	You must pass a file.
79002	You can upload a file with a size of 200 MB or less.
79003	You cannot upload this type of file. (Only text/csv and text/plain type of files are allowed.)
79004	File verification has not proceeded normally. please try again.
79005	You must pass either ON or OFF for the status.
81002	Error occurred while uploading the file.
83004	Failed to retrieve target population.
84401	Failed to conntect the Kakao TV.
84005	This Kakao Talk Channel is not linked to a Kakao Account.
84410	You do not have permission to use the Kakao TV channel.
84411	The Kakao TV channel does not exist or has been deleted.
85400	Connection to retrieve Ad View information is failed.
88000	Error in billing communication.
88005	Your balance is insufficient. This error occurs when the balance of the ad account is less than the budget (Available number of sending messages X price for sending message including VAT) required for ad group creation.
89701	Some Pixel & SDKs are being used in campaigns in the ad account.
89702	Some Pixel & SDKs are being used in ad groups in the ad account.
89704	Error occurred while retrieving Pixel & SDKs.
89705	Error occurred while setting ownership of Pixel & SDK.
89706	Error occurred while retrieving Pixel & SDKs with permission granted.
89709	The settings for Pixel & SDK are incorrect.
89710	Create a Pixel & SDK.
89713	You can add up to 100 Pixel & SDKs per account.
89714	Permission cannot be added to this Pixel & SDK.
90001	Bad request.
90002	Internal error.
90003	No permission.
90016	There is no category type of Kakao Data.

Sample

HTTP/1.1 400 Bad request
Content-Type: application/json;charset=UTF-8
{
    "code": -813,
    "msg": "KakaoMomentException",
    "extras": {
        "detailCode": 20023,
        "detailMsg": "허용되지 않은 광고계정의 집행 상태입니다.",
        "path": "/v2/moment/adAccount",
        "timestamp": "2018-10-01T10:16:14.294+0000"
    }
}

Class information

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
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.

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

BusinessAccount

Name	Type	Description
businessId	Long	Business Account ID
businessName	String	Business Account name

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
SPONSORED_BOARD	Sponsored board

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-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: Target

Name	Type	Description
ONE_MONTH	String	Data collected for the last 30 days, starting from yesterday.
TWO_MONTHS	String	Data collected for 30 days, starting from the date before 31 days to the date before 60 days (two months before)
THREE_MONTHS	String	Data collected for 30 days, starting from the date before 61 days to the date before 90 days (three months before)
FOUR_MONTHS	String	Data collected for 30 days, starting from the date before 91 days to the date before 120 days (four months before)

* The names of these parameters indicate from which 30 days the data was collected.

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 - video instream - image box - Catalog - Contents Message - Basic text - Wide list - Wide message - Carousel commerce - Carousel feed	Display - IMAGE_BANNER - IMAGE_NATIVE - VIDEO_NATIVE - VIDEO_INSTREAM - IMAGE_BOX - CATALOG_MANUAL - SERVICE_CONTENT Message - BASIC_TEXT_MESSAGE - WIDE_LIST_MESSAGE - WIDE_MESSAGE - CAROUSEL_COMMERCE_MESSAGE - CAROUSEL_FEED_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 - Unknown	- total - 15 - 20 - 25 - 30 - 35 - 40 - 45 - 50 - 55 - 60 - 65 - 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 Promotional text in the item asset group is passed only for a wide image or wide list type of 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 passed only for a wide image or wide list type of message.
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	Informative message
creativeFormat	String	Message creative's type. One of the followings: BASIC_TEXT_MESSAGE: Basic text message WIDE_MESSAGE: Wide image message WIDE_LIST_MESSAGE: Wide list message It must be same as format.
title	Title	Promotional text or title For BASIC_TEXT_MESSAGE or WIDE_LIST_MESSAGE, promotional text is displayed. For WIDE_LIST_MESSAGE, title is displayed.
image	Image	Image creative Only returned for the BASIC_TEXT_MESSAGE type.
video	Video	Kakao TV Video creative Only returned for the BASIC_TEXT_MESSAGE type.
buttonAssetGroups	ButtonAssetGroup	Button item
itemAssetGroups	ItemAssetGroup	List of items Only returned for the WIDE_MESSAGE or WIDE_LIST_MESSAGE type.
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

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	- msg_send - msg_open - msg_click - cost
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) - 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 - 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
TALK_CONVERSION	(Old) Talk conversion metrics - Sign up for Talk (1 day) - Sign up for Talk (7 days) - Purchase via Talk (1 day) - Purchase via Talk (7 days) - Price of purchase in Talk (1 day) - Price of purchase in Talk (7 days) - Participate in Talk (1 day) - Participate in Talk (7 days)	- conv_talk_reg_1d - conv_talk_reg_7d - conv_talk_purchase_1d - conv_talk_purchase_7d - conv_talk_purchase_p_1d - conv_talk_purchase_p_7d - conv_talk_part_1d - conv_talk_part_7d
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
EXPANDABLE	Expandable metrics - Number of impressions - Number of autoplays for video - Number of video plays for 3 seconds - 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 EXPANDABLE_VIDEO_PLAY_AUTO 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

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

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

ServiceContent

Name	Type	Description
serviceType	String	Content service type SPONSORED_BOARD
contentId	String	Board ID if SPONSORED_BOARD is used
contentDetailId	String	Board history value if SPONSORED_BOARD is used
encodedChannelId	String	Kakao Talk Channel's profile ID if SPONSORED_BOARD is used ID

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.

TargetingTerm

Name	Description
ONE_MONTH	Data collected for the last 30 days, starting from yesterday.
TWO_MONTHS	Data collected for 30 days, starting from the date before 31 days to the date before 60 days (two months before)
THREE_MONTHS	Data collected for 30 days, starting from the date before 61 days to the date before 90 days (three months before)
FOUR_MONTHS	Data collected for 30 days, starting from the date before 91 days to the date before 120 days (four months before)

* The names of these parameters indicate from which 30 days the data was collected.

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
trackerTargetingTerms	EnumSet of TargetingTerm	Term for tracker targeting

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)