アラートのベストプラクティス

このドキュメントには、Braze ドキュメントで使用されるアラートタイプに関する情報、一般的なガイドライン、および例が含まれています。

アラートタイプ

アラートは、読者が認識すべき情報を分類します。ドキュメントで使用できるアラートタイプは4種類あります。

• 重要
• 注記
• ヒント
• 警告

アラートを使用するタイミング

アラートは、重要な情報に読者の注意を引くために使用します。コンテンツは短く要点を押さえたものにしてください。読者の記憶に残る情報にすることが大切です。

各アラートの定義については、以下の表を参照してください。

アラートタイプ	定義
重要	読者が対処すべき必須情報を含みます。例: 非推奨の機能 請求への影響 関連する更新に関する情報 緊急性の高い機能の注意事項（例: ベータ機能） その他の重要な情報
注記	読者が知っておくべき一回限りの情報を含みます。例: 機能の注意事項 フォーマットに関するガイダンス 役立つ補足情報 アラートの内容の重要度が下がったため、重要アラートから降格された情報（例: 長期間掲載されていた重要アラートが標準の注記に変更される場合）
ヒント	読者が認識しておくべき補足的な知識や推奨事項を含みます。例: 追加のトラブルシューティング記事 使いやすさを向上させるステップやショートカット（例: アプリ内メッセージの追加カスタマイズ）
警告	読者が必ず対処すべき必須情報を含みます。以下のような内容が該当します: 不可逆的な結果（例: キャンペーンやキャンバスの削除） 機能を破壊する動作 データの損失 その他の重大な警告

アラートのベストプラクティス
以下は、アラートに関する一般的なガイドラインとベストプラクティスです。

一般的な原則として、記事の構造に不可欠なコンテンツ（機能の紹介、セットアップ手順、機能の使用手順など）にアラートを使用することは避けてください。判断に迷う場合は、ピアレビュー時にチームに相談してください。

ガイドライン	例
アラート内の情報を明確で簡潔な文で説明します。	note: Braze は、ユーザーが初めてアプリを使用するまでプロファイルを生成しないため、アプリをまだ開封していないユーザーをターゲットにすることはできません。 ステップ4: セグメントにフィルターを追加するセクションの注記アラート
同じ記事の異なるセクションに適用されるアラートの場合、繰り返しのコンテンツを避けるために、これらの詳細をまとめた新しいセクションの作成を検討してください。	dispatch_id 特定のメッセージ配信（キャンペーン送信など）の識別子である。同じディスパッチから発生するすべてのプッシュイベントは、同じものを含む。 dispatch_id.使う dispatch_id 同じ配信に属するイベントをグループ化することで、その配信におけるプッシュメッセージのライフサイクル（送信、バウンス、開封など）をまとめて関連付けられる。 state_change_source 完全なソース名の文字列を返す。例えば、ソースCSVのインポートは文字列を返す。 CSV import.利用可能なソースを以下に示します。 ソース 説明 SDK SDKエンドポイントs ダッシュボード ダッシュボードのユーザープロファイルのページからユーザーのサブスクリプションの状態が更新された場合 サブスクリプションページ ユーザー設定センター以外のメールを介してユーザー 配信停止が発生した場合 REST API REST APIエンドポイント CSV インポート CSVユーザーインポート 環境設定センター ユーザー設定センターからユーザーを更新した場合 受信メッセージ ユーザーが更新の場合、エンドユーザーsからSMSなどのチャネルsを経由した着信メッセージ 移行 ユーザーが内部移行または保守スクリプトによって更新されている場合 ユーザーマージ ユーザー結合処理で更新した場合 Canvas ユーザー更新ステップ キャンバスユーザー更新ステップによってユーザーが更新された場合 メッセージエンゲージメントイベントのプロパティ詳細
アラート内の情報を短い段落やリストに分けます。	important: 法的に要求されるトランザクションメールを SMS ゲートウェイに送信しないでください。これらのメールは配信されない可能性が高いためです。 電話番号とプロバイダーのゲートウェイドメイン（MM3 として知られている）を使用して送信したメールは、SMS（テキスト）メッセージとして受信される可能性がありますが、一部のメールプロバイダーはこの動作をサポートしていません。例えば、T-Mobile の電話番号（「[email protected]」など）にメールを送信した場合、SMS メッセージは T-Mobile ネットワークでその電話番号を所有している人に送信されます。 これらのメールが SMS ゲートウェイに配信されなくても、メール課金にはカウントされることにご注意ください。サポートされていないゲートウェイへのメール送信を避けるには、サポートされていないゲートウェイのドメイン名のリストを確認してください。 メールリストのインポートの重要アラート
アラートの表示に影響を与える可能性のある追加のフォーマット（コードスニペット、ステップ、周囲の画像など）を考慮してください。	tip: カタログのトリガーアイテム用に画像を読み込むには、カタログにという名前のフィールドが含まれているimage_url必要がある。その後、. を使って参照できる{{ items[0].image_url }}。 値下げ通知のコードスニペット付きヒントアラート
記事の冒頭にあるアラートには改行を含めます。	コンテンツカード実装ガイド
ベータ機能について記述する場合、ベータステータスと関連する Braze の連絡先情報を示す重要アラートを含めます。このベータアラートは、概要テキストの後、最初のメイン見出しの前に配置してください。
可能な限り、2つ以上のアラートを連続して使用することは避けてください。代わりに、情報を再構成するか、テキストの一部として含めてください。
アラートが長くなる場合は、情報をリストとして含む新しいセクションの作成を検討してください。例えば、トラブルシューティングの手順をアラートに含める代わりに、トラブルシューティングセクションを作成するか、関連記事へのリンクを提供することを検討してください。

