페이지 이동경로
  • 문서>
  • 카카오모먼트>
  • 애드뷰 관리

카카오모먼트

애드뷰 관리

이 문서는 애드뷰 관리 API 사용법을 안내합니다.

애드뷰 목록 보기

애드뷰 목록을 조회합니다. 조회한 애드뷰의 상세 정보는 카카오 비즈보드 유형 캠페인 하위의 소재 생성시 랜딩 유형 및 랜딩으로 활용 가능합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며, 요청 성공 시 응답 바디에 애드뷰 목록을 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
GET /openapi/v4/adViews HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Response
Name Type Description
- AdView[] 애드뷰 목록
Sample
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/adViews" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 1,
        "name": "첫번째_애드뷰",
        "type": "COMPACT",
        "templateType": "IMAGE"
    }
]

애드뷰 보기

애드뷰 상세 정보를 조회합니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 GET으로 요청하며, 조회할 애드뷰 번호를 필수 파라미터로 전달해야 합니다. 성공 시 애드뷰 상세 정보를 받습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
GET /openapi/v4/adViews/{id} HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
id Long 애드뷰 번호 O
Response
Name Type Description
id Long 애드뷰 번호
name String 애드뷰 이름
type String 애드뷰 유형
FULL(풀뷰),
COMPACT(콤팩트뷰) 중 하나
templateType String 템플릿 유형
IMAGE(이미지),
VIDEO(동영상),
CAROUSEL(캐러셀 : 콤팩트뷰만 해당),
SCROLL(스크롤 : 풀뷰만 해당) 중 하나
Sample
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/adViews/{id}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "id": 1,
    "name": "첫번째_애드뷰",
    "type": "COMPACT",
    "templateType": "IMAGE"
}

애드뷰 삭제하기

애드뷰를 삭제할 수 있습니다.

액세스 토큰(Access token)과 광고계정 ID(adAccountId)를 헤더에 담아 DELETE로 요청하고, 성공 시 HTTP 상태 코드 200에 응답 바디는 없습니다. 실패 시 에러 코드 및 상세 에러 코드로 사유를 확인합니다.

Request
URL
DELETE /openapi/v4/adViews/{id} HTTP/1.1 
Host: apis.moment.kakao.com
Authorization: Bearer {ACCESS_TOKEN}
Header
Name Type Description Required
Authorization String 액세스 토큰
Bearer {ACCESS_TOKEN} 형식으로 전달
O
adAccountId Long 광고계정 ID O
Parameter
Name Type Description Required
id Long 애드뷰 번호 O
Sample
Request
curl -X DELETE "https://apis.moment.kakao.com/openapi/v4/adViews/{id}" \
    -H "Authorization: Bearer {ACCESS_TOKEN}" \
    -H "adAccountId: {adAccountId}" \
    -H "Content-Type: application/json"
Response: 성공
HTTP/1.1 200 OK
Content-Length: 0
Content-type: application/json;charset=UTF-8
Response: 실패
HTTP/1.1 400 Bad request
Content-Type: application/json;charset=UTF-8
{
    "code": -813,
    "msg": "KakaoMomentException",
    "extras": {
        "detailCode": 39020,
        "detailMsg": "이 애드뷰를 랜딩으로 사용중인 소재가 있어서 삭제할 수 없습니다."
    }
}

더보기