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

kakao developers

관련사이트
  • 문서
  • 카카오모먼트
  • 광고 생성: 메시지 소재

사이드 메뉴

카카오맵

검색

카카오모먼트

광고 생성: 메시지 소재

이 문서는 메시지 소재 API 사용 방법을 안내합니다.

시작하기 전에

발송 시간에 따른 소재 등록, 추가 정책

시작일이 지난 발송 그룹에 소재를 생성하는 경우 광고그룹 상태에 따라 소재 저장 시 즉시 메시지가 발송될 수 있습니다. 소재 생성시 상위 광고그룹의 시작기간과 상태를 확인하시기 바랍니다.

유형발송시작 5분전발송시작 5분전~발송시점집행기간 내집행 종료 후
일반 메시지등록 가능등록가능등록가능등록 불가
소재 최적화등록 가능/ 추가 가능등록가능/ 광고그룹 OFF일때 추가 가능등록가능/ 광고그룹 OFF일때 추가 가능등록 불가/ 소재 추가 불가

소재 유형 및 필수 요소

프리미엄동영상(PREMIUM_VIDEO_MESSAGE) 유형 및 쿠폰북 에셋 그룹(CouponBookAssetGroup)이 포함된 소재는 오픈API로 생성이 불가합니다.

메시지 집행 가이드와 맞지 않는 이미지와 문구는 사용할 수 없습니다.

기본 텍스트형
요소필수랜딩: URL랜딩: 소식랜딩: 쿠폰랜딩: 애드뷰랜딩: 비즈니스폼
홍보이미지XXXXXX
홍보동영상X카카오 TV 랜딩카카오 TV 랜딩카카오 TV 랜딩카카오 TV 랜딩카카오 TV 랜딩
홍보문구O랜딩 없음랜딩 없음랜딩 없음랜딩 없음랜딩 없음
버튼 1XOOOXX
버튼 2XOOOOO
공유하기X랜딩 없음랜딩 없음랜딩 없음랜딩 없음랜딩 없음
  • 홍보이미지:
    • 가로 80px 이상, jpg.png(최대 10MB), 원본 이미지 최대 2억 픽셀 이하
    • 가로:세로 비율 1:2.5 이하
    • 버튼 1 랜딩이 있으면 동일한 랜딩 적용 (별도 설정 불가)
  • 홍보동영상: 직접 업로드한 영상 또는 카카오TV 채널에 업로드된 공개/비공개 영상 중 선택 가능
    • 버튼 1 랜딩이 있으면 동일한 랜딩 적용 (별도 설정 불가)
  • 홍보문구:
    • 이미지 또는 동영상 첨부 여부와 관계없이 최대 1,300자 입력 가능
    • 링크 입력 불가, 개행은 99개까지 가능
  • 버튼 1:
    • 레이블: 띄어쓰기 포함 최대 8자(초과 시 입력 제한)
  • 버튼 2:
    • 레이블: 띄어쓰기 포함 최대 8자(초과 시 입력 제한)
와이드이미지형
요소필수랜딩: URL랜딩: 소식랜딩: 쿠폰랜딩: 애드뷰랜딩: 비즈니스폼
홍보이미지O
홍보이미지, 홍보동영상 중 하나 필수
OOOXX
홍보동영상O
홍보이미지, 홍보동영상 중 하나 필수
카카오 TV 랜딩카카오 TV 랜딩카카오 TV 랜딩카카오 TV 랜딩카카오 TV 랜딩
홍보문구O랜딩 없음랜딩 없음랜딩 없음랜딩 없음랜딩 없음
버튼XOOOOO
공유하기X랜딩 없음랜딩 없음랜딩 없음랜딩 없음랜딩 없음
  • 홍보이미지:
    • 가로 80px 이상, jpg.png(최대 10MB), 원본 이미지 최대 2억 픽셀 이하
    • 가로:세로 비율 1:2.5 이하
  • 홍보동영상: 카카오TV 채널에 업로드된 공개/비공개 영상 중 선택 가능
  • 홍보문구:
    • 최대 76자 입력 가능(초과 시 입력 제한)
    • 링크 입력 불가, 개행은 5개까지 가능(필드에서 포커스 이동 시 유효성 검증)
  • 버튼:
    • 레이블: 띄어쓰기 포함 최대 8자(초과 시 입력 제한)
