타입 정보

이 문서는 카카오모먼트 API에서 사용되는 각종 타입에 대한 상세 정보를 제공합니다.

A

ActionButton

값	설명
LINK	바로가기
MORE	알아보기
RESERVATION	예약하기
PURCHASE	구매하기
REQUEST	신청하기
INQUIRE	문의하기
INSTALL	설치하기
RUN	실행하기
DOWNLOAD	다운로드
LAUNCH	사용하기
ADD_FRIEND	채널 추가
SUBSCRIBE	소식 받기
MORE_VIDEO	동영상 더보기
JOIN	가입하기
COUPON	쿠폰 받기

AdGroup

이름	타입	설명
id	Long	광고그룹 번호
name	String	광고그룹 이름
adGroupStatus	Status[]	광고그룹 상태

AdGroupType

값	설명
DISPLAY	디스플레이
DIRECT_MESSAGE	메시지

AdView

이름	타입	설명
id	Long	애드뷰 번호 소재 생성 및 수정 시 landingInfo.adViewItem.id에 해당 값으로 설정
name	String	애드뷰 이름
type	String	애드뷰 타입 COMPACT (콤팩트뷰), FULL (풀뷰) 중 하나
templateType	String	애드뷰 템플릿 타입 IMAGE (이미지), VIDEO (동영상), CAROUSEL (캐러셀), SCROLL (스크롤) 중 하나

AdViewItem

이름	타입	설명
id	Long	애드뷰 번호

AppTrackingType

이름	타입	설명
RETARGETING	String	리타게팅
CONVERSION	String	전환
BOTH	String	리타게팅과 전환 모두

AssetGroup

이름	타입	설명
assetGroupId	Long	슬라이드 번호
ordering	Integer	슬라이드 정렬 순서
image	Image	슬라이드 이미지
title	String	제목
description	String	홍보 문구
priceAmount	String	가격 정보
priceCurrencyCode	String	통화 정보 KRW, USD, JPY, EUR 중 하나
discountedPriceAmount	String	할인 가격 정보
rspvLandingUrl	String	대표 랜딩 URL
pcLandingUrl	String	PC 랜딩 URL
mobileLandingUrl	String	모바일 랜딩 URL

B

BaseAd

이름	타입	설명
adGroup	AdGroup	광고그룹
campaign	Campaign	캠페인
operation	Operation	연산 종류 연산 및 반응 종류 정책 참조
firstIndicator	Indicator	첫번째 반응 종류 연산 및 반응 종류 정책 참조
secondIndicator	Indicator	두번째 반응 종류 연산 및 반응 종류 정책 참조

BidStrategyTarget

이름	타입	설명
type	String	자동 입찰 옵션 TARGET_CPC(CPC 비용 목표), TARGET_CPA(CPA 비용 목표), TARGET_ROAS(ROAS 목표), MAXIMIZE_CONVERSION_VALUE(전환 가치 최대화) 중 하나
value	Long	목표 값 자동입찰 방식의 목표(비용 또는 ROAS) 값, type이 MAXIMIZE_CONVERSION_VALUE인 경우 0으로 지정

BusinessForm

이름	타입	설명
id	Long	모먼트에 연동된 비즈니스폼 ID 메시지 소재 생성시 필요한 ID
adAccountId	Long	광고계정 번호
bizFormId	Long	비즈니스폼 번호 소재 생성 및 수정시 landingInfo.bizFormId에 해당 값으로 설정
title	String	비즈니스폼 제목
flowType	String	비즈니스폼 유형 다음 중 하나 APPLY(바로응모형) SURVEY(설문조사형) RESERV(신청예약형)
linkedDate	String	모먼트에 연동된 일시 (yyyy-MM-dd'T'HH:mm:ss 형식)
beginDate	String	비즈니스폼 시작일시 (yyyy-MM-dd'T'HH:mm:ss 형식)
endDate	String	비즈니스폼 종료일시 (yyyy-MM-dd'T'HH:mm:ss 형식)

ButtonAssetGroup

이름	타입	설명
ordering	Long	정렬순번
title	String	버튼명
rspvLandingUrl	String	반응형 랜딩 URL
mobileLandingUrl	String	모바일 랜딩 URL
pcLandingUrl	String	PC 랜딩 URL
adViewId	Long	애드뷰 ID
bizFormId	Long	비즈니스폼 ID
channelPostId	Long	채널 소식 ID
channelCouponId	Long	채널 쿠폰 ID
thumbnail	String	썸네일
highlighted	Boolean	하이라이트 버튼 사용
landingType	String	랜딩 유형 LANDING_URL (URL), CHANNEL_COUPON (쿠폰), CHANNEL_POST (소식), AD_VIEW (애드뷰), BIZ_FORM (비즈니스폼) 중 하나

C

Campaign

이름	타입	설명
id	Long	캠페인 번호
adAccountId	Long	광고 계정 번호
name	String	캠페인 이름
campaignTypeGoal	CampaignTypeGoal	캠페인 유형 X 목표
objective	Objective	광고 목표 설정
dailyBudgetAmount	Long	일 예산 입력하지 않은 경우 예산 "한도 없음"과 같은 의미
config	String	캠페인 상태 ON, OFF, DEL(삭제) 중 하나
isDailyBudgetAmountOver	Boolean	일 예산 초과 여부
statusDescription	String	캠페인의 게재와 관련된 현재 상태
trackId	String	전환추적설정 번호

CampaignType

값	설명
TALK_BIZ_BOARD	카카오톡비즈보드
DISPLAY	디스플레이
TALK_CHANNEL	카카오톡 채널
DAUM_SHOPPING	다음쇼핑
VIDEO	동영상
PERSONAL_MESSAGE	개인화 메시지

CampaignTypeGoal

이름	타입	설명	필수
campaignType	CampaignType	캠페인 유형	O
goal	Goal	캠페인 목표	O

CategoryData

이름	타입	설명
id	String	카테고리 코드 광고그룹 생성 및 수정 시, "targeting.ufoInterests(관심사)" 또는 "targeting.ufoBusinessTypes(업종)"의 값으로 사용
name	String	카테고리 이름
children	CategoryData[]	하위 카테고리 데이터

ChannelCoupon

이름	타입	설명
id	Long	쿠폰 ID
title	String	쿠폰 제목
content	String	쿠폰 내용
statusCode	String	쿠폰의 상태
permalink	String	쿠폰 링크
entryImage	EntryImage	쿠폰 상세 이미지
createdAt	String	쿠폰 생성일시

ChannelCoupons

이름	타입	설명
id	String	채널 쿠폰 ID

ChannelPost

이름	타입	설명
id	Long	소식 번호
title	String	제목
status	String	상태
adult	Boolean	연령인증 소식 여부 true: 연령인증 소식 false: 일반 소식
permalink	String	소식 URL
createdDate	String	소식 생성일
publishedDate	String	소식 발행 날짜

Clip

이름	타입	설명
id	Long	클립 ID
duration	Double	영상 길이
thumbnailUrl	String	썸네일 이미지 URL
isOpen	Boolean	공개 클립인지 여부

