사이드 메뉴
Getting started
Kakao Developers
Login
Communication
Advertisement
- Concepts
- Ad creation: Ad account
- Ad creation: Campaign
- Ad creation: Ad group
- Targeting for ad group
- Custom audience targeting for ad group
- Ad creation: Creative common
- Ad creation: Display creative
- Ad creation: Message creative
- Ad creation: Personalized message creative
- Bizboard landing settings
- Report
- Message management
- Personalized message management
- Message ad management
- Message ad operation
- Ad View management
- Business Form+ management
- Business Form linkage management
- Pixel & SDK linkage management
- Audience management
- Engagement targeting management
- Customer file management
- Friend group management
- Ad account management
- Reference
- Type information
- Error code
Type info
This document provides the data type information used for Kakao Moment APIs.
| Value | 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 |
| PLAY | Play a game |
| Name | Type | Description |
|---|---|---|
| id | Long | Ad group ID |
| name | String | Ad group name |
| adGroupStatus | Enum: Status[] | Ad group status |
| Value | Description |
|---|---|
| DISPLAY | Display |
| DIRECT_MESSAGE | Message |
| Name | Type | Description |
|---|---|---|
| id | Long | Ad View ID |
| name | String | Ad View name |
| type | String | Ad View type |
| templateType | String | Ad View template type |
| Name | Type | Description |
|---|---|---|
| id | Long | Ad View ID |
| Name | Type | Description |
|---|---|---|
| RETARGETING | String | Retargeting |
| CONVERSION | String | Conversion |
| BOTH | String | Both retargeting and conversion |
| Name | Type | Description |
|---|---|---|
| assetGroupId | Long | Slide number |
| ordering | Integer | Slide order |
| image | Image | Slide image |
| title | String | Title |
| description | String | Promotional text |
| priceAmount | String | Price information |
| priceCurrencyCode | Enum: CurrencyCode | Price currency unit |
| discountedPriceAmount | String | Discounted price information |
| rspvLandingUrl | String | Representative landing URL |
| pcLandingUrl | String | Landing URL for PC |
| mobileLandingUrl | String | Landing URL for mobile |
| Name | Type | Description |
|---|---|---|
| adGroup | AdGroup | Ad group |
| campaign | Campaign | Campaign |
| operation | Enum: Operation | Operation type
Note: Refer to Available operation and engagement types by Type X Goal. |
| firstIndicator | Enum: Indicator | Type of the first response Note: Refer to Available operation and engagement types by Type X Goal. |
| secondIndicator | Enum: Indicator | Type of the second response
Note: Refer to Available operation and engagement types by Type X Goal. |
| messageAd | MessageAd | Message |
| Name | Type | Description |
|---|---|---|
| type | String | Automatic bidding options
|
| value | Long | Target value The cost target value of the Automatic bidding, pass 0 if type is MAXIMIZE_CONVERSION_VALUE |
| 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 | Enum | Landing type
|
| 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 |
| Name | Type | Description |
|---|---|---|
| title | String | Button name |
| pcLandingUrl | String | PC 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://. |
| mobileLandingUrl | String | Mobile landing URL for the button. Must be a valid URL starting with http:// or https://. |
| channelPostId | Long | Post ID. Used when the landing type is CHANNEL_POST.Must be obtained from the Channel Post List API. |
| channelCouponId | Long | Coupon ID. Used when the landing type is CHANNEL_COUPON.Must be obtained from the Coupon List API. |
| bizFormId | Long | Business Form ID. Used when the landing type is BIZ_FORM.Must be obtained from the Business Form List API. |
| adViewId | Long | Ad View ID. Used when the landing type is AD_VIEW.Must be obtained from the Ad View List API. |
| webembedChannelUrl | String | Web embed channel URL. The URL set for the web embed channel is displayed. |
| Name | Type | Description |
|---|---|---|
| title | String | Carousel title |
| description | String | Carousel promotional text |
| imageUrl | String | Carousel promotional area image URL |
| pcLandingUrl | String | PC 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://. |
| mobileLandingUrl | String | Mobile landing URL for the carousel. Must be a valid URL starting with http:// or https://. |
| shareFlag | Boolean | Whether to use the share option for the carousel.
Important: Cannot be used if ageVerification is true. |
| buttons | Button[] | Carousel button information |
| priceAmount | Integer | Carousel price information |
| priceCurrencyCode | Enum: CurrencyCode | Carousel currency information. |
| discountedPriceAmount | Integer | Carousel discounted price information. Must be at least 1% less than priceAmount. |
| 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 omitted, the budget is not limited. |
| config | Enum: Config | Campaign status |
| isDailyBudgetAmountOver | Boolean | Whether or not the daily budget is exceeded |
| statusDescription | String | Status of the campaign |
| trackId | String | Conversion tracking ID |
| Value | Description |
|---|---|
| TALK_BIZ_BOARD | Kakao Biz Board |
| DISPLAY | Display |
| VIDEO | Video |
| PRODUCT_CATALOG | Product catalog |
| TALK_BIZ_BOARD_RESERVED | Kakao Biz Board CPT |
| FOCUS_FULL_VIEW | Focus full view |
| PC_TALK_RICH_POP | Rich Pop All Day |
| PROFILE_FULL_VIEW | Profile full view |
| PC_TALK_BOTTOM | Focus board |
| DAUM_SHOPPING | Daum Shopping |
| TALK_CHANNEL | Kakao Talk Channel |
| PERSONAL_MESSAGE | Personalized message |
| Name | Type | Description |
|---|---|---|
| campaignType | Enum: CampaignType | Campaign type |
| goal | Enum: Goal | Campaign goal |
| 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 |
| Name | Type | Description |
|---|---|---|
| id | Long | Post ID |
| title | String | Title |
| status | String | Status |
| adult | Boolean | Whether it is an age verification post
|
| permalink | String | Post URL |
| createdDate | String | Date and time of post creation |
| publishedDate | String | Date and time of post publication |
| 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 |
| Name | Type | Description |
|---|---|---|
| id | Long | Clip Link ID |
| displayTitle | String | Clip Link title |
| playCount | Integer | Number of video plays |
| likeCount | Integer | Number of likes |
| commentCount | Integer | 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 | 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 | name | Description |
|---|---|---|
| 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 |
| Name | Type | Description |
|---|---|---|
| id | Long | Engagement target ID |
| name | String | Engagement target name |
| cohortId | Long | Registered engagement target number |
| inclusionType | Enum: InclusionType | Whether to include or exclude the information extracted through engagement targeting for ad group targeting |
| Name | Type | Description |
|---|---|---|
| businessRegistrationNumber | String | Business registration number |
| name | String | Business name |
| Value | Description |
|---|---|
| ON | Activated |
| OFF | Inactivated |
| DEL | Deleted |
| 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 |
| Name | Type | Description |
|---|---|---|
| id | String | Channel coupon ID |
| 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 |
| Name | Type | Description |
|---|---|---|
| couponBookTitleType | Enum | Coupon type.
|
| couponBookTitle | String | Coupon title. Entered according to the value of couponBookTitleType.
Important: Maximum 7 characters for Basic text, Carousel commerce, and Carousel feed, and maximum 12 characters for Wide image, Wide list, and Premium video |
| title | String | Detailed 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 |
| pcLandingUrl | String | PC 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://. |
| mobileLandingUrl | String | Mobile landing URL for the coupon. Must be a valid URL starting with http:// or https://. |
| Value | Description |
|---|---|
| KRW | ₩ |
| USD | $ |
| JPY | ¥ |
| EUR | € |
| Value | 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 |
| Name | Type | Description |
|---|---|---|
| id | Long | Customer file registration ID |
| inclusionType | Enum: InclusionType | Whether to include or exclude the information extracted from a customer file for ad group targeting |
| name | String | Customer file name |
| status | Enum: CustomerFileStatus | Customer file status |
| Name | Type | Description |
|---|---|---|
| type | CustomTargetType | Custom targeting type.
|
| referenceId | String | Custom target ID |
| inclusionType | TargetingInclusionType | Whether to include or exclude.
|
| name | String | Name |
| Name | Type | Description |
|---|---|---|
| start | String | Start date in yyyyMMdd format |
| end | String | End date in yyyyMMdd format |
| dimensions | Dimensions | Report criteria and values |
| metrics | Metrics | Report metrics and values |
| Value | 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 |
For the complete list, refer to Depth2Location table in Type information of location CSV file (Download).
| 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) |
| deprecated | Boolean | Whether 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).
| 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) |
| deprecated | Boolean | Whether the administrative district is deleted. If the value is true, the district has been deleted.If not deleted, this field is not included. |
| Name | Type | Description |
|---|---|---|
| genderType | Enum | Gender selection type.
|
| genders | String[] | Gender.
Important: Only allowed if genderType is NOT_ALL. |
| ageType | Enum | Age selection type.
|
| ages | String[] | Age range.
Important: Only allowed if ageType is NOT_ALL. |
| locationType | Enum | Location selection type.
Important: Only allowed if locationType is AREA. |
| depth1Locations | Depth1Location[] | 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. |
| depth2Locations | Depth2Location[] | 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. |
| depth3Locations | Depth3Location[] | 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. |
| Value | Description |
|---|---|
| ANDROID | Android |
| IOS | iOS |
| PC | PC |
| Value | Description |
|---|---|
| AD_ACCOUNT | ad_account_id: Ad account |
| CAMPAIGN | campaign_id: Campaign |
| AD_GROUP | ad_group_id: Ad group |
| CREATIVE | creative_id: Creative |
| Value | Description |
|---|---|
| CREATIVE_FORMAT | Creative format Creative type: Display
|
| PLACEMENT | Placement
|
| AGE | (Old) Age range
|
| AGE_BAND | Age range
|
| GENDER | Gender
|
| AGE_GENDER | (Old) Age range+gender |
| AGE_BAND_GENDER | Age range+gender |
| LOCATION | Location
|
| DEVICE_TYPE | Device type
|
| HOUR | Hour
|
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"}
| 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 |
| Name | Type | Description |
|---|---|---|
| startDate | String | Start date, in yyyy-MM-dd format |
| endDate | String | End date, in yyyy-MM-dd format |
| Value | Description |
|---|---|
| VISITING | Visit |
| CONVERSION | Conversion |
| REACH | Reach |
| VIEW | View |
| Name | Type | Description |
|---|---|---|
| title | String | Content |
| hash | String | hash value of the group |
| ordering | Integer | Sort order |
| isHighlighted | Boolean | Whether button is highlighted |
| landingType | Enum | Group landing type
|
| image | ImageInfo | Group image 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 |
| 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 |
| Name | Type | Description |
|---|---|---|
| url | String | Image URL |
| imageWidth | Integer | Image width |
| imageHeight | Integer | Image height |
| fileSize | Long | File size |
| fileName | String | File name |
| Value | Description |
|---|---|
| INCLUDE | Included |
| EXCLUDE | Excluded |
| Value | Description |
|---|---|
| PLAY | Video play |
| CLICK | Click |
| CONVERSION | Conversion |
| OPEN | Open |
| Name | Type | Description |
|---|---|---|
| title | String | Intro title (Maximum: 25 characters) |
| description | String | Intro promotional text (Maximum: 50 characters) |
| imageUrl | String | Intro promotional area image URL |
| pcLandingUrl | String | PC 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://. |
| mobileLandingUrl | String | Mobile landing URL for the intro. Must be a valid URL starting with http:// or https://. |
| Name | Type | Description |
|---|---|---|
| imageUrl | String | Item 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) |
| title | String | Item promotional text |
| landing | Landing[] | Landing information |
| Name | Type | Description |
|---|---|---|
| thumbnail | String | Thumbnail URL |
| landingType | Enum | Landing type
|
| ordering | Integer | Sort order |
| title | String | Promotional text or title Promotional text in the item asset group is passed only for WIDE_LIST_MESSAGE, CAROUSEL_COMMERCE_MESSAGE(Except for the intro card), CAROUSEL_FEED_MESSAGE, CATALOG_MESSAGE types. |
| description | String | Promotional text for CAROUSEL_FEED_MESSAGE |
| priceAmount | String | Price for CAROUSEL_COMMERCE_MESSAGE |
| priceCurrencyCode | Enum: CurrencyCode | Currency |
| discountedPriceAmount | String | Discounted price for CAROUSEL_COMMERCE_MESSAGE |
| mobileLandingUrl | String | Mobile landing URL Passed if landing type is set to LANDING_URL. |
| pcLandingUrl | String | PC landing URL Passed if landing type is set to LANDING_URL. |
| image | Image | Image creative Image in the item asset group is returned for WIDE_MESSAGE, WIDE_LIST_MESSAGE, CAROUSEL_COMMERCE_MESSAGE(Except for the intro card), CAROUSEL_FEED_MESSAGE, CATALOG_MESSAGE types. |
| thumbnail | Thumbnail | Representative image. |
| Name | Type | Description |
|---|---|---|
| pcLandingUrl | String | PC landing URL |
| mobileLandingUrl | String | Mobile landing URL |
| webembedChannelUrl | String | Web embed landing URL |
| channelPostId | Long | Channel post ID |
| channelCouponId | Long | Channel coupon ID |
| Name | Type | Description |
|---|---|---|
| landingType | String | Landing type
|
| profileId | String | Kakao 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. |
| action | String | Keyword. Important: Used if landingType (Landing type) is PF_BOT (Chatbot). |
| adViewItem | AdViewItem | Ad View object. Important: Used if landingType (Landing type) is AD_VIEW (Ad View). |
| url | String | URL. Important: Used if landingType (Landing type) is CHANNEL_WEBVIEW (Channel web view). |
| bizFormId | Long | Business Form ID. Important: Used if landingType (Landing type) is BIZ_FORM (Business Form). |
| bizFormplusId | Long | Business Form+ ID. Important: Used if landingType (Landing type) is BIZ_FORM_PLUS (Business Form Plus). |
| channelPostId | Long | Channel post ID. Important: Used if landingType (Landing type) is CHANNEL_POST (Channel post). |
| shopKey | String | Kakao Pay purchase store key. Important: Used if landingType (Landing type) is PAY_BUY (Kakao Pay purchase). |
| productId | String | Kakao 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).
| 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) |
| deprecated | Boolean | Whether the administrative district is deleted. If the value is true, the district has been deleted.If not deleted, this field is not included. |
- For required parameters by message type (
type), see Message type components
| Name | Type | Description |
|---|---|---|
| type | Enum | Message type (required)
|
| title | String | Message promotional text |
| items | Item[] | Item information |
| buttons | Button[] | Button information |
| couponBook | CouponBook[] | Coupon information |
| introCarousel | IntroCarousel | Intro information |
| carousels | Carousel[] | Carousel information |
| catalog | Catalog[] | Catalog information |
| buttonTitle | String | Spotlight message button name |
| landingUrl | String | Spotlight message landing URL |
| adFlag | Boolean | Advertising message
|
| shareFlag | Boolean | Whether to use the share option
Important: Cannot be used if ageVerification is true. |
| Name | Type | Description |
|---|---|---|
| id | String | Message creative ID |
| name | String | Message creative name |
| opStatus | Enum: Status[] | Message status |
| Value | Description |
|---|---|
| MASTER | Master role |
| MEMBER | Member role |
| Name | Type | Description |
|---|---|---|
| id | Long | Message creative ID |
| adAccountId | Long | Ad account ID |
| profileId | String | Kakao Talk Channel profile ID |
| profileName | String | Kakao Talk Channel profile name |
| name | String | Message creative name |
| shareFlag | Boolean | Sharing |
| adFlag | Boolean | Advertising message |
| creativeFormat | String | Message creative's type.
|
| title | Title | Promotional text or title Displayed on the different locations by the creative format.
|
| description | String | Promotional text for the intro card of CAROUSEL_COMMERCE_MESSAGE |
| image | Image | Image creative Only returned for the BASIC_TEXT_MESSAGE and CAROUSEL_COMMERCE_MESSAGE types. |
| buttonAssetGroups | ButtonAssetGroup | Button item |
| itemAssetGroups | ItemAssetGroup | List of items Only returned for the following types
|
| thumbnailUrl | String | Thumbnail image URL |
| csInfo | String | Phone number of customer support |
| couponBookAssetGroups | CouponBookAssetGroup | Coupon book information |
| createdDate | String | Date and time of the Message creative creation in yyyy-MM-dd'T'HH:mm:ss format |
| lastModifiedDate | String | Date and time of the Message creative modification in yyyy-MM-dd'T'HH:mm:ss format |
| hasIntro | Boolean | Whether the CAROUSEL_COMMERCE_MESSAGE creative has the intro card |
| introLandingType | String | Landing type of the CAROUSEL_COMMERCE_MESSAGE intro card |
| introMobileLandingUrl | String | Landing URL of the CAROUSEL_COMMERCE_MESSAGE intro card for mobile |
| introPcLandingUrl | String | Landing URL of the CAROUSEL_COMMERCE_MESSAGE intro card for PC |
| 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, 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
|
| sendRate | Integer | Option to send distributed messages Set the number of messages that are sent at once
|
| status | Enum | Status of sending a message
|
| syncStatus | Enum | Sync status with the sending system
|
| 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
|
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}
| Value | Description |
|---|---|
| BASIC | Basic metrics
|
| ADDITION | Additional metrics
|
| MESSAGE | Message basic metrics
|
| MESSAGE_ADDITION | Message additional metrics
|
| PIXEL_SDK_CONVERSION | Pixel & SDK conversion metrics
|
| PLUS_FRIEND | Kakao Talk friends metrics
|
| VIDEO | Video metrics
|
| SLIDE_CLICK | Slide metrics
|
| MESSAGE_CLICK | Message click metrics
|
| ADVIEW | Ad View metrics
|
| BIZ_BOARD | Bizboard metrics
|
| SPB | Board metrics
|
| TRIGGER | Frontal induction indicator
|
| Name | Type | Description |
|---|---|---|
| pcLandingUrl | String | PC landing URL |
| mobileLandingUrl | String | Mobile landing URL |
| webembedChannelUrl | String | Web embed landing URL |
| channelPostId | Long | Channel post ID |
| channelCouponId | Long | Channel coupon ID |
| Name | Type | Description |
|---|---|---|
| type | Enum: ObjectiveType | Type of the ad goal setting |
| value | String | Ad 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. |
| detailType | Enum: ObjectiveDetailType | Type of the conversion to be optimized, used if type is PIXEL_AND_SDK |
| Value | Description |
|---|---|
| TALK_CHANNEL | Kakao Talk Channel |
| PIXEL_AND_SDK | Pixel & SDK |
| Value | Description |
|---|---|
| PURCHASE | Purchase |
| APP_INSTALL | Install app |
| COMPLETE_REGISTRATION | Sign up |
| SIGN_UP | Apply for a service |
| CART | Add to a cart |
| PARTICIPATION | Potential customer |
| ADD_FRIEND | Add Kakao Talk Channel Friends Note: Only provided in the response when ObjectiveType is TALK_CHANNEL.Not supported for the request. |
| Value | Description |
|---|---|
| ONLY | ONLY |
| AND | AND |
| MINUS | MINUS |
| OR | OR |
| 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 |
| 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. |
| Value | 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. |
| Value | Description |
|---|---|
| WEEK | Weekly |
| MONTH | Monthly |
| Value | Description |
|---|---|
| KAKAO_TALK | Kakao Talk |
| DAUM | Daum |
| KAKAO_SERVICE | Kakao Service |
| NETWORK | Network |
| Value | 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). |
| CPV | Cost per View Type to charge per video view. |
| CPMS | Cost per Message Send Type to charge for each message sent. Used for message ad groups. |
| Name | Type | Description |
|---|---|---|
| rejectedTitle | String | Title of reason why a review is rejected |
| rejectedContent | String | Content of reason why a review is rejected |
| Name | Type | Description |
|---|---|---|
| messageAdId | String | Message ad ID, a unique identifier assigned when first created |
| name | String | Message name (Maximum: 50 characters). If not entered at creation, an automatically generated value is applied. |
| type | Enum | Message type.
|
| title | String | Message promotional text |
| items | Item[] | Item information |
| buttons | Button[] | Button information |
| couponBook | CouponBook[] | Coupon information |
| introCarousel | IntroCarousel | Intro information |
| carousels | Carousel[] | Carousel information |
| catalog | Catalog[] | Catalog information |
| buttonTitle | String | Spotlight message button name |
| landingUrl | String | Spotlight message landing URL |
| ageVerification | Boolean | Whether the message requires age verification
|
| adFlag | Boolean | Advertising message
|
| shareFlag | Boolean | Whether to use the share option
Important: Cannot be used if ageVerification is true. |
| Value | Description |
|---|---|
| ON | Activated |
| VOID | Impossible to run (System invalidated) |
| ADMIN_STOP | Administrator suspended |
| EXTERNAL_SERVICE_STOP | Linked service restricted |
| Name | Type | Description | Required |
|---|---|---|---|
| beginDate | String | Start date in yyyy-MM-dd'T'HH:mm:ss formatSet it to today or the day after today. | O |
| endDate | String | End date in yyyy-MM-dd'T'HH:mm:ss formatSet it to the start date or the day after the start date. | X |
| lateNight | Boolean | Late night targeting | O |
| detailTime | Boolean | Whether 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 |
| mondayTime | String[] | Set a specific time for Monday
"0" or "1" with an array length of 24Example: ["1","1", "0",....] Required if detailTime is set to true. | X |
| tuesdayTime | String[] | Set a specific time for Tuesday
"0" or "1" with an array length is 24.Example: ["1","1", "0",....] Required if detailTime is set to true. | X |
| wednesdayTime | String[] | Set a specific time for Wednesday
"0" or "1" with an array length is 24.Example: ["1","1", "0",....] Required if detailTime is set to true. | X |
| thursdayTime | String[] | Set a specific time for Thursday
"0" or "1" with an array length is 24.Example: ["1","1", "0",....] Required if detailTime is set to true. | X |
| fridayTime | String[] | Set a specific time for Friday
"0" or "1" with an array length is 24.Example: ["1","1", "0",....] Required if detailTime is set to true. | X |
| saturdayTime | String[] | Set a specific time for Saturday
"0" or "1" with an array length is 24.Example: ["1","1", "0",....] Required if detailTime is set to true. | X |
| sundayTime | String[] | Set a specific time for Sunday
"0" or "1" with an array length is 24.Example: ["1","1", "0",....] Required if detailTime is set to true. | X |
| 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 | Enum: PeriodUnit | Weekly or monthly basis | X |
| Value | 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 |
| ADACCOUNT_UNAVAILABLE | Ad account is unavailable to run |
| Value | 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_ADMIN_STOP | Administrator is suspended |
| Key | Applicable to message creatives | Description |
|---|---|---|
| OPERATING | Yes | Creative is available to run. |
| UNAPPROVED | No | Review is not approved. (Including review pending or suspension case) |
| INVALID_DATE | Yes | Delivery period has not started or is overdue. |
| MONITORING_REJECTED | No | Monitoring is pending. |
| SYSTEM_CONFIG_ADMIN_STOP | No | Creative is suspended by the administrator. |
| OFF | Yes | User status is OFF. |
| DELETED | Yes | Creative is deleted. |
| ADGROUP_UNAVAILABLE | Yes | Ad group that includes ads is not available to run. |
| SYSTEM_CONFIG_VOID | No | Creative 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* | 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 | - | - |
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* | 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 | - |
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* | 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 | - | - |
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* | 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 | - | - |
statusDescription are passed in Korean.
| Name | Type | Description |
|---|---|---|
| profileId | String | Kakao Talk Channel profile ID |
| inclusionType | Enum: InclusionType | Whether or not it is included |
| Name | Type | Description |
|---|---|---|
| id | Long | Kakao Talk Channel targeting ID |
| inclusionType | Enum: 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 |
| Name | Type | Description |
|---|---|---|
| id | Long | Friend group ID |
| name | String | Friend group name |
| inclusionType | Enum: 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 | Enum | File type
|
| groupKey | String | Friend group file's group key |
| 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 | Enum | Whether to use Audience.
|
| ageType | Enum | Selection type for age range
|
| ages | String[] | Age range |
| genderType | Enum | Selection type for gender
|
| genders | String[] | Gender |
| locations | Location[] | City/Province Refer to View city/province. |
| depth2Locations | Depth2Location[] | City/County/District Refer to View city/county/district. |
| depth3Locations | Depth3Location[] | Neighborhood/Town/Townships Refer to View dong/eup/myeon. |
| ufoInterests | UfoInterest[] | Interest targeting Refer to View categories of Network for placements API. |
| ufoDeprecatedInterests | UfoInterest[] | Deprecated interest targeting Refer to View categories of Network for placements API. |
| ufoBusinessTypes | UfoBusinessType[] | Business type targeting Refer to View categories of Network for placements API. |
| ufoDeprecatedBusinessTypes | UfoBusinessType[] | Deprecated business type targeting Refer to View categories of Network for placements API. |
| talkChannelTargetings | TalkChannelTargeting[] | Kakao Talk Channel targeting |
| syncAppTargetings | SyncAppTargeting[] | Kakao Login user targeting |
| customerFileTargetings | CustomerFileTargeting[] | Customer targeting |
| cohortTargetings | CohortTargeting[] | Engagement targeting |
| trackerTargetings | TrackerTargeting[] | Pixel & SDK targeting |
| talkChannelGroupTargetings | TalkChannelGroupTargeting[] | Information of friends group targeting. |
| Name | Type | Description | Required |
|---|---|---|---|
| type | String | Targeting type. Required for requests.
| O |
| devices | Enum: DeviceType[] | Device selection type.
| X |
| demographics | Demographics[] | Gender, age, and location information | X |
| customs | CustomTargeting[] | Custom targeting | X |
| friendPeriod | FriendPeriod[] | Friend period setting. Only users who became channel friends during the set period will receive the message. | X |
| ufoInterests | Set<UfoInterest> | Custom targeting > Kakao data > Category > Interest See View custom target category type Note: View only. | X |
| ufoBusinessTypes | Set<UfoBusinessType> | Custom targeting > Kakao data > Category > Business type See View custom target category type Note: View only. | X |
| 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 |
| Value | Description |
|---|---|
| DAY | day |
| ALL | entire requested period |
| Report counting unit | Maximum period to be retrieved |
|---|---|
| DAY | 1 month |
| ALL | 1 month |
| Name | Type | Description |
|---|---|---|
| id | Long | Tracker number |
| inclusionType | Enum: InclusionType | Whether to include or exclude the information extracted from a Pixel & SDK event for ad group targeting |
| trackId | String | Tracker ID |
| eventCode | String | Event code |
| trackRuleId | String | Tracker rule number |
| trackRuleName | String | Tracker rule name |
| term | Integer | Targeting period (Minimum: 1, Maximum: 180). |
| 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 |
| Name | Type | Description |
|---|---|---|
| value | String | Key that indicates detailed business type. For the complete list, refer to UfoBusinessType table in Type information of business type CSV file (Download). |
| Name | Type | Description |
|---|---|---|
| value | String | Key for interests For the complete list, refer to UfoInterest table in Type information of interest CSV file (Download). |
| Name | Type | Description |
|---|---|---|
| url | String | Video URL |
| fileName | String | Video file name |
| size | Long | Video file size |
| duration | String | Video duration |
| Name | Type | Description |
|---|---|---|
| url | String | Video creative URL |
| Name | Type | Description |
|---|---|---|
| url | String | Video URL |
| autoThumbnailUrl | String | Auto-extracted thumbnail URL |
| uploadThumbnailUrl | String | Uploaded thumbnail URL |