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

kakao developers

Related sites
  • Docs
  • Kakao Moment
  • Ad creation: Display creative

사이드 메뉴

Kakao Map

Search

Kakao Moment

Ad creation: Creative

This document describes how to use the Creative APIs.

Before you begin

Creative type

With the update on August 26, 2025, the following promotional image aspect ratios have been added.

Campaign typeCreative typePromotional ImageProfile Image
DisplayImage native (IMAGE_NATIVE)800x1000 pixels or more (4:5), 500KB, JPG/JPEG/PNG300x300 pixels or more (1:1), 500KB, JPG/JPEG/PNG

With the update on December 17, 2024, the following Video type of creatives has been added.

Campaign typeCreative typeProfile ImagePromotional videoCustom thumbnail
VideoVideo native (VIDEO_NATIVE)300x300 pixels or more (1:1), 500KB, JPG/JPEG/PNG720x1280 pixels or more (9:16), 100MB, AVI, FLV, MP4 recommended

1280x720 pixels or more (16:9), 100MB, AVI, FLV, MP4 recommended
720x1280 pixels or more (9:16), 500KB, JPG/JPEG/PNG

1280x720 pixels or more (16:9), 500KB, JPG/JPEG/PNG

With the update on September 5, 2024, the following Display type of creatives has been added.

Campaign typeCreative typePromotional imageProfile image
DisplayImage catalog (CATALOG_MANUAL)Promotional image in slide: 500x500 pixel or more (9:16), 500 KB, JPG/JPEG/PNG
Minimum of 4, maximum of 10 can be set
300 x 300 pixels or more (1:1), 500KB, JPG/JPEG/PNG

With the update on August 30, 2023, the following Display type of creatives has been added.

Campaign typeCreative typePromotional imageProfile image
DisplayImage native (IMAGE_NATIVE)720 x 1280 pixels or more (9:16), 500KB, JPG/JPEG/PNG300 x 300 pixels or more (1:1), 500KB, JPG/JPEG/PNG

With the update on February 21, 2023, the types of creatives that can be created for each campaign type have been changed as follows.

Campaign typeCreative typePromotional imageProfile image
Kakao BizboardImage banner (IMAGE_BANNER)1029 x 258, 300KB, PNG-24
DisplayImage native (IMAGE_NATIVE)500 x 500 pixels or more (1:1), 500KB, JPG/JPEG/PNG
1200 x 600 pixels or more (2:1), 500KB, JPG/JPEG/PNG
300 x 300 pixels or more (1:1), 500KB, JPG/JPEG/PNG

Creative landing type

You can now use various creative landing types and landing settings, along with the URL that has been provided already. You can set a creative landing type only under the 'Kakao Bizboard' type of campaign.

We now provide the APIs that retrieve a list to set a landing type, but do not provide the APIs to create an Ad View, Business Form, or others. In the case of purchases using Kakao Pay, you are only allowed to retrieve, not create or modify.

You can check how to use each creative landing type in the table below.

TypeParameter
URLUse mobileLandingUrl to set a URL.
Chatbot, Channel Web ViewUse the Viewing list of Kakao Talk Channel profiles API.
Ad ViewUse the Viewing list of Ad Views for landing settings API.
Business FormUse the Viewing list of Business Forms landing types API.
Channel PostUse Channel Post ID.

Create Display creative

Basic information
MethodURLAuthorization
POSThttps://apis.moment.kakao.com/openapi/v4/creativesBusiness token

Creates a Display creative.

When you request, you must set format (Creative format) to either IMAGE_BANNER, IMAGE_NATIVE, CATALOG_MANUAL, or VIDEO_NATIVE. Depending on the specified creative format, you need to pass different parameters when you request. For example, pass imageFileUrl for the image banner format, pass both imageFileUrl and profileImageFileUrl for the image native format, pass both slides list and profileImageFileUrl for the image catalog format, and pass videoFileUrl and profileImageFileUrl for video native format.

This API supports two types of Content-Type to create an image — application/json and multipart/form-data.

  • application/json: Pass the creative's image path with http:// or https:// URI scheme through the imageFileUrl parameter.
  • multipart/form-data: Pass the creative's local file path through the imageFile parameter.

Send a POST request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the detailed information of the created creative. If failed, refer to Error code to figure out its failure cause.

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

Landing URL

Landing URL has three types — URL for PC (pcLandingUrl), URL for mobile (mobileLandingUrl), and responsive URL(rspvLandingUrl). You must set at least one landing URL among these three types even though each URL is not required. The responsive URL cannot be set with other types.

Request

Header
NameDescriptionRequired
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.
O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.
O
Body: IMAGE_BANNER
NameTypeDescriptionRequired
adGroupIdLongAd group's ID.O
formatStringCreative's type.
Fixed to IMAGE_BANNER.
O
imageFileUrlStringPromotional image.
Image size: 1029x258
File Size: 300KB
File format: PNG-24
Pass a URL with http:// or https:// scheme.
O
Required in case of application/json
imageFileMultipart FilePromotional image.
Image size: 1029x258
File Size: 300KB
File format: PNG-24
Pass the local file path.
O
Required in case of multipart/form-data
landingInfoLandingInfoLanding type.
Allowed to set the landing type of creatives only under the 'Kakao Bizboard' type of campaign.
X
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
Not allowed to set for the 'Kakao Bizboard' type of campaign.
X
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
Not allowed to set for the 'Kakao Bizboard' type of campaign.
X
altTextStringDescription of the creative.
Used for voice guidance for people with disabilities.
Up to 30 characters are allowed.
Special characters are not allowed.
O
nameStringCreative's name.
Up to 50 characters are allowed.
If not specified, the name is automatically set in {CAMPAIGN_TYPE}_{CAMPAIGN_GOAL}_{CURRENT_TIME}_{CREATIVE_SIZE} format.
X
opinionStringOpinion for ad verification.
Up to 1,000 characters.
X
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
X
Available in case of multipart/form-data
Body: IMAGE_NATIVE
NameTypeDescriptionRequired
adGroupIdLongAd group's ID.O
formatStringCreative's type.
Fixed to IMAGE_NATIVE.
O
profileImageFileUrlStringProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
O
Required in case of application/json
profileImageFileMultipart FileProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass the local file path.
O
Required in case of multipart/form-data
imageFileUrlStringPromotional image.
Size: 500x500 or higher (1:1).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 1200x600 or higher (2:1).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 720x1280 or higher (9:16).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 800x1000 or higher (4:5).
File size: 500KB.
File format: JPG/JPEG/PNG.

