사이드 메뉴
시작하기
로그인
커뮤니케이션
광고
광고 생성: 메시지 소재
이 문서는 메시지 소재 API 사용 방법을 안내합니다.
시작일이 지난 발송 그룹에 소재를 생성하는 경우 광고그룹 상태에 따라 소재 저장 시 즉시 메시지가 발송될 수 있습니다. 소재 생성시 상위 광고그룹의 시작기간과 상태를 확인해야 합니다.
| 유형 | 발송시작 5분전 | 발송시작 5분전~발송시점 | 집행기간 내 | 집행 종료 후 |
|---|---|---|---|---|
| 일반 메시지 | 등록 가능 | 등록가능 | 등록가능 | 등록 불가 |
| 소재 최적화 | 등록 가능/ 추가 가능 | 등록가능/ 광고그룹 OFF일때 추가 가능 | 등록가능/ 광고그룹 OFF일때 추가 가능 | 등록 불가/ 소재 추가 불가 |
프리미엄동영상(PREMIUM_VIDEO_MESSAGE) 유형 및 쿠폰북 에셋 그룹(CouponBookAssetGroup)이 포함된 소재는 오픈API로 생성이 불가합니다.
메시지 집행 가이드와 맞지 않는 이미지와 문구는 사용할 수 없습니다.
| 요소 | 필수 | 랜딩: URL | 랜딩: 소식 | 랜딩: 쿠폰 | 랜딩: 애드뷰 | 랜딩: 비즈니스폼 |
|---|---|---|---|---|---|---|
| 홍보이미지 | X | X | X | X | X | X |
| 홍보문구 | O | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 |
| 버튼 1 | X | O | O | O | X | X |
| 버튼 2 | X | O | O | O | O | O |
| 공유하기 | X | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 |
- 홍보이미지:
- 가로 80 픽셀 이상, jpg.png(최대 10MB), 원본 이미지 최대 2억 픽셀 이하
- 가로:세로 비율 1:2.5 이하
- 버튼 1 랜딩이 있으면 동일한 랜딩 적용 (별도 설정 불가)
- 홍보문구:
- 이미지 첨부 여부와 관계없이 최대 1,300자 입력 가능
- 링크 입력 불가, 개행은 99개까지 가능
- 버튼 1:
- 레이블: 띄어쓰기 포함 최대 8자(초과 시 입력 제한)
- 버튼 2:
- 레이블: 띄어쓰기 포함 최대 8자(초과 시 입력 제한)
| 요소 | 필수 | 랜딩: URL | 랜딩: 소식 | 랜딩: 쿠폰 | 랜딩: 애드뷰 | 랜딩: 비즈니스폼 |
|---|---|---|---|---|---|---|
| 홍보이미지 | O | O | O | O | X | X |
| 홍보문구 | O | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 |
| 버튼 | X | O | O | O | O | O |
| 공유하기 | X | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 |
- 홍보이미지:
- 가로 80 픽셀 이상, jpg.png(최대 10MB), 원본 이미지 최대 2억 픽셀 이하
- 가로:세로 비율 1:2.5 이하
- 홍보문구:
- 최대 76자 입력 가능(초과 시 입력 제한)
- 링크 입력 불가, 개행은 5개까지 가능(필드에서 포커스 이동 시 유효성 검증)
- 버튼:
- 레이블: 띄어쓰기 포함 최대 8자(초과 시 입력 제한)
| 요소 | 필수 | 랜딩: URL | 랜딩: 소식 | 랜딩: 쿠폰 | 랜딩: 애드뷰 | 랜딩: 비즈니스폼 |
|---|---|---|---|---|---|---|
| 리스트1 타이틀 | X | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 |
| 리스트2~3 타이틀 | O | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 |
| 리스트1~3 홍보이미지 | O | O | O | O | X | X |
| 리스트1~3 홍보문구 | O | 각 항목에 설정된 홍보이미지와 동일 | 각 항목에 설정된 홍보이미지와 동일 | 각 항목에 설정된 홍보이미지와 동일 | 각 항목에 설정된 홍보이미지와 동일 | 각 항목에 설정된 홍보이미지와 동일 |
| 리스트4~5 홍보이미지 | X | O | O | O | X | X |
| 리스트4~5 홍보문구 | X | 각 항목에 설정된 홍보이미지와 동일 | 각 항목에 설정된 홍보이미지와 동일 | 각 항목에 설정된 홍보이미지와 동일 | 각 항목에 설정된 홍보이미지와 동일 | 각 항목에 설정된 홍보이미지와 동일 |
| 버튼 | X | O | O | O | O | O |
| 공유하기 | X | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 | 랜딩 없음 |
- 타이틀: 최대 20자 입력 가능(초과 시 입력 제한)
- 리스트1~3 홍보이미지:
- 가로 80 픽셀 이상, jpg.png(최대 10MB) 원본 이미지 최대 2억 픽셀 이하
- 가로:세로 비율 1:2.5 이하
- 항목1의 경우 800x400 픽셀, 나머지는 400x400 픽셀 권장 가이드
- 리스트1~3 홍보문구:
- 항목1의 경우 최대 25자, 나머지는 최대 30자 입력 가능(초과 시 입력 제한)
- 링크 입력 불가, 개행은 1개까지 가능(필드에서 포커스 이동 시 유효성 검증)
- 리스트4~5 홍보이미지:
- 가로 80 픽셀 이상, jpg.png(최대 10MB) 원본 이미지 최대 2억 픽셀 이하
- 가로:세로 비율 1:2.5 이하
- 리스트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 | 캐러셀 1 | buttonAssetGroup 0, 1 |
| itemAssetGroup 1 | 캐러셀 2 | buttonAssetGroup 2, 3 |
| itemAssetGroup 2 | 캐러셀 3 | buttonAssetGroup 4, 5 |
| itemAssetGroup 3 | 캐러셀 4 | buttonAssetGroup 6, 7 |
| itemAssetGroup 4 | 캐러셀 5 | buttonAssetGroup 8, 9 |
| itemAssetGroup 5 | 캐러셀 6 | buttonAssetGroup 10, 11 |
| 메서드 | URL | 인증 방식 |
|---|---|---|
POST | https://apis.moment.kakao.com/openapi/v4/creatives |
| 요구 사항 | 참고 | |
|---|---|---|
카카오톡 채널 X 도달 캠페인 하위의 소재를 생성합니다.
이 API는 사용자 계정, 광고계정마다 1초에 한 번씩 요청 가능하도록 제한되어 있습니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| adGroupId | Long | 광고그룹 번호 | O |
| format | Enum | 소재 유형
| O |
| name | String | 소재 이름(최대: 50자) 생략 시 {캠페인 유형}_{캠페인 목표}_{현재시간} 형식으로 자동 생성 | X |
| messageElement | MessageElement | 생성할 메시지 내용 MULTIPART/FORM-DATA 로 messageElement.{} 형식으로 요청 | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| creativeFormat | Enum | 메시지 소재 유형
중요: format과 같은 값으로 요청 | O |
| profileId | String | 카카오톡 채널 프로필 ID 참고: 카카오톡 채널 프로필 ID 확인 방법 | O |
| title | String | 홍보문구 또는 타이틀 소재 유형에 따라 노출 위치 상이
| O |
| description | String | 캐러셀 커머스형 인트로 카드 홍보문구(최대: 50자) | X |
| buttonAssetGroups | ButtonAssetGroup[] | 버튼 항목 기본 텍스트, 와이드 이미지, 와이드 리스트 유형은 버튼 미설정 가능 캐러셀 커머스, 캐러셀 피드는 버튼 1 필수 | X |
| itemAssetGroups | ItemAssetGroup[] | 리스트 항목 | O |
| shareFlag | Boolean | 공유하기
중요: 상위 광고그룹의 ageVerification(연령인증 메시지 여부)이 true인 경우 false만 요청 가능 | O |
| adFlag | Boolean | 광고성 메시지
| O |
| imageFile | Multipart File | 업로드할 이미지 파일 메시지 유형이 BASIC_TEXT_MESSAGE (기본 텍스트)이거나 CAROUSEL_COMMERCE_MESSAGE (캐러셀 커머스) 유형 인트로 카드일 경우에만 요청 가능 그 외 유형은 itemAssetGroup로 요청 가능 | X |
| csInfo | String | 고객센터 전화번호 | O |
| hasIntro | Boolean | 캐러셀 커머스 인트로 카드 유무 | X |
| introLandingType | String | 캐러셀 커머스 인트로 카드 랜딩 타입 | X |
| introMobileLandingUrl | String | 캐러셀 커머스 인트로 카드 모바일 랜딩 URL | X |
| introPcLandingUrl | String | 캐러셀 커머스 인트로 카드 pc 랜딩 URL | X |
| mobileLandingUrl | String | 캐러셀 커머스, 캐러셀 피드의 더보기 랜딩 URL | X |
| pcLandingUrl | String | 캐러셀 커머스, 캐러셀 피드의 더보기 랜딩 URL | X |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| ordering | Integer | 버튼 순서 기본 텍스트 유형 (BASIC_TEXT_MESSAGE) 은 0, 1을 그 외 유형은 0만 전달 가능 참고: 캐러셀 유형의 버튼 순서 | O |
| pcLandingUrl | String | PC 랜딩 URL 랜딩 유형이 LANDING_URL 인 경우 요청 가능하며 PC 랜딩 URL은 PC 카카오톡에서 버튼 클릭 시 별도의 URL로 랜딩 시키려는 경우 사용 http:// 또는 https:// 형식의 정상적인 랜딩 URL을 입력 | X |
| mobileLandingUrl | String | 모바일 랜딩 URL http:// 또는 https:// 형식의 정상적인 랜딩 URL을 입력 | X |
| title | String | 버튼명(최대: 8자) 비즈니스폼의 경우 아래에 정의된 버튼명으로만 요청 가능 "톡에서 설문하기" "톡에서 시승신청" "톡에서 예약하기" "톡에서 응모하기" "톡에서 참여하기" 캐러셀 커머스 유형의 경우 버튼 1번은 "구매하기"만 요청 가능 | O |
| landingType | Enum | 랜딩 유형
중요: 캐러셀 유형은 LANDING_URL(URL 랜딩)만 사용 가능 | O |
| channelCouponId | Long | 쿠폰 ID 쿠폰 목록 조회 API 로 조회되는 쿠폰 ID 중요: landingType(랜딩 유형)이 CHANNEL_COUPON(쿠폰 랜딩)인 경우 요청 가능 | X |
| channelPostId | Long | 소식 ID 채널 소식 목록 조회 API로 조회되는 소식 ID 중요: landingType(랜딩 유형)이 CHANNEL_POST(소식 랜딩)인 경우 요청 가능 | X |
| bizFormId | Long | 비즈니스폼 ID 비즈니스폼 목록 조회 API로 조회되는 비즈니스폼 ID 중요: landingType(랜딩 유형)이 BIZ_FORM(비즈니스폼 랜딩)인 경우 요청 가능 | X |
| adViewId | Long | 애드뷰 ID 애드뷰 목록 조회 API로 조회되는 애드뷰 ID 중요: landingType(랜딩 유형)이 AD_VIEW(애드뷰 랜딩)인 경우 요청 가능 | X |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| landingType | Enum | 랜딩 유형
| O |
| title | String | 홍보문구 소재 유형에 따라 노출 위치 상이
| O |
| description | String | 캐러셀 피드형 홍보문구(최대: 180자) | O |
| priceAmount | String | 캐러셀 커머스형 캐러셀 내 가격 정보(최소: 0, 최대: 99999999), 정수만 입력 가능 중요: CAROUSEL_COMMERCE_MESSAGE인 경우 필수 | X |
| priceCurrencyCode | Enum: CurrencyCode | 통화 정보 중요: CAROUSEL_COMMERCE_MESSAGE인 경우 필수 | X |
| discountedPriceAmount | String | 할인 가격 정보 캐러셀 커머스형 캐러셀 내 가격 정보(최소: 0, 최대: 99999999), 정수만 입력 가능 가격 정보 대비 입력 값이 1% 이상 차이가 나야 입력 가능 | X |
| mobileLandingUrl | String | 모바일 랜딩URL http:// 또는 https:// 형식의 정상적인 랜딩 URL을 입력 | X |
| pcLandingUrl | String | PC 랜딩 URL 랜딩 유형이 LANDING_URL 인 경우 요청 가능하며 PC 랜딩 URL은 PC 카카오톡에서 버튼 클릭 시 별도의 URL로 랜딩 시키려는 경우 사용 http:// 또는 https:// 형식의 정상적인 랜딩 URL을 입력 | X |
| channelPostId | Long | 소식 ID 채널 소식 목록 조회 API로 조회되는 소식 ID 중요: landingType(랜딩 유형)이 CHANNEL_POST(소식 랜딩)인 경우 요청 가능 | X |
| channelCouponId | Long | 쿠폰 ID 쿠폰 목록 조회 API 로 조회되는 쿠폰 ID 중요: landingType(랜딩 유형)이 CHANNEL_COUPON(쿠폰 랜딩)인 경우 요청 가능 | X |
| imageFile | Multipart File | 업로드할 이미지 파일 메시지 유형이 WIDE_MESSAGE(와이드 이미지), WIDE_LIST_MESSAGE(와이드 리스트), CAROUSEL_COMMERCE_MESSAGE(캐러셀커머스) 인트로 제외 카드, CAROUSEL_FEED_MESSAGE(캐러셀 피드) 유형에 사용 가능 | X |
| 이름 | 타입 | 설명 |
|---|---|---|
| id | Long | 원본 소재 번호 실제 집행 시 활용되는 소재 식별 값 |
| creativeId | Long | 소재 번호 메시지 소재는 심사 상태가 존재하지 않으며, 항상 원본 소재 번호와 동일함 |
| name | String | 소재명 |
| adGroupId | Long | 광고그룹 번호 |
| format | Enum | 소재 유형
|
| config | Enum: Config | 소재 상태 |
| systemConfig | Enum: SystemConfig | 소재 시스템 상태
|
| statusDescription | Enum | 메시지 광고그룹의 현재 상태
|
| creativeStatus | Enum | 소재의 운영 상태
|
| createdDate | String | 소재 생성일시 |
| lastModifiedDate | String | 소재 마지막 수정일시 |
| messageElement | MessageElement | 메시지 상세 설명 |
| ageVerification | Boolean | 연령인증 메시지 여부
|
요청
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 | 인증 방식 |
|---|---|---|
PUT | https://apis.moment.kakao.com/openapi/v4/creatives |
| 요구 사항 | 참고 | |
|---|---|---|
카카오톡 채널 X 도달 캠페인 하위의 소재를 수정합니다.
이 API는 사용자 계정, 광고계정마다 1초에 한 번씩 요청 가능하도록 제한되어 있습니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| adGroupId | Long | 광고그룹 번호 | O |
| format | Enum | 소재 유형
| O |
| name | String | 소재 이름(최대: 50자) 생략 시 {캠페인 유형}_{캠페인 목표}_{현재시간} 형식으로 자동 생성 | X |
| messageElement | MessageElement | 생성할 메시지 내용MULTIPART/FORM-DATA 로 messageElement.{} 형식으로 요청 | O |
| 이름 | 타입 | 설명 |
|---|---|---|
| id | Long | 원본 소재 번호 실제 집행 시 활용되는 소재 식별 값 |
| creativeId | Long | 소재 번호 메시지 소재는 심사 상태가 존재하지 않으며, 항상 원본 소재 번호와 동일함 |
| name | String | 소재명 |
| adGroupId | Long | 광고그룹 번호 |
| format | Enum | 소재 유형
|
| config | Enum: Config | 소재 상태 |
| systemConfig | Enum: SystemConfig | 소재 시스템 상태
|
| statusDescription | Enum | 메시지 광고그룹의 현재 상태
|
| creativeStatus | Enum | 소재의 운영 상태
|
| createdDate | String | 소재 생성일시 |
| lastModifiedDate | String | 소재 마지막 수정일시 |
| messageElement | MessageElement | 메시지 상세 설명 |
| ageVerification | Boolean | 연령인증 메시지 여부
|
요청
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 | 인증 방식 |
|---|---|---|
POST | https://apis.moment.kakao.com/openapi/v4/creatives/copy |
| 요구 사항 | 참고 | |
|---|---|---|
카카오톡 채널 X 도달 캠페인 하위의 소재를 복사합니다.
이 API는 사용자 계정, 광고계정마다 5초에 한 번씩 요청이 가능하도록 제한되어 있습니다.
| 이름 | 설명 | 필수 |
|---|---|---|
| Authorization | Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}인증 방식, 비즈니스 토큰으로 인증 요청 | O |
| adAccountId | adAccountId: ${AD_ACCOUNT_ID}광고계정 ID | O |
| 이름 | 타입 | 설명 | 필수 |
|---|---|---|---|
| adGroupId | Long | 소재들이 복사될 광고그룹 번호 | O |
| creativeIds | Long[] | 복사할 소재 번호 목록 | O |
| 이름 | 타입 | 설명 |
|---|---|---|
| - | MessageCreative[] | 소재 정보 목록 |
| 이름 | 타입 | 설명 |
|---|---|---|
| id | Long | 원본 소재 번호 실제 집행 시 활용되는 소재 식별 값 |
| creativeId | Long | 소재 번호 메시지 소재는 심사 상태가 존재하지 않으며, 항상 원본 소재 번호와 동일함 |
| name | String | 소재명 |
| adGroupId | Long | 광고그룹 번호 |
| format | Enum | 소재 유형
|
| config | Enum: Config | 소재 상태 |
| systemConfig | Enum: SystemConfig | 소재 시스템 상태
|
| statusDescription | Enum | 메시지 광고그룹의 현재 상태
|
| creativeStatus | Enum | 소재의 운영 상태
|
| createdDate | String | 소재 생성일시 |
| lastModifiedDate | String | 소재 마지막 수정일시 |
| messageElement | MessageElement | 메시지 상세 설명 |
| ageVerification | Boolean | 연령인증 메시지 여부
|
요청
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"}}]