와이드리스트형
요소필수랜딩: URL랜딩: 소식랜딩: 쿠폰랜딩: 애드뷰랜딩: 비즈니스폼
리스트1 타이틀필수 아님랜딩 없음랜딩 없음랜딩 없음랜딩 없음랜딩 없음
리스트2~3 타이틀O랜딩 없음랜딩 없음랜딩 없음랜딩 없음랜딩 없음
리스트1~3 홍보이미지O
홍보이미지, 홍보동영상 중 하나 필수
OOOXX
리스트1~3 홍보동영상O
홍보이미지, 홍보동영상 중 하나 필수
카카오TV로만 랜딩카카오TV로만 랜딩카카오TV로만 랜딩카카오TV로만 랜딩카카오TV로만 랜딩
리스트1~3 홍보문구O각 항목에 설정된 홍보이미지, 홍보동영상과 동일각 항목에 설정된 홍보이미지, 홍보동영상과 동일각 항목에 설정된 홍보이미지, 홍보동영상과 동일각 항목에 설정된 홍보이미지, 홍보동영상과 동일각 항목에 설정된 홍보이미지, 홍보동영상과 동일
리스트4~5 홍보이미지XOOOXX
리스트4~5 홍보동영상X카카오TV로만 랜딩카카오TV로만 랜딩카카오TV로만 랜딩카카오TV로만 랜딩카카오TV로만 랜딩
리스트4~5 홍보문구X각 항목에 설정된 홍보이미지, 홍보동영상과 동일각 항목에 설정된 홍보이미지, 홍보동영상과 동일각 항목에 설정된 홍보이미지, 홍보동영상과 동일각 항목에 설정된 홍보이미지, 홍보동영상과 동일각 항목에 설정된 홍보이미지, 홍보동영상과 동일
버튼XOOOOO
공유하기X랜딩 없음랜딩 없음랜딩 없음랜딩 없음랜딩 없음
  • 타이틀: 최대 20자 입력 가능(초과 시 입력 제한)
  • 리스트1~3 홍보이미지:
    • 가로 80px 이상, jpg.png(최대 10MB) 원본 이미지 최대 2억 픽셀 이하
    • 가로:세로 비율 1:2.5 이하
    • 항목1의 경우 800X400 px, 나머지는 400X400 px 권장 가이드
  • 리스트1~3 홍보동영상: 카카오TV 채널에 업로드된 공개/비공개 영상 중 선택 가능
  • 리스트1~3 홍보문구:
    • 항목1의 경우 최대 25자, 나머지는 최대 30자 입력 가능(초과 시 입력 제한)
    • 링크 입력 불가, 개행은 1개까지 가능(필드에서 포커스 이동 시 유효성 검증)
  • 리스트4~5 홍보이미지:
    • 가로 80px 이상, jpg.png(최대 10MB) 원본 이미지 최대 2억 픽셀 이하
    • 가로:세로 비율 1:2.5 이하
  • 리스트4~5 홍보동영상: 카카오TV 채널에 업로드된 공개/비공개 영상 중 선택 가능
  • 리스트4~5 홍보문구:
    • 항목1의 경우 최대 25자, 나머지는 최대 30자 입력 가능(초과 시 입력 제한)
    • 링크 입력 불가, 개행은 1개까지 가능
  • 버튼:
    • 레이블: 띄어쓰기 포함 최대 8자(초과 시 입력 막힘)

소재 수정 정책

수정은 기존의 메시지와 동일한 포맷이어야 합니다. 집행 5분전 이후부터는 소재의 이름만 수정가능합니다. 이름을 제외한 다른 파라미터는 무시됩니다.

메시지 집행 가이드와 맞지 않는 이미지와 문구는 사용할 수 없습니다.

유형발송시작 5분전발송시작 5분전~발송시점집행기간 내집행 종료 후
일반 메시지가능불가불가불가
소재 최적화가능불가불가불가

프리미엄동영상(PREMIUM_VIDEO_MESSAGE) 유형 및 쿠폰북 에셋 그룹(CouponBookAssetGroup)이 포함된 소재는 오픈API로 수정이 불가합니다.

소재 복사 불가 케이스

프리미엄동영상(PREMIUM_VIDEO_MESSAGE) 유형 및 쿠폰북 에셋 그룹(CouponBookAssetGroup)이 포함된 소재는 오픈API로 복사가 불가합니다.

