< 목 차 >
4-1. 템플릿 관리
4.1.1. 템플릿 카테고리 유형
4.1.2. 템플릿 상태값
4.1.3 테이블 템플릿
4-2. 혜택 템플릿
4-3. 템플릿 변수 & 혜택 관련
=========================================
[4.2 혜택 템플릿]
혜택 템플릿은 알림, 혜택 탭, 톡톡 채팅방 말풍선 등에서 보여지는 네이버 톡톡의 광고성 메시지 템플릿을 일컫습니다.
a. 알림 | b. 혜택 탭 |
혜택 템플릿은 기본형, LMS 형, 캐러셀 커머스형, 캐러셀 피드형, 리스트 커머스형, 리스트 피드형으로 총 6 가지 템플릿을 지원하고 있습니다.
혜택 메시지 종류(templateType) | 톡톡 말풍선 |
기본형(BENEFIT) |
혜택 메시지 종류(templateType) | 톡톡 말풍선 |
LMS 형(BENEFIT_LMS) | |
캐러셀 커머스형(BENEFIT_CAROUS EL_COMMERCE) |
혜택 메시지 종류(templateType) | 톡톡 말풍선 |
캐러셀 피드형(BENEFIT_CAROUSEL_FEED) | |
리스트 커머스형(BENEFIT_LIST_CO MMERCE) |
혜택 메시지 종류(templateType) | 톡톡 말풍선 |
리스트 피드형(BENEFIT_LIST_FEED) |
POST /v1/template/get
템플릿 조회 (getTemplate)
템플릿 조회
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{accessToken}}'
요청 파라미터 | |||||
키 | - | 타입 | 필수 | ||
naverPartnerKey | String | O | 파트너키 | ||
templateCode | String | O | 템플릿 코드 | ||
반환 값 | |||||
키 | - | 타입 | |||
code | String | 결과 코드 | |||
message | String | 실패 시 결과 메시지 | |||
data |
Object |
성공 시 데이터 (템플릿 설명 및 아래 응답 예제 참고) |
|||
[Example] [Request] | |||||
{ | |||||
"naverPartnerKey":"{{naverPartnerKey}}", | |||||
"templateCode":"TP-BENEFIT-CAROUSEL-COMMERCE-20241226-150618" | |||||
} | |||||
[Example] [Response – 정보성-BASIC] | |||||
{ |
"code": "200", "message": "요청 성공", "data": { "id": "1", "templateType": "BASIC", "productCode": "INFORMATION", "code": "TP-INFORMATION-BASIC-20241230-4105", "text": "템플릿 등록 테스트입니다.", "partnerId": "{{naverPartnerId}}", "categoryCode": "R014", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "buttons": [ { "type": "WEB_LINK", "buttonCode": "BTN-CODE-1", "buttonName": "웹 링크 버튼" } ], "createdAt": "2024-12-30 10:31:05", "modifiedAt": "2024-12-30 10:31:05" } |
||||
} |
|||||
[Example] [Response – 정보성-GIFT] | |||||
{
|
"code": "200", "message": "요청 성공", "data": { "id": "5730", "templateType": "GIFT", "productCode": "INFORMATION", "code": "TP-INFORMATION-GIFT-20241230-107", "text": "템플릿 등록 테스트입니다.", "partnerId": "{{naverPartnerId}}", "categoryCode": "P001", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "buttons": [ { "type": "WEB_LINK", "buttonCode": "BTN-CODE-1", "buttonName": "웹 링크 버튼" } ], "sampleCoupon": { "code": "sampleCoupon", "name": "샘플 쿠폰", "endDate": "2024-12-30", "publisher": "네이버톡톡" }, "createdAt": "2024-12-30 15:55:37", "modifiedAt": "2024-12-30 15:55:37" } } |
[Example] [Response – 정보성-TABLE] | |
{ "code": "200", "message": "요청 성공", "data": { "id": "5732", "templateType": "TABLE", "productCode": "INFORMATION", "code": "TP-INFORMATION-TABLE-20241230-121", "text": "#{applicant}님 #{asType} AS 방문 취소되었습니다.", "partnerId": "{{naverPartnerId}}", "categoryCode": "S001", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "tableElements": [ { "title": "테이블 0 타이틀", "strikeTitle": true, "subtitle": "테이블 0 서브 타이틀", "thumbnailImageUrl": "https://...PNG/logo.png?type=m600", "thumbnailImageHashId": "YiBmy4ah7cdE69_xBiHrQqKHnkZaeOaOkn1oyEHCf2rp6WpcI8CwA_KFG_eLmrRY", "table": [ { "title": "테이블 0 타이틀", "content": "테이블 0 본문" } ], "additionalContent": "부가 정보 영역입니다. \n 테이블 내에 부가 정보가 필요하다면 이곳에 적어주세요.", "buttons": [ { "type": "WEB_LINK", "buttonCode": "button_table_01", "buttonName": "테이블 0 속 버튼" } ] }, { "title": "테이블 1 타이틀", "strikeTitle": true, "subtitle": "테이블 1 서브 타이틀", "thumbnailImageUrl": "https:/… logo.png?type=m600", "thumbnailImageHashId": "YiBmy4ah7cdE69_xBiHrQqKHnkZaeOaOkn1oyEHCf2rp6WpcI8CwA_KFG_eLmrRY", "table": [ { "title": "테이블 1 타이틀", "content": "테이블 1 내용" } ], "additionalContent": "테이블 1 부가 정보", "buttons": [ { "type": "WEB_LINK", "buttonCode": "button_table_02", "buttonName": "테이블 1 속 버튼" } ] } ], "pushNotice": "#{applicant}님 #{asType} AS 방문 취소되었습니다.", "createdAt": "2024-12-30 15:56:50", "modifiedAt": "2024-12-30 15:56:50" } } |
[Example] [Response – 광고성-BASIC] | |
{ "code": "200", "message": "요청 성공", "data": { "id": "4", "templateType": "BENEFIT", "productCode": "BENEFIT", "code": "TP-BENEFIT-BASIC-20241230-115", "text": "역대급 할인 오늘 단 하루만 진행! 패션 PICK 5 시간 후 종료! 20 시까지 오늘 출발 상품", "partnerId": "{{naverPartnerId}}", "categoryCode": "B002", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "buttons": [ { "type": "WEB_LINK", "buttonCode": "POPUP_BUTTON1", "buttonName": "구매하기", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" }, { "type": "WEB_LINK", "buttonCode": "POPUP_BUTTON2", "buttonName": "팝업스토어", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" } ], "benefit": { "title": "곧 종료 시즌 막바지 ~70% 대박할인!", "feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-30", "categoryType": "LIVING", "benefitTypes": [ "TIMESALE", "PRODUCT" ], "blockCallNumber": "080-123-1234", "searchResultExposure": false, "discountInfo": { "discountType": "AMOUNT", "discountAmount": 3000, "minimumOrderAmount": 10000, "landingPageUrl": "https://www.naver.com", "benefitContent": "3,000 원 할인 쿠폰", "benefitKindType": "COUPON", "couponPublicationType": "DOWNLOAD" }, "validityInfo": { "validType": "PERIOD", "validStartedAt": "2024-12-30", "validEndedAt": "2024-12-30" }, "blockContactType": "TELEPHONE" }, "sampleImage": "https://... JPEG/2e1cd3ef565acbc8c20f11d91b4891d141d1a2caccd0c566eab28b91e2e5d306.jpg?type=m600", "createdAt": "2024-12-30 15:58:42", "modifiedAt": "2024-12-30 15:58:42" } } |
[Example] [Response – 광고성-LMS] | |
{ "code": "200", "message": "요청 성공", "data": { "id": "5734", "templateType": "BENEFIT_LMS", "productCode": "BENEFIT", "code": "TP-BENEFIT-LMS-20241230-160026", "text": "안녕하세요, 고객님.\n 진화하는 신종 보이스 피싱, 스미싱(피싱)은 예방이 최우선입니다!\n\n▶ 보이스 피싱, 스미싱 않고 바로 삭제하기 \n② 해당 전화번호로 전화연결하지 않기 \n③ 택배 배송 조회 등의 명목으로 본인인증, 신분증 및 개인정보, 휴대전화에 주민등록증 및 신용카드사진 저장하지 않기 \n⑤ 스마트폰에 백신프로그램 설치하기 \n⑥ 소액결제 차단 기능 설정하 경찰(신고전화 112)에 전화하여 신고하기\n\n 그 외 본인 명의의 휴대전화의 신규 개설을 차단하는 ‘가입제한 서비스’를 이용해 휴대 통해 가입 및 모바일 애플리케이션 중 ‘PASS 앱’을 통해 가입하기\n\n▶ 금융권 사칭 및 국세청, 관세청 사칭 등을 이용한 보이스 피 개통내용이 아니시면 문의.상담/문의:02-5-71**’\n '페이 01/05 985,000 원 결제완료(무이자 3 개월)귀하사용아니시면 (18-61**)취소요청’\ 빠른납부처리. [고객센터:16**-51**]'\n\n▶ '부고 문자'를 가장한 스미싱 문자 사례\n'부고, 부친께서 26 일 저녁 운명하셨기에 문자로 알립니다’\n'부인께서 오늘 오후 1 시경 교통사고로 돌아가셨기에 삼가알려드립니다. 장례식장’\n'오늘 오전 9 시경 큰딸이 교통사고로 첨부하는 부고 문자 사칭 \n\n▶ 건강보험공단 사칭 스미싱 문자 사례\n'{국민건강보험}건강검사 진단서 전송 완료. 내용보기’\n'[건강 주소 첨부\n\n▶ 문의\n· 모바일 고객센터 114(무료)\n", "partnerId": "{{naverPartnerId}}", "categoryCode": "B002", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "benefit": { "title": "1 월 특판 잔여 물량 선착순, 181 일 세전 금리 5%, 연금 보험, 올해가 마지막 기회!", "feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-30", "categoryType": "FINANCE", "benefitTypes": [ "EVENT" ], "blockCallNumber": "080-123-1234", "searchResultExposure": false, "validityInfo": { "validType": "PERIOD", "validStartedAt": "2024-12-30", "validEndedAt": "2024-12-30" }, "blockContactType": "TELEPHONE" }, "createdAt": "2024-12-30 16:00:26", "modifiedAt": "2024-12-30 16:00:26" } } |
|
[Example] [Response – 광고성-BENEFIT_CAROUSEL_COMMERCE] | |
{ "code": "200", "message": "요청 성공", "data": { "id": "5510", "templateType": "BENEFIT_CAROUSEL_COMMERCE", "productCode": "BENEFIT", "code": "TP-BENEFIT-CAROUSEL-COMMERCE-20241226-150618", "text": "다가오는 가을, 특별한 아웃핏으로 시원하고 멋진 가을 보내세요😀\n 역대급 할인 오늘 단 하루만 진행!", "partnerId": "{{naverPartnerId}}", "categoryCode": "B002", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "benefit": { "feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-26", "categoryType": "FASHION", "benefitTypes": [ "PRODUCT", "TIMESALE" ], "blockCallNumber": "080-123-1234", "searchResultExposure": true, "moreButtonUrl": "https://www.naver.com", "moreButtonMobileUrl": "https://www.naver.com", "discountInfo": { "discountType": "AMOUNT", "discountAmount": 3000, "minimumOrderAmount": 10000, "landingPageUrl": "https://www.naver.com", "benefitContent": "3,000 원 할인 쿠폰", "benefitKindType": "COUPON", "couponPublicationType": "DOWNLOAD" }, "validityInfo": { "validType": "PERIOD", "validStartedAt": "2024-12-29", "validEndedAt": "2024-12-30" }, "introduction": { "headerImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "headerImageUrl": "https://...JPEG/2e1cd3ef565acbc8c20f11d91b4891d141d1a2caccd0c566eab28b91e2e5d306.jpg?type=m600" "title": "지금부터 아뜨랑스 시즌🎵 예뿜뿜!!", "description": "다가오는 가을, 특별한 아웃핏으로 시원하고 멋진 가을 보내세요😀\n 역대급 할인 오늘 단 하루만 진 "buttonType": "WEB_LINK", "buttonCode": "INTRO_BUTTON0", "buttonTitle": "바로가기", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" }, "products": [ { "imageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://... JPEG/2e1cd3ef565acbc8c20f11d91b4891d141d1a2caccd0c566eab28b91e2e5d306.jpg?type=m600", "title": "가을꽈배기니트 가디건", "originalPrice": 127000, "currentPrice": 0, "buttonType": "WEB_LINK", "buttonCode": "C1_BUTTON0", "pcUrl": "www.naver.com", "mobileUrl": "https://m.naver.com" }, { "imageHashId": "3ABvgbhfy1UYviwjCDFOzn1rsjeUo20j7YSBIazwFhnp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://.... JPEG/resize-image-1.jpg?type=m600", "title": "가을 신상 바지", "originalPrice": 78000, "buttonType": "WEB_LINK", "buttonCode": "C2_BUTTON0", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" } ], "blockContactType": "TELEPHONE" }, "createdAt": "2024-12-26 15:06:20", "modifiedAt": "2024-12-26 15:06:20" } } |
[Example] [Response – 광고성-BENEFIT_LIST_COMMERCE] | |
{ "code": "200", "message": "요청 성공", "data": { "id": "5390", "templateType": "BENEFIT_LIST_COMMERCE", "productCode": "BENEFIT", "code": "TP-BENEFIT-LIST-COMMERCE-20241223-84", "text": "가을꽈배기니트 가디건 69,000 윈 가을 신상 바지 78,000 윈 가을 신상 2 28,000 윈 ", "partnerId": "{{naverPartnerId}}", "categoryCode": "B002", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "benefit": { "feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-25", "categoryType": "FASHION", "benefitTypes": [ "PRODUCT", "TIMESALE" ], "blockCallNumber": "080-123-1234", "searchResultExposure": true, "discountInfo": { "discountType": "AMOUNT", "discountAmount": 3000, "minimumOrderAmount": 10000, "landingPageUrl": "https://www.naver.com", "benefitContent": "3,000 원 할인 쿠폰", "benefitKindType": "COUPON", "couponPublicationType": "DOWNLOAD" }, "validityInfo": { "validType": "PERIOD", "validStartedAt": "2024-12-25", "validEndedAt": "2024-12-26" }, "introduction": { "headerImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "headerImageUrl": "https://... jpg?type=m600", "title": "지금부터 아뜨랑스 시즌🎵 예뿜뿜!!" }, "products": [ { "imageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://... jpg?type=m600", "title": "가을꽈배기니트 가디건", "originalPrice": 127000, "currentPrice": 69000, "buttonType": "WEB_LINK", "buttonCode": "C1_BUTTON1", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" }, { "imageHashId": "3ABvgbhfy1UYviwjCDFOzn1rsjeUo20j7YSBIazwFhnp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://... jpg?type=m600", "title": "가을 신상 바지", "originalPrice": 78000, "buttonType": "WEB_LINK", "buttonCode": "C2_BUTTON1", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" }, { "imageHashId": "3ABvgbhfy1UYviwjCDFOzn1rsjeUo20j7YSBIazwFhnp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://.. e-1.jpg?type=m600", "title": "가을 신상 2", "originalPrice": 28000, "buttonType": "WEB_LINK", "buttonCode": "C3_BUTTON1", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" } ], "blockContactType": "TELEPHONE" }, "createdAt": "2024-12-23 10:47:30", "modifiedAt": "2024-12-23 10:47:30" } } |
[Example] [Response – 광고성-BENEFIT_CAROUSEL_FEED] | |
{ "code": "200", "message": "요청 성공", "data": { "id": "5735", "templateType": "BENEFIT_CAROUSEL_FEED", "productCode": "BENEFIT", "code": "TP-BENEFIT-CAROUSEL-FEED-20241230-160154", "text": "다가오는 가을, 특별한 아웃핏으로 시원하고 멋진 가을 보내세요😀\n 역대급 할인 오늘 단 하루만 진행!", "partnerId": "{{naverPartnerId}}", "categoryCode": "B004", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "benefit": { "feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-30", "categoryType": "FASHION", "benefitTypes": [ "EVENT" ], "blockCallNumber": "080-123-1234", "searchResultExposure": true, "moreButtonUrl": "https://www.naver.com", "moreButtonMobileUrl": "https://www.naver.com", "validityInfo": { "validType": "PERIOD", "validStartedAt": "2024-12-30", "validEndedAt": "2024-12-30" }, "products": [ { "imageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://... jpg?type=m600", "title": "가을꽈배기니트 가디건", "description": "다가오는 가을, 특별한 아웃핏으로 시원하고 멋진 가을 보내세요😀\n 역대급 할인 오늘 단 하루 "buttons": [ { "type": "WEB_LINK", "buttonCode": "F1_BUTTON1", "buttonName": "구매하기", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" }, { "type": "WEB_LINK", "buttonCode": "F1_BUTTON2", "buttonName": "팝업스토어가나다", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" } ] }, { "imageHashId": "3ABvgbhfy1UYviwjCDFOzn1rsjeUo20j7YSBIazwFhnp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https….jpg?type=m600", "title": "가을 신상 바지", "description": "다가오는 가을,", "buttons": [ { "type": "APP_LINK", "buttonCode": "F2_BUTTON1", "buttonName": "구매하기", "iOsAppScheme": "https://naver.com", "aOsAppScheme": "https://m.naver.com" } ] } ], "blockContactType": "TELEPHONE" }, "createdAt": "2024-12-30 16:01:55", "modifiedAt": "2024-12-30 16:01:55" } } |
[Example] [Response – 광고성-BENEFIT_LIST_FEED] | |
{ "code": "200", "message": "요청 성공", "data": { "id": "5736", "templateType": "BENEFIT_LIST_FEED", "productCode": "BENEFIT", "code": "TP-BENEFIT-LIST-FEED-20241230-160245", "text": "가을꽈배기니트 가디건", "partnerId": "{{naverPartnerId}}", "categoryCode": "B002", "templateStatusType": "APPROVED", "templateSendingStatusType": "WAITING", "freeOfCharge": false, "benefit": { "feedDisplayImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "feedDisplayEndedAt": "2024-12-30", "categoryType": "FASHION", "benefitTypes": [ "TIMESALE", "PRODUCT" ], "blockCallNumber": "080-123-1234", "searchResultExposure": true, "discountInfo": { "discountType": "AMOUNT", "discountAmount": 3000, "minimumOrderAmount": 10000, "landingPageUrl": "https://www.naver.com", "benefitContent": "3,000 원 할인 쿠폰", "benefitKindType": "COUPON", "couponPublicationType": "DOWNLOAD" }, "validityInfo": { "validType": "PERIOD", "validStartedAt": "2024-12-30", "validEndedAt": "2024-12-30" }, "introduction": { "headerImageHashId": "om_TcC1RtnEnoc4tcjBJ0foG3lvbtlm6oW020F6MPZLp6WpcI8CwA_KFG_eLmrRY", "headerImageUrl": "https://... jpg?type=m600", "title": "지금부터 아뜨랑스 시즌🎵 예뿜뿜!!" }, "products": [ { "imageHashId": "3ABvgbhfy1UYviwjCDFOzn1rsjeUo20j7YSBIazwFhnp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://.... JPEG/resize-image-1.jpg?type=m600", "title": "가을꽈배기니트 가디건", "buttonType": "WEB_LINK", "buttonCode": "C1_BUTTON1", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" }, { "imageHashId": "3ABvgbhfy1UYviwjCDFOzn1rsjeUo20j7YSBIazwFhnp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://.... JPEG/resize-image-1.jpg?type=m600", "title": "가을 신상 바지", "buttonType": "WEB_LINK", "buttonCode": "C2_BUTTON1", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" }, { "imageHashId": "3ABvgbhfy1UYviwjCDFOzn1rsjeUo20j7YSBIazwFhnp6WpcI8CwA_KFG_eLmrRY", "imageUrl": "https://.... JPEG/resize-image-1.jpg?type=m600", "title": "가을 신상 코트", "buttonType": "WEB_LINK", "buttonCode": "C3_BUTTON1", "pcUrl": "https://www.naver.com", "mobileUrl": "https://m.naver.com" } ], "blockContactType": "TELEPHONE" }, "createdAt": "2024-12-30 16:02:49", "modifiedAt": "2024-12-30 16:02:49" } } |
POST /v1/template/register/information
정보성 템플릿 생성 (registerInformationTemplate)
정보성 템플릿 생성
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{accessToken}}'
[Request]
키 | 타입 | 필수 | 설명 |
naverPartnerKey | text(64) | Y | 네이버 파트너 키 |
productCode | text(64) | Y |
템플릿의 상품코드값입니다. 사용할 상품에 대한 코드를 대문자로 입력해야 합니다.
|
templateCode | text(64) | Y |
관리하는 템플릿의 코드값입니다. 영문,숫자,- 로 구성하며 파트너 별로 유니크한 값을 가져야 합니다. |
키 | 타입 | 필수 | 설명 |
text | text(2048) | Y | 발송할 텍스트를 정의하며 변수(#{변수명})를 지정할 수 있습니다. 변수는 샵(#)과 대괄호#{ } 를 활용하여 정의하며, 알파벳, 숫자, 한글, 슬래시(/), 하이픈(-), 언더바(_), 틸드(~)만 허용됩니다. 변수에 치환될 문자열은 150 자 이내까지 허용됩니다. |
categoryCode | text(8) | Y |
템플릿마다 어떤 상황에서 발송하는지에 대해, 정의된 템플릿 카테고리를 입력해야 합니다. 자세한 템플릿 카테고리 목록은 아래 7.2 를 참고하세요. |
buttons | json | N |
사용자에게 별도의 링크를 제공하기 위해 버튼을 추가할 수 있습니다. 링크 종류는 2 가지로 웹링크, 앱링크 모두 제공하며, 자세한 옵션은 아래를 참고하세요. |
sampleImageHashId | text | N | 이미지 API 를 통해 획득한 이미지 해시 아이디를 첨부합니다. 쿠폰이 첨부될 땐 이미지 첨부가 불가합니다. |
sampleCoupon | json | N | 수신자에게 쿠폰을 제공할 때 첨부되어야 하는 샘플 쿠폰 정보입니다. 자세한 옵션은 아래를 참고하세요. |
couponDescription | json | N | 수신자에게 제공할 쿠폰의 설명을 첨부하는 영역입니다. 이는 발송되는 템플릿마다 고정되는 값으로 실제 메세지 발송 시에는 첨부하지 않아도 되는 파라미터입니다. 최대 10 개 항목에 대한 설명이 가능합니다. 자세한 옵션은 아래를 참고하세요. |
benefit | json | N | 수신자에게 제공할 혜택 내용을 첨부하는 영역입니다. 첨부된 혜택내용은 피드와 톡톡 채팅창에 표시되며, 톡톡 파트너에게 제공되는 마케팅 메세지와 유사한 형태로 제공됩니다. |
버튼(buttons)을 구성하는 값은 아래와 같으며, 버튼은 최대 5 개까지 첨부할 수 있습니다.
키 | 설명 |
type |
WEB_LINK / APP_LINK
예) 배송조회 (배송사, 송장번호가 매번 다른 경우와 같이 각 발송건에 대해 변경되는 URL 첨부가 가능합니다.)
2. APP_LINK : 버튼에 연결할 링크가 앱인 경우입니다. 보내기 API 로 발송 시, iOsAppScheme, aOsAppScheme 모두 필수이며 URL Scheme 을 전달합니다. |
buttonCode |
특정 버튼을 가리키는 코드이며, 하나의 템플릿 코드 내에서만 유일한 값이면 됩니다. 버튼 코드값의 최대 길이는 64 입니다. |
buttonName | 사용자의 화면에 표시될 버튼 문구명입니다. 버튼 이름의 최대 길이는 64 입니다. |
쿠폰(sampleCoupon)을 구성하는 값은 아래와 같습니다. 또한 아래 쿠폰 정보는 보내기 API
호출시에도 동일한 형태로 값을 넣어야 합니다.
키 | 설명 |
code |
쿠폰 코드로 유효한 코드값이어야 합니다. 최대 100 자까지 가능하며, 한글,영어,숫자,-만 포함됩니다. |
키 | 설명 |
name | 쿠폰 이름으로 최대 20 자까지 가능합니다. |
endDate | 쿠폰 만료일로 YYYY-MM-DD 형태입니다. |
publisher | 쿠폰 발행처로 생략 시 파트너 계정의 계정프로필명이 입력됩니다. |
imageUrl | 쿠폰 바코드 이미지 URL 로 네이버 포토인프라에 업로드된 후 제공됩니다. 이미지 업로드 API 와 동일하게 사이즈는 300KB, 해상도는 552X552 권장합니다. |
쿠폰 설명(couponDescription)은 아래와 같습니다.
키 | 설명 |
title | 설명할 내용의 제목 영역으로 최대 30 자까지 가능합니다. |
content | 제목에 맞는 내용 영역으로 최대 1000 자까지 가능합니다. |
쿠폰 설명(couponDescription) 파라미터는 제목, 내용에 대응하는 {title, content}쌍이 리스트 형태로 구성되며 최대 10 개 항목까지 가능합니다.
테이블 템플릿의 경우, 아래 정보가 추가로 필요합니다.
키 | 타입 | 필수 | 설명 |
pushNotice | text(2048) | Y | text 대신 사용되며, 발송 시 사용할 푸시알림 메시지를 입력합니다. 템플릿 파라메터로 치환할 수 있습니다. |
tableInfo | json | Y | 테이블 값에 대한 객체가 필요하며 element 배열을 입력 받습니다. |
테이블 유형(tableInfo)은 다음과 같습니다. elementList 는 6 개까지 입력할 수 있습니다.
키 | 타입 | 필수 | 설명 |
elementList | Array | Y | 테이블 값에 대한 객체 배열을 입력 받습니다. 최소 1 개 이상, 최대 6 개까지 입력할 수 있습니다. |
'elementList'에 입력되는 table 정보는 다음과 같습니다.
위치 | 키 | 타입 | 필수 | 설명 |
1 | subtitle | text(30) | N | 서브 타이틀 영역입니다. |
2 | title | text(30) | Y | 타이틀 영역입니다. |
3 | strikeTitle | boolean | N | 타이틀의 취소선을 여부를 설정합니다. |
4 | thumbnailImageUrl | imageUrl | N | 썸네일 이미지 url 입니다. |
5 | thumbnailImageHashId | imageHashId | N |
썸네일 이미지 hashld 입니다. |
위치 | 키 | 타입 | 필수 | 설명 |
6 | table | json | N(조건부) |
테이블 항목입니다. 본문영역이 없는 경우 필수입니다. 최대 10 개까지 지정할 수 있습니다. . title : 필수, 7 자까지 입력 . content : 필수, 20 자까지 입력 |
7 | text | text(1000) | N(조건부) | 본문 영역입니다. 테이블이 없는 경우 필수입니다. |
8 | additionalContent | text(500) | N | 부가정보 영역입니다. |
9 | buttons | json | N |
사용자에게 별도의 링크를 제공하기 위해 버튼을 추가할 수 있습니다. 최대 5 개까지 입력할 수 있습니다. 링크 종류는 2 가지로 웹링크, 앱링크 모두 제공하며, 자세한 옵션은 공통정보를 참고하세요. |
[Example] [Request-정보성-BASIC] | |
{ "naverPartnerKey": "{{naverPartnerKey}}", "productCode": "INFORMATION", "templateCode": "TP-INFORMATION-BASIC-20241230-160245", "text": "템플릿 등록 테스트입니다.", "categoryCode": "R014", "templateType": "BASIC", "buttons": [ { "type": "WEB_LINK", "buttonCode": "BTN-CODE-1", "buttonName": "웹 링크 버튼" } ] } |
[Example] [Request-정보성-GIFT] | |
{ "naverPartnerKey": "{{naverPartnerKey}}", "productCode": "INFORMATION", "templateCode": "TP-INFORMATION-GIFT-20241230-160245", "text": "템플릿 등록 테스트입니다.", "categoryCode": "P001", "templateType": "GIFT", "sampleCoupon": { "code": "sampleCoupon", "name": "샘플 쿠폰", "endDate": "2024-12-30", "publisher": "네이버톡톡" }, "buttons": [ { "type": "WEB_LINK", "buttonCode": "BTN-CODE-1", "buttonName": "웹 링크 버튼" } ] } |
|
[Example] [Request-정보성-TABLE] | |
{ "naverPartnerKey": "{{naverPartnerKey}}", "productCode": "INFORMATION", "templateCode": "TP-INFORMATION-TABLE-20241230-160245", "categoryCode": "S001", "templateType": "TABLE", "pushNotice": "#{applicant}님 #{asType} AS 방문 취소되었습니다.", "tableInfo": { "elementList": [ { "title": "테이블 0 타이틀", "subtitle": "테이블 0 서브 타이틀", "strikeTitle": true, "thumbnailImageUrl": "https://.../images/common/logo.png", "table": [ { "title": "테이블 0 타이틀", "content": "테이블 0 본문" } ], "buttons": [ { "type": "WEB_LINK", "buttonCode": "button_table_01", "buttonName": "테이블 0 속 버튼" } ],
"additionalContent": "부가 정보 영역입니다. \n 테이블 내에 부가 정보가 필요하다면 이곳에 적어주세요." }
{ "title": "테이블 1 타이틀", "subtitle": "테이블 1 서브 타이틀", "strikeTitle": true, "thumbnailImageUrl": "https://.../images/common/logo.png", "table": [ { "title": "테이블 1 타이틀", "content": "테이블 1 내용" } ], "buttons": [ { "type": "WEB_LINK", "buttonCode": "button_table_02", "buttonName": "테이블 1 속 버튼" } ],
"additionalContent": "테이블 1 부가 정보" } ] } } |
[Response]
템플릿 상세 조회 참고
POST /v1/template/register/benefit
광고성 템플릿 생성 (registerBenefitTemplate)
광고성 템플릿 생성
-H 'Content-Type: application/json'
-H 'Authorization: Bearer {{accessToken}}'
[Request]
키 | 타입 | 필수 | 설명 |
naverPartnerKey | text(64) | Y | 네이버 파트너 키 |
productCode | text(64) | Y | 사용할 "마케팅/광고성-혜택" 상품에 대한 코드 "BENEFIT"을 대문자로 입력해야야 합니다. |
templateType | text(64) | Y |
혜택 템플릿 타입을 정하는 입력 값입니다. ·기본형: BENEFIT ·LMS 형: BENEFIT_LMS ·캐러셀 커머스형: BENEFIT_CAROUSEL_COMMERCE ·캐러셀 피드형: BENEFIT_CAROUSEL_FEED ·리스트 커머스형: BENEFIT_LIST_COMMERCE ·리스트 피드형: BENEFIT_LIST_FEED 유형코드 값을 입력해야 합니다. |
templateCode | text(64) | Y | 관리하는 템플릿의 코드값입니다. 영문과 숫자로 구성하며 파트너 별로 유니크한 값을 가져야 합니다. |
categoryCode | text(64) | Y |
템플릿마다 어떤 상황에서 발송하는지에 대해, 정의된 템플릿 카테고리를 입력해야 합니다. 자세한 템플릿 카테고리 목록은 템플릿 카테고리를 참고해주세요. |
sampleImageHashId | text |
기본형 : Y |
이미지 API 를 통해 획득한 이미지 해시 아이디를 첨부합니다.아래 benefit.feedDisplayImageHa |
sampleImageHashId | text |
LMS 형 : N |
shld 와 다른 값을 넣을 땐 톡톡 말풍선에 표시하는 이미지를 피드에 노출하는 이미지와 다르게 설정할 수 있으며, 생략 시엔 혜택 탭에 피드에 노출되는 이미지가 노출됩니다. sampleImageHashId 값과 benefit.feedDisplayImageHashId 값이 모두 없는 경우 노출 지면에서는 이미지 없이 텍스트로만 노출됩니다. |
benefit | json | Y | 고객에게 제공할 혜택소재의 내용을 첨부하는 영역입니다. 첨부된 내용은 알림, 혜택 탭 톡톡 채팅창에 표시됩니다. 템플릿 카테고리(categoryCode)를 '소식(B005)' 선택 시에는 필수 여부가 N 입니다. 자세한 내용은 Benefit 영역을 참고해주세요. |
text |
text (2048) |
Y (기본형, LMS형) |
발송할 텍스트를 정의합니다. 혜택 기본형은 공백을 포함하여 360 자까지 입력할 수 있고, 혜택 LMS 형은 2,000 자까지 입력할 수 있습니다. 변수 치환 기능은 Variable 를 참고해주세요. |
buttons | json | N |
사용자에게 별도의 링크를 제공하기 위해 버튼을 추가할 수 있습니다. 링크 종류는 2 가지로 웹링크, 앱링크 모두 지원하며, 자세한 옵션은 버튼 를 참고하세요. |
searchResult Exposure |
boolean | Y | 검색결과에 노출여부를 설정하는 값입니다. 미입력시 'false'가 기본값으로 입력됩니다. |
키 | 타입 | 필수 | 설명 |
sampleImageHashId | text |
LMS 형 : N |
shId 와 다른 값을 넣을 땐 톡톡 말풍선에 표시하는 이미지를 피드에 노출하는 이미지와 다르게 설정할 수 있으며, 생략 시엔 혜택 탭에 피드에 노출되는 이미지가 노출됩니다. sampleImageHashId 값과 benefit.feedDisplayImageHashId 값이 모두 없는 경우 노출 지면에서는 이미지 없이 텍스트로만 노출됩니다. |
benefit | json | Y | 고객에게 제공할 혜택소재의 내용을 첨부하는 영역입니다. 첨부된 내용은 알림, 혜택 탭 톡톡 채팅창에 표시됩니다. 템플릿 카테고리(categoryCode)를 '소식(B005)' 선택 시에는 필수 여부가 N 입니다. 자세한 내용은 Benefit 영역을 참고해주세요. |
text |
text (2048) |
Y (기본형, LMS형) |
발송할 텍스트를 정의합니다. 혜택 기본형은 공백을 포함하여 360 자까지 입력할 수 있고, 혜택 LMS 형은 2,000 자까지 입력할 수 있습니다. 변수 치환 기능은 Variable 를 참고해주세요. |
buttons | json | N |
사용자에게 별도의 링크를 제공하기 위해 버튼을 추가할 수 있습니다. 링크 종류는 2 가지로 웹링크, 앱링크 모두 지원하며, 자세한 옵션은 버튼 를 참고하세요. |
searchResult Exposure |
boolean | Y | 검색결과에 노출여부를 설정하는 값입니다. 미입력시 'false'가 기본값으로 입력됩니다. |
캐러셀형&피드형 추가
키 | 타입 | 설명 |
introduction | json | 캐러셀 커머스형, 리스트 커머스형, 리스트 피드형 타입에서 사용하는 "인트로"영역의 정보입니다. 해당 타입의 경우 필수값으로 사용됩니다. |
products | json |
캐러셀 커머스형, 캐러셀 피드형, 리스트 커머스형, 리스트 피드형 타입에서 사용하는 "상품"영역의 정보입니다. 해당 타입에 따라 2~6 개까지 입력가능합니다. -캐러셀 커머스형: 최소 2 개, 최대 5 개 -캐러셀 피드형: 최소 2 개, 최대 6 개 -리스트 커머스형: 최소 3 개, 최대 6 개 -리스트 피드형: 최소 2 개 최대 3 개 |
moreButtonUrl | text | 캐러셀형 타입에서 사용하는 "더보기" 버튼의 링크입니다. 미입력시 "더보기" 버튼은 표시되지 않습니다. |
moreButtonMobileUrl | text | 캐러셀형 타입에서 사용하는 "더보기" 버튼의 모바일용 링크입니다. 미입력시 moreButtonUrl 값으로 사용됩니다. |
moreButtoniOsAppScheme | text | 캐러셀형 타입에서 사용하는 "더보기" 버튼의 iOS 스킴 링크입니다. 선택 사항이며 미입력시 moreButtonUrl 값으로 사용됩니다. 스킴으로 등록시 "moreButtoniOsAppScheme", "moreButtonaOsAppScheme" 두 값 모두 등록이 필요합니다. |
moreButtonaOsAppScheme | text |
캐러셀형 타입에서 사용하는 "더보기" 버튼의 Android 스킴 링크입니다. 선택 사항이며 미입력시 moreButtonUrl 값으로 사용됩니다. 스킴으로 등록시 "moreButtoniOsAppScheme", "moreButtonaOsAppScheme" 두 값 모두 등록이 필요합니다. |
혜택 인트로(INTRODUCTION)는 다음과 같습니다.
키 | 타입 | 설명 |
headerImageHashId | text | 이미지 API 를 통해 획득한 이미지 해시 아이디를 첨부합니다. 또는 사용할 이미지의 imageUrl 을 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
headerImageUrl | text | 사용할 이미지의 imageUrl 을 넣습니다. 또는 이미 업로드한 imageHashId 를 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
title | text | 헤택 인트로의 제목을 입력합니다. 인트로가 사용될 경우 필수값이며 한글기준 20 자 이내 입력 가능합니다. |
description | text |
헤택 인트로의 내용을 입력합니다. 캐러셀 커머스형의 경우에만 필수값이며 2 번의 줄바꿈을 할 수 있으며 해당 타입에 따라 60~70 자까지 입력가능합니다. ·캐러셀 커머스형: 60 자 ·리스트 커머스형/리스트 피드형: 70 자 |
buttonTitle | text | 헤택 캐러셀 커머스형인 경우 필수 값이며, 사용할 버튼의 제목을 입력합니다. 8 자까지 입력 가능합니다. |
pcUrl | text | WEB_LINK 로 PC 에서 버튼이나, 이미지 클릭시 이동할 링크를 입력합니다. 반드시 http 나 https 로 시작해야 합니다. |
mobileUrl | text | WEB_LINK 로 모바일에서 버튼이나, 이미지 클릭시 이동할 링크를 입력합니다. 반드시 http 나 https 로 시작해야 합니다. |
iOsAppScheme | text | APP_LINK 로 iOS 스킴 링크를 입력합니다. 선택 사항입니다. |
aOsAppScheme | text | APP_LINK 로 Android 스킴 링크를 입력합니다. 선택 사항입니다. |
키 | 타입 | 설명 |
headerImageHashId | text | 이미지 API 를 통해 획득한 이미지 해시 아이디를 첨부합니다. 또는 사용할 이미지의 imageUrl 을 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
headerImageUrl | text | 사용할 이미지의 imageUrl 을 넣습니다. 또는 이미 업로드한 imageHashId 를 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
title | text | 헤택 인트로의 제목을 입력합니다. 인트로가 사용될 경우 필수값이며 한글기준 20 자 이내 입력 가능합니다. |
description | text |
헤택 인트로의 내용을 입력합니다. 캐러셀 커머스형의 경우에만 필수값이며 2 번의 줄바꿈을 할 수 있으며 해당 타입에 따라 60~70 자까지 입력가능합니다. ·캐러셀 커머스형: 60 자 ·리스트 커머스형/리스트 피드형: 70 자 |
buttonTitle | text | 헤택 캐러셀 커머스형인 경우 필수 값이며, 사용할 버튼의 제목을 입력합니다. 8 자까지 입력 가능합니다. |
pcUrl | text | WEB_LINK 로 PC 에서 버튼이나, 이미지 클릭시 이동할 링크를 입력합니다. 반드시 http 나 https 로 시작해야 합니다. |
mobileUrl | text | WEB_LINK 로 모바일에서 버튼이나, 이미지 클릭시 이동할 링크를 입력합니다. 반드시 http 나 https 로 시작해야 합니다. |
iOsAppScheme | text | APP_LINK 로 iOS 스킴 링크를 입력합니다. 선택 사항입니다. |
aOsAppScheme | text | APP_LINK 로 Android 스킴 링크를 입력합니다. 선택 사항입니다. |
캐러셀 커머스형, 리스트 커머스형의 상품 (PRODUCTS)은 다음과 같습니다.
키 | 타입 | 설명 |
imageHashId | text | 이미지 API 를 통해 획득한 이미지 해시 아이디를 첨부합니다. 또는 사용할 이미지의 imageUrl 을 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
imageUrl | text | 사용할 이미지의 imageUrl 을 넣습니다. 또는 이미 업로드한 imageHashId 를 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
title | text | 상품 제목을 입력합니다. 필수값이며 한글기준 20 자 이내 입력 가능합니다. |
originalPrice | number | 할인 전 가격을 입력합니다. 상품의 상품 가격은 최대 100 조 원입니다. |
currentPrice | number |
할인 된 가격을 입력합니다. 반드시 original 가격보다 같거나 작아야 합니다. 상품 할인 가격은 최대 99 조 9999 억 9999 만 9999 원까지 입력 가능하며 할인율은 자동계산되어 표시되고 1% 미만의 경우 표시되지 않습니다. |
pcUrl | text | WEB_LINK 로 PC 에서 버튼이나, 이미지 클릭시 이동할 링크를 입력합니다. 반드시 http 나 https 로 시작해야 합니다. |
mobileUrl | text | WEB_LINK 로 모바일에서 버튼이나, 이미지 클릭시 이동할 링크를 입력합니다. 반드시 http 나 https 로 시작해야 합니다. |
iOsAppScheme | text | APP_LINK 로 iOS 스킴 링크를 입력합니다. 선택 사항입니다. |
aOsAppScheme | text | APP_LINK 로 Android 스킴 링크를 입력합니다. 선택 사항입니다. |
캐러셀 피드형 상품 (PRODUCTS)은 다음과 같습니다. 버튼 1 개는 필수이며 최대 2 개까지 추가 가능합니다.
키 | 타입 | 설명 |
imageHashId | text | 이미지 API 를 통해 획득한 이미지 해시 아이디를 첨부합니다. 또는 사용할 이미지의 imageUrl 을 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
imageUrl | text |
사용할 이미지의 imageUrl 을 넣습니다. 또는 이미 업로드한 imageHashId 를 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
title | text | 상품 제목을 입력합니다. 필수값이며 한글기준 20 자 이내 입력 가능합니다. |
description | text | 상품 내용을 입력합니다. 필수값이며 2 번의 줄바꿈을 할 수 있으며 해당 타입에 따라 100 자까지 입력가능합니다. |
buttons | json | 사용자가 클릭할 수 있는 버튼을 1 개는 필수이며 2 개까지 입력할 수 있습니다. 버튼명은 8 자까지 입력 가능합니다. |
리스트 피드형 상품 (PRODUCTS)은 다음과 같습니다.
키 | 타입 | 설명 |
imageHashId | text | 이미지 API 를 통해 획득한 이미지 해시 아이디를 첨부합니다. 또는 사용할 이미지의 imageUrl 을 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
imageUrl | text |
사용할 이미지의 imageUrl 을 넣습니다. 또는 이미 업로드한 imageHashId 를 넣습니다. 둘 중 하나는 반드시 입력해야 합니다. |
title | text |
상품 내용을 입력합니다. 필수값이며 줄바꿈은 1 번 한글기준 28 자 이내 입력 가능합니다. |
pcUrl | text | WEB_LINK 로 PC 에서 버튼이나, 이미지 클릭시 이동할 링크를 입력합니다. 반드시 http 나 https 로 시작해야 합니다. |
mobileUrl | text | WEB_LINK 로 모바일에서 버튼이나, 이미지 클릭시 이동할 링크를 입력합니다. 반드시 http 나 https 로 시작해야 합니다. |
iOsAppScheme | text | APP_LINK 로 iOS 스킴 링크를 입력합니다. 선택 사항입니다. |
aOsAppScheme | text | APP_LINK 로 Android 스킴 링크를 입력합니다. 선택 사항입니다. |
버튼 (buttons)
리스트형에서의 '버튼(buttons)'은 리스트 'product'의 링크를 의미합니다.
기본형 | LMS 형 | 캐러셀 커머스형 | 캐러셀 피드형 | 리스트 커머스형 | 리스트 피드형 | |
버튼 필수 여부 |
N |
버튼 스펙 없음 |
Y | Y | Y | Y |
버튼명 수정 가능 여부 |
Y |
N '구매하기'로 고정 |
Y |
N '구매하기'로 고정 |
Y | |
버튼 갯수 |
최대 2 개 |
캐러셀 당 최대 1 개 |
캐러셀 당 최대 2 개 |
최소 3 개~ 최대 6 개 |
최소 2 개~ 최대 3 개 |
|
버튼 앱링크 지원 여부 |
가능 | 가능 | 가능 | 가능 | 가능 |
검색 노출 여부 값(searchResultExposure)에 따라 button 스펙이 상이합니다.
searchResultExposure= true 인 경우 > 버튼 URL 개인화가 불가합니다.
템플릿 생성 시 버튼 URL 을 확정하여 생성해야 합니다.
키 | 설명 |
type |
WEB_LINK 또는 APP_LINK
등록 시, iOsAppScheme, aOsAppScheme 모두 필수이며 URL Scheme을 전달합니다. |
한 버튼에서 WEB_LINK 와 APP_LINK 를 중복으로 사용할 수 없습니다. | |
buttonCode |
searchResultExposure = true 인 경우 버튼 코드 생성은 메시지 발송 형식을 위한 것이며, 버튼 코드를 통한 URL 개인화는 불가합니다. 특정 버튼을 가리키는 코드이며, 하나의 템플릿 코드 내에서만 유일한 값이면 됩니다. 버튼 코드값의 최대 길이는 64 자 입니다. |
buttonName | 사용자의 화면에 표시될 버튼 문구명입니다. 기본형 버튼명의 최대 길이는 20 자 입니다. 커머스형의 버튼명 최대 길이는 8 자입니다 |
mobileUrl | type 에서 WEB_LINK 선택 시, 모바일에서 버튼 클릭시 이동할 링크를 입력합니다. |
pcUrl | type 에서 WEB_LINK 선택 시, PC 에서 버튼 클릭시 이동할 링크를 입력합니다. |
iOsAppScheme | type 에서 APP_LINK 선택 시, iOS 스킴 링크를 입력합니다 |
searchResultExposure = false 인 경우 > 버튼 URL 개인화가 가능합니다.
메시지 발송 시점에 URL 을 포함하여 발송 가능합니다. 반드시 URL 포함하여야 발송 가능합니다.
키 | 설명 |
type |
WEB_LINK 또는 APP_LINK
등록 시, iOsAppScheme, aOsAppScheme 모두 필수이며 URL Scheme 을 전달합니다. |
buttonCode |
한 버튼에서 WEB_LINK 와 APP_LINK 를 중복으로 사용할 수 없습니다. searchResultExposure = true 인 경우 버튼 코드 생성은 메시지 발송 형식을 위한 것이며, 버튼 코드를 통한 URL 개인화는 불가합니다. 특정 버튼을 가리키는 코드이며, 하나의 템플릿 코드 내에서만 유일한 값이면 됩니다. 버튼 코드값의 최대 길이는 64 자 입니다. |
buttonName | 사용자의 화면에 표시될 버튼 문구명입니다. 기본형 버튼명의 최대 길이는 20 자 입니다. 커머스형의 버튼명 최대 길이는 8 자입니다. |
mobileUrl | type 에서 WEB_LINK 선택 시, 모바일에서 버튼 클릭시 이동할 링크를 입력합니다. |
pcUrl | type 에서 WEB_LINK 선택 시, PC 에서 버튼 클릭시 이동할 링크를 입력합니다. |
iOsAppScheme | type 에서 APP_LINK 선택 시, iOS 스킴 링크를 입력합니다 |
aOsAppScheme | type 에서 APP_LINK 선택 시, Android 스킴 링크를 입력합니다 |
댓글
댓글 0개
이 문서에는 댓글을 달 수 없습니다.