{"id":13428879,"url":"https://github.com/programmerr47/ganalytics","last_synced_at":"2025-03-16T02:30:41.707Z","repository":{"id":145536094,"uuid":"86938780","full_name":"programmerr47/ganalytics","owner":"programmerr47","description":"Analytics library preferably sharpened for Google Analytics","archived":false,"fork":false,"pushed_at":"2017-09-23T08:51:39.000Z","size":239,"stargazers_count":11,"open_issues_count":5,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-10-27T06:39:22.047Z","etag":null,"topics":["analytics","analytics-api","analytics-tracking","annotations","google-analytics"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/programmerr47.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-04-01T19:53:29.000Z","updated_at":"2022-10-03T16:43:40.000Z","dependencies_parsed_at":null,"dependency_job_id":"897c0406-aff8-4f8b-8844-6e28737dcf5d","html_url":"https://github.com/programmerr47/ganalytics","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerr47%2Fganalytics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerr47%2Fganalytics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerr47%2Fganalytics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/programmerr47%2Fganalytics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/programmerr47","download_url":"https://codeload.github.com/programmerr47/ganalytics/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243815605,"owners_count":20352195,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","analytics-api","analytics-tracking","annotations","google-analytics"],"created_at":"2024-07-31T01:01:07.628Z","updated_at":"2025-03-16T02:30:41.676Z","avatar_url":"https://github.com/programmerr47.png","language":"Kotlin","readme":"# Overview\n[ ![Download](https://api.bintray.com/packages/programmerr47/maven/ganalytics-core/images/download.svg) ](https://bintray.com/programmerr47/maven/ganalytics-core/_latestVersion)\n\n\nGanalytics is tiny api layer for any analytics in application. It provides an object oriented, typesafe, strict and testable way to organize work with analytics in the application. More information on [wiki pages](https://github.com/programmerr47/ganalytics/wiki).\n\nHere is [latest changelog](https://github.com/programmerr47/ganalytics/releases/tag/v1.1).\n\nAlso, you can read these articles for more details:\n1) [Introduction to conception](https://medium.com/@programmerr47/declarative-analytics-ganalytics-4cb927b98be8)\n2) [V1.1 Changelog details](https://medium.com/@programmerr47/effective-application-analytic-832f950232b9)\n\n# Get library\nWith gradle:\n```\ncompile 'com.github.programmerr47:ganalytics-core:1.1.0'\n```\n\nWith maven:\n```\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.github.programmerr47\u003c/groupId\u003e\n  \u003cartifactId\u003eganalytics-core\u003c/artifactId\u003e\n  \u003cversion\u003e1.1.0\u003c/version\u003e\n  \u003ctype\u003epom\u003c/type\u003e\n\u003c/dependency\u003e\n```\n\n# Basic Usage\nTo start with gathering analytics:\n1. Create an group or category interface and fill it with necessary annotations:\n```kotlin\n@Prefix\ninterface CategoryInterface {\n    fun action()\n    @NoPrefix fun otherAction(@Label(LabelConverter::class) String label)\n}\n```\nor\n```kotlin\ninterface GroupInterface {\n    @Prefix fun category(): CategoryInterface\n    @Convention(NamingConventions.LOWER_CAMEL_CASE) fun otherCategory(): OtherCategoryInterface\n}\n```\nFor more information about [interfaces](https://github.com/programmerr47/ganalytics/wiki/Interfaces) and [annotations](https://github.com/programmerr47/ganalytics/wiki/Annotations) read linked sections.\n\n2. Prepare `Ganalytics` instance through:\n\n_For group interfaces:_\n```kotlin\nval ganalytics = Ganalytics({ System.out.println(it) /**or do something with received incoming events**/ }) {\n     cutOffAnalyticsClassPrefix = false\n     prefixSplitter = \"_\"\n     namingConvention = NamingConventions.LOWER_SNAKE_CASE\n     labelTypeConverters += TypeConverterPair\u003cDummyDataClass\u003e { it.name } +\n             TypeConverterPair\u003cDummyReversedClass\u003e { it.id.toString() } \n}\n```\nwich is equal to:\n```kotlin\nval ganalytics = GanalyticsSettings {\n    cutOffAnalyticsClassPrefix = false\n    prefixSplitter = \"_\"\n    namingConvention = NamingConventions.LOWER_SNAKE_CASE\n    labelTypeConverters += TypeConverterPair\u003cDummyDataClass\u003e { it.name } +\n            TypeConverterPair\u003cDummyReversedClass\u003e { it.id.toString() }\n}.createGroup { System.out.println(it) /**or do something with received incoming events**/ }\n```\n\n_For category interfaces:_\n```kotlin\nval ganalytics = GanalyticsSettings {\n    cutOffAnalyticsClassPrefix = false\n    prefixSplitter = \"_\"\n    namingConvention = NamingConventions.LOWER_SNAKE_CASE\n    labelTypeConverters += TypeConverterPair\u003cDummyDataClass\u003e { it.name } +\n            TypeConverterPair\u003cDummyReversedClass\u003e { it.id.toString() }\n}.createSingle { System.out.println(it) /** or do something with received incoming events**/ }\n```\n\n3. Pass an interface class to `ganalytics`: \n\n`val analytics = ganalytics.create(GroupInterface::class)`\n\n4. Now you can use `analytics`. For example:\n\n`analytics.category().otherAction(\"label\")`\n\nwill print to the standart output: `Event(category=sampleinterface, action=sampleinterface_method1)`\n\n**Note:** instead of `System.out.println` you can pass, for example:\n\n```kotlin \ngoogleAnalyticsTracker.send(HitBuilders.EventBuilder()\n        .setCategory(it.category)\n        .setAction(it.action)\n        .setLabel(it.label)\n        .setValue(it.value)\n        .build())\n```\n\nOr any analytics method as you want.\n\nFor more info of basic usage see samples folder in project.\nAlso please visit [the wiki pages](https://github.com/programmerr47/ganalytics/wiki) to know more details.\n","funding_links":[],"categories":["Libraries"],"sub_categories":["Analytics"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogrammerr47%2Fganalytics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprogrammerr47%2Fganalytics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprogrammerr47%2Fganalytics/lists"}