케이스처리
카카오톡 채널이 다른 캠페인 하위 메시지소재 복사 팝업에서 캠페인 선택 리스트에는 채널의 프로필ID가 일치하는 것만 노출됨
카카오톡 채널이 같은 캠페인 하위 메시지소재 복사 팝업에서 ageVerification: true인 기존 광고그룹의 하위 소재는 ageVerification: false인 신규 광고그룹으로 복사 불가
에디터 배포 전에 광고그룹 하위에 저장한 채널 파트너센터 메시지복사 대상으로 선택한 소재 중에 포함된 경우 얼럿 노출
쿠폰의 상태가 즉시종료, 응모기간완료 상태인 쿠폰을 랜딩으로 하는 메시지복사 가능 소재 개수에 카운트 하지 않고, 리스트에는 '복사불가' 표시
비즈니스폼의 상태가 종료, 긴급종료 상태인 비즈니스폼을 랜딩으로 하는 메시지복사 가능 소재 개수에 카운트 하지 않고, 리스트에는 '복사불가' 표시
소식의 상태가 삭제 상태인 소식를 랜딩으로 하는 메시지복사 가능 소재 개수에 카운트 하지 않고, 리스트에는 '복사불가' 표시
애드뷰의 상태가 삭제 상태인 애드뷰를 랜딩으로 하는 메시지복사 가능 소재 개수에 카운트 하지 않고, 리스트에는 '복사불가' 표시

버튼 항목

  • 기본 텍스트, 와이드 이미지, 와이드 리스트 유형은 버튼 미설정 가능
  • 캐러셀 커머스, 캐러셀 피드는 버튼 1 필수
소재 유형설정 가능 버튼 수버튼 1 설정 가능 랜딩버튼 2 설정 가능 랜딩
BASIC_TEXT_MESSAGE (기본텍스트)2개미설정, URL, 소식, 쿠폰미설정, URL, 소식, 쿠폰, 애드뷰, 비즈니스폼
WIDE_MESSAGE (와이드이미지)1개미설정, URL, 소식, 쿠폰, 애드뷰, 비즈니스폼공유하기(shareFlag) 설정 시 공유하기 버튼 노출
WIDE_LIST_MESSAGE (와이드 리스트)1개미설정, URL, 소식, 쿠폰, 애드뷰, 비즈니스폼공유하기(shareFlag) 설정 시 공유하기 버튼 노출
CAROUSEL_COMMERCE_MESSAGE (캐러셀커머스)1개미설정, URL공유하기(shareFlag) 설정 시 공유하기 버튼 노출
CAROUSEL_FEED_MESSAGE (캐러셀 피드)2개미설정, URL미설정, URL

캐러셀 유형의 버튼 순서

캐러셀 유형 입력 순서카드 번호버튼 넘버링
itemAssetGroup 0캐러셀 1buttonAssetGroup 0, 1
itemAssetGroup 1캐러셀 2buttonAssetGroup 2, 3
itemAssetGroup 2캐러셀 3buttonAssetGroup 4, 5
itemAssetGroup 3캐러셀 4buttonAssetGroup 6, 7
itemAssetGroup 4캐러셀 5buttonAssetGroup 8, 9
itemAssetGroup 5캐러셀 6buttonAssetGroup 10, 11

메시지 소재 생성

기본 정보
메서드URL인증 방식
POSThttps://apis.moment.kakao.com/openapi/v4/creatives비즈니스 토큰

카카오톡 채널 X 도달 캠페인 하위의 소재를 생성합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 POST로 요청하며, 요청이 성공하면 응답 본문에 JSON 객체로 생성된 소재의 상세 정보를 목록으로 포함합니다. 실패 시 에러 코드에서 원인을 확인합니다.

이 API는 사용자 계정, 광고계정마다 1초에 한 번씩 요청 가능하도록 제한되어 있습니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청
O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
광고계정 ID
O
본문
이름타입설명필수
adGroupIdLong광고그룹 번호O
formatString소재 유형, 아래 중 하나
  • BASIC_TEXT_MESSAGE: 기본텍스트
  • WIDE_MESSAGE: 와이드이미지
  • WIDE_LIST_MESSAGE: 와이드리스트
  • CAROUSEL_COMMERCE_MESSAGE: 캐러셀커머스
  • CAROUSEL_FEED_MESSAGE: 캐러셀 피드
O
nameString소재 이름
최대 50자
설정하지 않은 경우 {캠페인 유형}_{캠페인 목표}_{현재시간}
으로 생성
X
messageElementMessageElement생성할 메시지 내용
MULTIPART/FORM-DATA 로 mesasgeElement.{} 형식으로 요청
O
MessageElement
이름타입설명필수
creativeFormatString메시지 소재 유형, 아래 중 하나
  • BASIC_TEXT_MESSAGE: 기본 텍스트
  • WIDE_MESSAGE: 와이드 이미지
  • WIDE_LIST_MESSAGE: 와이드 리스트
  • CAROUSEL_COMMERCE_MESSAGE: 캐러셀커머스
  • CAROUSEL_FEED_MESSAGE: 캐러셀 피드
format과 동일해야 함
O
profileIdString카카오톡 채널 프로필 ID

