본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

Related sites
  • Docs
  • Kakao Moment
  • Ad View management

사이드 메뉴

Docs Home

Getting started

Kakao Developers

Login

Communication

Map

Navigation

Advertisement

Search

More

Kakao Moment

Ad View management

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

View list of Ad Views

Basic information
MethodURLAuthorization
GEThttps://apis.moment.kakao.com/openapi/v4/adViews
RequirementsSee also

Returns 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.

Request

Header
NameDescriptionRequired
AuthorizationBusiness token as a type of user authentication.
Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}		O
adAccountIdAd account's ID.
adAccountId: ${AD_ACCOUNT_ID}		O

Response

Body
NameTypeDescription
-AdView[]List of Ad View information.
AdView
NameTypeDescription
idLongAd View's ID.
nameStringAd View's name.
typeEnumAd View's type.
  • FULL: Full view
  • COMPACT: Compact view
templateTypeEnumTemplate type.
  • IMAGE: Image
  • VIDEO: Video
  • CAROUSEL: Carousel (Compact view only)
  • SCROLL: Scroll (Full view only)

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
MethodURLAuthorization
GEThttps://apis.moment.kakao.com/openapi/v4/adViews/${ID}
RequirementsSee also

Returns detailed information about the specified Ad View.

Request

Header
NameDescriptionRequired
AuthorizationBusiness token as a type of user authentication.
Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}		O
adAccountIdAd account's ID.
adAccountId: ${AD_ACCOUNT_ID}		O
Path variable
NameTypeDescriptionRequired
IDLongAd View's ID.O

Response

Body
NameTypeDescription
idLongAd View's ID.
nameStringAd View's name.
typeEnumAd View's type.
  • FULL: Full view
  • COMPACT: Compact view
templateTypeEnumTemplate type.
  • IMAGE: Image
  • VIDEO: Video
  • CAROUSEL: Carousel (Compact view only)
  • SCROLL: Scroll (Full view only)

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
MethodURLAuthorization
DELETEhttps://apis.moment.kakao.com/openapi/v4/adViews/${ID}
RequirementsSee also

Deletes an Ad View.

Request

Header
NameDescriptionRequired
AuthorizationBusiness token as a type of user authentication.
Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}		O
adAccountIdAd account's ID.
adAccountId: ${AD_ACCOUNT_ID}		O
Path variable
NameTypeDescriptionRequired
IDLongAd View's ID.O

Sample

Request
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"
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

Was this helpful?

    Kakao Moment > Ad View management - Kakao Developers | Docs