Enter a valid URL in the format of http:// or https://.
O
application/json.
Required when using this method.
imageFileMultipart FilePromotional image.
Size: 500x500 or higher (1:1).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 1200x600 or higher (2:1).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 720x1280 or higher (9:16).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 800x1000 or higher (4:5).
File size: 500KB.
File format: JPG/JPEG/PNG.

Enter a local file path.
O
multipart/form-data.
Required when using this method.
slidesSlides[]Slide items of IMAGE_NATIVE creative (Minimum 1, Maximum 10).X
titleStringTitle.
Up to 25 characters are allowed.
O
profileNameStringProfile name.
Up to 20 characters are allowed.
O
descriptionStringPromotional text.
Up to 45 characters are allowed.
O
actionButtonActionButtonCall-to-action button.O
actionButtonFontColorStringCall-to-action text color
One of #000000 (Black) or #FFFFFF (White).

Important: When specifying the call-to-action text color, you must also specify actionButtonBackgroundColor (button color).
X
actionButtonBackgroundColorStringButton color
One of the colors except the unsupported ones (#FFFFFF, #F0F0F0, #000000, #FEE500).

Important: When specifying the button color, you must also specify actionButtonFontColor (call-to-action text color).
X
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
Not allowed to set for the 'Kakao Bizboard' type of campaign.
X
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
Not allowed to set for the 'Kakao Bizboard' type of campaign.
X
altTextStringDescription of the creative.
Used for voice guidance for people with disabilities.
Up to 30 characters are allowed.
Special characters are not allowed.
O
nameStringCreative's name.
Up to 50 characters are allowed.
If not specified, the name is automatically set in {CAMPAIGN_TYPE}_{CAMPAIGN_GOAL}_{CURRENT_TIME}_{CREATIVE_SIZE} format.
X
opinionStringOpinion for ad verification.
Up to 1,000 characters.
X
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
X
Available in case of multipart/form-data
Body: CATALOG_MANUAL
NameTypeDescriptionRequired
adGroupIdLongAd group's ID.O
formatStringCreative's type.
Fixed to CATALOG_MANUAL.
O
profileImageFileUrlStringProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
O
Required in case of application/json
profileImageFileMultipart FileProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass the local file path.
O
Required in case of multipart/form-data
slidesSlides[]Slide items of CATALOG_MANUAL creative (Minimum 4, Maximum 10).

Important: Existing assetGroups will no longer be available after 2025.9.30.
O
profileNameStringProfile name.
Up to 20 characters are allowed.
O
actionButtonActionButtonCall-to-action button.O
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
X
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
X
nameStringCreative's name.
Up to 50 characters are allowed.
If not specified, the name is automatically set in {CAMPAIGN_TYPE}_{CAMPAIGN_GOAL}_{CURRENT_TIME}_{CREATIVE_SIZE} format.
X
opinionStringOpinion for ad verification.
Up to 1,000 characters.
X
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
X
Available in case of multipart/form-data
Body: VIDEO_NATIVE
NameTypeDescriptionRequired
adGroupIdLongAd group's ID.O
formatStringCreative's type.
Fixed to VIDEO_NATIVE.
O
profileImageFileUrlStringProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
O
Required in case of application/json
profileImageFileMultipart FileProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass the local file path.
O
Required in case of multipart/form-data
slidesSlides[]Slide items of VIDEO_NATIVE creative (Minimum 1, Maximum 10).X
titleStringTitle.
Up to 25 characters are allowed.
O
profileNameStringProfile name.
Up to 20 characters are allowed.
O
descriptionStringPromotional text.
Up to 45 characters are allowed.
O
actionButtonActionButtonCall-to-action button.O
actionButtonFontColorStringCall-to-action text color
One of #000000 (Black) or #FFFFFF (White).

Important: When specifying the call-to-action text color, you must also specify actionButtonBackgroundColor (button color).
X
actionButtonBackgroundColorStringButton color
One of the colors except the unsupported ones (#FFFFFF, #F0F0F0, #000000, #FEE500).

Important: When specifying the button color, you must also specify actionButtonFontColor (call-to-action text color).
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
If passed,
O*
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
O*
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
O*
nameStringCreative's name.
Up to 50 characters are allowed.
If not specified, the name is automatically set in {CAMPAIGN_TYPE}_{CAMPAIGN_GOAL}_{CURRENT_TIME}_{CREATIVE_SIZE} format.
X
opinionStringOpinion for ad verification.
Up to 1,000 characters.
X
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
X
Available in case of multipart/form-data
videoFileUrlStringPromotional video
Size: 720x1280 pixels or more (9:16) or 1280x720 pixels or more (16:9)
File size: 1GB
File format: AVI/FLV/MP4
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
videoFileMultipartFilePromotional video
Size: 720x1280 pixels or more (9:16) or 1280x720 pixels or more (16:9)
File size: 1GB
File format: AVI/FLV/MP4
Pass the local file path.
X
Available in case of multipart/form-data
uploadThumbnailImageFileUrlStringCustum thumbnail
Size: 1280x720 pixels or more (16:9)
File size: 500KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
uploadThumbnailImageFileMultipartFileCustum thumbnail
Size: 1280x720 pixels or more (16:9)
File size: 500KB
File format: JPG/JPEG/PNG
Pass the local file path.
X
Available in case of multipart/form-data
* One of rspvLandingUrl, mobileLandingUrl, and pcLandingUrl is required.
LandingInfo
NameTypeDescription
landingTypeLandingTypeLanding type.
profileIdStringKakao Talk Channel's profile ID if PF_BOT (Chatbot) or CHANNEL_WEBVIEW is set for a landing type.
Pass the Kakao Talk Channel's profile ID obtained through the Viewing list of Kakao Talk Channel profiles API.
actionStringKeyword if PF_BOT (Chatbot) is set for a landing type.
adViewItemAdViewItemAd View object if AD_VIEW is set for a landing type.
Pass the id obtained through the Viewing list of Ad Views for landing settings API.
urlStringURL if CHANNEL_WEBVIEW (Channel Web View) is set for a landing type.
bizFormIdLongBusiness Form's ID if BIZ_FORM (Business Form) is set for a landing type.
Pass the bizFormId obtained through the Viewing list of Business Forms for landing settings API.
channelPostIdLongChannel post ID if CHANNEL_POST is set for a landing type.
Pass the Post ID obtained through the Viewing list of Channel Posts for landing settings API.
LandingType
NameDescription
PF_BOTChatbot
AD_VIEWAd View
CHANNEL_WEBVIEWChannel Web View
BIZ_FORMBusiness Form
CHANNEL_POSTChannel Post
AdViewItem
NameTypeDescription
idLongAd View's ID.
Slides
  • The previous name of Slides, AssetGroup, will no longer be available after 2025.9.30.
NameTypeDescriptionRequired
imageFileUrlStringSlide image
Image size: 500 x 500 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
O
Required in case of application/json
imageFileMultipart FileSlide image
Image size: 500 x 500 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass the local file path.
O
Required in case of multipart/form-data
titleStringTitle
Up to 25 characters are allowed.
O
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
X
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
X
descriptionStringPromotional text (Maximum: 45 characters).
Not allowed when creating sub-slides of IMAGE_NATIVE (Image native) or VIDEO_NATIVE (Video native).
X
priceAmountStringPrice information(Minimum: 0, Maximum: 9999999999)
Integers only when CurrencyCode is KRW or JPY
Up to 2 decimal places when CurrencyCode is USD, EUR
To use priceAmount, priceCurrencyCode is required.
X
priceCurrencyCodeStringCurrency
One of KRW, USD, JPY, and EUR
To use priceCurrencyCode, priceAmount and discountedPriceAmount are required.
X
discountedPriceAmountStringDiscounted price information(Minimum: 0, Maximum: 9999999999)
Integers only when CurrencyCode is KRW or JPY
Up to 2 decimal places when CurrencyCode is USD, EUR
discountedPriceAmount must be less than priceAmount
To use discountedPriceAmount, priceAmount and priceCurrencyCode are required.
X

Response

Body: IMAGE_BANNER
NameTypeDescription
idLongOriginal creative ID used for execution.
creativeIdLongCreative'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.
adGroupIdLongAd group's ID.
formatStringCreative's type.
IMAGE_BANNER
imageImageUploaded promotional image.
landingInfoLandingInfoSpecified data for landing.
pcLandingUrlStringLanding URL for PC.
mobileLandingUrlStringLanding URL for mobile.
rspvLandingUrlStringResponsive landing URL.
altTextStringDescription of the creative.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
systemConfigStringCreative's system status.
Either ON or ADMIN_STOP.
nameStringCreative's name.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
statusDescriptionStringCurrent status of creative.
opinionProofOpinionFile[]List of materials for ad verification.
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
rejectedReasonString[]Reasons for rejection of creative (Empty array).
Body: IMAGE_NATIVE
NameTypeDescription
idLongOriginal creative ID for execution.
creativeIdLongCreative'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.
adGroupIdLongAd group's ID.
formatStringCreative's type.
Fixed to IMAGE_NATIVE.
profileImageImageUploaded profile image.
imageImageUploaded promotional image.
titleStringTitle.
profileNameStringProfile name.
descriptionStringPromotional text.
actionButtonStringCall-to-action button.
pcLandingUrlStringLanding URL for PC.
mobileLandingUrlStringLanding URL for mobile.
rspvLandingUrlStringResponsive landing URL.
altTextStringDescription of the creative.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
systemConfigStringCreative's system status.
Either ON or ADMIN_STOP.
nameStringCreative's name.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
statusDescriptionStringCurrent status of creative.
opinionProofOpinionFile[]List of materials for ad verification.
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
rejectedReasonString[]Reasons for rejection of creative (Empty array).
Body: CATALOG_MANUAL
NameTypeDescription
idLongOriginal creative ID for execution.
creativeIdLongCreative'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.
adGroupIdLongAd group's ID.
formatStringCreative's type.
Fixed to CATALOG_MANUAL.
profileImageImageUploaded profile image.
assetGroupsAssetGroup[]Slide item.
profileNameStringProfile name.
actionButtonStringCall-to-action button.
pcLandingUrlStringLanding URL for PC.
mobileLandingUrlStringLanding URL for mobile.
rspvLandingUrlStringResponsive landing URL.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
systemConfigStringCreative's system status.
Either ON or ADMIN_STOP.
nameStringCreative's name.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
statusDescriptionStringCurrent status of creative.
creativeStatusStringCreative's operation status.
One of the followings:
  • OPERATING: Possible to opearate.
  • UNAPPROVED: Unapproved.
  • INVALID_DATE: Invalid date.
  • MONITORING_REJECTED: Admin suspended.
  • OFF: User OFF.
  • DELETED: Deleted.
  • ADGROUP_UNAVAILABLE: Impossible to operate ad group.
opinionProofOpinionFile[]List of materials for ad verification.
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
rejectedReasonString[]Reasons for rejection of creative (Empty array).
Body: VIDEO_NATIVE
NameTypeDescription
idLongOriginal creative ID for execution.
creativeIdLongCreative'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.
adGroupIdLongAd group's ID.
formatStringCreative's type.
Fixed to VIDEO_NATIVE.
profileImageFileUrlStringProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
profileImageFileMultipart FileProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass the local file path.
titleStringTitle.
profileNameStringProfile name.
descriptionStringPromotional text.
actionButtonStringCall-to-action button.
rspvLandingUrlStringResponsive landing URL.
mobileLandingUrlStringLanding URL for mobile.
pcLandingUrlStringLanding URL for PC.
nameStringCreative's name.
opinionStringOpinion for ad verification.
Up to 1,000 characters.
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
frequencyCapTypeStringAuto setting type of frequency capping.
frequencyCapIntegerFrequency capping.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
systemConfigStringCreative's system status.
Either ON or ADMIN_STOP.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
creativeStatusStringCreative's operation status.
One of the followings:
  • OPERATING: Possible to opearate.
  • UNAPPROVED: Unapproved.
  • INVALID_DATE: Invalid date.
  • MONITORING_REJECTED: Admin suspended.
  • OFF: User OFF.
  • DELETED: Deleted.
  • ADGROUP_UNAVAILABLE: Impossible to operate ad group.
imageImageUploaded promotional image.
profileImageImageUploaded profile image.
videoVideoUploaded promotional video.
statusDescriptionStringCurrent status of creative.
rejectedReasonString[]Reasons for rejection of creative (Empty array).
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
thumbnailImageImageUploaded custom thumbnail image.

Sample

Request: application/json
curl -X POST "https://apis.moment.kakao.com/openapi/v4/creatives" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
-H "Content-Type: application/json" \
-d '{
"adGroupId":1234,
"format":"IMAGE_BANNER",
"imageFileUrl":"https://www.image.com/sample.png",
"altText":"creative_description",
"landingInfo": {
"landingType":"AD_VIEW",
"adViewItem":{"id":1}
},
"name": "first_image_banner"
}'
Request: multipart/form-data
curl -X POST "https://apis.moment.kakao.com/openapi/v4/creatives" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: multipart/form-data" \
-F "adGroupId=1234" \
-F "format=IMAGE_BANNER" \
-F "imageFile=@local_640X200_image_path" \
-F "altText=creative_description" \
-F "name=first_image_banner" \
-F "mobileLandingUrl=http://www.daum.net" \
-F "landingInfo.landingType=AD_VIEW" \
-F "landingInfo.adViewItem.id=search_query"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"id": 1,
"creativeId": 2,
"adGroupId": 1234,
"format": "IMAGE_BANNER",
"name": "first_image_banner",
"landingInfo": {
"landingType": "AD_VIEW",
"adViewItem": {"id":1}
},
"pcLandingUrl": null,
"mobileLandingUrl": "&bid=null&DA=XYZ",
"rspvLandingUrl": null,
"frequencyCap": null,
"frequencyCapType": "AUTO",
"config": "ON",
"systemConfig": "ON",
"reviewStatus": "WAITING",
"image": {
"url": "http://xxx.kakao.co.kr/sample_image_banner_xxx.jpeg",
"fileName": "sample.jpeg",
"width": 640,
"height": 100,
"size": 50000
},
"altText": "creative_description",
"statusDescription": "심사중",
"createdDate": "2020-01-01T00:00:00.00000",
"lastModifiedDate": "2020-01-01T00:00:00.000000",
"rejectedReason": []
}

