For AI agents: a documentation index is available at /docs/llms.txt. Append .md to any page URL for markdown, or send Accept: text/markdown.
イベントとプロパティの説明
イベントやプロパティの説明を追加または編集することで、組織の他のメンバーがイベントやプロパティが何を表しているかを理解できるようになります。
これは、トラッキングプランに含まれるアクティブなイベントとプロパティにのみ適用されます。 また、カスタムイベントには適用されません。
イベントに説明を追加する
イベントに説明を追加するには、次の手順に従います。
- イベント に移動し、説明を追加したいイベントの名前をクリックします。
- 表示されるフライアウトで、説明を追加(詳細の下)をクリックします。
- イベントの説明を入力し、適用をクリックします。
イベント プロパティに説明を追加
イベントプロパティの説明を変更するには、2つの方法があります。同じイベントプロパティを複数のイベントタイプに適用できるため、グローバルイベントプロパティと特定のイベントとイベントのプロパティペアについて説明を追加できます。イベントに固有のイベントプロパティの説明が存在しない場合、その説明はデフォルトでグローバルイベントプロパティの説明になります。
- イベント固有のプロパティの説明を変更するには、イベント に移動し、イベント名をクリックして 詳細 パネルを開きます。説明を追加と表示されている場所に説明を入力し、適用をクリックして保存します。
- イベントプロパティのグローバルな説明を変更するには、*[プロパティ]> [イベントプロパティ]*に移動し、イベントプロパティ名をクリックして [詳細] パネルを開きます。説明を追加と表示されている場所に説明を入力し、適用をクリックして保存します。
ユーザーまたはグループのプロパティに説明を追加する
ユーザープロパティまたはグループプロパティの説明を変更するには、[プロパティ]> [ユーザープロパティ] または [プロパティ]> [グループプロパティ] に移動します。プロパティ名をクリックして、詳細パネルを開きます。説明を追加と表示されている場所に説明を入力し、適用をクリックして保存します。
AI が生成した説明
有料プランの場合、Amplitudeはイベント、イベントプロパティ、ユーザープロパティの説明を提案します。提案は詳細パネルの説明領域に表示されます。Amplitudeは提案を説明に自動的に保存するわけではなく、提案に対してアクションを起こすまで既存の説明はすべて表示されたままです。
説明の出所
Amplitudeは、2つの情報源に基づいています。
- アップロードされたファイル: [設定] > [AIコントロール] の下でプロジェクトにアップロードしたファイル (データ辞書やプロダクト仕様など)。Amplitudeはこれらを最も信頼できるソースとみなし、他のすべてよりも優先しています。 詳細については、ファイルのアップロードを参照してください。
- プロジェクトデータ:プロジェクト独自のAmplitudeデータ。イベント名やプロパティ名、既存の説明、プロジェクト全体での使用方法、取り得る値などが含まれます。
Amplitudeは、これらの情報源のいずれかに遡ることができる記述を示唆するだけです。 使用頻度が低く、一致するファイルがないイベントやプロパティには、提案は表示されません。これは、空の説明が曖昧な説明よりも有用であるためです。
プロジェクトにスコープを指定したファイルのみが、そのプロジェクトのイベントとプロパティを記述します。 組織レベルのファイルは、他のAmplitude AI機能をサポートしていますが、イベントやプロパティの説明は提供されません。 ファイルをプロジェクトにアップロードすると、そのプロジェクトの説明は数分以内に更新されます。
データディクショナリをアップロードする
最良の結果を得るには、プロジェクトにデータディクショナリをアップロードしてください。 データディクショナリは、プロジェクトのタクソノミー(イベント、イベントのプロパティ、それぞれの意味など)を説明するドキュメントです。Amplitudeは使用状況データのみから推測できるものよりもこのデータに大きく依存しているため、データディクショナリを持つプロジェクトは、そうでないプロジェクトよりも明らかに優れた提案を得ることができます。
Amplitude はファイルとイベントやプロパティを名前で照合します。 Order Placedのデータディクショナリの行には、そのイベントが記述されています。プロパティの場合、タイプも重要です。 ユーザープロパティを記述する行は、同じ名前のイベントプロパティには適用されません。
提案が表示される場所
提案は2つの場所に表示されます。
- データ内:イベント または プロパティ に移動し、イベントまたはプロパティを選択します。提案は詳細パネルの 説明 フィールドに表示されます。提案は、_イベント_テーブルまたは_プロパティ_テーブルには表示されず、詳細パネルにのみ表示されます。
- チャートのドロップダウン内:チャートのイベントまたはプロパティを選択すると、リストの横にある詳細パネルに提案が表示されます。一部のドロップダウンは読み取り専用です。 その場合、データからの提案を受け入れるか拒否してください。
提案を特定する
提案は手動で書かれた説明とは異なります:
- 提案には点線付きの下線が付いています。 誰かが書いた説明にはそうはいきません。
- 下線付きテキストにカーソルを合わせると、ソースを指定したツールチップが開きます。ソースはアップロードされたファイル(複数のファイルが貢献している場合にはすべてのファイル)またはプロジェクトのAmplitudeデータのみから取得された場合は「Amplitudeチャート、ダッシュボード、およびプロダクトメタデータ」です。
- 外観は、説明フィールドにすでに存在する内容によって異なります。 既存の説明がない場合、提案されたテキストは単独で表示されます。 既存の説明が不完全な場合、Amplitudeはギャップを埋めるテキストを提案し、元の内容を維持し、新しい部分を2番目の段落として追加します。 Amplitudeが完全な置換を提案すると、現在のテキストが削除され、その後に置換が表示されます。
提案を適用する
提案をレビューするには:
- 提案を選択して、提案されたテキストを含むエディタを開きます。
- 次のいずれかの操作を実行します。
- 適用を選択して、テキストをそのまま確定します。
- テキストを編集し、適用を選択して変更を確定します。
- 提案を拒否し、元の説明を保持するには、元に戻す を選択します。
- すべてを現状のままにしておくには、キャンセル を選択します。
提案を受け入れたり拒否したりすると、その提案は表示されなくなります。Amplitudeは、誰かがレビューする前から、検索やその他のAI機能のために提案されたテキストをすでに使用しているため、承認しても有効にするのではなく、確定します。
Amplitudeは、自身が定義するイベントやプロパティ、カスタムイベント、変換に関する提案を生成しません。 イベントプロパティに特定のイベントに対するオーバーライドが含まれている場合、Amplitudeは、そのオーバーライドにまだ説明がない場合にのみ説明を提案します。受け入れると、共有プロパティの説明ではなく、オーバーライドが書き込まれます。
これは役に立ちましたか?