ClipLink

이름	타입	설명
id	Long	클립링크 ID
displayTitle	String	클림링크 제목
playCount	int	영상 재생 횟수
likeCount	int	좋아요 갯수
commentCount	int	댓글 갯수
createTime	DateTime	생성 시각
updateTime	DateTime	업데이트 시각
clip	Clip	영상 상세 정보
linkUrl	String	클립링크 링크

code: 네트워크 게재지면 하위 목록 정보

값	설명
IAB1	예술 및 엔터테인먼트
IAB10	홈/정원
IAB11	법, 정부와 정치
IAB12	언론
IAB13	개인금융
IAB14	사회
IAB15	과학
IAB16	애완동물
IAB17	스포츠
IAB18	스타일/패션
IAB19	컴퓨터/기술
IAB2	자동차
IAB20	여행
IAB21	부동산
IAB22	쇼핑
IAB23	종교
IAB24	미분류
IAB3	산업
IAB4	직업
IAB5	교육
IAB6	가족 및 육아
IAB7	건강 및 운동
IAB8	식음료
IAB9	취미

code: 게재지면 카카오톡 하위 섹션 카테고리 목록 정보

값	설명
KKO99-0	오픈채팅탭 노출 제외
KKO99-1	채팅탭에만 노출

CohortTargeting

이름	타입	설명
id	Long	광고 반응 타겟 번호
name	String	광고반응 타겟 이름
cohortId	Long	내 광고 반응 타겟 번호
inclusionType	InclusionType	포함 여부

Company

이름	타입	설명
businessRegistrationNumber	String	사업자등록번호
name	String	회사명

Config

값	설명
ON	활성화
OFF	비활성화
DEL	삭제

CouponBookAssetGroup

이름	타입	설명
couponBookTitle	String	쿠폰북 타이틀
couponBookTitleType	String	쿠폰북 타이틀 타입
title	String	쿠폰북 상세 설명
channelCoupons	ChannelCoupons	채널 쿠폰 정보
mobileLandingUrl	String	모바일 랜딩 URL
pcLandingUrl	String	PC 랜딩 URL
ordering	Integer	정렬 순서

CurrencyCode

값	설명
KRW	₩
USD	$
JPY	¥
EUR	€

CustomerFileStatus

값	설명
WAITING	고객파일 모수추출 대기중
COMPLETE	모수추출 완료
DELETE	삭제 또는 삭제중인 상태
ERROR	그 외 비정상적인 경우
MODIFYING	수정된 모수 준비중

CustomerFileTargeting

이름	타입	설명
id	Long	고객 파일 등록 번호
inclusionType	InclusionType	포함 여부
name	String	고객 파일 이름
status	Enum of CustomerFileStatus	고객 파일의 처리 상태

D

DatePreset (Enum)

값	설명
TODAY	오늘, 00시 부터 현재 전 시간까지
YESTERDAY	어제, 00시 부터 24시 까지
LAST_7DAY	어제 24시까지 7일의 기간, 오늘 미포함
LAST_14DAY	어제 24시까지 14일의 기간, 오늘 미포함
LAST_30DAY	어제 24시까지 30일의 기간, 오늘 미포함
THIS_MONTH	이번달, 1일부터 오늘까지 기간
LAST_MONTH	지난달, 1일부터 마지막일까지 기간

시/군/구 이름 : Depth2Location

이름	타입	설명
value	String	시/군/구 키(Key)
description	String	설명
depth1Name	String	시/도 이름 전체 시/도 이름 참고
depth2Name	String	시/군/구 이름 전체 시/군/구 이름 참고

동/읍/면 이름 : Depth3Location

이름	타입	설명
value	String	동/읍/면 키(Key)
description	String	설명
depth1Name	String	상위 지역 이름 시/도 이름 전체 시/도 이름 참고
depth2Name	String	하위 지역 이름 시/군/구 이름 전체 시/군/구 이름 참고
depth3Name	String	동/읍/면 이름 전체 동/읍/면 이름 참고

DeviceType

값	설명
ANDROID	안드로이드
IOS	IOS
PC	PC

Dimension: Level, 보고서 조회 레벨 기준(Enum)

값	설명	코드
AD_ACCOUNT	광고계정	ad_account_id
CAMPAIGN	캠페인	campaign_id
AD_GROUP	광고그룹	ad_group_id
CREATIVE	소재	creative_id

Dimension, 보고서 조회 기준(Enum)

값	설명	코드
CREATIVE_FORMAT	소재 형식 Display - 이미지 배너 - 이미지 네이티브 - 비디오 네이티브 - 이미지 박스 - 이미지 카탈로그 - 다이나믹 카탈로그 - 콘텐츠 Message - 기본 텍스트 - 와이드 리스트 - 와이드 이미지 - 캐러셀 커머스 - 캐러셀 피드 - 프리미엄 동영상	Display - IMAGE_BANNER - IMAGE_NATIVE - VIDEO_NATIVE - IMAGE_BOX - CATALOG_MANUAL - CATALOG_DYNAMIC - SERVICE_CONTENT Message - BASIC_TEXT_MESSAGE - WIDE_LIST_MESSAGE - WIDE_MESSAGE - CAROUSEL_COMMERCE_MESSAGE - CAROUSEL_FEED_MESSAGE - PREMIUM_VIDEO_MESSAGE
PLACEMENT	게재지면 - total - 카카오톡 - 다음 - 카카오스토리 - 카카오서비스 - 네트워크	- total - KAKAO_TALK - DAUM - KAKAO_STORY - KAKAO_SERVICE - NETWORK
AGE	(구) 연령 - total - 15~19 - 20~25 - 26~30 - 31~40 - 41~50 - 51~70 - 알 수 없음	- total - 15 - 20 - 26 - 31 - 41 - 51 - -1
AGE_BAND	연령 - total - 15~19 - 20~25 - 25~29 - 30~34 - 35~39 - 40~44 - 45~49 - 50~54 - 55~59 - 60~64 - 65~69 - 70이상 - 알 수 없음	- total - 15 - 20 - 25 - 30 - 35 - 40 - 45 - 50 - 55 - 60 - 65 - 70 - 0
GENDER	성별 - total - 남 - 여 - 알 수 없음	- total - M - F - N
AGE_GENDER	(구) 연령+성별
AGE_BAND_GENDER	연령+성별
LOCATION	지역 - total - 서울특별시 - 인천광역시 - 경기도 - 강원도 - 세종특별자치시 - 대전광역시 - 충청북도 - 충청남도 - 광주광역시 - 전라북도 - 전라남도 - 대구광역시 - 울산광역시 - 경상북도 - 경상남도 - 부산광역시 - 제주틀별자치도 - 해외 - 알수없음	- total - I - K - B - A - Q - G - P - O - E - M - L - F - J - D - C - H - N - Z - U
DEVICE_TYPE	디바이스 - total - PC - Android - iOS - 기타	- total - PC - Android - iOS - N/A
HOUR	시간대 - total - 00:00~00:59 - 01:00~01:59 - 02:00~02:59 - 03:00~03:59 - 04:00~04:59 - 05:00~05:59 - 06:00~06:59 - 07:00~07:59 - 08:00~08:59 - 09:00~09:59 - 10:00~10:59 - 11:00~11:59 - 12:00~12:59 - 13:00~13:59 - 14:00~14:59 - 15:00~15:59 - 16:00~16:59 - 17:00~17:59 - 18:00~18:59 - 19:00~19:59 - 20:00~20:59 - 21:00~21:59 - 22:00~22:59 - 23:00~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

