페이지 이동경로
  • Docs>
  • Kakao Moment>
  • Ad View management

Kakao Moment

Ad View management

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

View list of Ad Views

Basic information
Method URL Authorization
GET https://apis.moment.kakao.com/openapi/v4/adViews Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to retrieve 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.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.		 O

Response

Body
Name Type Description
- AdView[] List of Ad View information.
AdView
Name Type Description
id Long Ad View's ID.
name String Ad View's name.
type String Ad View's type.
Either of FULL (Full view) or COMPACT (Compact view).
templateType String Template type.
One of the followings:
IMAGE
VIDEO
CAROUSEL: Only for Compact view
SCROLL: Only for Full view

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/adViews" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": 1,
        "name": "first_ad_view",
        "type": "COMPACT",
        "templateType": "IMAGE"
    }
]

View Ad View

Basic information
Method URL Authorization
GET https://apis.moment.kakao.com/openapi/v4/adViews/${ID} Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to retrieve 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.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.		 O
Path variable
Name Type Description Required
ID Long Ad View's ID. O

Response

Body
Name Type Description
id Long Ad View's ID.
name String Ad View's name.
type String Ad View's type.
Either of FULL (Full view) or COMPACT (Compact view).
templateType String Template type.
One of the followings:
IMAGE
VIDEO
CAROUSEL: Only for Compact view
SCROLL: Only for Full view

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/adViews/${ID}" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "id": 1,
    "name": "first_ad_view",
    "type": "COMPACT",
    "templateType": "IMAGE"
}

Delete Ad View

Basic information
Method URL Authorization
DELETE https://apis.moment.kakao.com/openapi/v4/adViews/${ID} Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

This API enables you to delete 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.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.		 O
Path variable
Name Type Description Required
ID Long Ad View's ID. O

Sample

Request
curl -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"
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8
Response: Fail
HTTP/1.1 400 Bad request
Content-Type: application/json;charset=UTF-8
{
    "code": -813,
    "msg": "KakaoMomentException",
    "extras": {
        "detailCode": 39020,
        "detailMsg": "이 애드뷰를 랜딩으로 사용중인 소재가 있어서 삭제할 수 없습니다."
    }
}

See more

Kakao Moment> Ad View management