Kakao Moment

Ad creation: Creative

This document describes how to use the Creative APIs.

View list of creatives

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/creatives`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Returns a list of creatives.

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

Query parameter

Name	Type	Description	Required
adGroupId	`Long`	Ad group's ID.	O
config	`Enum: Config[]`	Creative's status (Default: `ON`, `OFF`).	X

Response

Body

Name	Type	Description
content	`Creative[]`	List of creative information.

Creative

Name	Type	Description
id	`Long`	Original creative ID for execution.
name	`String`	Creative's name.
config	`Enum: Config`	Creative's status.
systemConfig	`Enum: SystemConfig`	Creative's system status. `ON`: Activated `ADMIN_STOP`: Administrator suspended

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/creatives?adGroupId=1234&config=ON" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "content": [
    {
      "id": 1111,
      "name": "creative1",
      "type": "DISPLAY",
      "config": "ON"
    },
    {
      "id": 1112,
      "name": "creative2",
      "type": "DISPLAY",
      "config": "OFF"
    }
  ]
}

View creative

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/creatives/${ID}`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Returns detailed information about the specified creative.

Response notes

Opinion and evidence files may be delayed due to review processing synchronization and are returned as null until synchronization is complete.
Detailed information about expandable elements is not supported.
Unused values may be returned as null.

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`	Original creative ID for execution.	O

Response

Body: Display creative

Key	Type	Description
id	`Long`	Original creative ID for execution.
creativeId	`Long`	Creative's ID. If the creative is newly created: the same as the original creative ID, regardless of review status. If the creative is modified after it was initially created and approved, and the modification requires review: a new creative ID is issued, so it differs from the original creative ID. If the creative is modified after it was initially created and approved, and the modification does not require review: no new creative ID is issued, so it remains the same as the original creative ID.
name	`String`	Creative's name.
format	`Enum`	Creative's type. `IMAGE_BANNER`: Image banner `IMAGE_NATIVE`: Image native `VIDEO_NATIVE`: Video native
pcLandingUrl	`String`	Landing URL for PC.
mobileLandingUrl	`String`	Landing URL for mobile.
rspvLandingUrl	`String`	Responsive landing URL.
frequencyCapType	`Enum`	Frequency capping. `AUTO`: Automatic setting `DAY_IMP`: Detailed setting
frequencyCapTime	`Long`	Frequency capping time.
frequencyCap	`Long`	Frequency capping count.
config	`Enum: Config`	Creative's status.
systemConfig	`Enum: SystemConfig`	Creative's system status. `ON`: Activated `ADMIN_STOP`: Administrator suspended
reviewStatus	`Enum`	Review status. `APPROVED`: Review approved. `WAITING`: Review in progress. `REJECTED`: Review rejected. `MODIFICATION_WAITING`: Review for modification in progress. `MODIFICATION_REJECTED`: Review for modification rejected.
creativeStatus	`Enum`	Creative's operation status. `OPERATING`: Possible to operate `UNAPPROVED`: Unapproved `INVALID_DATE`: Invalid date `MONITORING_REJECTED`: Monitoring pending `OFF`: User OFF `DELETED`: Deleted `ADGROUP_UNAVAILABLE`: Impossible to operate ad group `SYSTEM_CONFIG_ADMIN_STOP`: Suspended by administrator
statusDescription	`String`	Current status of creative.
image	`Image`	Information about the main image of the `IMAGE_BANNER`, `IMAGE_NATIVE`, and `VIDEO_NATIVE` type of creative.
landingInfo	`LandingInfo`	Specified data for landing.
altText	`String`	Alternative description of the `IMAGE_NATIVE` type of creative.
title	`String`	Title of the `IMAGE_NATIVE` or `VIDEO_NATIVE` type of creative.
description	`String`	Promotional text of the `IMAGE_NATIVE` or `VIDEO_NATIVE` type of creative.
actionButton	`String`	Call-to-action button of the `IMAGE_NATIVE` and `VIDEO_NATIVE` type of creative.
profileName	`String`	Profile name of the `IMAGE_NATIVE` or `VIDEO_NATIVE` type of creative.
profileImage	`Image`	Uploaded profile image.
video	`Video`	Video of the `VIDEO_NATIVE` type of creative.
videoSkippableType	`String`	Video display type of the `VIDEO_INSTREAM` type of creative. `SECONDS_5`: Impressed for 5 seconds at most. `SECONDS_15`: Impressed for 15 seconds at most.
rejectedReason	`RejectedReason[]`	Reasons for rejection of creative.
assetGroups	`AssetGroup[]`	Slide item.
hasExpandable	`Boolean`	Whether or not Expandable component is included.
opinion	`String`	Opinion for ad verification.
opinionProof	`OpinionFile[]`	List of materials for ad verification.
createdDate	`String`	Date and time when the creative is created.
lastModifiedDate	`String`	Date and time when the creative is lastly modified.
ageVerification	`Boolean`	Whether to use age verification messages. `true`: Age verification message used. `false`: General message used.

Body: Message creative

Name	Type	Description
id	`Long`	Original creative ID for execution.
creativeId	`Long`	Creative's ID. Message creatives have no review status and are always the same as the original creative ID (`id`).
name	`String`	Creative's name.
adGroupId	`Long`	Ad group's ID.
format	`Enum`	Creative's type. `BASIC_TEXT_MESSAGE`: Basic text `WIDE_MESSAGE`: Wide image `WIDE_LIST_MESSAGE`: Wide list `CAROUSEL_COMMERCE_MESSAGE`: Carousel commerce `CAROUSEL_FEED_MESSAGE`: Carousel feed `PREMIUM_VIDEO_MESSAGE`: Premium video
config	`Enum: Config`	Creative's status.
systemConfig	`Enum: SystemConfig`	Creative's system status. `ON`: Activated `ADMIN_STOP`: Administrator suspended
statusDescription	`Enum`	Current status of a Kakao TalkChannel X Reach ad group. `발송 대기`: Ready `발송중`: Sending `발송중지`: Paused `발송종료`: Finished
creativeStatus	`Enum`	Creative's operation status. `OPERATING`: Possible to operate. `INVALID_DATE`: Invalid date. `OFF`: User OFF. `DELETED`: Deleted. `ADGROUP_UNAVAILABLE`: Impossible to operate ad group.
createdDate	`String`	Date and time when the creative is created.
lastModifiedDate	`String`	Date and time when the creative is lastly modified.
messageElement	`MessageElement`	Detailed information about Message creative.
ageVerification	`Boolean`	Whether to use age verification messages. `true`: Age verification message used. `false`: General message used.

Body: Video creative

Name	Type	Description
id	`Long`	Original creative ID used for execution.
creativeId	`Long`	Creative's ID. If the creative is newly created: the same as the original creative ID, regardless of review status. If the creative is modified after it was initially created and approved, and the modification requires review: a new creative ID is issued, so it differs from the original creative ID. If the creative is modified after it was initially created and approved, and the modification does not require review: no new creative ID is issued, so it remains the same as the original creative ID.
format	`String`	Creative's type. Fixed to `VIDEO_NATIVE`.
name	`String`	Creative's name.
adGroupId	`Long`	Ad group's ID.
pcLandingUrl	`String`	Landing URL for PC.
mobileLandingUrl	`String`	Landing URL for mobile.
rspvLandingUrl	`String`	Responsive landing URL.
frequencyCapType	`Enum`	Frequency capping. `AUTO`: Automatic setting `DAY_IMP`: Detailed setting
frequencyCapTime	`Long`	Frequency capping time.
frequencyCap	`Long`	Frequency capping count.
config	`Enum: Config`	Creative's status.
systemConfig	`Enum: SystemConfig`	Creative's system status. `ON`: Activated `ADMIN_STOP`: Administrator suspended
reviewStatus	`Enum`	Review status. `APPROVED`: Review approved. `WAITING`: Review in progress. `REJECTED`: Review rejected. `MONITORING_REJECTED`: Monitoring pending.
creativeStatus	`Enum`	Creative's operation status. `OPERATING`: Possible to operate. `UNAPPROVED`: Unapproved. `INVALID_DATE`: Invalid date. `MONITORING_REJECTED`: Monitoring pending. `OFF`: User OFF. `DELETED`: Deleted. `ADGROUP_UNAVAILABLE`: Impossible to operate ad group.
image	`Image`	Uploaded promotional image.
title	`String`	Title.
description	`String`	Promotional text.
actionButton	`String`	Call-to-action button.
profileName	`String`	Profile name.
profileImage	`Image`	Uploaded profile image.
video	`Video`	Uploaded promotional video.
statusDescription	`String`	Current status of creative.
rejectedReason	`RejectedReason[]`	Reasons for rejection of creative, returned as an empty array.
createdDate	`String`	Date and time when the creative is created.
lastModifiedDate	`String`	Date and time when the creative is lastly modified.
opinionProof	`OpinionFile[]`	List of materials for ad verification.
thumbnailImage	`Image`	Uploaded custom thumbnail image.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/creatives/${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": 1111,
  "name": "Display Ad Creative",
  "landingInfo": {
    "landingType": "AD_VIEW",
    "communicatorAdViewId": 1
  },
  "format": "IMAGE_BANNER",
  "landingUrl": "http://www.daum.net",
  "frequencyCapType": "DAY_IMP",
  "frequencyCap": 3,
  "frequencyCapTime": 24,
  "config": "ON",
  "image": {
    "url": "http://xxx.kakao.co.kr/sample.jpg",
    "fileName": "sample.jpeg",
    "width": 640,
    "height": 100,
    "size": 50000
  },
  "reviewStatus": "REJECTED",
  "creativeStatus": "UNAPPROVED",
  "statusDescription": "심사보류",
  "rejectedReason": [
    {
      "rejectedTitle": "공통1>가격 불일치",
      "rejectedContent": "등록하신 광고 소재 내 가격 정보가 랜딩페이지 내 실제 판매금액과 일치하지 않아 광고 등록이 보류되었습니다.\n* 광고 소재 내 가격 정보 : 39,800\n* 랜딩 페이지 내 가격 정보 : 49,800\n - 수정방법 : 모든 이용자가 구매 가능한 정확한 가격을 기재해 주시기 바랍니다."
    }
  ],
  "createdDate": "2020-01-01T00:00:00",
  "lastModifiedDate": "2020-01-01T01:00:00",
  "hasExpandable": false
}

Response: Fail

{
  "code": -813,
  "msg": "KakaoMomentException",
  "extras": {
    "detailCode": 33003,
    "detailMsg": "소재가 존재하지 않습니다."
  }
}

Change creative status

Basic information

Method	URL	Authorization
`PUT`	`https://apis.moment.kakao.com/openapi/v4/creatives/onOff`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Enables you to change a creative's status.

