콘텐츠 카드 통합
이 문서에서는 콘텐츠 카드 데이터 모델, 표준 피드 UI 옵션 및 추가 카드 메서드를 포함한 웹용 콘텐츠 카드 통합을 다룹니다.
This guide uses code samples from the Braze Web SDK 4.0.0+. To upgrade to the latest Web SDK version, see SDK Upgrade Guide.
Braze 웹 SDK에는 콘텐츠 카드 피드 UI가 포함되어 있어 빠르게 통합할 수 있습니다. 대신 자체 UI를 빌드하려면 콘텐츠 카드 사용자 지정 가이드를 참조하세요.
표준 피드 UI
포함된 콘텐츠 카드 UI를 사용하려면 웹사이트에서 피드를 표시할 위치를 지정해야 합니다.
이 예제에서는 콘텐츠 카드 피드를 <div id="feed"></div>
에 배치하려고 합니다. 세 개의 버튼을 사용하여 피드를 숨기거나, 표시하거나, 토글(현재 상태에 따라 숨기거나 표시)합니다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
<button id="toggle" type="button">Toggle Cards Feed</button>
<button id="hide" type="button">Hide Cards Feed</button>
<button id="show" type="button">Show Cards Feed</button>
<nav>
<h1>Your Personalized Feed</h1>
<div id="feed"></div>
</nav>
<script>
const toggle = document.getElementById("toggle");
const hide = document.getElementById("hide");
const show = document.getElementById("show");
const feed = document.getElementById("feed");
toggle.onclick = function(){
braze.toggleContentCards(feed);
}
hide.onclick = function(){
braze.hideContentCards();
}
show.onclick = function(){
braze.showContentCards(feed);
}
</script>
toggleContentCards(parentNode, filterFunction)
및 showContentCards(parentNode, filterFunction)
메서드를 사용하는 경우 인수를 제공하지 않으면 모든 콘텐츠 카드가 페이지 오른쪽에 있는 고정 위치 사이드바에 표시됩니다. 그렇지 않으면 피드가 지정된 parentNode
옵션에 배치됩니다.
매개변수 | 설명 |
---|---|
parentNode |
콘텐츠 카드를 렌더링할 HTML 노드입니다. 상위 노드에 이미 Braze 콘텐츠 카드 보기가 직계 하위로 존재하는 경우 기존 콘텐츠 카드가 대체됩니다. 예를 들어 document.querySelector(".my-container") 를 전달해야 합니다. |
filterFunction |
이 보기에 표시되는 카드의 필터 또는 정렬 기능입니다. {pinned, date} 기준으로 정렬된 Card 오브젝트 배열로 호출됩니다. 이 사용자에 대해 렌더링할 정렬된 Card 오브젝트 배열을 반환할 것으로 예상됩니다. 생략하면 모든 카드가 표시됩니다. |
콘텐츠 카드 토글에 대한 자세한 내용은 SDK 참조 설명서를 참조하세요.
콘텐츠 카드 데이터 모델
콘텐츠 카드 데이터 모델은 웹 SDK에서 사용할 수 있습니다.
Braze 웹 SDK는 세 가지 콘텐츠 카드 유형을 제공합니다: ImageOnly, CaptionedImage, ClassicCard. 각 유형은 기본 모델 카드에서 공통 속성정보를 상속받으며 다음과 같은 추가 속성정보가 있습니다.
카드 데이터 가입에 대한 자세한 내용은 분석 로깅을 참조하세요.
기본 콘텐츠 카드 모델 속성 - 카드
모든 콘텐츠 카드에는 이러한 공유 속성이 있습니다:
등록정보 | 설명 |
---|---|
expiresAt |
카드 만료 시간의 Unix 타임스탬프. |
extras |
(선택 사항) 값 문자열이 포함된 문자열 오브젝트로 형식이 지정된 키-값 페어 데이터. |
id |
(선택 사항) 카드의 ID입니다. 이는 분석 목적으로 이벤트와 함께 Braze에 다시 보고됩니다. |
pinned |
이 속성정보는 대시보드에서 카드가 ‘고정됨’으로 설정되었는지 여부를 반영합니다. |
updated |
이 카드가 마지막으로 수정된 시점의 UNIX 타임스탬프입니다. |
viewed |
이 속성정보는 사용자가 카드를 조회했는지 여부를 반영합니다. |
isControl |
이 속성정보는 카드가 A/B 테스트 내에서 ‘대조군’인 경우 true 입니다. |
이미지 전용 콘텐츠 카드 속성정보 - ImageOnly
ImageOnly 카드는 클릭 가능한 전체 크기 이미지입니다.
등록정보 | 설명 |
---|---|
aspectRatio |
카드 이미지의 가로 세로 비율이며 이미지 로딩이 완료되기 전에 힌트 역할을 합니다. 특정 상황에서는 속성이 제공되지 않을 수 있습니다. |
categories |
이 속성정보는 순전히 커스텀 구현의 구성을 위해 제공되며, 대시보드 작성기에서 이러한 카테고리를 설정할 수 있습니다. |
clicked |
이 속성정보는 이 카드가 이 기기에서 클릭된 적이 있는지 여부를 나타냅니다. |
created |
Braze에서 카드가 생성된 시간의 UNIX 타임스탬프입니다. |
dismissed |
이 속성은 이 카드가 기각되었는지 여부를 나타냅니다. |
dismissible |
이 속성은 사용자가 카드를 해지하여 보기에서 제거할 수 있는지 여부를 반영합니다. |
imageUrl |
카드 이미지의 URL입니다. |
linkText |
URL의 표시 텍스트입니다. |
url |
카드를 클릭한 후 열릴 URL입니다. |
캡션 이미지 콘텐츠 카드 속성 - CaptionedImage
CaptionedImage 카드는 클릭 가능한 전체 크기 이미지로, 설명 텍스트가 함께 제공됩니다.
등록정보 | 설명 |
---|---|
aspectRatio |
카드 이미지의 가로 세로 비율이며 이미지 로딩이 완료되기 전에 힌트 역할을 합니다. 특정 상황에서는 속성이 제공되지 않을 수 있습니다. |
categories |
이 속성정보는 순전히 커스텀 구현의 구성을 위해 제공되며, 대시보드 작성기에서 이러한 카테고리를 설정할 수 있습니다. |
clicked |
이 속성정보는 이 카드가 이 기기에서 클릭된 적이 있는지 여부를 나타냅니다. |
created |
Braze에서 카드가 생성된 시간의 UNIX 타임스탬프입니다. |
dismissed |
이 속성은 이 카드가 기각되었는지 여부를 나타냅니다. |
dismissible |
이 속성은 사용자가 카드를 해지하여 보기에서 제거할 수 있는지 여부를 반영합니다. |
imageUrl |
카드 이미지의 URL입니다. |
linkText |
URL의 표시 텍스트입니다. |
title |
이 카드의 제목 텍스트입니다. |
url |
카드를 클릭한 후 열릴 URL입니다. |
클래식 콘텐츠 카드 속성정보 - ClassicCard
클래식카드 모델에는 텍스트가 없는 이미지 또는 텍스트가 있는 이미지가 포함될 수 있습니다.
등록정보 | 설명 |
---|---|
aspectRatio |
카드 이미지의 가로 세로 비율이며 이미지 로딩이 완료되기 전에 힌트 역할을 합니다. 특정 상황에서는 속성이 제공되지 않을 수 있습니다. |
categories |
이 속성정보는 순전히 커스텀 구현의 구성을 위해 제공되며, 대시보드 작성기에서 이러한 카테고리를 설정할 수 있습니다. |
clicked |
이 속성정보는 이 카드가 이 기기에서 클릭된 적이 있는지 여부를 나타냅니다. |
created |
Braze에서 카드가 생성된 시간의 UNIX 타임스탬프입니다. |
description |
이 카드의 본문 텍스트입니다. |
dismissed |
이 속성은 이 카드가 기각되었는지 여부를 나타냅니다. |
dismissible |
이 속성은 사용자가 카드를 해지하여 보기에서 제거할 수 있는지 여부를 반영합니다. |
imageUrl |
카드 이미지의 URL입니다. |
linkText |
URL의 표시 텍스트입니다. |
title |
이 카드의 제목 텍스트입니다. |
url |
카드를 클릭한 후 열릴 URL입니다. |
대조군
기본 콘텐츠 카드 피드를 사용하는 경우 노출 수와 클릭 수가 자동으로 추적됩니다.
콘텐츠 카드에 대한 커스텀 통합을 사용하는 경우 제어 카드가 표시되면 노출 횟수를 기록해야 합니다. 이러한 노력의 일환으로, A/B 테스트에서 노출 횟수를 기록할 때 제어 카드를 처리해야 합니다. 이러한 카드는 비어 있으며 사용자에게 표시되지 않지만, 여전히 노출 횟수를 기록하여 제어 카드가 아닌 카드와 해당 성능을 비교해야 합니다.
콘텐츠 카드가 A/B 테스트의 대조군에 있는지 확인하려면 card.isControl
속성정보(Web SDK v4.5.0 이상)를 확인하거나 카드가 ControlCard
인스턴스(card instanceof braze.ControlCard
)인지 확인합니다.
카드 방법
방법 | 설명 |
---|---|
logContentCardImpressions |
지정된 카드 목록에 대한 노출 이벤트를 기록합니다. Braze UI가 아닌 사용자 지정 UI를 사용할 때 필요합니다. |
logContentCardClick |
지정된 카드에 대한 클릭 이벤트를 기록합니다. Braze UI가 아닌 사용자 지정 UI를 사용할 때 필요합니다. |
showContentCards |
사용자의 콘텐츠 카드를 표시합니다. |
hideContentCards |
현재 표시된 Braze 콘텐츠 카드를 숨깁니다. |
toggleContentCards |
사용자의 콘텐츠 카드를 표시합니다. |
getCachedContentCards |
마지막 콘텐츠 카드 새로 고침에서 현재 사용 가능한 모든 카드를 가져옵니다. |
subscribeToContentCardsUpdates |
콘텐츠 카드 업데이트에 가입합니다. 구독자 콜백은 콘텐츠 카드가 업데이트될 때마다 호출됩니다. |
dismissCard |
프로그래밍 방식으로 카드를 해제합니다(v2.4.1에서 사용 가능). |
자세한 내용은 SDK 참조 설명서를 참조하세요.
계속 진행할 준비가 되셨나요? 콘텐츠 카드의 기본 사항을 이해했다면 콘텐츠 카드 사용자 지정 가이드를 참조하여 사용자 지정을 시작하세요.