コンテンツカードの統合
この記事では、コンテンツカードデータモデル、標準フィード UI オプション、追加のカードメソッドなど、Web 用のコンテンツカード統合について説明します。
このガイドでは、Braze Web SDK 4.0.0+のコードサンプルを使用する。最新のWeb SDKバージョンにアップグレードするには、SDKアップグレードガイドを参照のこと。
Braze Web SDK には、統合作業をスピードアップするコンテンツカードフィード UI が含まれています。代わりに独自のUIを構築したい場合は、コンテンツ・カードのカスタマイズ・ガイドを参照のこと。
標準フィードUI
付属のコンテンツカード UI を使用するには、Web サイト上のどこにフィードを表示するかを指定する必要があります。
この例では、コンテンツカードフィードを配置する <div id="feed"></div>
があります。3つのボタンを使って、フィードの非表示、表示、トグル(現在の状態に応じて非表示、表示)を切り替える。
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 |
このビューに表示されるカードのフィルターまたはソート機能。Card オブジェクトの配列で呼び出され、{pinned, date} でソートされます。このユーザーにレンダリングするために、ソートされた Card オブジェクトの配列を返す必要があります。省略した場合は、すべてのカードが表示される。 |
コンテンツカードの切り替えに関する詳細は、SDK リファレンスドキュメントを参照してください。
コンテンツカードデータモデル{#data-models}
コンテンツカードのデータモデルは、Web SDK で利用できます。
Braze Web SDK には、3種類のコンテンツカードがあります。ImageOnly、CaptionedImage、ClassicCardである。各タイプは、ベースモデルカードから共通のプロパティを継承し、以下の追加プロパティを持つ。
カードデータの購読については、「分析のロギング」を参照してください。
ベース・コンテンツ・カード・モデルのプロパティ - カード
すべてのコンテンツカードは、以下の共有プロパティを持っています。
プロパティ | 説明 |
---|---|
expiresAt |
カードの有効期限を示すUNIXタイムスタンプ。 |
extras |
(オプション)値文字列を持つ文字列オブジェクトとしてフォーマットされたキーと値のペアデータ。 |
id |
(オプション)カードのID。これは、分析目的でイベントとともに Braze に報告されます。 |
pinned |
このプロパティは、カードがダッシュボードで「ピン留め」されているかどうかを反映する。 |
updated |
このカードが最後に更新されたUNIXタイムスタンプ。 |
viewed |
このプロパティは、ユーザがカードを閲覧したかどうかを反映する。 |
isControl |
カードが AB テスト内の「コントロール」グループである場合、このプロパティは 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
ClassicCardモデルは、テキストなしの画像、または画像付きのテキストを含むことができる。
プロパティ | 説明 | |
---|---|---|
aspectRatio |
カードの画像のアスペクト比。画像の読み込みが完了する前のヒントとなる。特定の状況ではプロパティが提供されない場合があることに注意してください。 | |
categories |
このプロパティは、純粋にカスタム実装で整理するためのもので、これらのカテゴリーはダッシュボードコンポーザーで設定できます。 | |
clicked |
このプロパティは、このカードがこのデバイスでクリックされたことがあるかどうかを示す。 | |
created |
Brazeからのカード作成時間のUNIXタイムスタンプ。 | |
description |
このカードの本文。 | |
dismissed |
このプロパティは、このカードが却下されたかどうかを示す。 | |
dismissible |
このプロパティは、ユーザーがカードを閉じてビューから削除できるかどうかを反映します。 | |
imageUrl |
カードの画像のURL。 | |
linkText |
URLの表示テキスト。 | |
title |
このカードのタイトルテキスト。 | |
url |
カードがクリックされた後に開かれるURL。 |
対照群
デフォルトのコンテンツカードフィードを使用すると、インプレッションとクリックが自動的に追跡されます。
コンテンツカード用のカスタム統合を使用している場合、コントロールカードが表示されたときのインプレッションを記録する必要があります。この作業の一環として、AB テストでインプレッションを記録する際には、必ずコントロールカードを処理するようにしてください。これらのカードは空白であり、ユーザーに表示されませんが、コントロールカードでないカードとのパフォーマンスを比較するために、インプレッションを記録する必要がある。
コンテンツカードが AB テストのコントロールグループにあるかどうかを判断するには、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 リファレンスドキュメントを参照してください。
さらに上を目指す準備はできているか?コンテンツカードの基本を理解したら、コンテンツカードカスタマイズガイドを参照してカスタマイズを始めよう。