Merge pull request #23 from tfandkusu/fix_markdown

ドキュメント作成を少し修正

.gitignore

@@ -38,5 +38,7 @@ bin/
 ### Mac OS ###
 .DS_Store
 
+local.properties
+
 ga913-android
 ga913-ios

README.md

@@ -1,3 +1,8 @@
 # 【WIP】DroidKaigi 2024「 データに基づく意思決定を支える、Google Analytics for Firebase のイベント送信」の Analytics イベント定義リポジトリ実装例
 
 同一仕様の [iOS アプリ](https://github.com/tfandkusu/ga913-ios)と [Android アプリ](https://github.com/tfandkusu/ga913-android)に対して Analytics イベントを定義したクラスをコード生成するリポジトリです。
+
+## イベント仕様書
+
+- [画面遷移イベント](https://github.com/tfandkusu/ga913-yaml/blob/main/screens.md)
+- [画面内操作イベント](https://github.com/tfandkusu/ga913-yaml/blob/main/actions.md)

actions.md

@@ -1,21 +1,21 @@
-# 画面内イベント一覧
+# 画面内操作イベント一覧
 
 # ランドマーク一覧画面
 
-| イベント名 | Analytics イベント名 | パラメータ | コンバージョンイベント |
+| 操作内容 | Analytics イベント名 | パラメータ | コンバージョンイベント |
 | -- | -- | -- | -- |
-| いいねを付けたランドマークのみを表示するスイッチ | LandmarkListFavoritesOnlySwitch | スイッチの ON/OFF favorites_only: Boolean<br> |  |
+| いいねを付けたランドマークのみを表示するスイッチ | LandmarkListFavoritesOnlySwitch | スイッチの ON/OFF favorites_only: Int<br> |  |
 
 # ランドマーク詳細画面
 
-| イベント名 | Analytics イベント名 | パラメータ | コンバージョンイベント |
+| 操作内容 | Analytics イベント名 | パラメータ | コンバージョンイベント |
 | -- | -- | -- | -- |
-| いいねを付ける | LandmarkDetailFavoriteOn | ランドマークの ID id: Long<br>ランドマークの名前 name: String<br> | ○ |
-| いいねを解除する | LandmarkDetailFavoriteOff | ランドマークの ID id: Long<br>ランドマークの名前 name: String<br> |  |
+| いいねを付ける | LandmarkDetailFavoriteOn | ランドマークの ID id: Int<br>ランドマークの名前 name: String<br> | ○ |
+| いいねを解除する | LandmarkDetailFavoriteOff | ランドマークの ID id: Int<br>ランドマークの名前 name: String<br> |  |
 
 # 情報画面
 
-| イベント名 | Analytics イベント名 | パラメータ | コンバージョンイベント |
+| 操作内容 | Analytics イベント名 | パラメータ | コンバージョンイベント |
 | -- | -- | -- | -- |
 | プライバシーポリシーを表示する | InfoPrivacyPolicy |  |  |
 

src/main/kotlin/com/tfandkusu/ga913yaml/MarkdownGenerator.kt

@@ -24,7 +24,7 @@ object MarkdownGenerator {
 
     private fun generateActionsMarkdown(screens: List<Screen>) {
         val builder = StringBuilder()
-        builder.append("# 画面内イベント一覧\n\n")
+        builder.append("# 画面内操作イベント一覧\n\n")
         for (screen in screens) {
             if (screen.actions.isNotEmpty()) {
                 builder.append("# ${screen.description}\n\n")
@@ -37,7 +37,7 @@ object MarkdownGenerator {
 
     private fun generateActionsMarkdown(screen: Screen): String {
         val builder = StringBuilder()
-        builder.append("| イベント名 | Analytics イベント名 | パラメータ | コンバージョンイベント |\n")
+        builder.append("| 操作内容 | Analytics イベント名 | パラメータ | コンバージョンイベント |\n")
         builder.append("| -- | -- | -- | -- |\n")
         for (action in screen.actions) {
             builder.append(
@@ -70,9 +70,9 @@ object MarkdownGenerator {
         when (this) {
             ParameterType.STRING -> "String"
             ParameterType.INT -> "Int"
-            ParameterType.LONG -> "Long"
+            ParameterType.LONG -> "Int" // BigQuery には Long はない
             ParameterType.FLOAT -> "Float"
             ParameterType.DOUBLE -> "Double"
-            ParameterType.BOOLEAN -> "Boolean"
+            ParameterType.BOOLEAN -> "Int" // BigQuery には Boolean はない
         }
 }