이름	타입	설명
type	String	미디어 타입, image, video 등
url	String	이미지 URL
thumbnail	String	섬네일 이미지
previewImage	String	video 타입인 경우 섬네일 이미지
playUrl	String	video 타입인 경우 재생 URL
name	String	이름

G

Goal

값	설명
VISITING	방문
CONVERSION	전환
REACH	도달
VIEW	조회

GroupInfo

이름	타입	설명
title	String	내용
hash	String	그룹 hash 값
ordering	Integer	정렬 순서
isHighlighted	Boolean	버튼 하이라이트 여부
landingType	String	그룹 랜딩 유형 CHANNEL_POST, CHANNEL_COUPON, AD_VIEW, BIZ_FORM, LANDING_URL 중 하나
image	ImageInfo	그룹 이미지 정보
video	VideoInfo	그룹 비디오 정보
pcLandingUrl	String	PC 랜딩URL
mobileLandingUrl	String	모바일 랜딩URL
channelPostId	Long	그룹 랜딩으로 선택된 채널 소식 ID
channelPostTitle	String	그룹 랜딩으로 선택된 채널 소식 내용
channelCouponId	Long	그룹 랜딩으로 선택된 채널 쿠폰 ID
channelCouponTitle	String	그룹 랜딩으로 선택된 채널 쿠폰 제목
adViewId	Long	그룹 랜딩으로 선택된 애드뷰 ID
bizFormId	Long	그룹 랜딩으로 선택된 비즈니스폼 ID

I

Image

이름	타입	설명
size	Long	파일 사이즈
url	String	이미지 URL
fileName	String	이미지 파일명
width	Integer	넓이
height	Integer	높이
mimeType	String	Mime 유형

ImageInfo

이름	타입	설명
url	String	이미지 URL
imageWidth	Integer	이미지 너비
imageHeight	Integer	이미지 높이
fileSize	Long	파일 사이즈
fileName	String	파일명

InclusionType

값	설명
INCLUDE	포함
EXCLUDE	제외

Indicator

이름	타입	설명
PLAY	String	영상 플레이
CLICK	String	클릭
CONVERSION	String	전환
OPEN	String	OPEN

ItemAssetGroup

이름	타입	설명
thumbnail	Long	썸네일 URL
landingType	Image	랜딩 유형 카카오TV 동영상 소재일 경우 Null이며 그 외의 경우엔 아래 유형으로 응답 LANDING_URL (URL), CHANNEL_COUPON (쿠폰), CHANNEL_POST (소식) 중 하나
ordering	Integer	정렬 순번
title	String	홍보문구 또는 타이틀 아이템 에셋 그룹 내 홍보문구는 와이드 리스트, 캐러셀 커머스(인트로카드 제외), 캐러셀 피드 유형에 응답
description	String	캐러셀 피드형 홍보문구
priceAmount	String	가격 정보 캐러셀 커머스형 캐러셀 내 가격 정보
priceCurrencyCode	String	통화 정보 KRW, USD, JPY, EUR 중 하나
discountedPriceAmount	String	할인 가격 정보 캐러셀 커머스형 캐러셀 내 가격 정보
mobileLandingUrl	String	모바일 랜딩 URL 랜딩 유형이 LANDING_URL (URL) 일경우 응답
pcLandingUrl	String	PC 랜딩 URL 랜딩 유형이 LANDING_URL (URL) 일경우 응답
image	Image	이미지 소재 아이템 에셋 그룹 내 Image는 와이드 이미지, 와이드 리스트, 캐러셀 커머스(인트로카드 제외), 캐러셀 피드 유형에 응답
video	Video	카카오TV 동영상 소재 아이템 에셋 그룹 내 Video는 와이드 이미지, 와이드 리스트 유형에만 응답
thumbnail	Thumbnail	대표 이미지 카카오TV 동영상 소재일 경우 대표 이미지로 사용되는 이미지 정보

K

KakaoTvChannelInfo

이름	타입	설명
id	Long	카카오TV 채널 ID
name	String	카카오TV 채널 이름
description	String	카카오TV 채널 설명
totalClipCount	Integer	카카오TV 채널의 영상 개수
openClipCount	Integer	재생목록에 담긴 공개된 클립의 개수
subscriberCount	Integer	구독자수
visitCount	Integer	카카오TV 채널의 영상 시청 수
isOpen	Boolean	카카오TV 채널의 공개 및 비공개 여부
createTime	DateTime	카카오TV 채널 생성 시각
updateTime	DateTime	카카오TV 채널 업데이트 시각
clipCount	Integer	재생목록에 담긴 클립의 개수
linkUrl	String	카카오TV 채널 페이지 링크

L

LandingInfo

이름	타입	설명
landingType	String	랜딩 유형 PF_BOT (챗봇), AD_VIEW (애드뷰), MESSAGE (메시지), CHANNEL_WEBVIEW (채널웹뷰), BIZ_FORM (비즈니스폼), PAY_BUY (카카오페이 구매) 중 하나
profileId	String	챗봇, 채널웹뷰 랜딩 사용시 카카오톡 채널 프로필 ID 카카오톡 채널 프로필 보기 API를 통해 조회되는 응답 중 카카오톡 채널 프로필 ID를 요청
action	String	PF_BOT (챗봇) 랜딩 사용시 키워드
adViewItem	AdViewItem	AD_VIEW (애드뷰) 랜딩 사용시 애드뷰 객체
url	String	CHANNEL_WEBVIEW (채널웹뷰) 랜딩 사용시 URL
bizFormId	Long	BIZ_FORM (비즈니스폼) 랜딩 사용시 비즈니스폼 번호
channelPostId	Long	CHANNEL_POST (채널포스) 랜딩 사용시 채널 소식 아이디
shopKey	String	PAY_BUY (카카오페이 구매) 랜딩 사용시 카카오페이 구매 상점 키
productId	String	PAY_BUY (카카오페이 구매) 랜딩 사용시 카카오페이 구매 상품 아이디

Location

이름	설명
value	String
description	String
depth1Name	String
depth2Name	String

M

MemberType

값	설명
MASTER	마스터 권한
MEMBER	멤버 권한

MessageElement

