이 문서는 카카오 키워드광고 API를 소개합니다.
카카오 키워드광고 API는 카카오 키워드광고 플랫폼의 광고계정, 캠페인, 광고그룹, 소재, 키워드와 관련된 설정 정보를 API를 통해 조회하고 이와 관련된 성과 지표를 확인할 수 있는 기능을 제공합니다. 또한, 광고계정, 캠페인, 광고그룹, 소재, 키워드에 대한 ON/OFF 및 일예산, 입찰가 등을 변경할 수 있으며 광고를 집행하기 위한 부가적 기능의 이미지, 서류 등의 정보를 등록, 조회할 수 있는 기능을 제공합니다.
프리미엄링크 유형의 API만 제공하며, 톡채널광고 유형은 보고서 API만 제공됩니다.
카카오 키워드광고 API는 비즈 앱으로 전환하고 비즈니스 인증을 도입한 카카오디벨로퍼스 애플리케이션(이하 앱)이라면 별도 권한 신청 없이 카카오 키워드광고 가입 후 사용 가능합니다.
카카오 키워드광고 API는 비즈 앱에서만 사용 가능하며, 각 비즈 앱에서 비즈니스 인증으로 발급받은 비즈니스 토큰과 광고계정번호로 호출할 수 있습니다. 기존 앱이 있는 경우, [내 애플리케이션] > [비즈니스]에서 해당 앱의 비즈 앱 여부를 확인할 수 있습니다. 기존 앱이 없는 경우, 애플리케이션 등록을 참고하여 새로운 비즈 앱을 등록합니다.
광고주와 대행사는 카카오 키워드광고에 가입하여 카카오 키워드광고 API를 사용할 수 있습니다. 각 사용자는 광고계정의 마스터 또는 멤버 권한을 갖고 있어야 합니다. [설정] > [광고계정 관리] > [멤버관리]에서 멤버를 초대하거나 해제할 수 있습니다. 또한 각 사용자의 카카오계정은 본인인증을 받은 상태여야 합니다.
현재 제공되는 카카오 키워드광고 API 목록입니다.
API | 설명 |
---|---|
광고계정 목록 보기 | 조회자가 소속된 광고계정 목록 조회 제공하는 정보: 광고계정 ID, 광고계정 이름, 광고계정 유형, 광고계정 ON/OFF/DEL 상태 |
광고계정 보기 | 광고계정의 상세 내용 조회 제공하는 정보: 광고계정 ID, 광고계정 이름, 광고계정 소유 사업자정보, 광고주 사업자 정보, 광고계정 유형, 광고계정 ON/OFF/DEL 상태, 관리자 정지 여부, 잔액 부족 여부, 게재 상태 |
실시간 잔액 보기 | 광고계정의 잔액 조회 |
영업권 보기 | 광고계정에 연동된 영업권 조회 |
카카오톡 채널 프로필 목록 보기 | 조회자의 카카오계정을 기준으로 카카오 키워드광고에서 활용 가능한 카카오톡 채널 프로필 목록 조회 |
광고계정 생성하기 | 카카오비즈니스 관리자센터에 등록한 사업자 ID를 이용하여 광고계정 생성 사업자 카카오계정만 생성 가능 |
광고계정 상태 바꾸기 | 광고계정의 운영 상태 ON/OFF 수정 |
API | 설명 |
---|---|
비즈채널 목록 보기 | 비즈채널 목록 조회 제공하는 정보: 비즈채널 ID, 웹사이트명, 웹사이트 URL정보, 업종 ID |
비즈채널 보기 | 비즈채널 내용 조회 제공하는 정보: 비즈채널 ID, 웹사이트명, 웹사이트 URL정보, 심사 상태, 검수계정 여부, 카카오톡 채널 정보, 업종 ID |
비즈채널 웹사이트 생성하기 | 비즈채널 하위에 캠페인 생성 설정 가능한 항목: 웹사이트명, 웹사이트 URL정보, 검수계정 정보, 카카오톡 채널 정보, 업종 ID, 심사서류 |
카카오톡 채널 수정하기 | 생성된 비즈채널에 카카오톡 채널 등록, 삭제 |
비즈채널 삭제하기 | 비즈채널 삭제 |
API | 설명 |
---|---|
캠페인 목록 보기 | 광고계정 하위 캠페인 목록 조회 제공하는 정보: 비즈채널 ID, 캠페인 ID, 캠페인 이름, 캠페인 ON/OFF 상태 |
캠페인 보기 | 캠페인 상세 내용 조회 제공하는 정보: 비즈채널 ID, 캠페인 ID, 캠페인 이름, 캠페인 ON/OFF 상태, 운영상태, 전환추적 고유코드, 추적URL 설정상태, 일예산, 일 예산 초과 여부 |
캠페인 생성하기 | 광고계정 하위에 캠페인 생성 설정 가능한 항목: 캠페인 이름, 전환추적 고유코드, 추적URL 설정상태, 일예산 |
캠페인 수정하기 | 생성된 캠페인 수정 수정 가능한 항목: 캠페인 이름, 전환추적 코유코드, 추적URL 설정상태, 일예산 |
캠페인 상태 바꾸기 | 캠페인의 운영 상태 ON/OFF 수정 |
캠페인 일 예산 수정하기 | 캠페인의 일 예산 수정 |
캠페인 삭제하기 | 캠페인 삭제 |
API | 설명 |
---|---|
광고그룹 목록 보기 | 캠페인 하위 광고그룹 목록 조회 제공하는 정보: 캠페인 ID, 광고그룹 ID, 광고그룹 이름, 광고그룹 ON/OFF 상태 |
광고그룹 보기 | 광고그룹 상세 정보 조회 제공하는 정보: 캠페인 ID, 광고그룹 ID, 광고그룹 이름, 캠페인 ON/OFF 상태, 광고그룹 운영상태, 상세 매체유형 정보, 상세 디바이스 설정 정보, 키워드확장 설정여부, 키워드확장 제외 키워드, 일예산, 일예산 초과여부, 기본입찰가, 모바일 입찰가중치, PC 입찰가중치, 키워드확장 입찰가중치, 콘텐츠매체 입찰가, 집행기간 |
광고그룹 생성하기 | 캠페인 하위에 광고그룹 생성 설정 가능한 항목: 광고그룹 이름, 상세 매체유형, 상세 디바이스 설정, 키워드확장 설정, 키워드확장 제외 키워드, 기본입찰가, 일예산, 모바일 입찰가중치, PC 입찰가중치, 키워드확장 입찰가중치, 콘텐츠 매체 입찰가, 집행기간 |
광고그룹 수정하기 | 생성된 광고그룹 수정 수정 가능한 항목: 광고그룹 이름, 상세 매체유형, 상세 디바이스 설정, 키워드확장 설정, 키워드확장 제외 키워드, 기본입찰가, 일예산, 모바일 입찰가중치, PC 입찰가중치, 키워드확장 입찰가중치, 콘텐츠 매체 입찰가, 집행기간 |
광고그룹 상태 바꾸기 | 광고그룹의 운영상태 ON/OFF 수정 |
광고그룹 기본입찰가 수정하기 | 광고그룹의 기본입찰가 수정 |
광고그룹 일 예산 수정하기 | 광고그룹의 일예산 수정 |
광고그룹 입찰가중치 수정하기 | 광고그룹의 모바일 입찰가중치, PC 입찰가중치, 키워드확장 입찰가중치 수정 |
광고그룹 콘텐츠 매체 입찰가 수정하기 | 광고그룹의 콘텐츠 매체 입찰가 수정 |
광고그룹 삭제하기 | 광고그룹 삭제 |
API | 설명 |
---|---|
키워드 목록 보기 | 광고그룹하위 키워드 목록 조회 제공하는 정보: 광고그룹 ID, 키워드 ID, 키워드, 키워드 ON/OFF 상태 |
키워드 보기 | 키워드 상세 정보 조회 제공하는 정보: 광고그룹 ID, 키워드 ID, 키워드, 키워드 ON/OFF 상태, 키워드 랜딩 URL 정보, 입찰전략, 운영 상태 정보, 심사 상태 정보 |
키워드 생성하기 | 광고그룹 하위에 키워드 생성 설정 가능한 항목: 키워드, 입찰전략 |
키워드 생성하기: 개별 옵션 설정 | 광고그룹 하위에 키워드 생성 설정 가능한 항목: 키워드, 입찰전략, 키워드 랜딩 URL |
키워드 수정하기 | 생성된 키워드 수정 설정 가능한 항목: 입찰전략, 키워드 랜딩 URL |
키워드 상태 바꾸기 | 키워드의 운영상태 ON/OFF 수정 |
키워드 입찰가 수정하기 | 키워드의 입찰가 수정 |
키워드 랜딩 URL 수정하기 | 키워드의 랜딩 URL 수정 |
키워드 심사보류 사유 확인하기 | 심사보류된 키워드의 심사보류 사유 확인 |
키워드 품질지수 보기 | 키워드의 품질지수 조회 |
키워드 삭제하기 | 키워드 삭제 |
API | 설명 |
---|---|
소재 목록 보기 | 비즈채널 하위 소재 목록 조회 제공하는 정보: 비즈채널 ID, 소재 ID, 소재이름, 기본소재 제목, 기본소재 설명문구, 사용중 확장소재 타입 |
소재 보기 | 비즈채널하위 소재 상세 조회 제공하는 정보: 광고계정 ID, 비즈채널 ID, 소재 ID, 소재이름, 기본소재 정보(제목, 설명문구, 랜딩 URL), 기본소재 의료광고 심의정보, 확장소재 상세 정보 |
소재 생성하기 | 광고그룹 하위에 소재 생성 설정 가능한 항목: 소재이름, 기본소재 정보(제목, 설명문구, 랜딩 URL), 기본소재 의료광고 심의정보, 확장소재 |
소재 삭제하기 | 소재 삭제 |
API | 설명 |
---|---|
광고그룹 단위 연결 소재 목록 보기 | 광고그룹 ID 기준으로 연결된 광고소재 조회 제공하는 정보: 광고그룹 ID, 소재 ID, 소재연결 ID, 광고그룹에 연결된 소재의 ON/OFF 상태 |
광고소재 단위 연결 광고그룹 목록 보기 | 광고소재 ID 기준으로 연결된 광고그룹 조회 제공하는 정보: 광고그룹 ID, 소재 ID, 소재연결 ID, 광고그룹에 연결된 소재의 ON/OFF 상태 |
소재연결 보기 | 소재연결 ID 기준으로 연결정보 제공하는 정보: 광고그룹 ID, 소재 ID, 소재연결 ID, 광고그룹에 연결된 소재의 ON/OFF 상태 |
소재연결하기 | 광고그룹 하위에 광고소재 생성 설정 가능한 항목: 연결할 광고그룹 ID, 소재 ID |
소재연결 상태 바꾸기 | 광고그룹에 연결된 소재의 운영 상태 ON/OFF 수정 |
소재연결 삭제하기 | 연결 광고소재 삭제 |
API | 설명 |
---|---|
이미지 목록 보기 | 광고계정 하위 이미지 목록 조회 제공하는 정보: 이미지 ID, 이미지 다운로드 URL, 이미지 파일 이름, 이미지 넓이, 이미지 높이, 이미지 파일 크기, 이미지 마지막 사용시간 |
이미지 보기 | 이미지 상세 정보 조회 제공하는 정보: 이미지 ID, 이미지 다운로드 URL, 이미지 파일 이름, 이미지 넓이, 이미지 높이, 이미지 파일 크기, 이미지 마지막 사용시간 |
이미지 등록하기 | 이미지 등록 |
이미지 삭제하기 | 등록된 이미지 삭제 |
API | 설명 |
---|---|
심사서류 목록 보기 | 비즈채널 하위 심사서류 목록 조회 제공하는 정보: 비즈채널 ID, 웹사이트명, 심사서류 정보 |
심사서류 등록하기 | 심사서류 등록 |
API | 설명 |
---|---|
연동 중인 픽셀 & SDK 목록 보기 | 광고계정에 권한이 추가된 픽셀 & SDK 목록 조회 |
연동 가능한 픽셀 & SDK 목록 보기 | 광고계정에 권한을 추가할 수 있는 픽셀 & SDK 조회 |
픽셀 & SDK 연동하기 | 광고계정에 픽셀 & SDK 권한 추가 |
픽셀 & SDK 연동 해제하기 | 광고계정에 픽셀 & SDK 권한 삭제 |
API | 설명 |
---|---|
사업자 정보 보기 | 광고계정 사업자의 정보 조회 제공하는 정보: 사업자 ID, 사업자등록번호, 사업자 이름, 대표자 이름, 업태, 종목, 주소 정보 |
API | 설명 |
---|---|
광고계정 보고서 보기 | 광고계정 보고서 조회 |
캠페인 보고서 보기 | 캠페인 보고서 조회 |
광고그룹 보고서 보기 | 광고그룹 보고서 조회 |
키워드 보고서 보기 | 키워드 보고서 조회 |
소재 보고서 보기 | 광고 소재 보고서 조회 |
용어 | 설명 |
---|---|
광고계정 | 광고계정은 광고집행을 관리하는 단위로, 광고주가 직접 생성하거나 광고 운영을 대행하는 대행사가 직접 생성할 수 있습니다. 대행사에서 광고계정을 생성할 경우 광고주 정보를 별도로 기입할 수 있습니다. 광고계정의 사업자 정보는 세금계산서 발행정보의 기준이 됩니다. |
비즈채널 | 광고 집행을 하기 위해 홍보할 웹사이트입니다. 검색 사용자에게 광고를 통해 노출되는 사업자 정보입니다. |
캠페인 | 가장 상위의 전략 단위로, 캠페인의 전략 변경을 통해서 캠페인에 소속된 모든 광고그룹의 광고를 편리하게 관리할 수 있습니다. |
광고그룹 | 캠페인 하위에 광고그룹을 생성할 수 있으며, 광고그룹별로 게재 설정, 입찰가, 집행기간 등 상세한 전략 설정이 가능합니다. |
키워드 | 사용자가 검색 시 입력한 검색어를 지칭합니다. 광고그룹 내 다양한 키워드를 생성할 수 있으며, 생성한 소재를 노출하기 위한 단어입니다. 광고 집행을 결정하는 중요한 단위로 생성한 소재와 관련성 높은 키워드를 설정하면 효과적인 광고 성과를 볼 수 있습니다. |
소재 | 텍스트 및 이미지, 전화번호 등 다양한 노출방식으로 소재들을 설정할 수 있으며, 생성한 소재 형식으로 광고가 노출됩니다. |
소재연결 | 생성된 소재들은 광고그룹과 연결되어야 합니다. 검색한 키워드가 속해있는 광고그룹 내 연결된 소재가 노출됩니다. |
이미지 | 광고에 함께 노출되는 확장소재에서 사용하기 위한 이미지입니다. |
심사서류 | 비즈채널과 소재 심사에 필요한 서류를 관리할 수 있습니다. |
픽셀 & SDK | 카카오 픽셀은 광고계정이 소유하고 있는 웹사이트에 설치할 수 있으며, 카카오 SDK는 모바일 애플리케이션(앱)에 설치하여 카카오 서비스 활동 로그를 수집하는 도구입니다. 설치된 픽셀 및 SDK를 통하여 실제 방문, 회원가입, 검색, 장바구니, 구매, 앱 실행, 앱 설치 등의 행위를 할 때 그 내역에 대하여 정보를 수집하여 사용자의 행동 분석 및 최적화된 운영에 활용할 수 있습니다. |
사업자 정보 | 광고를 진행하기 위한 사업자 광고계정 생성시, 사업자의 정보를 확인할 수 있습니다. |
보고서 | 집행한 광고의 결과를 항목별로 구성하여 확인할 수 있는 맞춤화된 보고서로 최근 2년간의 데이터를 제공합니다. 광고계정, 캠페인, 광고그룹, 키워드, 소재별로 구분하여 보고서를 만들 수 있으며, 기본 지표 외에도 전체 노출수, 클릭당비용, 평균노출순위 등 추가 지표도 함께 확인할 수 있습니다. |
카카오 키워드광고 플랫폼에서 다운로드한 자료의 ID에는 앞자리에 'K' 문자가 붙어 있지만(예: K1234567890), API에서 사용하는 각 ID는 Long 타입의 숫자로만 이뤄져 있습니다(예: 1234567890). API 호출 시 각 ID 파라미터 값은 Long 타입 숫자만 사용 가능한 점에 주의합니다.
이름 | 설명 |
---|---|
adAccountId | 광고계정 ID |
bizChannelId | 비즈채널 ID |
campaignId | 캠페인 ID |
adGroupId | 광고그룹 ID |
keywordId | 키워드 ID |
creativeId | 소재 ID |
creativeLinkId | 소재연결 ID |
imageId | 이미지 ID |
reviewDocumentId | 심사서류 ID |
변경 날짜 | 변경 이력 |
---|---|
2024.1.30 | * 신규 API 추가 - 광고계정 목록 보기: 페이지 형식의 응답 제공, 광고계정 개수 제한 없이 사용 가능, 기존 API 제공 종료일(2024.5.9) |
2023.12.6 | * 보고서: 톡채널검색광고 오픈에 따른 신규 지표값 추가 - 카카오톡친구 지표 설정( KAKAO_FRIEND )값 추가- 카카오톡친구 지표 상세 이름(Metrics: KAKAO_FRIEND) 참고 - 추가 지표내 노출당비용( costperimp ) 추가- 분석데이터(보고서: Dimension) 추가: 매칭유형( TARGETING_TYPE ), 소재타입(TEMPLATE_CATEGORY )- Dimensions내 product 추가 |
2022.4.26 | * 픽셀 & SDK - 픽셀 & SDK API의 호출 주소 변경: /openapi/v1/... → /openapi/v2/... (기존 호출 주소는 2022년 6월부터 사용 불가) - 응답 구성 변경 : 연동 중인 픽셀 & SDK 목록 보기, 연동 가능한 픽셀 & SDK 목록 보기 |
2022.4.6 | * 광고그룹, 키워드, 소재 Status 값 추가 - 광고그룹 Status 추가 : 운영 불가(광고계정 관리자정지), 운영 불가(광고계정 OFF), 운영 불가(잔액 부족)- 키워드, 소재 Status 추가 : 운영 불가(광고계정 관리자정지), 운영 불가(광고계정 OFF), 운영 불가(잔액 부족), 운영 불가(캠페인 일예산 초과), 운영 불가(캠페인 OFF) |
2021.8.9 | * 신규 API 추가 - 키워드 심사보류 사유 확인하기 |
2021.7.20 | * 신규 API 추가 - 키워드 생성하기: 개별 옵션 설정 |
2021.7.15 | * 목록보기 Response값 개선 - 캠페인 목록보기: 캠페인 운영상태 외 4개 추가 - 광고그룹 목록 보기: 광고그룹 운영상태 외 13개 추가 - 키워드 목록 보기: 키워드 운영 상태 정보 외 1개 추가 - 광고그룹 단위 연결 소재 목록 보기: 광고소재 운영상태 추가 - (광고소재 단위) 연결 광고그룹 목록 보기: 광고소재 운영상태 추가 * 삭제 ID값 조회 가능하도록 변경 - 캠페인 보기 - 광고그룹 보기 - 키워드 보기 - 소재 보기 - 소재연결 보기 |
2021.7.5 | * 소재 목록 보기: config 에 ON , DEL 조회 추가 및 Response내 config 출력값 추가 |
2021.7.1 | * 목록보기 상태값 조회 개선 - 캠페인 목록 보기: config 에 DEL 조회 추가- 광고그룹 목록 보기: config 에 DEL 조회 추가- 키워드 목록 보기: config 에 DEL 조회 추가- 광고그룹 단위 연결 소재 목록 보기: config 에 ON , OFF , DEL 조회 추가- (광고소재 단위) 연결 광고그룹 목록 보기: config 에 ON , OFF , DEL 조회 추가* 키워드 보고서 보기의 요청 파라미터 중 adGroupId(광고그룹 ID)을 미필수값으로 변경 * 키워드 보고서 보기의 Response Dimensions 내 campaignId , adGroupId 출력값 추가 |
2021.6.29 | * 보고서 API 초당 요청 횟수 완화: 1초당 1건 → 1초당 5건 (레퍼런스 참고) |
2021.6.24 | * 키워드 보고서 보기의 요청 파라미터 중 adGroupId (광고그룹 ID)을 필수값으로 변경 |
2021.6.18 | * 보고서 API 초당 요청 횟수 완화: 5초당 1건 → 1초당 1건 (레퍼런스 참고) |