참고: 카카오톡 채널 프로필 ID 확인 방법
O
titleString홍보문구 또는 타이틀
소재유형에 따라 노출 위치 상이함
  • BASIC_TEXT_MESSAGE: 기본텍스트 (홍보 문구, 최대 400자, 이미지/동영상 첨부시 300자)
  • WIDE_MESSAGE: 와이드 이미지 (홍보 문구, 최대 76자)
  • WIDE_LIST_MESSAGE: 와이드 리스트 (타이틀, 최대 20자)
  • CAROUSEL_COMMERCE_MESSAGE: 캐러셀 커머스 (인트로 카드의 홍보타이틀, 최대 20자)
O
descriptionString캐러셀 커머스형 인트로 카드 홍보문구
최대 50자 입력 가능
X
buttonAssetGroupsButtonAssetGroup[]버튼 항목
기본 텍스트, 와이드 이미지, 와이드 리스트 유형은 버튼 미설정 가능
캐러셀 커머스, 캐러셀 피드는 버튼 1 필수
X
itemAssetGroupsItemAssetGroup[]리스트 항목O
shareFlagBoolean공유하기
true(설정), false(미설정) 중 하나
상위 광고그룹의 연령인증 메시지(ageVerification: true)로 설정된 경우 false만 요청 가능
O
adFlagBoolean광고성 메시지
설정 (true),
미설정 (false) 중 하나
O
imageFileMultipart file업로드할 이미지 파일
메시지 유형이 BASIC_TEXT_MESSAGE (기본 텍스트)이거나 CAROUSEL_COMMERCE_MESSAGE (캐러셀 커머스) 유형 인트로 카드일 경우에만 요청 가능
그 외 유형은 itemAssetGroup로 요청 가능
X
videoMetaVideoMeta연동할 카카오TV 정보
메시지 유형이 기본 텍스트 (BASIC_TEXT_MESSAGE) 일 경우에만 요청 가능
그 외 유형은 itemAssetGroup로 요청 가능
캐러셀 유형은 동영상 소재 사용 불가
X
csInfoString고객센터 전화번호O
hasIntroBoolean캐러셀 커머스 인트로 카드 유무X
introLandingTypeString캐러셀 커머스 인트로 카드 랜딩 타입X
introMobileLandingUrlString캐러셀 커머스 인트로 카드 모바일 랜딩 URLX
introPcLandingUrlString캐러셀 커머스 인트로 카드 pc 랜딩 URLX
mobileLandingUrlString캐러셀 커머스, 캐러셀 피드의 더보기 랜딩 URLX
pcLandingUrlString캐러셀 커머스, 캐러셀 피드의 더보기 랜딩 URLX
ButtonAssetGroup
이름타입설명필수
orderingInteger버튼 순서
기본 텍스트 유형 (BASIC_TEXT_MESSAGE) 은 0, 1을
그 외 유형은 0만 전달 가능

참고: 캐러셀 유형의 버튼 순서
O
pcLandingUrlStringPC 랜딩 URL
랜딩 유형이 LANDING_URL 인 경우 요청 가능하며
PC 랜딩 URL은 PC 카카오톡에서 버튼 클릭 시 별도의 URL로 랜딩 시키려는 경우 사용
http:// 또는 https:// 형식의 정상적인 랜딩 URL을 입력
X
mobileLandingUrlString모바일 랜딩 URL
http:// 또는 https:// 형식의 정상적인 랜딩 URL을 입력
O*
titleString버튼명
최대 8자까지 요청 가능
비즈니스폼의 경우 아래에 정의된 버튼명으로만 요청 가능
"톡에서 설문하기"
"톡에서 시승신청"
"톡에서 예약하기"
"톡에서 응모하기"
"톡에서 참여하기"
캐러셀 커머스 유형의 경우 버튼 1번은 "구매하기"만 요청 가능
O
landingTypeString랜딩 유형
URL 랜딩 (LANDING_URL),
쿠폰 랜딩 (CHANNEL_COUPON),
소식 랜딩 (CHANNEL_POST),
비즈니스폼 랜딩 (BIZ_FORM),
애드뷰 랜딩 (AD_VIEW) 중 하나
단, 캐러셀 유형의 경우 랜딩은 URL 랜딩만 활용 가능
O
channelCouponIdLong쿠폰 ID
랜딩 유형이 쿠폰 랜딩 (CHANNEL_COUPON) 인 경우 요청 가능
쿠폰 목록 조회 API 로 조회되는 쿠폰 ID
O*
channelPostIdLong소식 ID
랜딩 유형이 소식 랜딩 (CHANNEL_POST) 인 경우 요청 가능
채널 소식 목록 조회 API로 조회되는 소식 ID
O*
bizFormIdLong비즈니스폼 ID
랜딩 유형이 비즈니스폼 랜딩 (BIZ_FORM) 인 경우 요청 가능
비즈니스폼 목록 조회 API로 조회되는 비즈니스폼 ID
O*
adViewIdLong애드뷰 ID
랜딩 유형이 애드뷰 랜딩 (AD_VIEW) 인 경우 요청 가능
애드뷰 목록 조회 API로 조회되는 애드뷰 ID
O*
ItemAssetGroup
이름타입설명필수
landingTypeString랜딩 유형
URL 랜딩 (LANDING_URL),
쿠폰 랜딩(CHANNEL_COUPON),
소식 랜딩(CHANNEL_POST) 중 하나를 전달
O
titleString홍보문구
소재 유형에 따라 위치 상이
  • WIDE_LIST_MESSAGE: 와이드리스트 (타이틀, 1번째 최대 25자, 2~5번째 최대 30자, 1번, 4번, 5번 리스트는 필수 아님)
  • CAROUSEL_COMMERCE_MESSAGE: 캐러셀커머스 (타이틀, 최대 25자)
  • CAROUSEL_FEED_MESSAGE: 캐러셀 피드 (타이틀, 최대 20자)
