카카오모먼트 API 레퍼런스
이 문서는 카카오모먼트 API 목록 및 응답 정보를 제공합니다.
API 목록
- Host:
apis.moment.kakao.com
광고 생성: 광고계정
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/adAccounts/pages |
GET |
광고계정 목록 조회 |
|
/openapi/v4/adAccounts/${AD_ACCOUNT_ID} |
GET |
광고계정 조회 |
|
/openapi/v4/adAccounts/balance |
GET |
실시간 잔액 조회 |
|
/openapi/v4/adAccounts/bizRight |
GET |
영업권 조회 |
|
/openapi/v4/adAccounts/channel/profiles |
GET |
카카오톡 채널 프로필 목록 조회 |
|
/openapi/v4/adAccounts/trackers |
GET |
픽셀 & SDK 목록 조회 |
|
/openapi/v4/adAccounts |
POST |
광고계정 생성 |
1초당 1회 |
/openapi/v4/adAccounts/onOff |
PUT |
광고계정 상태 변경 |
1초당 1회 |
광고 생성: 캠페인
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/campaigns |
GET |
캠페인 목록 조회 |
|
/openapi/v4/campaigns/${ID} |
GET |
캠페인 조회 |
|
/openapi/v4/campaigns |
POST |
캠페인 생성 |
|
/openapi/v4/campaigns |
PUT |
캠페인 수정 |
|
/openapi/v4/campaigns/dailyBudgetAmount |
PUT |
일 예산 수정 |
1초당 1회 |
/openapi/v4/campaigns/onOff |
PUT |
캠페인 상태 변경 |
1초당 1회 |
/openapi/v4/campaigns/${ID} |
DELETE |
캠페인 삭제 |
|
/openapi/v4/campaigns/${ID}/latestSystemConfigHistory |
GET |
캠페인 시스템 정지 사유 조회 |
|
/openapi/v4/campaigns/${ID}/systemConfigHistories |
GET |
캠페인 시스템 정지 사유 목록 조회 |
|
광고 생성: 광고그룹
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/adGroups |
GET |
광고그룹 목록 조회 |
|
/openapi/v4/adGroups/${ID} |
GET |
광고그룹 조회 |
|
/openapi/v4/adGroups |
POST |
디스플레이 광고그룹 생성 |
5초당 1회 |
/openapi/v4/adGroups |
PUT |
디스플레이 광고그룹 수정 |
5초당 1회 |
/openapi/v4/adGroups/dailyBudgetAmount |
PUT |
디스플레이 광고그룹 일 예산 수정 |
1초당 1회 |
/openapi/v4/adGroups/bidAmount |
PUT |
디스플레이 광고그룹 최대 입찰금액 수정 |
1초당 1회 |
/openapi/v4/adGroups/pacing |
PUT |
디스플레이 광고그룹 게재 방식 수정 |
1초당 1회 |
/openapi/v4/adGroups |
POST |
메시지 광고그룹 생성 |
5초당 1회 |
/openapi/v4/adGroups |
PUT |
메시지 광고그룹 수정 |
5초당 1회 |
/openapi/v4/targetings/populationScore |
POST |
메시지 광고그룹 예상 모수 조회 |
|
/openapi/v4/adGroups/cancel/${ID} |
PUT |
메시지 광고그룹 계약 해지 |
|
/openapi/v4/adGroups |
POST |
개인화 메시지 광고그룹 생성 |
5초당 1회 |
/openapi/v4/adGroups |
PUT |
개인화 메시지 광고그룹 수정 |
5초당 1회 |
/openapi/v4/adGroups/onOff |
PUT |
광고그룹 상태 변경 |
1초당 1회 |
/openapi/v4/adGroups/${ID} |
DELETE |
광고그룹 삭제 |
|
/openapi/v4/adGroups/${ID}/latestSystemConfigHistory |
GET |
광고그룹 시스템 정지 사유 조회 |
|
/openapi/v4/adGroups/${ID}/systemConfigHistories |
GET |
광고그룹 시스템 정지 사유 목록 조회 |
|
광고그룹 타겟 조회
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/targetings/location/depth1 |
GET |
시/도 조회 |
|
/openapi/v4/targetings/location/depth2 |
GET |
시/군/구 조회 |
|
/openapi/v4/targetings/location/depth3 |
GET |
동/읍/면 조회 |
|
/openapi/v4/targetings/placement/adServingCategories |
GET |
네트워크 게재지면 하위 목록 조회 |
|
/openapi/v4/targetings/placement/sectionCategories |
GET |
섹션 카테고리 목록 조회 |
|
/openapi/v4/adGroups/targetings/cohort/availables |
GET |
타게팅 가능한 광고반응타겟 조회 |
|
/openapi/v4/adGroups/targetings/trackers/eventCreatables/${TRACK_ID} |
GET |
타게팅 가능한 픽셀 & SDK 이벤트 조회 |
|
/openapi/v4/adGroups/targetings/customerFiles/availables |
GET |
타게팅 가능한 고객파일 목록 조회 |
|
/openapi/v4/adGroups/targetings/talkChannelGroupFiles/availables |
GET |
타게팅 가능한 친구그룹 목록 조회 |
|
/openapi/v4/adGroups/targetings/talkChannels/availables |
GET |
타게팅 가능한 카카오톡 채널 정보 목록 조회 |
|
/openapi/v4/adGroups/targetings/syncProfiles/availables |
GET |
타게팅 가능한 카카오 로그인 이용자 목록 조회 |
|
광고그룹 맞춤타겟 조회
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/targetings/data/categories?type=INTEREST |
GET |
맞춤타겟 카테고리 타입 조회 |
|
/openapi/v4/targetings/location/map |
GET |
맞춤타겟 모먼트 타게팅 조회 |
|
광고 생성: 소재
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/creatives |
GET |
소재 목록 조회 |
|
/openapi/v4/creatives/${ID} |
GET |
소재 조회 |
|
/openapi/v4/creatives |
POST |
디스플레이 소재 생성 |
1초당 1회 |
/openapi/v4/creatives |
PUT |
디스플레이 소재 수정 |
1초당 1회 |
/openapi/v4/creatives/copy |
POST |
디스플레이 소재 복사 |
5초당 1회 |
/openapi/v4/creatives/${ID}/opinionProof |
GET |
디스플레이 소재 의견증빙 조회 |
|
/openapi/v4/creatives |
POST |
메시지 소재 생성 |
1초당 1회 |
/openapi/v4/creatives |
PUT |
메시지 소재 수정 |
1초당 1회 |
/openapi/v4/creatives/copy |
POST |
메시지 소재 복사 |
5초당 1회 |
/openapi/v4/creatives |
POST |
개인화 메시지 소재 템플릿 생성 |
1초당 1회 |
/openapi/v4/creatives |
PUT |
개인화 메시지 소재 템플릿 수정 |
1초당 1회 |
/openapi/v4/creatives/onOff |
PUT |
소재 상태 변경 |
1초당 1회 |
/openapi/v4/creatives/${ID} |
DELETE |
소재 삭제 |
|
/openapi/v4/creatives/${ID}/systemConfigHistory |
GET |
시스템 정지 사유 조회 |
|
/openapi/v4/creatives/${ID}/systemConfigHistories |
GET |
시스템 정지 사유 목록 조회 |
|
비즈보드 랜딩 유형 조회
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/creatives/landing/talkBizForms |
GET |
비즈니스폼 랜딩 유형 목록 조회 |
|
/openapi/v4/creatives/landing/adViews |
GET |
애드뷰 랜딩 유형 목록 조회 |
|
/openapi/v4/creatives/landing/channelPosts/${PROFILE_ID} |
GET |
채널 소식 랜딩 유형 목록 조회 |
|
보고서
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/adAccounts/report |
GET |
광고계정 보고서 조회 |
5초당 1회 |
/openapi/v4/campaigns/report |
GET |
캠페인 보고서 조회 |
5초당 1회 |
/openapi/v4/adGroups/report |
GET |
광고그룹 보고서 조회 |
1초당 1회 |
/openapi/v4/creatives/report |
GET |
소재 보고서 조회 |
5초당 1회 |
메시지 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/messages/kakaotv/channels |
GET |
카카오TV 채널 목록 조회 |
|
/openapi/v4/messages/kakaotv/channels/${ID} |
GET |
카카오TV 채널 상세 조회 |
|
/openapi/v4/messages/kakaotv/channels/${ID}/clipLinks |
GET |
카카오TV 채널 영상 목록 조회 |
|
/openapi/v4/messages/kakaotv/channels/${CHANNEL_ID}/clipLinks/${CLIP_LINK_ID} |
GET |
카카오TV 채널 영상 상세 조회 |
|
/openapi/v4/messages/coupons |
GET |
메시지 버튼 쿠폰 목록 조회 |
|
/openapi/v4/messages/coupons/${ID} |
GET |
메시지 버튼 쿠폰 상세 조회 |
|
/openapi/v4/messages/adViews |
GET |
메시지 버튼 애드뷰 목록 조회 |
|
/openapi/v4/messages/posts/${PROFILE_ID} |
GET |
메시지 버튼 소식 목록 조회 |
|
/openapi/v4/messages/bizForms |
GET |
메시지 버튼 비즈니스폼 목록 조회 |
|
/openapi/v4/messages/bizForms/${BIZ_FORM_ID} |
GET |
메시지 버튼 비즈니스폼 상세 조회 |
|
개인화 메시지 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/messages/creatives/${ID}/sendTestPersonalMessage |
POST |
개인화 메시지 테스트 발송 |
1분당 1회 |
/openapi/v4/messages/creatives/1/sendPersonalMessage |
POST |
개인화 메시지 단건 발송 요청 |
|
/openapi/v4/messages/creatives/${ID}/sendPersonalMessages |
POST |
개인화 메시지 다건 발송 요청 |
|
/openapi/v4/messages/creatives/${ID}/statuses/${REQUEST_ID} |
GET |
개인화 메시지 발송 상태 조회 |
|
/openapi/v4/messages/personal/images/upload |
POST |
개인화 메시지 이미지 업로드 |
|
/openapi/v4/messages/personal/videos/register |
POST |
개인화 메시지 비디오 등록 |
|
메시지광고 운영
| URL |
메서드 |
이름 |
제한 |
/openapi/message/v2/message-ads/message |
POST |
메시지광고 저장 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/message |
PATCH |
메시지 수정 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/send-test |
POST |
메시지광고 테스트 발송 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation |
POST |
메시지광고 발송 예약 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation |
GET |
메시지광고 발송 예약 조회 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation |
PATCH |
메시지광고 발송 예약 수정 |
|
/openapi/message/v2/message-ads/sending-reservation/location |
GET |
타게팅 지역 조회 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation/targeting-price |
POST |
타게팅 모수 및 단가 조회 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/finish |
PUT |
메시지광고 종료 |
|
메시지광고 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/message/v2/message-ads |
POST |
메시지광고 목록 조회 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID} |
GET |
메시지광고 조회 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID} |
DELETE |
메시지광고 삭제 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/message |
GET |
메시지 조회 |
|
/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/copy |
POST |
메시지 복사 |
|
/openapi/message/v2/message-ads/reports |
POST |
메시지광고 보고서 조회 |
|
애드뷰 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/adViews |
GET |
애드뷰 목록 조회 |
|
/openapi/v4/adViews/${ID} |
GET |
애드뷰 조회 |
|
/openapi/v4/adViews/${ID} |
DELETE |
애드뷰 삭제 |
|
비즈니스폼 연동 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/talkBizForms/linkages |
GET |
연동된 비즈니스폼 목록 조회 |
|
/openapi/v4/talkBizForms/linkables |
GET |
연동 가능한 비즈니스폼 목록 조회 |
|
/openapi/v4/talkBizForms |
POST |
비즈니스폼 연동 |
|
픽셀 & SDK 연동 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/trackers/rights |
GET |
연동된 픽셀 & SDK 목록 조회 |
5초당 1회 |
/openapi/v4/trackers/rightAvailables |
GET |
연동 가능한 픽셀 & SDK 목록 조회 |
|
/openapi/v4/trackers |
POST |
픽셀 & SDK 연동 |
|
/openapi/v4/trackers/${ID} |
DELETE |
픽셀 & SDK 연동 해제 |
|
오디언스 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/targetings/audiences |
GET |
오디언스 목록 조회 |
|
/openapi/v4/targetings/${ID} |
GET |
오디언스 상세 조회 |
|
/openapi/v4/targetings |
POST |
오디언스 생성 |
|
/openapi/v4/targetings |
PUT |
오디언스 수정 |
|
/openapi/v4/targetings/${ID} |
DELETE |
오디언스 삭제 |
|
/openapi/v4/targetings |
DELETE |
오디언스 여러 개 삭제 |
|
/openapi/v4/targetings/${ID}/adGroups |
GET |
오디언스 사용 현황 조회 |
|
/openapi/v4/targetings/${ID}/unlink?adGroupId=${AD_GROUP_ID} |
PUT |
오디언스 사용 해제 |
|
광고반응타겟 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/targetings/cohort/list |
GET |
광고반응타겟 목록 조회 |
|
/openapi/v4/targetings/cohort/${ID} |
GET |
광고반응타겟 조회 |
|
/openapi/v4/targetings/cohort/creatables |
GET |
광고반응타겟 생성 가능 대상 조회 |
|
/openapi/v4/targetings/cohort |
POST |
광고반응타겟 생성 |
1초당 1회 |
/openapi/v4/targetings/cohort/name |
PUT |
광고반응타겟 이름 수정 |
1초당 1회 |
/openapi/v4/targetings/cohort |
PUT |
광고반응타겟 데이터 수정 |
|
/openapi/v4/targetings/cohort/${ID} |
DELETE |
광고반응타겟 삭제 |
1초당 1회 |
/openapi/v4/targetings/cohort |
DELETE |
광고반응타겟 여러 개 삭제 |
1초당 1회 |
/openapi/v4/targetings/cohort/usages/${ID} |
GET |
사용 현황 조회 |
|
고객파일 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/customerFiles |
GET |
고객파일 목록 조회 |
|
/openapi/v4/customerFiles/${ID} |
GET |
고객파일 상세 조회 |
5초당 1회 |
/openapi/v4/customerFiles |
POST |
고객파일 등록 |
5초당 1회 |
/openapi/v4/customerFiles |
PUT |
고객파일 수정 |
|
/openapi/v4/customerFiles/name |
PUT |
고객파일 이름 수정 |
|
/openapi/v4/customerFiles/${ID} |
DELETE |
고객파일 삭제 |
|
/openapi/v4/customerFiles |
DELETE |
고객파일 여러 개 삭제 |
|
/openapi/v4/customerFiles/usages/${ID} |
GET |
사용 현황 조회 |
|
친구그룹 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/talkChannelGroupFiles |
GET |
친구그룹 목록 조회 |
|
/openapi/v4/talkChannelGroupFiles |
POST |
친구그룹 등록 |
5초당 1회 |
/openapi/v4/talkChannelGroupFiles/name |
PUT |
친구그룹 이름 수정 |
|
/openapi/v4/talkChannelGroupFiles/${ID} |
DELETE |
친구그룹 삭제 |
|
/openapi/v4/talkChannelGroupFiles |
DELETE |
친구그룹 여러 개 삭제 |
|
/openapi/v4/talkChannelGroupFiles/usages/${ID} |
GET |
사용 현황 조회 |
|
광고계정 관리
| URL |
메서드 |
이름 |
제한 |
/openapi/v4/companies |
GET |
사업자 정보 조회 |
|
응답 코드
아래 목록에 없는 에러 코드 정보는 공통 에러 코드와 비즈니스 인증 에러 코드를 참고합니다.
HTTP 상태 코드
| 상태 코드 |
설명 |
참고 |
| 200 |
성공 |
- |
| 400 |
실패 |
일반적인 오류
주로 API에 필요한 필수 파라미터 관련 |
| 401 |
실패 |
인증 오류
주로 사용자 토큰 관련 |
| 403 |
실패 |
권한/퍼미션등의 오류 |
| 429 |
실패 |
사용량 제한(쿼터) 초과 |
| 500 |
실패 |
시스템 오류 |
| 502 |
실패 |
시스템 오류 |
| 503 |
실패 |
서비스 점검중 |
에러 코드
에러 코드를 참고합니다.