アラートの例

各アラートタイプがドキュメントでどのように、なぜ使用されるかについては、以下の例を参照してください。

重要アラート

• 記事: Web プッシュ
• ユースケース: Web プッシュのセットアップ時に読者が知っておくべき重要な機能の注意事項を含みます。
• アラートの理由: 注記アラートではなく重要アラートを使用します。これは、Web プッシュのセットアップ時に読者が知っておくべき内容の重要度がより高いためです。

• 記事: メール設定
• ユースケース:
  • 請求対象メールが倍増する可能性に関する重要な機能の注意事項を提供します
  • 必要に応じてカスタマーサクセスマネージャーに連絡するよう読者を誘導します
• アラートの理由: ここでは、メール設定の BCC アドレスに関する詳細を伝えるために重要アラートを使用しています。この情報は、警告アラートではなく重要アラートとして提示するのが最適です。なぜなら、この情報を省略しても機能に不可逆的な影響（機能の破壊、永続的なデータ損失など）を与えないためです。

• 記事: 高度なキャンペーン設定
• ユースケース: 通知の優先度に関する緊急性の高い機能の注意事項を含みます。読者を新しい情報にリダイレクトします。
• アラートの理由: ここでは、読者を最新の情報にリダイレクトし、そのセクションが特定のユーザーにのみ適用されることを強調するために、重要アラートが最適です。また、セクションヘッダーの後に配置されているため、読者はセクションの残りを読む前に重要アラートに対処する必要があります。

注記アラート

• 記事: コンテンツカードの作成
• ユースケース: コンテンツカードについて詳しく学ぶ際に、読者が認識しておくべき追加情報を含みます。
• アラートの理由: この注記アラートは、Braze がユーザーの古いコンテンツカードをどのように循環させるかについてのバックグラウンド情報を提供します。これは読者にとって有用な補足情報であり、重要アラートやヒントアラートを使用する必要はありません。

• 記事: カスタム属性
• ユースケース: 読者が認識しておくべき一般的な情報を含みます。関連コンテンツ（時間属性）について詳しく学ぶための記事を提供します。
• アラートの理由: この情報は、重要アラートではなく注記アラートを使用して伝えるのが最適です。コンテンツの目的は一般的な情報を提供することであり、この情報を無視しても機能の使いやすさに影響しないためです。

• 記事: カスタムデータの管理
• ユースケース: 読者が認識しておくべき一般的な情報を含みます。詳細については Braze の連絡先にリダイレクトします。
• アラートの理由: この注記アラートは、カスタム属性を管理する際に読者が知っておくと役立つデータストレージに関する追加情報を提供します。ただし、コンテンツは読者にとってより強い重要度の表示を必要としないため、注記アラートがここでは適切です。

ヒントアラート

• 記事: SMS および RCS 請求計算ツール
• ユースケース: メッセージの長さと SMS セグメント数を理解するためのツールを読者に提供します。コピーの制限に関する理解に役立つ情報を提供します。
• アラートの理由: これは長めのヒントアラートです。コピーを入力してメッセージが何セグメントで送信されるかを確認するためのスペースを提供するためです。ヒントアラートがここでは最適な選択肢です。SMS メッセージのセットアッププロセスで読者が使用できる便利なジェネレーターだからです。

• 記事: 日付別の日次アプリアンインストール KPI のエクスポート
• ユースケース: このエンドポイントを使用する際のトラブルシューティングのアドバイスを提供します。
• アラートの理由: ヒントアラートは読者に追加のサポートを提供します。注記アラートではなくヒントアラートを使用します。コンテンツの焦点がトラブルシューティング記事を提供して読者を支援することにあるためです。

警告アラート

• 記事: ユーザープロファイルのライフサイクル
• ユースケース: Braze でユーザープロファイルを作成する際に読者がすべきでないことを示します。
• アラートの理由: 警告アラートは、ユーザーを一意に識別する前に external_id を割り当てることに対して読者に注意を促すために使用されます。この情報は、重要アラートではなく警告アラートを使用して伝えるのが最適です。ユーザープロファイルに不可逆的な結果をもたらすためです。

• 記事: Segment for Currents
• ユースケース: Currents コネクターを作成する際に読者に注意を促します。これらのコネクターを誤って作成した場合の結果を含みます。
• アラートの理由: ここでは、Braze Segment Currents 統合の制限を説明するために警告アラートが最適です。重要アラートではなく警告アラートを使用します。同じ Currents コネクターを誤って複数作成すると、データが失われる可能性があるためです。

• 記事: キャンバスの作成
• ユースケース: 機能が正しく動作しない可能性のある情報をリストします。対象オーディエンスがキャンペーンを受信しなかったり、キャンバスに入らなかったりする可能性について詳述します。
• アラートの理由: ここでは、機能が正しく動作しない可能性があることを示すために警告アラートを使用しています。この情報は、重要アラートではなく警告アラートを使用して伝えるのが最適です。情報が重大であり、キャンバスの配信を破壊する可能性があるためです。