O
descriptionString캐러셀 피드형 홍보문구
최대 180자 입력 가능
O
priceAmountString캐러셀 커머스형 캐러셀 내 가격 정보
(최소: 0, 최대: 99999999, 정수만 입력 가능)
캐러셀 커머스형에서 필수
O*
priceCurrencyCodeString통화 정보
KRW, USD, JPY, EUR 중 하나
캐러셀 커머스형에서 필수
O*
discountedPriceAmountString할인 가격 정보
캐러셀 커머스형 캐러셀 내 가격 정보
(최소: 0, 최대: 99999999, 정수만 입력 가능)
가격 정보 대비 입력 값이 1% 이상 차이가 나야 입력 가능
X
mobileLandingUrlString모바일 랜딩URL
http:// 또는 https:// 형식의 정상적인 랜딩 URL을 입력
X
pcLandingUrlStringPC 랜딩 URL
랜딩 유형이 LANDING_URL 인 경우 요청 가능하며
PC 랜딩 URL은 PC 카카오톡에서 버튼 클릭 시 별도의 URL로 랜딩 시키려는 경우 사용
http:// 또는 https:// 형식의 정상적인 랜딩 URL을 입력
X
channelPostIdLong소식 ID
랜딩 유형이 소식 랜딩(CHANNEL_POST)인 경우 요청 가능
채널 소식 목록 조회 API로 조회되는 소식 ID
X
channelCouponIdLong쿠폰 ID
랜딩 유형이 쿠폰 랜딩(CHANNEL_COUPON)인 경우 요청 가능
쿠폰 목록 조회 API 로 조회되는 쿠폰 ID
X
imageFileMultipart File업로드할 이미지 파일
메시지 유형이 WIDE_MESSAGE(와이드 이미지), WIDE_LIST_MESSAGE(와이드 리스트), CAROUSEL_COMMERCE_MESSAGE(캐러셀커머스) 인트로 제외 카드, CAROUSEL_FEED_MESSAGE(캐러셀 피드) 유형에 사용 가능
O*
videoMetaVideoMeta동영상 (카카오TV) 메타 정보
WIDE_MESSAGE(와이드 이미지), WIDE_LIST_MESSAGE(와이드 리스트)일 경우 요청
O*
VideoMeta
이름타입설명필수
idLong연동할 카카오TV 클립링크 ID
카카오TV 채널 영상 상세 조회 API의 응답에 포함된 clipLinkId
O
thumbnailString썸네일 URL
카카오TV 채널 영상 상세 조회 API를 이용하여 응답받는 썸네일 URL
O
isLoadBoolean카카오TV 영상 로드 여부
고정값(true)로 전달해야 함
O
isLiveBoolean카카오TV 라이브 영상 여부
고정값(false)로 전달해야 함
O
isLinkBoolean카카오TV 영상 링크 여부
고정값(true)로 전달해야 함
O

응답

본문
이름타입설명
idLong원본 소재 번호
실제 집행 시 활용되는 소재 식별 값
creativeIdLong소재 번호
메시지 소재는 심사 상태가 존재하지 않으며, 항상 원본 소재 번호와 동일함
nameString소재명
adGroupIdLong광고그룹 번호
formatString소재 유형, 아래 중 하나
  • BASIC_TEXT_MESSAGE: 기본텍스트
  • WIDE_MESSAGE: 와이드이미지
  • WIDE_LIST_MESSAGE: 와이드리스트
  • CAROUSEL_COMMERCE_MESSAGE: 캐러셀커머스
  • CAROUSEL_FEED_MESSAGE: 캐러셀 피드