Edit Display creative

Basic information
MethodURLAuthorization
PUThttps://apis.moment.kakao.com/openapi/v4/creativesBusiness token

Enables you to edit display creatives.

The parameters to be provided differ depending on the creative type. For example, IMAGE_BANNER requires imageFileUrl, IMAGE_NATIVE requires both imageFileUrl and profileImageFileUrl, CATALOG_MANUAL requires slides list and profileImageFileUrl, and VIDEO_NATIVE requires both videoFileUrl and profileImageFileUrl.

This API enables you to edit a Display creative. Depending on the creative type, you need to pass different parameters when you request. For example, pass imageFileUrl for image banner format, and pass both imageFileUrl and profileImageFileUrl for image native format, and pass videoFileUrl and profileImageFileUrl for video native format.

This API supports two types of Content-Type to create an image — application/json and multipart/form-data.

  • application/json: Pass the creative's image path in http:// or https:// URI scheme through the imageFileUrl parameter.
  • multipart/form-data: Pass the creative's local file path through the imageFile parameter.

No matter which type you request, the result of editing a creative is the same. If there is no imageFileUrl or profileImageFileUrl in the request body, the image that has previously registered is used.

Send a PUT request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the detailed information of the modified creative. Some response fields may return null even though they are not used. If failed, refer to Error code to figure out its failure cause.

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