이름	타입	설명
id	Long	메시지 소재 ID
adAccountId	Long	광고계정 ID
profileId	String	카카오톡 채널 프로필 ID
profileName	String	카카오톡 채널 프로필명
name	String	메시지 소재명
shareFlag	Boolean	공유하기
adFlag	Boolean	광고성 메시지
creativeFormat	String	메시지 소재 유형 다음 중 하나 기본 텍스트 (BASIC_TEXT_MESSAGE) 와이드 이미지 (WIDE_MESSAGE) 와이드 리스트 (WIDE_LIST_MESSAGE) 캐러셀커머스 (CAROUSEL_COMMERCE_MESSAGE) 캐러셀피드 (CAROUSEL_FEED_MESSAGE)
title	Title	홍보문구 또는 타이틀 소재 유형별 노출 위치가 상이함 기본 텍스트 (BASIC_TEXT_MESSAGE): 홍보문구 와이드 이미지 (WIDE_MESSAGE): 홍보문구 와이드 리스트 (WIDE_LIST_MESSAGE): 타이틀 CAROUSEL_COMMERCE_MESSAGE(캐러셀커머스): 인트로 카드의 홍보타이틀
description	String	캐러셀 커머스형 인트로 카드 홍보문구
image	Image	이미지 소재 기본 텍스트 (BASIC_TEXT_MESSAGE) 유형과 CAROUSEL_COMMERCE_MESSAGE(캐러셀커머스) 유형 인트로 카드에 응답됨
video	Video	카카오 TV 동영상 소재 기본 텍스트 (BASIC_TEXT_MESSAGE), 프리미엄동영상 (PREMIUM_VIDEO_MESSAGE) 유형에만 응답됨
buttonAssetGroups	ButtonAssetGroup	버튼 항목
itemAssetGroups	ItemAssetGroup	리스트 항목, 아래 유형에 응답됨 와이드 이미지(WIDE_MESSAGE) 혹은 와이드 리스트(WIDE_LIST_MESSAGE) CAROUSEL_COMMERCE_MESSAGE(캐러셀커머스) CAROUSEL_FEED_MESSAGE(캐러셀 피드)
thumbnailUrl	String	썸네일 이미지 URL
csInfo	String	고객센터 전화번호
couponBookAssetGroups	CouponBookAssetGroup	쿠폰북 항목
createdDate	String	메시지 소재 생성일 yyyy-MM-dd'T'HH:mm:ss 형식
lastModifiedDate	String	메시지 소재 마지막 수정일 yyyy-MM-dd'T'HH:mm:ss 형식
hasIntro	Boolean	캐러셀 커머스 인트로 카드 유무
introLandingType	String	캐러셀 커머스 인트로 카드 랜딩 타입
introMobileLandingUrl	String	캐러셀 커머스 인트로 카드 모바일 랜딩 URL
introPcLandingUrl	String	캐러셀 커머스 인트로 카드 pc 랜딩 URL

MessageSendingInfo

이름	타입	설명
contractCount	Integer	구매발송수 예상 발송 모수보다 작게 설정할 수 없음
longTerm	Boolean	전체발송 후 새 친구에게도 보내기 보내기(true), 보내지 않기(false) 중 하나 보내기로 설정한 경우 schedule 항목의 beginDate(시작일), beginTime(시작시간), endDate(종료일), endTime(종료시간)을 필수로 전달
price	Long	발송단가
pushAlarm	Boolean	푸시알림 보내지 않기 보내지 않기(true), 보내기(false) 중 하나
sendRate	Integer	분산발송 하기 분산발송 하기 (100, 500, 1000, 1500, 2000), 분산발송 하지 않기 (0) 중 하나
status	String	메시지 발송 상태 READY (발송 대기), SENDING(발송중), PAUSE(발송중지), FINISHED(발송완료), STOPPED(즉시종료), EXPIRED(기간만료), SAVE(저장) 중 하나
syncStatus	String	발송시스템과의 연동 상태 READY(연동 대기), SUCCESS(연동 성공), FAILED(연동 실패) 중 하나
ageVerification	Boolean	연령인증 메시지 여부 true: 연령인증 메시지 false: 일반 메시지
startedAT	String	발송 시작 시간
finishedAT	String	발송 완료 시간

MetricsGroup (Enum)