configString소재 상태
ON, OFF, DEL(삭제) 중 하나
systemConfigString소재 시스템 상태
ON, ADMIN_STOP 중 하나
statusDescriptionString메시지 광고그룹의 현재 상태
발송 대기, 발송중, 발송중지, 발송종료 중 하나
creativeStatusString소재의 운영 상태
OPERATING(운영가능), UNAPPROVED(심사미승인), INVALID_DATE(기간오류), MONITORING_REJECTED(관리자정지), OFF(사용자OFF), DELETED(삭제), ADGROUP_UNAVAILABLE(광고그룹 운영불가) 중 하나
createdDateString소재 생성일시
lastModifiedDateString소재 마지막 수정일시
messageElementMessageElement메시지 상세 설명
ageVerificationBoolean연령인증 메시지 여부
  • true: 연령인증 메시지
  • false: 일반 메시지

예제

요청
curl -X POST "https://apis.moment.kakao.com/openapi/v4/creatives" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}" \
-F "messageElement.creativeFormat=BASIC_TEXT_MESSAGE" \
-F "messageElement.profileId=_Xxo" \
-F "messageElement.title=홍보문구" \
-F "messageElement.buttonAssetGroups[0].ordering=0" \
-F "messageElement.buttonAssetGroups[0].landingType=LANDING_URL" \
-F "messageElement.buttonAssetGroups[0].title=버튼1" \
-F "messageElement.buttonAssetGroups[0].pcLandingUrl=http://www.daum.net" \
-F "messageElement.buttonAssetGroups[0].mobileLandingUrl=http://www.kakaocorp.com" \
-F "messageElement.buttonAssetGroups[1].ordering=1" \
-F "messageElement.buttonAssetGroups[1].landingType=BIZ_FORM" \
-F "messageElement.buttonAssetGroups[1].bizFormId=1" \
-F "messageElement.buttonAssetGroups[1].title=톡에서 시승신청" \
-F "messageElement.name=기본텍스트" \
-F "messageElement.shareFlag=true" \
-F "messageElement.adFlag=true" \
-F "messageElement.csInfo=02-1234-5678" \
-F "messageElement.imageFile=@/directory/banner.png" \
-F "adGroupId=39688" \
-F "format=BASIC_TEXT_MESSAGE"
응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"id": 12345,
"creativeId": 12345,
"name": "카카오톡 채널_도달_20210625",
"adGroupId": 11223,
"format": "BASIC_TEXT_MESSAGE",
"config": "ON",
"systemConfig": "ON",
"statusDescription": "발송 대기",
"creativeStatus": "OPERATING",
"createdDate": "2021-06-25T17:04:02.883575",
"lastModifiedDate": "2021-06-25T17:04:06.291245",
"messageElement": {
"id": 12345,
"adAccountId": 123,
"profileId": "_xbHxd",
"name": "카카오톡 채널_도달_20210625",
"creativeFormat": "BASIC_TEXT_MESSAGE",
"title": "홍보문구입니다.",
"image": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"shareFlag": true,
"adFlag": true,
"thumbnail": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"buttonAssetGroups": [
{
"ordering": 0,
"title": "버튼1",
"pcLandingUrl": "http://www.daum.net",
"mobileLandingUrl": "https://www.kakaocorp.com",
"landingType": "LANDING_URL"
}
],
"thumbnailUrl": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"messageThumbnail": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"createdDate": "2021-06-25T17:04:02.883575",
"lastModifiedDate": "2021-06-25T17:04:06.291245"
}
}

메시지 소재 수정

기본 정보
메서드URL인증 방식
PUThttps://apis.moment.kakao.com/openapi/v4/creatives비즈니스 토큰

카카오톡 채널 X 도달 캠페인 하위의 소재를 수정합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 PUT으로 요청하며, 요청이 성공하면 응답 본문에 JSON 객체로 소재 상세 정보를 목록으로 포함합니다. 실패 시 에러 코드에서 원인을 확인합니다.

이 API는 사용자 계정, 광고계정마다 1초에 한 번씩 요청 가능하도록 제한되어 있습니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청
O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
광고계정 ID
O
본문
이름타입설명필수
adGroupIdLong광고그룹 번호O
formatString소재 유형
BASIC_TEXT_MESSAGE(기본텍스트),
WIDE_MESSAGE(와이드이미지),
  • WIDE_LIST_MESSAGE: 와이드리스트
  • CAROUSEL_COMMERCE_MESSAGE: 캐러셀커머스
  • CAROUSEL_FEED_MESSAGE: 캐러셀 피드