Request

Header
NameDescriptionRequired
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.
O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.
O
Body: IMAGE_BANNER
NameTypeDescriptionRequired
idLongOriginal creative ID for execution.O
adGroupIdLongAd group's ID.O
formatStringCreative's type.
Fixed to IMAGE_BANNER.
O
imageFileUrlStringPromotional image.
Image size: 1029x258
File Size: 300KB
File format: PNG-24
Pass a URL with http:// or https:// scheme.
O
Required in case of application/json
imageFileMultipart FilePromotional image.
Image size: 1029x258
File Size: 300KB
File format: PNG-24
Pass the local file path.
O
Required in case of multipart/form-data
landingInfoLandingInfoData to be set for landing.
Not allowed to request three types of the landing URL at once.
X
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
Not allowed to set for the 'Kakao Bizboard' type of campaign.
X
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
Not allowed to set for the 'Kakao Bizboard' type of campaign.
X
altTextStringDescription of the creative.
Used for voice guidance for people with disabilities.
Up to 30 characters are allowed.
Special characters are not allowed.
O
nameStringCreative's name.
Up to 50 characters are allowed.
If you do not specify, the name specified when creating the creative is used.
X
opinionStringOpinion for ad verification.
Up to 1,000 characters.
X
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
X
Available in case of multipart/form-data
Body: IMAGE_NATIVE
NameTypeDescriptionRequired
idLongOriginal creative ID for execution.O
adGroupIdLongAd group's ID.O
formatStringCreative type.
Fixed to IMAGE_NATIVE.
O
profileImageFileUrlStringProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
O
Required in case of application/json
profileImageFileMultipart FileProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass the local file path.
O
Required in case of multipart/form-data
imageFileUrlStringPromotional image.
Size: 500x500 or higher (1:1).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 1200x600 or higher (2:1).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 720x1280 or higher (9:16).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 800x1000 or higher (4:5).
File size: 500KB.
File format: JPG/JPEG/PNG.

