공통 Object
View Template 구성에 따라서 상세 Object별 타입과 자세한 설명을 제공합니다.
주의
공통 Object 파라미터의 필수 여부는 View Template 타입에 따라 조금씩 다르게 정의됩니다.
- LIST 타입에서 사용되는 Object: Item의
imageUrl파라미터는선택요소로 정의됩니다.- CAROUSEL 타입에서 사용되는 Object: Item의
imageUrl파라미터는필수요소로 정의됩니다.
Item
표Item| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| head | Object: TemplateText | 선택 |
번호 등 Item을 지칭할 수 있는 정보 ex) 1 또는 1위 |
| imageUrl | String | 필수/선택 |
Item별 이미지 URL |
| thumbnail | Object: MediaThumbnail | 선택 |
썸네일 정보 |
| primaryText | Object: TemplateText | 필수 |
Item의 핵심 정보 표시 - 가장 중요한 정답형 정보로 최대 두 줄까지 표시 |
| secondaryText | Object: TemplateText | 선택 |
Item의 두번째 중요 정보 표시 - primaryText의 부가 정보로 최대 두 줄까지 표시 |
| action | Object: Action | 선택 |
Item 선택 시 수행할 액션 |
TemplateText
표TemplateText| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| iconUrl | String | 선택 |
이미지 URL 정보 - iconUrl 입력 시, thumbnail도 함께 입력 |
| thumbnail | Object: IconThumbnail | 선택 |
썸네일 정보 - iconUrl 입력 시, 함께 입력 필요 |
| plainText | String | 필수 |
기본 텍스트 - 태그를 이해하지 못하는 클라이언트를 위한 정보 제공 |
| styledText | String | 선택 |
스타일 텍스트 - 줄바꿈, 이탤릭, 언더라인, 취소선, 컬러 태그 포함 - 기초적인 스타일을 표현하기 위해 제공되는 정보 |
줄바꿈:ex) the first line the second line |
|||
이탤릭:ex) this text is italic |
|||
언더라인:ex) this text is underlined |
|||
취소선:ex) |
|||
컬러:ex) this color is blue |
안내
TemplateText는 plainText와 styledText를 구분하여 지원하고 있습니다.
- 가장 최적화된 정보 제공을 위해 styledText 사용을 권장합니다.
- 정보 중요도가 높은 title과 content.primaryText는 가능한 한 styledText 사용을 지양합니다.
Background
표Background| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| color | String | 선택 |
배경 색상 ex) "#RRGGBB" |
| imageUrl | String | 선택 |
이미지 URL 정보 - imageUrl 입력 시, thumbnail도 함께 입력 |
| thumbnail | Object: BackgroundThumbnail | 선택 |
썸네일 정보 - imageUrl 입력 시, 함께 입력 |
TemplateMedia
표TemplateMedia| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| mediaType | String | 필수 |
IMAGE, VIDEO 중 선택 |
| mediaUrl | String | 필수 |
미디어 URL 정보 |
| thumbnail | Object: MediaThumbnail | 필수 |
썸네일 정보 |
TemplateButton
표TemplateButton| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| iconUrl | String | 필수/선택 |
이미지 URL 정보 - iconUrl 입력 시, thumbnail도 함께 입력 |
| thumbnail | Object: IconThumbnail | 선택 |
썸네일 정보 - iconUrl 입력 시, 함께 입력 필요 |
| plainText | String | 필수 |
버튼 텍스트 정보 |
| action | Object: Action | 필수 |
액션 정의 |
Action
표Action| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| url | String | 필수 |
버튼 동작 URL - 웹뷰(Web View) 띄우기 - 앱 스키마(App Scheme) 열기 - 카카오 i Event(다른 인텐트 연결 등) |
Content
표Content| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| primaryText | Object: TemplateText | 필수 |
가장 중요한 정답형 정보 |
| secondaryText | Object: TemplateText | 선택 |
primaryText의 부가 정보 |
| paragraph | Object: TemplateText | 필수 |
문단 정보 |
MediaThumbnail
표MediaThumbnail| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| small | String | 필수 |
기기 해상도가 320dpi 이하인 경우 적용 |
| medium | String | 필수 |
기기 해상도가 320~640dpi 사이인 경우 적용 |
| large | String | 필수 |
기기 해상도가 640dpi 이상인 경우 적용 |
IconThumbnail
표IconThumbnail| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| small | String | 필수 |
기기 해상도가 320dpi 이하인 경우 적용 |
| medium | String | 필수 |
기기 해상도가 320~640dpi 인 경우 적용 |
| large | String | 필수 |
기기 해상도가 640dpi 이상인 경우 적용 |
BackgroundThumbnail
표BackgroundThumbnail| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| small | String | 필수 |
기기 해상도가 320dpi 이하인 경우 적용 |
| medium | String | 필수 |
기기 해상도가 320~640dpi 인 경우 적용 |
| large | String | 필수 |
기기 해상도가 640dpi 이상인 경우 적용 |
Meta
표Meta| 파라미터 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
| plainText | String | 필수 |
톡 템플릿 버튼명 |
| mobileUrl | String | 필수 |
모바일에서 보여질 링크 |
| webUrl | String | 필수 |
웹에서 보여질 링크 |