Skip to content

APIメールユーザー設定センター

ユーザー設定センターを設定すると、ユーザーがメールメッセージングの通知設定を一か所で編集・管理できるようになります。この記事では、APIで生成するユーザー設定センターの構築手順を説明しますが、ドラッグ&ドロップエディターを使用してユーザー設定センターを構築することもできます。

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を取得できます。

ステップ2: メールキャンペーンに含める

メールにユーザー設定センターへのリンクを配置するには、購読解除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タグが有効なリンクに解決されない場合があります。ページが読み込まれた場合でも、設定を保存ボタンは無効になっており、購読変更は保存されません。
  • ドラッグ&ドロップエディターのプレビュータブ: レイアウトとスタイリングをプレビューできますが、エディターからユーザー設定の保存をテストすることはできません。

エンドツーエンドのテスト方法

フルローンチの前にユーザー設定センターのリンクとボタンが正しく動作することを確認するには、以下の手順を実行してください。

  1. ユーザー設定センターのLiquidタグを含むキャンペーンまたはキャンバスのメールステップを作成します。
  2. テストユーザーまたは小規模な内部セグメントのみをターゲットにします。
  3. メッセージを起動し、実際の受信トレイからメールを開きます(テスト送信ではありません)。
  4. ユーザー設定センターのリンクを選択し、購読グループを更新して、設定を保存を選択します。
  5. Brazeダッシュボードでユーザーのプロファイルに変更が反映されていることを確認します。

APIで構築されたユーザー設定センターの代替手段として、ユーザー設定センターURL生成エンドポイントを使用して、テスト送信以外で特定のユーザーの有効なURLを取得できます。

その他のテスト送信の制限事項については、テストメッセージの送信を参照してください。

プレビュー、テスト送信、ライブ送信

方法 レイアウトのプレビュー 購読変更の保存
ドラッグ&ドロップエディターのプレビュータブ 不可
キャンペーンまたはキャンバスのテスト送信 部分的(メールは届きます) 不可
テストユーザーまたはセグメントへのライブ送信
ユーザー設定センターURL生成 API

ユーザー設定センターを編集する

ユーザー設定センター更新エンドポイントを使用して、ユーザー設定センターを編集・更新できます。

ユーザー設定センターと詳細を確認する

ユーザー設定センターを確認するには、ユーザー設定センター詳細表示エンドポイントを使用して、最終更新タイムスタンプやユーザー設定センターIDなどの関連情報を返します。

ユーザー設定センターをカスタマイズする

Brazeはユーザー設定センターからの購読状態の更新を管理し、ユーザー設定センターを同期した状態に保ちます。ただし、以下のオプションで購読グループAPIを使用して、独自のユーザー設定センターを作成・ホストすることもできます。

URLの本文にクエリ文字列のフィールド値ペアを使用して、ユーザーIDとメールカテゴリをページに渡すことで、ユーザーは購読解除の選択を確認するだけで済みます。このオプションは、ユーザー識別子をハッシュ形式で保存しており、まだ購読センターを持っていない場合に適しています。

このオプションでは、各メールカテゴリに固有の購読解除リンクが必要です:
http://mycompany.com/query-string-form-fill?field_id=Alex&field_category=offers

オプション2: JSON Webトークンによる認証

JSON Webトークンを使用して、通常はユーザー名とパスワードのログインなどの認証レイヤーの背後にあるWebサーバーの一部(アカウント設定など)にユーザーを認証します。

このアプローチでは、URLにクエリ文字列の値ペアを埋め込む必要はありません。これらはJSON Webトークンのペイロードで渡すことができます。例:

1
2
3
4
5
{
    "user_id": "1234567890",
    "name": "Alex Smith",
    "category": "offers"
}

よくある質問

テスト送信でユーザー設定センターが機能しないのはなぜですか?

ユーザー設定センターのリンクにはライブ送信コンテキストが必要です。テスト送信では有効なユーザー設定センターURLは生成されず、ページが読み込まれた場合にSave Preferencesボタンは無効になります。これは想定された動作です。エンドツーエンドのテストを行うには、テストユーザーまたは小規模な内部セグメントに対してキャンペーンまたはキャンバスステップを起動するか、ユーザー設定センターURL生成エンドポイントを使用してください。詳細については、ユーザー設定センターのテストを参照してください。

ユーザー設定センターを作成していないのに、ダッシュボードに「PreferenceCenterBrazeDefault」が表示されるのはなぜですか?

これは、レガシーLiquid ${preference_center_url}が使用されている場合にユーザー設定センターをレンダリングするために使用されます。つまり、${preference_center_url}またはpreference_center.${PreferenceCenterBrazeDefault}を参照するキャンバスステップやテンプレートは機能しません。これは、レガシーLiquidまたは「PreferenceCenterBrazeDefault」をメッセージの一部として含む以前に送信されたメッセージにも適用されます。

新しいメッセージで${preference_center_url}を再度参照すると、「PreferenceCenterBrazeDefault」という名前のユーザー設定センターが再び作成されます。

ユーザー設定センターは複数の言語をサポートしていますか?

いいえ。ただし、カスタムのオプトインおよびオプトアウトページのHTMLを記述する際にLiquidを活用できます。ダイナミックなリンクを使用して購読解除を管理している場合、これは単一のリンクです。

たとえば、スペイン語を話すユーザーの購読解除率を追跡する場合、別々のキャンペーンを使用するか、Currentsに関する分析を活用する必要があります(ユーザーが購読解除した時期を確認し、そのユーザーの優先言語を確認するなど)。

別の例として、スペイン語を話すユーザーの購読解除率を追跡する場合、ユーザーの言語がスペイン語であれば購読解除URLに?Spanish=trueのようなクエリパラメーター文字列を追加し、そうでなければ通常の購読解除リンクを使用できます:

1
2
3
4
{% if ${language} == 'spanish' %} "${unsubscribe_url}?spanish=true"
{% else %}
${unsubscribe_url}
{% endif %}

その後、Currentsを通じて、どのユーザーがスペイン語を話し、その購読解除リンクに対するクリックイベントがいくつあったかを特定できます。

いいえ。メールキャンペーンの作成時に「メール本文に購読解除リンクが含まれていません」というメッセージが表示される場合、購読解除リンクがコンテンツブロックに含まれている場合にこの警告が表示されることが想定されています。

デフォルトのブラウザアイコンを更新するにはどうすればよいですか?

デフォルトでは、ブラウザタブ名の横のアイコン(ファビコン)には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"
      }
    ]
  }
}
New Stuff!