Enter a valid URL in the format of http:// or https://.
O
application/json.
Required when using this method.
imageFileMultipart FilePromotional image.
Size: 500x500 or higher (1:1).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 1200x600 or higher (2:1).
File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 720x1280 or higher (9:16).

File size: 500KB.
File format: JPG/JPEG/PNG.

Size: 800x1000 or higher (4:5).
File size: 500KB.
File format: JPG/JPEG/PNG.

Enter a local file path.
O
multipart/form-data.
Required when using this method.
slidesSlides[]Slide items of IMAGE_NATIVE creative (Minimum 1, Maximum 10).X
titleStringTitle.
Up to 25 characters are allowed.
O
profileNameStringProfile name.
Up to 20 characters are allowed.
O
descriptionStringPromotional text.
Up to 45 characters are allowed.
O
actionButtonActionButtonCall-to-action button.O
actionButtonFontColorStringCall-to-action text color
One of #000000 (Black) or #FFFFFF (White).

Important: When specifying the call-to-action text color, you must also specify actionButtonBackgroundColor (button color).
X
actionButtonBackgroundColorStringButton color
One of the colors except the unsupported ones (#FFFFFF, #F0F0F0, #000000, #FEE500).

Important: When specifying the button color, you must also specify actionButtonFontColor (call-to-action text color).
X
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
X
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
X
altTextStringDescription of the creative.
Used for voice guidance for people with disabilities.
Up to 30 characters are allowed.
Special characters are not allowed.
O
nameStringCreative's name.
Up to 50 characters are allowed.
If you do not specify, the name specified when creating the creative is used.
X
opinionStringOpinion for ad verification.
Up to 1,000 characters.
X
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
X
Available in case of multipart/form-data
Body: CATALOG_MANUAL
NameTypeDescriptionRequired
idLongOriginal creative ID for execution.O
adGroupIdLongAd group's ID.O
formatStringCreative's type.
Fixed to CATALOG_MANUAL.
O
profileImageFileUrlStringProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
profileImageFileMultipart FileProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass the local file path.
X
Available in case of multipart/form-data
slidesSlides[]Slide items of CATALOG_MANUAL creative (Minimum 4, Maximum 10).

Important: Existing assetGroups will no longer be available after 2025.9.30.
O
profileNameStringProfile name.
Up to 20 characters are allowed.
O
actionButtonActionButtonCall-to-action button.O
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
X
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
X
nameStringCreative's name.
Up to 50 characters are allowed.
If not specified, the name is automatically set in {CAMPAIGN_TYPE}_{CAMPAIGN_GOAL}_{CURRENT_TIME}_{CREATIVE_SIZE} format.
X
opinionStringOpinion for ad verification.
Up to 1,000 characters.
X
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
X
Available in case of multipart/form-data
Body: VIDEO_NATIVE
NameTypeDescriptionRequired
idLongOriginal creative ID used for execution.O
adGroupIdLongAd group's ID.O
formatStringCreative's type.
Fixed to VIDEO_NATIVE.
O
profileImageFileUrlStringProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
profileImageFileMultipart FileProfile image.
Image size: 300 x 300 pixels or more (1:1)
File Size: 500 KB
File format: JPG/JPEG/PNG
Pass the local file path.
X
Available in case of multipart/form-data
slidesSlides[]Slide items of VIDEO_NATIVE creative (Minimum 1, Maximum 10).X
titleStringTitle.
Up to 25 characters are allowed.
O
profileNameStringProfile name.
Up to 20 characters are allowed.
O
descriptionStringPromotional text.
Up to 45 characters are allowed.
O
actionButtonActionButtonCall-to-action button.O
actionButtonFontColorStringCall-to-action text color
One of #000000 (Black) or #FFFFFF (White).

Important: When specifying the call-to-action text color, you must also specify actionButtonBackgroundColor (button color).
X
actionButtonBackgroundColorStringButton color
One of the colors except the unsupported ones (#FFFFFF, #F0F0F0, #000000, #FEE500).

Important: When specifying the button color, you must also specify actionButtonFontColor (call-to-action text color).
X
rspvLandingUrlStringRepresentative responsive landing URL.
Pass a valid URL with http:// or https:// scheme.
If passed,
O*
mobileLandingUrlStringRepresentative landing URL for mobile.
Pass a valid URL with http:// or https:// scheme.
O*
pcLandingUrlStringRepresentative landing URL for PC.
Pass a valid URL with http:// or https:// scheme.
O*
nameStringCreative's name.
Up to 50 characters are allowed.
If not specified, the name is automatically set in {CAMPAIGN_TYPE}_{CAMPAIGN_GOAL}_{CURRENT_TIME}_{CREATIVE_SIZE} format.
X
opinionStringOpinion for ad verification.
Up to 1,000 characters.
X
opinionProofFileUrlListString[]Material for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
opinionProofFileListMultipart FileMaterial for ad verification.
File format: JPG, JPEG, PNG, PDF
Total file size: 10 MB or less
Up to 10 files are allowed.
Pass the local file path.
X
Available in case of multipart/form-data
videoFileUrlStringPromotional video
Size: 720x1280 pixels or more (9:16) or 1280x720 pixels or more (16:9)
File size: 1GB
File format: AVI/FLV/MP4
Pass a valid URL with http:// or https:// scheme.
O
Required in case of application/json
videoFileMultipartFilePromotional video
Size: 720x1280 pixels or more (9:16) or 1280x720 pixels or more (16:9)
File size: 1GB
File format: AVI/FLV/MP4
Pass the local file path.
O
Required in case of multipart/form-data
uploadThumbnailImageFileUrlStringCustum thumbnail
Size: 1280x720 pixels or more (16:9)
File size: 500KB
File format: JPG/JPEG/PNG
Pass a valid URL with http:// or https:// scheme.
X
Available in case of application/json
uploadThumbnailImageFileMultipartFileCustum thumbnail
Size: 1280x720 pixels or more (16:9)
File size: 500KB
File format: JPG/JPEG/PNG
Pass the local file path.
X
Available in case of multipart/form-data
* One of rspvLandingUrl, mobileLandingUrl, and pcLandingUrl is required.
Landing URL

Landing URL has three types — URL for PC (pcLandingUrl), URL for mobile (mobileLandingUrl), and responsive URL(rspvLandingUrl). You must set at least one landing URL among these three types even though each URL is not required. The Video native and Image box among Display ad creatives do not support landing URLs by type.

Response

Body: IMAGE_BANNER
NameTypeDescription
idLongOriginal creative ID for execution.
creativeIdLongCreative'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.
adGroupIdLongAd group's ID.
formatStringCreative's type.
IMAGE_BANNER
imageImageUploaded promotional image.
landingInfoLandingInfoSpecified data for landing.
pcLandingUrlStringLanding URL for PC.
mobileLandingUrlStringLanding URL for mobile.
rspvLandingUrlStringResponsive landing URL.
frequencyCapTypeStringAuto setting type of frequency capping.
frequencyCapIntegerFrequency capping.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
nameStringCreative's name.
altTextStringDescription of the creative.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
statusDescriptionStringCurrent status of creative.
opinionProofOpinionFile[]List of materials for ad verification.
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
rejectedReasonString[]Reasons for rejection of creative (Empty array).
Body: IMAGE_NATIVE
NameTypeDescription
idLongOriginal creative ID for execution.
creativeIdLongCreative'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.
adGroupIdLongAd group's ID.
formatStringCreative's type.
IMAGE_NATIVE
profileImageImageUploaded profile image.
imageImageUploaded promotional image.
titleStringTitle.
profileNameStringProfile name.
descriptionStringPromotional text.
actionButtonStringCall-to-action button.
pcLandingUrlStringLanding URL for PC.
mobileLandingUrlStringLanding URL for mobile.
rspvLandingUrlStringResponsive landing URL.
frequencyCapTypeStringAuto setting type of frequency capping.
frequencyCapIntegerFrequency capping.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
nameStringCreative's name.
altTextStringDescription of the creative.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
statusDescriptionStringCurrent status of creative.
opinionProofOpinionFile[]List of materials for ad verification.
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
rejectedReasonString[]Reasons for rejection of creative (Empty array).
Body: CATALOG_MANUAL
NameTypeDescription
idLongOriginal creative ID for execution.
creativeIdLongCreative'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.
adGroupIdLongAd group's ID.
formatStringCreative's type.
Fixed to CATALOG_MANUAL.
profileImageImageUploaded profile image.
profileNameStringProfile name.
assetGroupsAssetGroup[]Slide item.
actionButtonStringCall-to-action button.
pcLandingUrlStringLanding URL for PC.
mobileLandingUrlStringLanding URL for mobile.
rspvLandingUrlStringResponsive landing URL.
frequencyCapTypeStringAuto setting type of frequency capping.
frequencyCapIntegerFrequency capping.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
systemConfigStringCreative's system status.
Either ON or ADMIN_STOP.
nameStringCreative's name.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
creativeStatusStringCreative's operation status.
One of the followings:
  • OPERATING: Possible to opearate.
  • UNAPPROVED: Unapproved.
  • INVALID_DATE: Invalid date.
  • MONITORING_REJECTED: Admin suspended.
  • OFF: User OFF.
  • DELETED: Deleted.
  • ADGROUP_UNAVAILABLE: Impossible to operate ad group.
statusDescriptionStringCurrent status of creative.
opinionProofOpinionFile[]List of materials for ad verification.
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
rejectedReasonString[]Reasons for rejection of creative (Empty array).
Body: VIDEO_NATIVE
NameTypeDescription
idLongOriginal creative ID used for execution.
creativeIdLongCreative'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.
formatStringCreative's type.
Fixed to VIDEO_NATIVE.
nameStringCreative's name.
adGroupIdLongAd group's ID.
pcLandingUrlStringLanding URL for PC.
mobileLandingUrlStringLanding URL for mobile.
rspvLandingUrlStringResponsive landing URL.
frequencyCapTypeStringAuto setting type of frequency capping.
frequencyCapIntegerFrequency capping.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
systemConfigStringCreative's system status.
Either ON or ADMIN_STOP.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
creativeStatusStringCreative's operation status.
One of the followings:
  • OPERATING: Possible to opearate.
  • UNAPPROVED: Unapproved.
  • INVALID_DATE: Invalid date.
  • MONITORING_REJECTED: Admin suspended.
  • OFF: User OFF.
  • DELETED: Deleted.
  • ADGROUP_UNAVAILABLE: Impossible to operate ad group.
imageImageUploaded promotional image.
titleStringTitle.
descriptionStringPromotional text.
actionButtonStringCall-to-action button.
profileNameStringProfile name.
profileImageImageUploaded profile image.
videoVideoUploaded promotional video.
statusDescriptionStringCurrent status of creative.
rejectedReasonString[]Reasons for rejection of creative (Empty array).
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
opinionProofOpinionFile[]List of materials for ad verification.
thumbnailImageImageUploaded custom thumbnail image.

Sample

Request: application/json
curl -X PUT "https://apis.moment.kakao.com/openapi/v4/creatives" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: application/json" \
-d '{
"id":1234,
"adGroupId":5678,
"format":"IMAGE_BANNER",
"imageFileUrl":"http://www.company.com/images/sample_image_banner.jpg",
"altText":"edit_creative_description",
"mobileLandingUrl":"http://www.daum.net",
"name":"edit_image"
}'
Request: multipart/form-data
curl -X PUT "https://apis.moment.kakao.com/openapi/v4/creatives" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-H "Content-Type: multipart/form-data" \
-F "id=1234" \
-F "adGroupId=5678" \
-F "format=IMAGE_BANNER" \
-F "imageFile=@local_640X200_image_path" \
-F "altText=edit_creative_description" \
-F "mobileLandingUrl=http://www.daum.net"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"id": 1234,
"creativeId": 1235,
"adGroupId": 5678,
"format": "IMAGE_BANNER",
"name": "edit_image",
"landingInfo": {
"landingType": "AD_VIEW",
"communicatorAdViewId": 1
},
"pcLandingUrl": null,
"mobileLandingUrl": null,
"rspvLandingUrl": null,
"frequencyCap": null,
"frequencyCapType": "AUTO",
"config": "ON",
"systemConfig": "ON",
"reviewStatus": "WAITING",
"image": {
"url": "http://xxx.kakao.co.kr/sample_image_banner_xxx.jpg",
"fileName": "sample_image_banner.jpg",
"width": 640,
"height": 100,
"size": 50000
},
"altText": "edit_creative_description",
"statusDescription": "심사중",
"createdDate": "2020-01-01T00:00:00.00000",
"lastModifiedDate": "2020-01-01T00:00:00.000000",
"rejectedReason": []
}