O
nameString소재 이름
최대 50자
설정하지 않은 경우 {캠페인 유형}_{캠페인 목표}_{현재시간}
으로 설정됩니다.
X
messageElementMessageElement생성할 메시지 내용
MULTIPART/FORM-DATA 로 mesasgeElement. 형식으로 요청
O

응답

본문
이름타입설명
idLong원본 소재 번호
실제 집행 시 활용되는 소재 식별 값
creativeIdLong소재 번호
메시지 소재는 심사 상태가 존재하지 않으며, 항상 원본 소재 번호와 동일함
nameString소재명
adGroupIdLong광고그룹 번호
formatString소재 유형, 아래 중 하나
  • BASIC_TEXT_MESSAGE: 기본텍스트
  • WIDE_MESSAGE: 와이드이미지
  • WIDE_LIST_MESSAGE: 와이드리스트
  • CAROUSEL_COMMERCE_MESSAGE: 캐러셀커머스
  • CAROUSEL_FEED_MESSAGE: 캐러셀 피드
configString소재 상태
ON, OFF, DEL(삭제) 중 하나
systemConfigString소재 시스템 상태
ON, ADMIN_STOP 중 하나
statusDescriptionString메시지 광고그룹의 현재 상태
발송 대기, 발송중, 발송중지, 발송종료 중 하나
creativeStatusString소재의 운영 상태
OPERATING(운영가능), UNAPPROVED(심사미승인), INVALID_DATE(기간오류), MONITORING_REJECTED(관리자정지), OFF(사용자OFF), DELETED(삭제), ADGROUP_UNAVAILABLE(광고그룹 운영불가) 중 하나
createdDateString소재 생성일시
lastModifiedDateString소재 마지막 수정일시
messageElementMessageElement메시지 상세 설명
ageVerificationBoolean연령인증 메시지 여부
  • true: 연령인증 메시지
  • false: 일반 메시지

예제

요청
curl -X PUT "https://apis.moment.kakao.com/openapi/v4/creatives" \
-H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
-H "adAccountId: ${AD_ACCOUNT_ID}"
-F "messageElement.creativeFormat=BASIC_TEXT_MESSAGE" \
-F "messageElement.profileId=_Xxo" \
-F "messageElement.title=홍보문구" \
-F "messageElement.buttonAssetGroups[0].ordering=0" \
-F "messageElement.buttonAssetGroups[0].landingType=LANDING_URL" \
-F "messageElement.buttonAssetGroups[0].title=버튼1" \
-F "messageElement.buttonAssetGroups[0].pcLandingUrl=http://www.daum.net" \
-F "messageElement.buttonAssetGroups[0].mobileLandingUrl=http://www.kakaocorp.com" \
-F "messageElement.buttonAssetGroups[1].ordering=1" \
-F "messageElement.buttonAssetGroups[1].landingType=BIZ_FORM" \
-F "messageElement.buttonAssetGroups[1].bizFormId=1" \
-F "messageElement.buttonAssetGroups[1].title=톡에서 시승신청" \
-F "messageElement.name=기본텍스트" \
-F "messageElement.shareFlag=true" \
-F "messageElement.adFlag=true" \
-F "messageElement.csInfo=02-1234-5678" \
-F "messageElement.imageFile=@/directory/banner.png" \
-F "adGroupId=39688" \
-F "format=BASIC_TEXT_MESSAGE"
응답
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"id": 12345,
"creativeId": 12345,
"name": "카카오톡 채널_도달_20210625",
"adGroupId": 11223,
"format": "BASIC_TEXT_MESSAGE",
"config": "ON",
"systemConfig": "ON",
"statusDescription": "발송 대기",
"creativeStatus": "OPERATING",
"createdDate": "2021-06-25T17:04:02.883575",
"lastModifiedDate": "2021-06-25T17:04:06.291245",
"messageElement": {
"id": 12345,
"adAccountId": 123,
"profileId": "_xbHxd",
"name": "카카오톡 채널_도달_20210625",
"creativeFormat": "BASIC_TEXT_MESSAGE",
"title": "홍보문구입니다.",
"image": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"shareFlag": true,
"adFlag": true,
"thumbnail": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"buttonAssetGroups": [
{
"ordering": 0,
"title": "버튼1",
"pcLandingUrl": "http://www.daum.net",
"mobileLandingUrl": "https://www.kakaocorp.com",
"landingType": "LANDING_URL"
}
],
"thumbnailUrl": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"messageThumbnail": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"createdDate": "2021-06-25T17:04:02.883575",
"lastModifiedDate": "2021-06-25T17:04:06.291245"
}
}

