This document describes how to use the Ad View management APIs.

Retrieves a list of Ad Views.

You can use the retrieved Ad View information to set as a landing to or a landing type when you create a creative under the 'Kakao Bizboard' type of a campaign.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns a list of each Ad View's detailed information in JSON format. If failed, refer to Error code to figure out its failure cause.

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 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 1,
        "name": "first_ad_view",
        "type": "COMPACT",
        "templateType": "IMAGE"
    }
]

Retrieves the detailed information of the specified Ad View.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. You must pass the Ad View ID to be retrieved as a parameter when you request. If the request is successful, this API returns the detailed information of the Ad View in JSON format. If failed, refer to Error code to figure out its failure cause.

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 OK
Content-Type: application/json;charset=UTF-8
{
    "id": 1,
    "name": "first_ad_view",
    "type": "COMPACT",
    "templateType": "IMAGE"
}

Deletes an Ad View.

Send a DELETE request with the issued business token and an ad account ID (adAccountId) in the request header. You must pass the campaign ID as a parameter when you request. If the request is successful, this API returns the HTTP status code 200 without the response body. If failed, refer to Error code to figure out its failure cause.

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 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8

HTTP/1.1 400 Bad request
Content-Type: application/json;charset=UTF-8
{
    "code": -813,
    "msg": "KakaoMomentException",
    "extras": {
        "detailCode": 39020,
        "detailMsg": "이 애드뷰를 랜딩으로 사용중인 소재가 있어서 삭제할 수 없습니다."
    }
}

• Kakao Moment API Reference