APIメールユーザー設定センター
ユーザー設定センターを設定すると、ユーザーがメールメッセージングの通知設定を一か所で編集・管理できるようになります。この記事では、APIで生成するユーザー設定センターの構築手順を説明しますが、ドラッグ&ドロップエディターを使用してユーザー設定センターを構築することもできます。
Brazeダッシュボードで、オーディエンス > メールユーザー設定センターに移動します。
ここで各サブスクリプショングループを管理・表示できます。作成した各サブスクリプショングループは、このユーザー設定センターリストに追加されます。複数のユーザー設定センターを作成できます。
ユーザー設定センターはBrazeメールチャネル内で使用することを目的としています。ユーザー設定センターのリンクは各ユーザーに基づいて動的に生成されるため、外部でホストすることはできません。
APIでユーザー設定センターを作成する
ユーザー設定センターBrazeエンドポイントを使用すると、Brazeがホストするウェブサイトであるユーザー設定センターを作成でき、ユーザーのサブスクリプション状態やサブスクリプショングループのステータスを表示できます。HTMLとCSSを使用して、開発者チームがページのスタイリングをブランドガイドラインに合わせたユーザー設定センターを構築できます。
Liquidを使用すると、サブスクリプショングループの名前と各ユーザーのステータスを取得できます。これにより、ページが読み込まれたときにBrazeがこのデータを保存・取得します。
前提条件
| 要件 | 説明 |
|---|---|
| ユーザー設定センターの有効化 | Brazeダッシュボードにユーザー設定センター機能を使用する権限があること。 |
| メール、SMS、またはWhatsAppサブスクリプショングループを持つ有効なワークスペース | 有効なユーザーとメール、SMS、またはWhatsAppサブスクリプショングループを持つ稼働中のワークスペース。 |
| 有効なユーザー | メールアドレスとexternal IDを持つユーザー。 |
| ユーザー設定センター権限を持つ生成済みAPIキー | Brazeダッシュボードで、設定 > APIキーに移動し、ユーザー設定センター権限を持つAPIキーにアクセスできることを確認します。 |
ステップ 1: ユーザー設定センター作成エンドポイントを使用する
ユーザー設定センター作成エンドポイントを使用して、ユーザー設定センターの構築を始めましょう。ユーザー設定センターをカスタマイズするには、ブランディングに合ったHTMLをpreference_center_page_htmlフィールドとconfirmation_page_htmlフィールドに含めることができます。
ユーザー設定センターURL生成エンドポイントを使用すると、Brazeを通じて送信されるメール以外で、特定のユーザーのユーザー設定センターURLを取得できます。
Brazeはdata: URLを使用するiframe内でconfirmation_page_htmlをレンダリングします。ブラウザはdata: URLを不透明なオリジンとして扱います。そのため、そのiframe内のスクリプトは追加の外部リソースを読み込むことができず、そのページから親ウィンドウのナビゲーションやフレーム間通信は失敗します。
代わりに、スクリプトを埋め込む代わりに、ホストされた調査URLなどの外部コンテンツにリンクできます。サードパーティツールを埋め込む必要があり、ベンダーが許可している場合は、ツールのホストされたHTTPS URLをsrcに指定した<iframe>を使用してください。
ステップ 2: メールCampaignに含める
NaverのAndroidアプリやiOSアプリなど、Brazeのユーザー設定センターをサポートしていないブラウザがあります。一部のユーザーがこれらのブラウザを使用することが予想される場合は、メール設定を管理するための代替方法を提供することを検討してください。
メールにユーザー設定センターへのリンクを配置するには、配信停止URLを挿入する方法と同様に、メール内の目的の場所に以下のLiquidタグを使用します。
1
{{preference_center.${kitchenerie_preference_center_example}}}
Liquidを含むHTMLの組み合わせも使用できます。たとえば、HTMLエディターまたはドラッグ&ドロップエディターでURLとして以下を貼り付けることができます。これにより、すべてのメールサブスクリプショングループを自動的にリストする基本的なユーザー設定センターレイアウトが表示されます。リンクエイリアスを使用する場合は、Brazeがトラッキングパラメーターを追加できるように、Liquidタグの後に末尾のクエスチョンマーク(?)を追加してください。
1
<a href="{{preference_center.${kitchenerie_preference_center_example}}}?">Edit your preferences</a>
ユーザー設定センターには、ユーザーがすべてのメールの配信を停止できるチェックボックスがあります。テストメッセージとして送信された場合、これらの設定は保存できないことに注意してください。
上記のLiquidタグは、CampaignまたはCanvasを起動する場合にのみ機能します。テストメールの送信では有効なリンクは生成されません。ユーザー設定センターのリンクを確認するには、テストプロファイルのみをターゲットとするCampaignでメッセージを起動してください。
ユーザー設定センターを編集する
ユーザー設定センター更新エンドポイントを使用して、ユーザー設定センターを編集・更新できます。
ユーザー設定センターと詳細を確認する
ユーザー設定センターを確認するには、ユーザー設定センター詳細表示エンドポイントを使用して、最終更新タイムスタンプやユーザー設定センターIDなどの関連情報を返します。
ユーザー設定センターをカスタマイズする
Brazeはユーザー設定センターからのサブスクリプション状態の更新を管理し、ユーザー設定センターを同期した状態に保ちます。ただし、以下のオプションでサブスクリプショングループAPIを使用して、独自のユーザー設定センターを作成・ホストすることもできます。
オプション 1: 文字列クエリパラメーターを使用したリンク
URLの本文にクエリ文字列のフィールド値ペアを使用して、ユーザーIDとメールカテゴリをページに渡すことで、ユーザーは配信停止の選択を確認するだけで済みます。このオプションは、ユーザー識別子をハッシュ形式で保存しており、まだサブスクリプションセンターを持っていない場合に適しています。
このオプションでは、各メールカテゴリに固有の配信停止リンクが必要です:
http://mycompany.com/query-string-form-fill?field_id=John&field_category=offers
Liquidフィルターを使用して、送信時にユーザーのexternal IDをハッシュ化することも可能です。これにより、user_idがMD5ハッシュ値に変換されます。例:
1
2
{% assign my_string = ${user_id} | md5 %}
My encoded string is: {{my_string}}
オプション 2: JSON Webトークンによる認証
JSON Webトークンを使用して、通常はユーザー名とパスワードのログインなどの認証レイヤーの背後にあるWebサーバーの一部(アカウント設定など)にユーザーを認証します。
このアプローチでは、URLにクエリ文字列の値ペアを埋め込む必要はありません。これらはJSON Webトークンのペイロードで渡すことができます。例:
1
2
3
4
5
{
"user_id": "1234567890",
"name": "John Doe",
"category": "offers"
}
よくある質問
ユーザー設定センターを作成していないのに、ダッシュボードに「PreferenceCenterBrazeDefault」が表示されるのはなぜですか?
これは、レガシーLiquid ${preference_center_url}が使用されている場合にユーザー設定センターをレンダリングするために使用されます。つまり、${preference_center_url}またはpreference_center.${PreferenceCenterBrazeDefault}を参照するキャンバスステップやテンプレートは機能しません。これは、レガシーLiquidまたは「PreferenceCenterBrazeDefault」をメッセージの一部として含む以前に送信されたメッセージにも適用されます。
新しいメッセージで${preference_center_url}を再度参照すると、「PreferenceCenterBrazeDefault」という名前のユーザー設定センターが再び作成されます。
ユーザー設定センターは複数の言語をサポートしていますか?
いいえ。ただし、カスタムのオプトインおよびオプトアウトページのHTMLを記述する際にLiquidを活用できます。動的リンクを使用して配信停止を管理している場合、これは単一のリンクです。
たとえば、スペイン語を話すユーザーの配信停止率を追跡する場合、別々のCampaignを使用するか、Currentsに関する分析を活用する必要があります(ユーザーが配信停止した時期を確認し、そのユーザーの優先言語を確認するなど)。
別の例として、スペイン語を話すユーザーの配信停止率を追跡する場合、ユーザーの言語がスペイン語であれば配信停止URLに?Spanish=trueのようなクエリパラメーター文字列を追加し、そうでなければ通常の配信停止リンクを使用できます:
1
2
3
4
{% if ${language} == 'spanish' %} "${unsubscribe_url}?spanish=true"
{% else %}
${unsubscribe_url}
{% endif %}
その後、Currentsを通じて、どのユーザーがスペイン語を話し、その配信停止リンクに対するクリックイベントがいくつあったかを特定できます。
送信には配信停止リンクとメールユーザー設定センターの両方が必要ですか?
いいえ。メールCampaignの作成時に「メール本文に配信停止リンクが含まれていません」というメッセージが表示される場合、配信停止リンクがコンテンツブロックに含まれている場合にこの警告が表示されることが想定されています。
デフォルトのブラウザアイコンを更新するにはどうすればよいですか?
デフォルトでは、ブラウザタブ名の横のアイコン(ファビコン)にはBrazeのロゴが使用されます。カスタムファビコンを追加するには、作成または更新のユーザー設定センターAPI呼び出しでlinks-tags属性を介して設定します。Brazeはホストされたページに<link rel="icon" ...>タグを挿入します。
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
{
"name": "MyPreferenceCenter",
"preference_center_title": "Email Preferences",
"preference_center_page_html": "<!doctype html> ...",
"confirmation_page_html": "<!doctype html> ...",
"state": "active",
"options": {
"links-tags": [
{
"rel": "icon",
"type": "image/png",
"sizes": "32x32",
"href": "https://yourcdn.com/path/to/favicon-32x32.png"
},
{
"rel": "shortcut icon",
"type": "image/x-icon",
"href": "https://yourcdn.com/path/to/favicon.ico"
},
{
"rel": "apple-touch-icon",
"sizes": "180x180",
"href": "https://yourcdn.com/path/to/apple-touch-icon.png"
}
]
}
}