Status change conditions

Only Display ad creatives can be changed.
Creatives under Kakao Talk Channel campaigns cannot be changed.

Rate limit

This API limits the number of calls you can make to every one second per user account and ad account.

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

Body

Name	Type	Description	Required
id	`Long`	Original creative ID for execution.	O
config	`Enum: Config`	Creative's status. `ON`: Activated `OFF`: Inactivated	O

Sample

Request

curl -X PUT "https://apis.moment.kakao.com/openapi/v4/creatives/onOff" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "Content-Type: application/json" \
    -d '{
            "id": 1234,
            "config": "ON"
        }'

Response

HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8

Response: Fail

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "code": -813,
  "msg": "KakaoMomentException",
  "extras": {
    "detailCode": 33003,
    "detailMsg": "소재가 존재하지 않습니다."
  }
}

Delete creative

Basic information

Method	URL	Authorization
`DELETE`	`https://apis.moment.kakao.com/openapi/v4/creatives/${ID}`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Deletes a creative.

Note

Deleting a creative means giving up the operation of creatives, not deleting its data.

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`	Original creative ID for execution.	O

Sample

Request

curl -v -X DELETE "https://apis.moment.kakao.com/openapi/v4/creatives/${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

{
  "code": -813,
  "msg": "KakaoMomentException",
  "extras": {
    "detailCode": 75008,
    "detailMsg": "카카오톡 채널_도달 소재는 삭제할 수 없습니다.",
    "path": "/v2/moment/creatives",
    "timestamp": "2020-04-01T10:16:14.294+0000"
  }
}

View reason for system stop

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/creatives/${ID}/systemConfigHistory`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Returns the reason why the specified creative's system is stopped.