값	설명	코드
BASIC	기본지표 - 노출수 - 클릭수 - 클릭률 - 비용 - 재생수 - 재생률	- imp - click - ctr - cost - video_play_3s - vtr
ADDITION	추가지표 - 도달수 - 노출당 비용 - 클릭당 비용 - 도달당 비용 - 재생당비용	- reach - cost_per_imp - cost_per_click - cost_per_reach - cost_per_video_play_3s
MESSAGE	메시지 기본지표 - 발송 수 - 열람수 - 전체 클릭수 - 비용 - 발송 실패수	- msg_send - msg_open - msg_click - cost - msg_send_fail
MESSAGE_ADDITION	메시지 추가지표 - 발송당 비용 - 열람당 비용 - 전체 클릭당 비용	- cost_per_msg_send - cost_per_msg_open - cost_per_msg_click
PIXEL_SDK_CONVERSION	픽셀 & SDK 전환 지표 - 가입 완료 (1일) - 가입 완료 (7일) - 장바구니 보기 (1일) - 장바구니 보기 (7일) - 구매 (1일) - 구매 (7일) - 구매 금액 (1일) - 구매 금액 (7일) - ROAS (1일) - ROAS (7일) - 추정 ROAS (1일) - 추정 ROAS (7일) - 잠재 고객 (1일) - 잠재 고객 (7일) - 서비스 신청 (1일) - 서비스 신청 (7일) - 앱 설치 (1일) - 앱 설치 (7일) - 회원 가입당 비용 (1일) - 회원 가입당 비용 (7일) - 회원 가입률 (1일) - 회원 가입률 (7일) - 관심상품추가 (1일) - 관심상품추가당 비용 (1일) - 관심상품추가율 (1일) - 관심상품추가 (7일) - 관심상품추가당 비용 (7일) - 관심상품추가율 (7일) - 장바구니추가(1일) - 장바구니추가당 비용(1일) - 장바구니추가율(1일) - 장바구니추가(7일) - 장바구니추가당 비용(7일) - 장바구니추가율(7일) - 장바구니 열람당 비용 (1일) - 장바구니 열람당 비용 (7일) - 장바구니 열람률 (1일) - 장바구니 열람률 (7일) - 구매당 비용 (1일) - 구매당 비용 (7일) - 구매율 (1일) - 구매율 (7일) - 잠재 고객당 비용 (1일) - 잠재 고객당 비용 (7일) - 잠재 고객률 (1일) - 잠재 고객률 (7일) - 서비스 신청당 비용 (1일) - 서비스 신청당 비용 (7일) - 서비스 신청률 (1일) - 서비스 신청률 (7일) - 앱 설치당 비용 (1일) - 앱 설치당 비용 (7일) - 앱 설치율 (1일) - 앱 설치율 (7일)	- 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_purchase_p_per_cost_1d - conv_purchase_p_per_cost_7d - conv_estimated_purchase_p_per_cost_1d - conv_estimated_purchase_p_per_cost_7d - conv_participation_1d - conv_participation_7d - conv_signup_1d - conv_signup_7d - conv_app_install_1d - conv_app_install_7d - cost_per_conv_cmpt_reg_1d - cost_per_conv_cmpt_reg_7d - conv_cmpt_reg_1d_rate - conv_cmpt_reg_7d_rate - conv_add_to_wishlist_1d - cost_per_conv_add_to_wishlist_1d - conv_add_to_wishlist_1d_rate - conv_add_to_wishlist_7d - cost_per_conv_add_to_wishlist_7d - conv_add_to_wishlist_7d_rate - conv_add_to_cart_1d - cost_per_conv_add_to_cart_1d - conv_add_to_cart_1d_rate - conv_add_to_cart_7d - cost_per_conv_add_to_cart_7d - conv_add_to_cart_7d_rate - cost_per_conv_view_cart_1d - cost_per_conv_view_cart_7d - conv_view_cart_1d_rate - conv_view_cart_7d_rate - cost_per_conv_purchase_1d - cost_per_conv_purchase_7d - conv_purchase_1d_rate - conv_purchase_7d_rate - cost_per_conv_participation_1d - cost_per_conv_participation_7d - conv_participation_1d_rate - conv_participation_7d_rate - cost_per_conv_signup_1d - cost_per_conv_signup_7d - conv_signup_1d_rate - conv_signup_7d_rate - cost_per_conv_app_install_1d - cost_per_conv_app_install_7d - conv_app_install_1d_rate - conv_app_install_7d_rate
PLUS_FRIEND	카카오친구 지표 - 친구 추가수 (1일) - 친구 추가수 (7일) - 친구 추가 수당 비용 (1일) - 친구 추가 수당 비용 (7일) - 친구 추가율 (1일) - 친구 추가율 (7일)	- conv_kf_pf_add_1d - conv_kf_pf_add_7d - cost_per_conv_kf_pf_add_1d - cost_per_conv_kf_pf_add_7d - conv_kf_pf_add_1d_rate - conv_kf_pf_add_7d_rate
VIDEO	동영상 지표 - 재생수 - 재생당 비용 - 자동 재생수 - 터치 재생수 - 사운드 ON수 - 5초 재생수 - 10초 재생수 - 15초 재생수 - 30초 재생수 - 60초 재생수 - 25% 재생수 - 50% 재생수 - 75% 재생수 - 100% 재생수	- 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	슬라이드 지표 - 슬라이드1 클릭수 - 슬라이드2 클릭수 - 슬라이드3 클릭수 - 슬라이드4 클릭수 - 슬라이드5 클릭수 - 슬라이드6 클릭수 - 슬라이드7 클릭수 - 슬라이드8 클릭수 - 슬라이드9 클릭수 - 슬라이드10 클릭수 - 기타 클릭수	- 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	메시지 클릭지표 - 공유버튼 클릭수 - 이미지/동영상 클릭수 - 타이틀 클릭수 - 텍스트 클릭수 - 동영상 클릭수 - 동영상 3초 재생수 - 동영상 5초 재생수 - 동영상 10초 재생수 - 동영상 15초 재생수 - 동영상 30초 재생수 - 동영상 60초 재생수 - 리스트1 클릭수 - 리스트2 클릭수 - 리스트3 클릭수 - 리스트4 클릭수 - 리스트 1 재생수 - 리스트 1 3초 재생수 - 리스트 1 5초 재생수 - 리스트 1 10초 재생수 - 리스트 1 15초 재생수 - 리스트 1 30초 재생수 - 리스트 1 60초 재생수 - 리스트 2 재생수 - 리스트 2 3초 재생수 - 리스트 2 5초 재생수 - 리스트 2 10초 재생수 - 리스트 2 15초 재생수 - 리스트 2 30초 재생수 - 리스트 2 60초 재생수 - 리스트 3 재생수 - 리스트 3 3초 재생수 - 리스트 3 5초 재생수 - 리스트 3 10초 재생수 - 리스트 3 15초 재생수 - 리스트 3 30초 재생수 - 리스트 3 60초 재생수 - 리스트 4 재생수 - 리스트 4 3초 재생수 - 리스트 4 5초 재생수 - 리스트 4 10초 재생수 - 리스트 4 15초 재생수 - 리스트 4 30초 재생수 - 리스트 4 60초 재생수 - 버튼1 클릭수 - 버튼2 클릭수 - 캐러셀 1 버튼1 클릭수 - 캐러셀 2 버튼1 클릭수 - 캐러셀 3 버튼1 클릭수 - 캐러셀 4 버튼1 클릭수 - 캐러셀 5 버튼1 클릭수 - 캐러셀 6 버튼1 클릭수 - 캐러셀 1 버튼2 클릭수 - 캐러셀 2 버튼2 클릭수 - 캐러셀 3 버튼2 클릭수 - 캐러셀 4 버튼2 클릭수 - 캐러셀 5 버튼2 클릭수 - 캐러셀 6 버튼2 클릭수 - 캐러셀 1 쿠폰 버튼 클릭수 - 캐러셀 2 쿠폰 버튼 클릭수 - 캐러셀 3 쿠폰 버튼 클릭수 - 캐러셀 4 쿠폰 버튼 클릭수 - 캐러셀 5 쿠폰 버튼 클릭수 - 캐러셀 6 쿠폰 버튼 클릭수 - 더보기 클릭수 - 쿠폰 버튼 클릭수 - 기타 클릭수	- 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	애드뷰 지표 - 버튼1 클릭수 - 버튼2 클릭수 - 공유 버튼 클릭수 - 이미지/동영상1 노출수 - 동영상1 자동 재생수 - 동영상1 터치 재생수 - 동영상1 3초 재생수 - 이미지/동영상2 노출수 - 동영상2 자동 재생수 - 동영상2 터치 재생수 - 동영상2 3초 재생수 - 이미지/동영상3 노출수 - 동영상3 자동 재생수 - 동영상3 터치 재생수 - 동영상3 3초 재생수 - 이미지/동영상4 노출수 - 동영상4 자동 재생수 - 동영상4 터치 재생수 - 동영상4 3초 재생수 - 이미지/동영상5 노출수 - 동영상5 자동 재생수 - 동영상5 터치 재생수 - 동영상5 3초 재생수 - 이미지/동영상6 노출수 - 동영상6 자동 재생수 - 동영상6 터치 재생수 - 동영상6 3초 재생수 - 이미지/동영상7 노출수 - 동영상7 자동 재생수 - 동영상7 터치 재생수 - 동영상7 3초 재생수 - 이미지/동영상8 노출수 - 동영상8 자동 재생수 - 동영상8 터치 재생수 - 동영상8 3초 재생수 - 이미지/동영상9 노출수 - 동영상9 자동 재생수 - 동영상9 터치 재생수 - 동영상9 3초 재생수 - 이미지/동영상10 노출수 - 동영상10 자동 재생수 - 동영상10 터치 재생수 - 동영상10 3초 재생수	- ADV_CLICK_BUTTON1 - ADV_CLICK_BUTTON2 - ADV_CLICK_BUTTON_SHARE - ADV_TH1_VIEW - ADV_TH1_VIDEO_PLAY_AUTO - ADV_TH1_VIDEO_PLAY_TOUCH - ADV_TH1_VIDEO_PLAY_3S - ADV_TH2_VIEW - ADV_TH2_VIDEO_PLAY_AUTO - ADV_TH2_VIDEO_PLAY_TOUCH - ADV_TH2_VIDEO_PLAY_3S - ADV_TH3_VIEW - ADV_TH3_VIDEO_PLAY_AUTO - ADV_TH3_VIDEO_PLAY_TOUCH - ADV_TH3_VIDEO_PLAY_3S - ADV_TH4_VIEW - ADV_TH4_VIDEO_PLAY_AUTO - ADV_TH4_VIDEO_PLAY_TOUCH - ADV_TH4_VIDEO_PLAY_3S - ADV_TH5_VIEW - ADV_TH5_VIDEO_PLAY_AUTO - ADV_TH5_VIDEO_PLAY_TOUCH - ADV_TH5_VIDEO_PLAY_3S - ADV_TH6_VIEW - ADV_TH6_VIDEO_PLAY_AUTO - ADV_TH6_VIDEO_PLAY_TOUCH - ADV_TH6_VIDEO_PLAY_3S - ADV_TH7_VIEW - ADV_TH7_VIDEO_PLAY_AUTO - ADV_TH7_VIDEO_PLAY_TOUCH - ADV_TH7_VIDEO_PLAY_3S - ADV_TH8_VIEW - ADV_TH8_VIDEO_PLAY_AUTO - ADV_TH8_VIDEO_PLAY_TOUCH - ADV_TH8_VIDEO_PLAY_3S - ADV_TH9_VIEW - ADV_TH9_VIDEO_PLAY_AUTO - ADV_TH9_VIDEO_PLAY_TOUCH - ADV_TH9_VIDEO_PLAY_3S - ADV_TH10_VIEW - ADV_TH10_VIDEO_PLAY_AUTO - ADV_TH10_VIDEO_PLAY_TOUCH - ADV_TH10_VIDEO_PLAY_3S
BIZ_BOARD	비즈보드 지표 - 노출수 (확장) - 동영상 자동 재생수 (모션) - 동영상 자동 재생수 (확장) - 동영상 3초 재생수 (모션) - 동영상 3초 재생수 (확장) - 행동유도 클릭수 (확장) - 이미지 클릭수 (확장) - 이미지1 노출수 (확장) - 이미지2 노출수 (확장) - 이미지3 노출수 (확장) - 이미지4 노출수 (확장) - 이미지5 노출수 (확장) - 이미지1 클릭수 (확장) - 이미지2 클릭수 (확장) - 이미지3 클릭수 (확장) - 이미지4 클릭수 (확장) - 이미지5 클릭수 (확장)	- EXPANDABLE_IMP - MOTION_VIDEO_PLAY_AUTO - EXPANDABLE_VIDEO_PLAY_AUTO - MOTION_VIDEO_PLAY_3S - EXPANDABLE_VIDEO_PLAY_3S - EXPANDABLE_CLICK_CTA - EXPANDABLE_CLICK_IMAGE1 - EXPANDABLE_VIEWABLE_GOODS_1 - EXPANDABLE_VIEWABLE_GOODS_2 - EXPANDABLE_VIEWABLE_GOODS_3 - EXPANDABLE_VIEWABLE_GOODS_4 - EXPANDABLE_VIEWABLE_GOODS_5 - EXPANDABLE_CLICK_GOODS_1 - EXPANDABLE_CLICK_GOODS_2 - EXPANDABLE_CLICK_GOODS_3 - EXPANDABLE_CLICK_GOODS_4 - EXPANDABLE_CLICK_GOODS_5
SPB	보드 지표 - 채널 홈 클릭수 - 채널 추가 클릭수 - 아티클1 클릭수 - 아티클2 클릭수 - 아티클3 클릭수 - 아티클4 클릭수 - 아티클5 클릭수 - 아티클6 클릭수 - 아티클7 클릭수 - 아티클8 클릭수 - 아티클9 클릭수 - 아티클10 클릭수	- channel_home_click - channel_add_click - article1_click - article2_click - article3_click - article4_click - article5_click - article6_click - article7_click - article8_click - article9_click - article10_click
MESSAGE_ADDITION	- 열람률 - 메시지 클릭률	- msg_open_rate - msg_click_rate
TRIGGER	전면형 유도 지표 - 유도 영역 노출수	- trigger_viewable