Copy Display creative

Basic information
MethodURLAuthorization
POSThttps://apis.moment.kakao.com/openapi/v4/creatives/copyBusiness token

Enables you to copy a Display creative.

You can request to copy up to 20 creatives but may fail to copy if exceeding the maximum number of creatable creatives of an account.

You can copy only the Image banner, Image native, Image catalog, and Video native creatives under the 'Kakao Bizboard X Visit(방문)', 'Kakao Bizboard X Conversion(전환)', 'Display X Visit(방문)', 'Display X Conversion(전환)', and 'Vidoe X View(조회)' type of campaign.

Send a POST request with the issued business token and an ad account ID (adAccountId) in the request header. You must also pass the ad group ID which the creatives will copy to and the creative IDs to be copied as a list. If the request is successful, this API returns the detailed information of the copied creatives. If failed, refer to Error code to figure out its failure cause.

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

Request

Header
NameDescriptionRequired
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.
O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.
O
Body
NameTypeDescriptionRequired
adGroupIdLongAd group ID which the creatives will be copied to (Up to 100).O
creativeIdsLong[]List of creative IDs to be copied.O

Response

Body
NameTypeDescription
-DisplayCreative[]List of creative information.
DisplayCreative
NameTypeDescription
idLongOriginal creative ID for execution.
creativeIdLongCreative'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.
nameStringCreative's name.
formatStringCreative type.
One of IMAGE_BANNER, IMAGE_NATIVE, CATALOG_MANUAL, or VIDEO_NATIVE.
landingUrlStringLanding URL.
frequencyCapIntegerFrequency capping.
configStringCreative's status.
One of ON, OFF, or DEL (Deleted).
systemConfigStringCreative's system status.
Either ON or ADMIN_STOP.
reviewStatusStringReview status.
One of the followings:
  • APPROVED: Review approved.
  • WAITING Review in progress.
  • REJECTED: Review rejected.
  • MODIFICATION_WAITING: Review for modification in progress.
  • MODIFICATION_REJECTED: Review for modification rejected.