메시지 소재 복사

기본 정보
메서드URL인증 방식
POSThttps://apis.moment.kakao.com/openapi/v4/creatives/copy비즈니스 토큰

카카오톡 채널 X 도달 캠페인 하위의 소재를 복사합니다.

비즈니스 토큰과 광고계정 ID(adAccountId)를 헤더에 담아 POST로 광고그룹 ID와 복사할 소재 번호 목록을 지정하여 요청합니다. 성공 시 복사된 소재 정보의 배열을 받습니다. 실패 시 에러 코드에서 원인을 확인합니다.

이 API는 사용자 계정, 광고계정마다 5초에 한 번씩 요청이 가능하도록 제한되어 있습니다.

요청

헤더
이름설명필수
AuthorizationAuthorization: Bearer ${BUSINESS_ACCESS_TOKEN}
인증 방식, 비즈니스 토큰으로 인증 요청
O
adAccountIdadAccountId: ${AD_ACCOUNT_ID}
광고계정 ID
O
본문
이름타입설명필수
adGroupIdLong소재들이 복사될 광고그룹 번호O
creativeIdsLong[]복사할 소재 번호 목록O

응답

본문
이름타입설명
-MessageCreative[]소재 정보 목록
MessageCreative
이름타입설명
idLong원본 소재 번호
실제 집행 시 활용되는 소재 식별 값
creativeIdLong소재 번호
메시지 소재는 심사 상태가 존재하지 않으며, 항상 원본 소재 번호와 동일함
nameString소재명
adGroupIdLong광고그룹 번호
formatString소재 유형, 아래 중 하나
  • BASIC_TEXT_MESSAGE: 기본텍스트
  • WIDE_MESSAGE: 와이드이미지
  • WIDE_LIST_MESSAGE: 와이드리스트
  • CAROUSEL_COMMERCE_MESSAGE: 캐러셀커머스
  • CAROUSEL_FEED_MESSAGE: 캐러셀 피드
configString소재 상태
ON, OFF, DEL 중 하나
systemConfigString소재 시스템 상태
ON, ADMIN_STOP 중 하나
statusDescriptionString메시지 광고그룹의 현재 상태, 아래 중 하나
  • 발송 대기
  • 발송중
  • 발송중지
  • 발송종료
creativeStatusString소재의 운영 상태, 아래 중 하나
  • OPERATING: 운영가능
  • UNAPPROVED: 심사미승인
  • INVALID_DATE: 기간오류
  • MONITORING_REJECTED: 관리자정지
  • OFF: 사용자OFF
  • DELETED: 삭제
  • ADGROUP_UNAVAILABLE: 광고그룹 운영불가
createdDateString소재 생성일시
lastModifiedDateString소재 마지막 수정일시
messageElementMessageElement메시지 상세 설명
ageVerificationBoolean연령인증 메시지 여부
  • true: 연령인증 메시지
  • false: 일반 메시지

예제

요청
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": 11223,
"creativeIds": [12345]
}'
응답
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8
[
{
"id": 12346,
"creativeId": 12346,
"name": "카카오톡 채널_도달_20210625",
"adGroupId": 11223,
"format": "BASIC_TEXT_MESSAGE",
"config": "ON",
"systemConfig": "ON",
"statusDescription": "발송 대기",
"creativeStatus": "OPERATING",
"createdDate": "2021-06-25T17:04:03",
"lastModifiedDate": "2021-06-25T17:04:06",
"messageElement": {
"id": 78428,
"adAccountId": 759,
"profileId": "_xbHxd",
"name": "카카오톡 채널_도달_20210625",
"creativeFormat": "BASIC_TEXT_MESSAGE",
"title": "홍보문구입니다.",
"image": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"shareFlag": true,
"adFlag": true,
"thumbnail": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"buttonAssetGroups": [
{
"ordering": 0,
"title": "버튼1",
"pcLandingUrl": "http://www.daum.net",
"mobileLandingUrl": "https://www.kakaocorp.com",
"landingType": "LANDING_URL"
}
],
"thumbnailUrl": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"messageThumbnail": {
"fileSize": 168816,
"url": "//beta.daumcdn.net/b2/creative/759/d7961bd0662a240f43f047d3116a25f3.jpg",
"fileName": "풀뷰 1280x720.jpg",
"imageWidth": 1280,
"imageHeight": 720,
"mimeType": "image/jpeg",
"imageHash": "35156f0c1393434ced4be21423d08a6a"
},
"createdDate": "2021-06-25T17:04:03",
"lastModifiedDate": "2021-06-25T17:04:06"
}
}
]

더 보기

도움이 되었나요?