イベント名の付け方

Overview

イベントの命名に関しては、一貫性と明確さを確保するために、いくつかの規則に従うことが有益です。明確で直感的なイベント名は、共同作業を行ったり、後でイベントデータを分析したりする際に、追跡されているイベントの目的を効果的に伝えるのに役立ちます。人間が読みやすいイベント名を使用することで、イベントが自己説明的であり、追加の説明や解読を必要としないことを保証できます。

ベストプラクティス

イベント名の付け方に関する考慮事項は以下の通りです：

明確で説明的な名前を使用する : ユーザーが追跡しているアクションを正確に説明するイベント名を選択してください。名前が何が起こったかを簡潔に伝え、技術的すぎたりあいまいであったりしないことを確認してください。
一貫性を持つ : イベントの命名規則を設定し、それを追跡の実装全体で遵守します。
小文字とアンダースコアまたはダッシュを使用してください : ほとんどのオペレーティングシステムは大文字と小文字を区別します。イベント名には常に小文字を使用し、可読性を向上させるために複数の単語をアンダースコア(_)またはダッシュ(-)で区切ってください。例えば、「video_playback_started」や「checkout_completed」。
アクションベースのイベントには動詞を使用する : アクションを示すためにイベント名を動詞で始めます。例えば、「user_signed_in」、「item_added_to_cart」、または「form_submitted」。
関連するオブジェクトまたはコンテキスト情報を含める : イベントが特定のオブジェクトまたはコンテキストを含む場合は、それをイベント名に含めてください。例えば、「product_purchased」や「article_shared」。
略語や頭字語の使用を避ける : 略語は文字数を節約するかもしれませんが、混乱を招く可能性もあります。一般的に、すべてのチームメンバーが理解しやすい完全な単語を使用する方が良いです。
イベント名は簡潔に保つ : 明確さを保ちながら、イベント名はできるだけ短くするようにしてください。長いイベント名は扱いにくく、作業が難しくなることがあります。

上記の規則をあなたの特定のニーズや要件に合わせて調整できます。重要なのは、チームの理解に合致し、イベントデータの解釈を容易にする慣例を選択することです。

推奨事項

イベントには 5 文字以上の名前を付けることをお勧めします。

ユーザー/イベントプロパティの値は 512 文字に制限されています。
非ASCII文字はエスケープする必要があります。
ユーザーまたはイベント属性を「moe」で始めないでください。MoEngageは「moe」で始まるイベント名を追跡しない場合があります。
例 :
- moe_addtocart
- カートに追加
- カートに追加
- カートに追加
- カートに追加
可能な限り、一貫性のためにモバイルアプリとウェブサイトで同じ名前を使用してください。
共通のプレフィックスを持つ類似のイベントをグループ化します。例えば、「booking_initiated」、「booking-dates-selected」、「BookingRoomSelected」、および「Booking_completed」。
スペースの代わりに単語の間にアンダースコアまたはハイフンを使用してください。スペースで埋められた属性は読み取ることができず、あなたのユースケースが失敗する原因となる可能性があります。
すべてのユーザーアクションをイベントとして作成すると、イベントのプールの中で意味のある回答を見つけるのが難しくなります。より具体的なものではなく、より一般的なイベントを採用してください。例えば、「video_start」、「video_pause」、および「video_end」といった3つの個別のイベントの代わりに、「Duration」をプロパティ値として持つ「video_watched」イベントを使用します。
画面の読み込みやアンロード、ボタンのクリック、フォームの送信をキャプチャしないでください。代わりに、ビジネス目標に沿ったユーザーアクションを記録してください。
ページビューをイベントとしてキャプチャしたり、ページURLをイベントプロパティとしてキャプチャしないでください。人々があなたの製品をどのように使用しているかについて、訪問するページよりも良い洞察を得ることができます。
オブジェクトデータ型の属性については、オブジェクト属性とオブジェクト内の属性またはキーに異なる名前を維持してください。

禁止された文字

イベント名には以下の特殊文字や記号を使用しないでください：

$ ドル記号
。ドット
< left angle bracket
+ プラス記号
% パーセント
右角括弧
< left angle bracket
+ プラス記号
% パーセント
右角括弧
！感嘆符
` backtick`
& アンパサンド
* アスタリスク
# ポンド
| パイプ
{
？疑問符
"ダブルクオーテーション"
= 等号
} 右中括弧
/ スラッシュ
コロン
emojis
\\ バックスラッシュ
空白スペース
@
' シングルクォート '

このリストは、イベントの名前付けにおいて一般的なエラーを避けるのに役立つことを目的としています。ご質問がある場合は、サポートチームにお問い合わせください。

予約済みのキーワード

MoEngageの標準イベントは通常「moe_ eventname 」として追跡されます。前述のように、イベント名の先頭に「moe.」を付けることは避けてください。
MoEngageによって追跡される標準/派生イベントのリストを参照し、カスタムイベントでの重複を避けてください。