creativeStatusStringCreative's operation status.
One of the followings:
  • OPERATING: Possible to opearate.
  • UNAPPROVED: Unapproved.
  • INVALID_DATE: Invalid date.
  • MONITORING_REJECTED: Admin suspended.
  • OFF: User OFF.
  • DELETED: Deleted.
  • ADGROUP_UNAVAILABLE: Impossible to operate ad group.
statusDescriptionStringCurrent status of creative.
imageImageInformation about the main image of the IMAGE_BANNER, IMAGE_NATIVE, and VIDEO_NATIVE type of creative.
assetGroupsAssetGroup[]Slide item of CATALOG_MANUAL.
landingInfoLandingInfoSpecified data for landing.
altTextStringAlternative description of the IMAGE_BANNER type of creative.
titleStringTitle of the IMAGE_NATIVE or VIDEO_NATIVE type of creative.
actionButtonStringCall-to-action button of the IMAGE_NATIVE, VIDEO_NATIVE or CATALOG_MANUAL type of creative.
profileNameStringProfile name of the IMAGE_NATIVE, VIDEO_NATIVE or CATALOG_MANUAL type of creative.
descriptionStringPromotional text of the IMAGE_NATIVE or VIDEO_NATIVE type of creative.
profileImageImageUploaded profile image.
videoVideoVideo with the VIDEO_NATIVE type of creative.
rejectedReasonRejectedReasonReasons for rejection of creative.
opinionProofOpinionFile[]List of materials for ad verification.
createdDateStringDate and time when the creative is created.
lastModifiedDateStringDate and time when the creative is lastly modified.
thumbnailImageImageUploaded custom thumbnail image.

