概要
イベントに名前を付ける際は、追跡の実装全体で一貫性と明確さを確保するために、いくつかの規則に従うと効果的です。明確で直感的なイベント名は、共同作業を行う場合や後でイベントデータを分析する場合に、追跡対象のイベントの目的を効果的に伝えるのに役立ちます。人間が読みやすいイベント名を使用することで、イベントが一目で理解でき、追加の説明や解読が不要になります。ベストプラクティス
検討すべきイベントの命名規則は以下のとおりです。- 明確で説明的な名前を使用する：追跡対象のユーザーアクションを正確に表すイベント名を選択します。過度に技術的または曖昧にならず、何が起きたかを簡潔に伝える名前にしてください。
- 一貫性を保つ：イベントの命名規則を定め、追跡の実装全体でその規則を守ります。
- 小文字とアンダースコアまたはダッシュを使用する：ほとんどのオペレーティングシステムは大文字と小文字を区別します。読みやすさのため、イベント名には常に小文字を使用し、複数の単語はアンダースコア（_）またはダッシュ（-）で区切ります。例：“video_playback_started” や “checkout_completed”。
- アクションベースのイベントには動詞を使用する：アクションを示すために、イベント名を動詞で始めます。例：“user_signed_in”、“item_added_to_cart”、“form_submitted”。
- 関連するオブジェクトやコンテキストの情報を含める：イベントに特定のオブジェクトやコンテキストが関係する場合は、それをイベント名に含めます。例：“product_purchased” や “article_shared”。
- 略語や頭字語の使用を避ける：略語は文字数を節約できますが、混乱を招く可能性もあります。一般的には、すべてのチームメンバーが容易に理解できる完全な単語を使用するほうが適切です。
- イベント名を簡潔にする：明確さを保ちながら、イベント名をできるだけ短くするようにします。長いイベント名は扱いにくく、作業が難しくなる場合があります。
推奨事項
- イベント名は最低 5 文字にすることをお勧めします。
- 非 ASCII 文字はエスケープする必要があります。
- ユーザー属性やイベント属性を “moe” で始めないでください。MoEngage は “moe” で始まるイベント名を追跡しない場合があります。
例：- moe_addtocart
- addToCart
- AddToCart
- Add_to_cart
- Add-to-Cart
- 一貫性を保つため、可能な限りモバイルアプリとウェブサイトで同じ名前を使用してください。
- 類似したイベントは共通のプレフィックスでグループ化します。例：“booking_initiated”、“booking-dates-selected”、“BookingRoomSelected”、“Booking_completed”。
- 単語の間にはスペースではなく、アンダースコアまたはハイフンを使用します。スペースを含む属性は読み取れず、ユースケースが失敗する原因となる場合があります。
- すべてのユーザーアクションをイベントとして作成すると、多数のイベントの中から意味のある答えを見つけにくくなります。具体的なイベントよりも、より一般的なイベントを使用してください。たとえば、“video_start”、“video_pause”、“video_end” のような 3 つの個別のイベントではなく、“Duration” をプロパティ値として持つ “video_watched” イベントを使用します。
- 画面の読み込みや終了、ボタンのクリック、フォームの送信をキャプチャしないでください。代わりに、ビジネス目標に沿ったユーザーアクションを記録します。
- ページビューをイベントとして、またはページ URL をイベントプロパティとしてキャプチャしないでください。訪問したページよりも、ユーザーがプロダクトをどのように使用しているかについて、より優れたインサイトを得ることができます。
- オブジェクトデータ型の属性については、オブジェクト属性とオブジェクト内の属性またはキーに異なる名前を付けてください。
使用禁止文字
イベント名には、以下の特殊文字や記号を使用しないでください。- $ ドル記号
- . ドット
- < 左山括弧
- + プラス記号
- % パーセント
- > 右山括弧
- < 左山括弧
- % パーセント
- > 右山括弧
- ! 感嘆符
- ` バッククォート
- & アンパサンド
- * アスタリスク
- # シャープ
- | パイプ
- { 左波括弧
- ? 疑問符
- ” 二重引用符
- = 等号
- } 右波括弧
- / スラッシュ
- : コロン
- 絵文字
- \ バックスラッシュ
- 空白
- @ アットマーク
- ’ 一重引用符
予約キーワード
- MoEngage の標準イベントは通常、‘moe_*eventname’ として追跡されます。*前述のとおり、moe で始まるイベント名は避けてください。
- MoEngage が追跡する標準/派生イベントのリストを参照し、カスタムイベントとの重複を避けてください