If there are multiple system suspension reasons, the most recent admin suspension reason is returned. Only when the creative's systemConfig is ADMIN_STOP, the response is returned.

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`	Original creative ID for execution.	O

Response

Body

Name	Type	Description
id	`Long`	System suspension ID.
systemConfig	`Enum: SystemConfig`	System suspension status. `ON`: Activated `ADMIN_STOP`: Administrator suspended
reason	`String`	System suspension reason.
createdDate	`String`	Date and time when the system suspension reason is created in `yyyy-MM-dd'T'HH:mm:ss` format.
lastModifiedDate	`String`	Date and time when the system suspension reason is lastly updated in `yyyy-MM-dd'T'HH:mm:ss` format.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/creatives/${ID}/systemConfigHistory" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"

Response

{
  "id": 1234,
  "systemConfig": "ADMIN_STOP",
  "adminStopReason": "has been suspended due to the end of the creative landing.",
  "createdDate": "2021-01-01T00:00:00",
  "lastModifiedDate": "2021-01-01T00:00:00"
}

Response: Fail

{
  "code": -813,
  "msg": "KakaoMomentException",
  "extras": {
    "detailCode": 33003,
    "detailMsg": "Creative does not exist."
  }
}

View list of reasons for system stop

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/creatives/${ID}/systemConfigHistories`	Business token