Sample

Request
curl -X POST "https://apis.moment.kakao.com/openapi/v4/creatives/copy" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-d '{
"adGroupId" : 23456,
"creativeIds" : [34567,34568]
}'
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
{
"id": 35678,
"creativeId": 35678,
"adGroupId": 23456,
"format": "IMAGE_BANNER",
"name": "image_creative1",
"landingInfo": {
"landingType": "URL",
"url": "http://m.daum.net"
},
"pcLandingUrl": null,
"mobileLandingUrl": "http://m.daum.net",
"rspvLandingUrl": null,
"frequencyCap": null,
"frequencyCapType": "AUTO",
"config": "ON",
"systemConfig": "ON",
"reviewStatus": "APPROVED",
"creativeStatus": "OPERATING",
"image": {
"url": "http://xxx.kakao.co.kr/sample_image_111.jpg",
"fileName": "sample_image.jpg",
"width": 640,
"height": 480,
"size": 100000
},
"altText": "image_description1",
"title": "Title",
"description": "Promotion text",
"actionButton": "JOIN",
"profileName": "Profile name",
"profileImage": {
"url": "http://xxx.kakao.co.kr/sample_profile_111.jpg",
"fileName": "sample_profile.jpg",
"width": 300,
"height": 300,
"size": 50000
},
"video": {
"url": "http://xxx.kakao.co.kr/sample_image_111.avi",
"fileName": "sample_video.avi",
"size": 500000,
"duration": 3.0
},
"statusDescription": "운영중",
"rejectedReason": [],
"createdDate": "2020-01-01T00:00:00.000000",
"lastModifiedDate": "2020-01-01T00:00:00.000000",
"opinionProof": null,
"thumbnailImage": {
"url": "http://xxx.kakao.co.kr/sample_image_111.jpg",
"fileName": "sample_image.jpg",
"width": 640,
"height": 480,
"size": 100000
},
{
"id": 35679,
"creativeId": 35679,
"adGroupId": 23456,
"format": "IMAGE_BANNER",
"name": "image_creative2",
"landingInfo": {
"landingType": "URL",
"url": "http://m.daum.net"
},
"pcLandingUrl": null,
"mobileLandingUrl": "http://m.daum.net",
"rspvLandingUrl": null,
"frequencyCap": null,
"frequencyCapType": "AUTO",
"config": "ON",
"systemConfig": "ON",
"reviewStatus": "APPROVED",
"creativeStatus": "OPERATING",
"image": {
"url": "http://xxx.kakao.co.kr/sample_image_222.jpg",
"fileName": "sample_image.jpg",
"width": 640,
"height": 480,
"size": 100000
},
"altText": "image_description2",
"title": "Title",
"description": "Promotion text",
"actionButton": "JOIN",
"profileName": "Profile name",
"profileImage": {
"url": "http://xxx.kakao.co.kr/sample_profile_222.jpg",
"fileName": "sample_profile.jpg",
"width": 300,
"height": 300,
"size": 50000
},
"video": {
"url": "http://xxx.kakao.co.kr/sample_image_222.avi",
"fileName": "sample_video.avi",
"size": 500000,
"duration": 3.0
},
"statusDescription": "운영중",
"rejectedReason": [],
"createdDate": "2020-01-01T00:00:00.000000",
"lastModifiedDate": "2020-01-01T00:00:00.000000",
"opinionProof": null,
"thumbnailImage": {
"url": "http://xxx.kakao.co.kr/sample_image_222.jpg",
"fileName": "sample_image.jpg",
"width": 640,
"height": 480,
"size": 100000
}
]

Retrieve materials for Display ad verification

Basic information
MethodURLAuthorization
GEThttps://apis.moment.kakao.com/openapi/v4/creatives/${ID}/opinionProofBusiness token

Retrieves the materials for verification that are submitted for the corresponding Display creative.

Send a GET request with the issued business token in the request header. If the request is successful, this API returns the information on the materials for verification in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header
NameDescriptionRequired
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Business token as a type of user authentication.
O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
Ad account's ID.
O
Path variable
NameTypeDescriptionRequired
IDLongOriginal creative ID for execution.O

Response

Body
NameTypeDescription
idLongOpinion ID.
opinionStringOpinion for ad verification.
opinionProofFileListOpinionFile[]List of materials for verification.

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/creatives/${ID}/opinionProof" \
-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,
"opinion": "의견증빙",
"opinionProofFileList": [
{
"id": 11,
"originalFileName": "sample_1.jpg",
"downloadUrl": "https://xxx.kakao.com/sample_1.jpg"
}
]
}
Response: Fail
{
"code": -813,
"msg": "KakaoMomentException",
"extras": {
"detailCode": 75637,
"detailMsg": "의견증빙 정보가 존재하지 않습니다."
}
}

See more

Was this helpful?