イベント名の付け方、ネーミングについてどうしようかいちいち悩むのが面倒なので色々調べてみました。
Googleの公式記事やその他プロダクト分析ツールの記事などを読むと、大体おさえるべきポイントが分かったのでこの記事にまとめます。
なお、当社はすべてのサービスにおいてこの規則にのっとってイベント名を決めています。
この記事では、イベント命名におけるベストプラクティスと、それを避けるべき一般的な間違いについて解説します。
イベントのネーミングにお悩みの方のお役に立つと思います。
【目次】
イベント名はこうすべき
アルファベットの小文字とアンダーバーを使うべき
- OK(推奨する形式): 例えば
event_name_like_thisのように、全て小文字でアンダーバーを使います。 - NG(避けるべき命名):
eventName,FormSubmit,BUTTON_CLICKなどのキャメルケースや大文字の使用は避けましょう。
動詞の使い方
- OK(推奨する形式): 動詞は現在形で表現し、「data_send」や「content_remove」といった形で利用します。
- NG(避けるべき命名): 受動態や過去形など、「data_sent」や「content_removed」のような形式は避けましょう。
目的語の位置は最初に
- OK(推奨する形式): 目的語を最初に記述し、その後に動詞を置くことで直感的な理解を促します。
例:
article_video_start,contact_button_click。 - NG(避けるべき命名):
start_video,click_buttonのように動詞を先にする命名法は避けましょう。
カテゴリの表現
- OK(推奨する形式): カテゴリはコロン
:を使って表現します。 例:settings:name_change,payment:plan_upgrade。