Requirements		See also
Obtain usage permission Switch to a Biz app	Register business redirect URI Set business consent items	Error code Glossary

Returns the reasons why the specified creative's system was stopped during the last two years.

Only when the creative's systemConfig is ADMIN_STOP, the response is returned.

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`	Original creative ID for execution.	O

Response

Body

Name	Type	Description
-	`SystemStopReason[]`	List of system suspension reason.

SystemStopReason

Name	Type	Description
id	`Long`	System suspension ID.
systemConfig	`Enum: SystemConfig`	System suspension status. `ON`: Activated `ADMIN_STOP`: Administrator suspended
reason	`String`	System suspension reason.
createdDate	`String`	Date and time when the system suspension reason is created in `yyyy-MM-dd'T'HH:mm:ss` format.
lastModifiedDate	`String`	Date and time when the system suspension reason is lastly updated in `yyyy-MM-dd'T'HH:mm:ss` format.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/creatives/${ID}/systemConfigHistories" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

Response

[
  {
    "id": 1235,
    "systemConfig": "ADMIN_STOP",
    "adminStopReason": "has been suspended due to the end of the creative landing.",
    "createdDate": "2021-01-01T00:00:00",
    "lastModifiedDate": "2021-01-01T00:00:00"
  },
  {
    "id": 1234,
    "systemConfig": "ADMIN_STOP",
    "adminStopReason": "has been suspended due to the end of the creative landing.",
    "createdDate": "2021-01-01T00:00:00",
    "lastModifiedDate": "2021-01-01T00:00:00"
  }
]

Response: Fail

{
  "code": -813,
  "msg": "KakaoMomentException",
  "extras": {
    "detailCode": 33003,
    "detailMsg": "Creative does not exist."
  }
}

See more

Kakao Moment API Reference

사이드 메뉴

Getting started

Kakao Developers

Login

Communication

Map

Navigation

Advertisement

Search

More

Ad creation: Creative

View list of creatives

Basic information

Request

Header

Query parameter

Response

Body

Creative

Sample

Request

Response

View creative

Basic information

Response notes

Request

Header

Path variable

Response

Body: Display creative

Body: Message creative

Body: Video creative

Sample

Request

Response

Response: Fail

Change creative status

Basic information

Status change conditions

Rate limit

Request

Header

Body

Sample

Request

Response

Response: Fail

Delete creative

Basic information

Request

Header

Path variable

Sample

Request

Response

Response: Fail

View reason for system stop

Basic information

Request

Header

Path variable

Response

Body

Sample

Request

Response

Response: Fail

View list of reasons for system stop

Basic information

Request

Header

Path variable

Response

Body

SystemStopReason

Sample

Request

Response

Response: Fail

See more