O

Objective

이름	설명
type	ObjectiveType 참고
value	광고목표설정의 번호 ObjectiveType이 TALK_CHANNEL인 경우 카카오톡 채널 프로필 목록 보기 API를 통해 조회한 id 값 ObjectiveType 이 PIXEL_AND_SDK 인 경우 '픽셀&SDK 목록 보기'의 조회된 ID 값
detailType	ObjectiveDetailType

ObjectiveType

값	설명
TALK_CHANNEL	카카오톡채널
PIXEL_AND_SDK	픽셀&SDK

ObjectiveDetailType

값	설명
PURCHASE	구매
APP_INSTALL	앱설치
COMPLETE_REGISTRATION	회원가입
SIGN_UP	서비스신청
CART	장바구니
PARTICIPATION	잠재고객
ADD_FRIEND	채널 친구 추가 비고: ObjectiveType이 TALK_CHANNEL일 경우 응답에서만 받을 수 있는 값으로, 해당 값으로 요청은 불가

Operation

이름	타입	설명
ONLY	String	ONLY
AND	String	AND
MINUS	String	MINUS
OR	String	OR

OpinionFile

이름	타입	설명
id	Long	의견증빙 파일 번호
originalFileName	String	업로드 시 파일 이름
downloadUrl	String	의견증빙 파일 URL

OptimizationStatus

값	설명
LEVEL_1	1단계 제한된 머신러닝
LEVEL_2	2단계 기본 머신러닝
LEVEL_3	3단계 심화된 머신러닝
LEVEL_4	4단계 최적의 머신러닝
INVALID	조회 불가
READY	학습 대기
null	값 없음 전환 목적이 아닌 경우 상태 값이 없음

P

Pacing

값	설명
NONE	설정 해제
QUICK	빠른 게재 가능한 한 빨리 광고 결과를 얻을 수 있도록 예산을 최대한 사용하여 광고 노출을 유도합니다.
NORMAL	일반 게재 일예산을 시간대별로 분할하여 시간대별 분할된 예산만큼 사용할 수 있도록 광고 노출을 제어합니다.

PeriodUnit

값	설명
WEEK	주 단위
MONTH	월 단위

Placement

값	설명
KAKAO_TALK	카카오톡
KAKAO_STORY	카카오스토리
DAUM	다음
KAKAO_SERVICE	카카오 서비스
NETWORK	네트워크

PricingType

값	설명
CPC	Cost per Click 광고를 클릭한 경우에 과금되며, 실시간으로 광고 입찰 경쟁에 참여하여 탄력적인 광고 운영이 가능합니다.
CPM	Cost per Mille 1,000회 노출당 과금되는 방식으로, 노출을 기준으로 입찰 경쟁에 참여가 가능합니다.
CPA	Cost per Action '카카오 친구 늘리기' 광고목적 시 클릭으로부터 24시간 이내 발생한 전환(친구추가)에 대해서 과금되는 방식입니다.

