사이드 메뉴
시작하기
로그인
커뮤니케이션
광고
카카오모먼트
애드뷰 관리
이 문서는 애드뷰 관리 API 사용법을 안내합니다.
| 메서드 | URL | 인증 방식 |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/v4/adViews | 비즈니스 토큰 |
애드뷰 목록을 조회합니다.
조회한 애드뷰의 상세 정보는 카카오 비즈보드 유형 캠페인 하위의 소재 생성시 랜딩 유형 및 랜딩으로 활용 가능합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며, 요청 성공 시 응답 본문에 애드뷰 목록을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID | O |
| 이름 | 타입 | 설명 |
|---|---|---|
| - | AdView[] | 애드뷰 목록 |
요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/adViews" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "adAccountId: ${AD_ACCOUNT_ID}"
응답
HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8[{"id": 1,"name": "첫번째_애드뷰","type": "COMPACT","templateType": "IMAGE"}]
| 메서드 | URL | 인증 방식 |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/v4/adViews/${ID} | 비즈니스 토큰 |
애드뷰 상세 정보를 조회합니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며, 조회할 애드뷰 번호를 필수 파라미터로 전달해야 합니다. 성공 시 애드뷰 상세 정보를 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long | 애드뷰 번호 | O |
| 이름 | 타입 | 설명 |
|---|---|---|
| id | Long | 애드뷰 번호 |
| name | String | 애드뷰 이름 |
| type | String | 애드뷰 유형 FULL(풀뷰), COMPACT(콤팩트뷰) 중 하나 |
| templateType | String | 템플릿 유형 IMAGE(이미지), VIDEO(동영상), CAROUSEL(캐러셀 : 콤팩트뷰만 해당), SCROLL(스크롤 : 풀뷰만 해당) 중 하나 |
요청
curl -X GET "https://apis.moment.kakao.com/openapi/v4/adViews/${ID}" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "adAccountId: ${AD_ACCOUNT_ID}"
응답
HTTP/1.1 200 OKContent-Type: application/json;charset=UTF-8{"id": 1,"name": "첫번째_애드뷰","type": "COMPACT","templateType": "IMAGE"}
| 메서드 | URL | 인증 방식 |
|---|---|---|
DELETE | https://apis.moment.kakao.com/openapi/v4/adViews/${ID} | 비즈니스 토큰 |
애드뷰를 삭제할 수 있습니다.
비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 DELETE로 요청하고, 성공 시 HTTP 상태 코드 200에 응답 본문은 없습니다. 실패 시 에러 코드에서 원인을 확인합니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ID | Long | 애드뷰 번호 | O |
요청
curl -v -X DELETE "https://apis.moment.kakao.com/openapi/v4/adViews/${ID}" \-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \-H "adAccountId: ${AD_ACCOUNT_ID}" \-H "Content-Type: application/json"
응답: 성공
HTTP/1.1 200 OKContent-Length: 0Content-Type: application/json;charset=UTF-8
응답: 실패
HTTP/1.1 400 Bad requestContent-Type: application/json;charset=UTF-8{"code": -813,"msg": "KakaoMomentException","extras": {"detailCode": 39020,"detailMsg": "이 애드뷰를 랜딩으로 사용중인 소재가 있어서 삭제할 수 없습니다."}}