사이드 메뉴
시작하기
로그인
커뮤니케이션
광고
쉬운 메시지광고: 광고계정 관리
이 문서는 카카오모먼트 쉬운 메시지광고의 광고계정 관리 API 사용 방법을 안내합니다.
| 메서드 | URL | 인증 방식 |
|---|---|---|
POST | https://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts | 비즈니스 토큰 |
쉬운 메시지광고 API용 광고계정을 생성합니다.
이 API는 도입 안내의 절차 완료 후 사용할 수 있습니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 POST로 요청합니다. 요청 성공 시 응답은 생성된 광고계정 정보를 포함합니다. 실패 시 에러 코드 및 상세 에러 코드로 원인을 확인합니다.
이 API는 사용자 계정마다 초당 1회 요청 가능하도록 제한되어 있습니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| channel-profile-id | channel-profile-id: ${CHANNEL_PROFILE_ID}카카오톡 채널 프로필 ID | O |
| Content-Type | Content-Type: application/json요청 데이터 타입 | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| name | String | 생성할 광고계정 및 PIXEL & SDK 이름 전달하지 않을 경우, 카카오모먼트 시스템에서 자동 입력 직접 입력 시 공백 포함 15자 이하 한글, 영어, 숫자, 마침표(.), 공백 포함 가능 자음 또는 모음만 입력할 수 없음 시스템 자동 입력 시 등록 예시: P1465256N000001"P"+${제휴사ID}+"N"+000001(순차 증가) 형식 | X |
| 이름 | 타입 | 설명 |
|---|---|---|
| id | Long | 광고계정 번호 |
| name | String | 광고계정명 |
| ownerCompany | Company | 광고계정 소유 사업자 정보 |
| advertiser | Company | 광고주 사업자 정보 |
| type | String | 광고계정 유형, 아래 중 하나
|
| config | String | 광고계정 상태, 아래 중 하나
|
| isAdminStop | Boolean | 관리자 정지 여부 |
| isOutOfBalance | Boolean | 잔액부족 여부 |
| statusDescription | String | 광고계정의 게재와 관련된 현재 상태 |
| talkChannelProfileId | String | 카카오톡 채널 프로필 ID 참고: 카카오톡 채널 프로필 ID 확인 방법 |
| bizRightId | Long | 영업권 ID |
| bizRightStatus | String | 영업권 요청 상태 |
| creditLimit | Long | 후불 한도 |
| offeredFreeCash | Long | 지급한 무상 캐시 |
| trackId | String | PIXEL&SDK ID |
| trackRightId | String | PIXEL&SDK 연동 ID |
| memberAccountId | Long | 추가한 멤버 ID |
요청
curl -X POST "https://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \-H "Content-Type: application/json" \-d '{"name": "광고계정이름"}'
응답
HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8{"id": 55689,"name": "이름","ownerCompany": {"businessRegistrationNumber": "891-88-00985","name": "카카오커머스"},"advertiser": {"businessRegistrationNumber": "891-88-00985","name": "카카오커머스"},"type": "BUSINESS","config": "ON","isAdminStop": "false","isOutOfBalance": "false","statusDescription": "","talkChannelProfileId": "_xbHxd","bizRightId": 3855,"bizRightStatus": "COMPLETED","creditLimit": 1000,"offeredFreeCash": 1000,"trackId": "3723273380963501395","trackRightId": "100012798","memberAdAccountId": null}
| 메서드 | URL | 인증 방식 |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts | 비즈니스 토큰 |
쉬운 메시지광고 API용 광고계정을 조회합니다.
이 API는 도입 안내의 절차 완료 후 사용할 수 있습니다.
비즈니스 토큰과 카카오톡 채널 프로필 ID를 헤더에 담아 GET으로 요청합니다. 요청 성공 시 응답은 광고계정 정보를 포함합니다. 실패 시 에러 코드 및 상세 에러 코드로 원인을 확인합니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| channel-profile-id | channel-profile-id: ${CHANNEL_PROFILE_ID}카카오톡 채널 프로필 ID | O |
| Content-Type | Content-Type: application/json요청 데이터 타입 | O |
| 이름 | 타입 | 설명 |
|---|---|---|
| id | Long | 광고계정 번호 |
| name | String | 광고계정명 |
| ownerCompany | Company | 광고계정 소유 사업자 정보 |
| advertiser | Company | 광고주 사업자 정보 |
| type | String | 광고계정 유형 BUSINESS(사업자 광고계정) |
| config | String | 광고계정 상태, 아래 중 하나
|
| isAdminStop | Boolean | 관리자 정지 여부 |
| isOutOfBalance | Boolean | 잔액부족 여부 |
| statusDescription | String | 광고계정의 게재와 관련된 현재 상태 |
| talkChannelProfileId | String | 카카오톡 채널 프로필 ID 참고: 카카오톡 채널 프로필 ID 확인 방법 |
| bizRightId | Long | 영업권 ID |
| bizRightStatus | String | 영업권 요청 상태 |
| creditLimit | Long | 후불 한도 |
| offeredFreeCash | Long | 지급한 무상 캐시 |
| trackId | String | PIXEL&SDK ID |
| trackRightId | String | PIXEL&SDK 연동 ID |
| memberAccountId | Long | 추가한 멤버 ID |
요청
curl -X GET "https://apis.moment.kakao.com/openapi/message/v1/message-ad-accounts" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \-H "Content-Type: application/json"
응답
HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8{"id": 55689,"name": "이름","ownerCompany": {"businessRegistrationNumber": "891-88-00985","name": "카카오커머스"},"advertiser": {"businessRegistrationNumber": "891-88-00985","name": "카카오커머스"},"type": "BUSINESS","config": "ON","isAdminStop": "false","isOutOfBalance": "false","statusDescription": "","talkChannelProfileId": "_xbHxd","bizRightId": 3855,"bizRightStatus": "COMPLETED","creditLimit": 1000,"offeredFreeCash": 1000,"trackId": "3723273380963501395","trackRightId": "100012798","memberAdAccountId": null}