R

RejectedReason

이름	타입	설명
rejectedTitle	String	심사 보류사유 제목
rejectedContent	String	심사 보류사유 내용

S

Schedule

이름	타입	설명
beginDate	String	시작 날짜 오늘이거나 또는 오늘 날짜 이후로 설정 형식 : yyyy-MM-dd
endDate	String	종료 날짜 시작 날짜와 같거나 또는 그 이후로 설정 형식 : yyyy-MM-dd
lateNight	Boolean	심야 타게팅
detailTime	Boolean	상세 시간 설정 여부 lateNight(심야타게팅)이 true이고, 해당 값을 false로 요청할 경우 기본값으로 설정됨(22:00 ~ 06:59)
mondayTime	String[]	월요일 상세 시간 설정 1 : 노출 설정 0 : 비노출 설정 24시간이 1, 0으로 이루어진 배열로 배열 크기는 24 예) ["1","1", "0",....] detailTime(상세 시간 설정 여부)가 true인 경우엔 필수로 요청되어야 함
tuesdayTime	String[]	화요일 상세 시간 설정 1 : 노출 설정 0 : 비노출 설정 24시간이 1, 0으로 이루어진 배열로 배열 크기는 24 예) ["1","1", "0",....] detailTime(상세 시간 설정 여부)가 true인 경우엔 필수로 요청되어야 함
wednesdayTime	String[]	수요일 상세 시간 설정 1 : 노출 설정 0 : 비노출 설정 24시간이 1, 0으로 이루어진 배열로 배열 크기는 24 예) ["1","1", "0",....] detailTime(상세 시간 설정 여부)가 true인 경우엔 필수로 요청되어야 함
thursdayTime	String[]	목요일 상세 시간 설정 1 : 노출 설정 0 : 비노출 설정 24시간이 1, 0으로 이루어진 배열로 배열 크기는 24 예) ["1","1", "0",....] detailTime(상세 시간 설정 여부)가 true인 경우엔 필수로 요청되어야 함
fridayTime	String[]	금요일 상세 시간 설정 1 : 노출 설정 0 : 비노출 설정 24시간이 1, 0으로 이루어진 배열로 배열 크기는 24 예) ["1","1", "0",....] detailTime(상세 시간 설정 여부)가 true인 경우엔 필수로 요청되어야 함
saturdayTime	String[]	토요일 상세 시간 설정 1 : 노출 설정 0 : 비노출 설정 24시간이 1, 0으로 이루어진 배열로 배열 크기는 24 예) ["1","1", "0",....] detailTime(상세 시간 설정 여부)가 true인 경우엔 필수로 요청되어야 함
sundaytime	String[]	일요일 상세 시간 설정 1 : 노출 설정 0 : 비노출 설정 24시간이 1, 0으로 이루어진 배열로 배열 크기는 24 예) ["1","1", "0",....] detailTime(상세 시간 설정 여부)가 true인 경우엔 필수로 요청되어야 함

Schedule

이름	타입	설명	필수
detailTime	Boolean	상세 시간 설정 여부	O
beginDate	String	시작일	O
beginTime	String	시작시간	X
endDate	String	종료일	X
endTime	String	종료시간	X
mondayTime	String[]	월요일 집행 시간	X
tuesdayTime	String[]	화요일 집행 시간	X
wednesdayTime	String[]	수요일 집행 시간	X
thursdayTime	String[]	목요일 집행 시간	X
fridayTime	String[]	금요일 집행 시간	X
saturdayTime	String[]	토요일 집행 시간	X
sundayTime	String[]	일요일 집행 시간	X
lateNight	Boolean	심야타게팅 여부	O
periodUnit	PeriodUnit	주/월 구분	X

Status: 캠페인

값	설명
READY	집행 예정
LIVE	집행 중
FINISHED	집행 완료
OFF	사용자OFF
DELETED	삭제
EXCEED_DAILY_BUDGET	캠페인 일 예산 초과
PAUSED	일시중지
NO_AVAILABLE_CREATIVE	집행 가능한 소재가 없음
CANCELED	계약해지
SYSTEM_CONFIG_EXTERNAL_SERVICE_STOP	연결 서비스 제한으로 운영불가인 상태
ADACCOUNT_UNAVAILABLE	광고계정 운영불가

Status: 광고그룹

값	설명
READY	집행 예정
LIVE	집행 중
FINISHED	집행 완료
OFF	사용자OFF
DELETED	삭제
EXCEED_DAILY_BUDGET	광고 그룹 일 예산 초과
PAUSED	일시중지
NO_AVAILABLE_CREATIVE	집행 가능한 소재가 없음
CANCELED	계약해지
CAMPAIGN_UNAVAILABLE	캠페인 운영불가
SYSTEM_CONFIG_ADMIN_STOP	관리자 정지

Status: 소재

소재의 운영 상태	메시지 소재 가능 여부	설명
OPERATING(운영가능)	가능	운영가능 상태
UNAPPROVED(심사미승인)	불가능	심사승인이 아닌 상태(심사중, 심사보류를 모두 포함)
INVALID_DATE(기간오류)	가능	집행기간이 도래하지 않았거나 이미 지난 상태
MONITORING_REJECTED(모니터링 보류)	불가능	관리자정지 상태
MONITORING_REJECTED(관리자정지)	불가능	관리자정지 상태
OFF(사용자OFF)	가능	사용자 OFF 상태
DELETED(삭제)	가능	삭제된 상태
ADGROUP_UNAVAILABLE(광고그룹 운영불가)	가능	광고 상위단위인 광고그룹이 운영불가인 상태
SYSTEM_CONFIG_VOID(운영불가 콘텐츠오류)	불가능	소재 콘텐츠 오류로 소재 운영불가인 상태
SYSTEM_CONFIG_VOID(운영불가 콘텐츠오류)	불가능	소재 콘텐츠 오류로 소재 운영불가인 상태

statusDescription: 캠페인

캠페인의 게재와 관련된 현재 상태	캠페인 상태	일 예산 초과 여부
운영중	ON	false
일 예산 초과	ON	true
사용자 OFF	OFF	false
사용자 OFF, 일 예산 초과	OFF	true
삭제됨	DEL	-

statusDescription: 소재 심사 상태

광고 소재의 게재와 관련된 현재 상태	원 소재 심사 상태	소재 상태	수정 소재 심사 상태
운영중	APPROVED	ON	심사승인
운영중(수정사항 심사중)	MODIFICATION_WAITING	ON	심사승인
운영중(수정사항 심사보류)	MODIFICATION_REJECTED	ON	심사승인
심사중	WAITING	ON	심사중
심사보류	REJECTED	ON	심사보류
관리자정지	REJECTED	ON	관리자정지
관리자정지(수정사항 심사중)	MODIFICATION_WAITING	ON	관리자정지
관리자정지(수정사항 심사보류)	MODIFICATION_REJECTED	ON	관리자정지
사용자OFF	APPROVED	OFF	심사승인
사용자OFF, 수정사항 심사중	MODIFICATION_WAITING	OFF	심사승인
사용자OFF, 수정사항 심사보류	MODIFICATION_REJECTED	OFF	심사승인
사용자OFF, 심사중	WAITING	OFF	심사중
사용자OFF, 심사보류	REJECTED	OFF	심사보류
사용자OFF, 관리자정지	REJECTED	OFF	관리자정지
사용자OFF, 관리자정지(수정사항 심사중)	MODIFICATION_WAITING	OFF	관리자정지
사용자OFF, 관리자정지(수정사항 심사보류)	MODIFICATION_REJECTED	OFF	관리자정지
삭제됨	-	DEL	-

statusDescription: 디스플레이 광고그룹

디스플레이 광고그룹의 게재와 관련된 현재 상태	광고그룹 상태	일예산초과 여부	집행기간 유효 여부
운영중	ON	false	true
일예산초과	ON	true	true
기간외	ON	false	false
일예산초과, 기간외	ON	true	false
사용자OFF	OFF	false	true
사용자OFF, 일예산초과	OFF	true	true
사용자OFF, 기간외	OFF	false	false
사용자OFF, 일예산초과, 기간외	OFF	true	false
삭제됨	DEL	-	-

SyncAppTargeting

이름	타입	설명
profileId	String	카카오톡 채널 프로필 ID
inclusionType	String	포함여부 INCLUDE(포함), EXCLUDE(제외) 중 하나

SystemConfig

값	설명
ON	활성화
VOID	운영불가 (시스템 무효처리)
ADMIN_STOP	관리자정지
EXTERNAL_SERVICE_STOP	연결 서비스 제한

T

TalkChannelGroupTargeting

이름	타입	설명
id	Long	친구그룹 ID
talkChannelGroupFileId	Long	친구그룹 파일 ID
name	String	친구그룹 이름
inclusionType	String	포함 여부 INCLUDE(포함), EXCLUDE(제외) 중 하나
fileType	String	친구그룹 유형 다음 중 하나 APP_USER_ID(앱유저아이디) PHONE_NUMBER(전화번호) MESSAGE_RETARGET(메시지 발송 대상자)
groupKey	String	친구그룹 파일의 그룹 키

TalkChannelTargeting

이름	타입	설명
id	Long	카카오톡 채널 타게팅 번호
name	String	카카오톡 채널 타게팅 이름
inclusionType	InclusionType	포함 여부
profileId	Integer	인코딩된 프로필 아이디
profileName	String	프로필 이름

Targeting

이름	타입	설명
id	Long	오디언스 번호 일반 타겟팅 설정 시 id 제공되지 않음
name	String	오디언스명 일반 타겟팅 설정 시 name 제공되지 않음
type	String	오디언스 사용여부 NORMAL(일반 타겟팅 설정), DISPLAY(디스플레이 오디언스 관리기능 설정), MESSAGE(메시지 오디언스 관리기능 설정) 중 하나
ageType	String	연령대 전체 선택 종류 ALL(전체), NOT_ALL(부분 선택) 중 하나
ages	Set of String	연령대
genderType	String	성별 전체 선택 종류 ALL(전체), NOT_ALL(부분 선택) 중 하나
genders	Set of String	성별
locations	Set of Location	시/도 시/도 보기 참고
depth2Locations	Set of Location	시/군/구 시/군/구 보기 참고
depth3Locations	Set of Location	데모그래픽 > 행정구역 > 동/읍/면 동/읍/면 보기 참고 locationType(AREA)로 요청한 경우 locations(시/도) 타게팅, depth2Locations(시/군/구) 타게팅, depth3Locations(동/읍/면) 타게팅 중 하나는 요청해야 함 행정구역 타게팅 세 가지 함께 요청 가능
ufoInterests	EnumSet of UfoInterest	관심사 타게팅 맞춤타겟 카테고리 타입 보기 참고
ufoBusinessTypes	EnumSet of UfoBusinessType	업종 타게팅 맞춤타겟 카테고리 타입 보기 참고
talkChannelTargetings	Set of TalkChannelTargeting	카카오톡 채널 타게팅
syncAppTargetings	Set of SyncAppTargeting	카카오 로그인 이용자 타게팅
customerFileTargetings	Set of CustomerFileTargeting	고객파일 타게팅
cohortTargetings	Set of CohortTargeting	광고반응 타게팅
trackerTargetings	Set of TrackerTargeting	픽셀&SDK 타게팅
talkChannelGroupTargeting	Set of TalkChannelGroupTargeting	친구그룹 타게팅

Thumbnail

이름	타입	설명
fileSize	Long	파일 사이즈
url	String	대표 썸네일 이미지 URL
fileName	String	대표 썸네일 파일명
imageWidth	Integer	넓이
imageHeight	Integer	높이
mimeType	String	Mime 유형

TimeUnit

값	설명
DAY	일

보고서 집계단위	조회할 수 있는 최대 기간
DAY	최대 1개월

TrackerTargeting

이름	타입	설명
id	Long	트래커 번호
inclusionType	InclusionType	포함 여부
trackId	String	트래커 ID
eventCode	String	이벤트 코드
trackRuleId	String	트래커 룰 번호
trackRuleName	String	트래커 룰 이름
term	Integer	타겟 기간(최소: 1, 최대: 180)

TrackRule

이름	타입	설명
trackRuleId	String	트래커 정보 아이디
trackId	String	트래커 아이디
eventCode	String	이벤트 코드
name	String	트래커 정보 이름
ruleSetStr	String[]	룰셋 정의

U

UfoBusinessType

이름	타입	설명
value	String	업종 키(Key) 업종 상세 정보 참고

UfoInterest

이름	타입	설명
value	String	관심사 키(Key) 관심사 상세 정보 참고

V

Video: 디스플레이 소재

이름	타입	설명
url	String	비디오 소재 URL

Video: 메시지 소재

이름	타입	설명
vid	String	고유한 카카오TV 동영상 ID
name	String	카카오TV 동영상명
previewImage	String	이미지 보기 이미지 URL
thumbnail	String	썸네일 URL
duration	Double	재생 시간
clipId	String	Mime 유형
clipLinkId	Long	클립 링크 ID
liveLinkId	Long	라이브 링크 ID
CHANNEL_ID	Long	채널 ID
channelName	String	채널명
isVertical	Boolean	세로 여부
videoType	String	동영상 유형 UPLOAD, PREUPLOAD, LINK, NONE 중 하나
isOwner	Boolean	소유자 여부

VideoInfo

이름	타입	설명
vid	String	카카오 TV 비디오 ID
name	String	카카오 TV 비디오 이름
duration	Integer	카카오 TV 비디오 재생시간
clipId	Long	카카오 TV 비디오 클립 ID
clipLinkId	Long	카카오 TV 비디오 클립 링크 ID
liveLinkId	Long	카카오 TV 라이브 링크 ID
channelName	String	카카오 TV 채널 이름
videoType	String	비디오 타입 UPLOAD(업로드된 동영상), PREUPLOAD(불러오기된 동영상), LINK(링크된 동영상) 중 하나