Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soushin/measurer
Measurer: Library for Google Analytics(using measurement protocol)
https://github.com/soushin/measurer
android google-analytics jvm kotlin kotlin-multiplatform kotlin-native measurement-protocol
Last synced: about 2 months ago
JSON representation
Measurer: Library for Google Analytics(using measurement protocol)
- Host: GitHub
- URL: https://github.com/soushin/measurer
- Owner: soushin
- Created: 2019-02-21T02:21:47.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-02-28T08:11:04.000Z (almost 6 years ago)
- Last Synced: 2024-08-02T09:26:56.765Z (5 months ago)
- Topics: android, google-analytics, jvm, kotlin, kotlin-multiplatform, kotlin-native, measurement-protocol
- Language: Kotlin
- Size: 3.34 MB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-kotlin-multiplatform - measurer - Google Analytics(using measurement protocol). (Libraries / Utility)
README
[ ](https://bintray.com/soushin/maven/measurer/_latestVersion)
# Measurer
- Measurer is client library for Google Analytics(using measurement protocol).
- Kotlin Multi-platform support.
## Features
- Supports all measurement protocol parameters.
- Supports all hit types.
- Supports batching of requests.
- This library abstracts the HTTP client. you can implement by any HTTP client(like ktor client, etc).
common sample code
```kotlin
class Sample {
suspend fun track() {
val mp = MeasurementProtocol
.Builder(
trackingId = "UA-12345678-1"
).build()
mp.also { ga ->
ga.pageView("mydemo.com", "/checkout").apply {
clientId = "555"
documentTitle = "Checkout"
productAction = "checkout"
product = Product(index = 1).apply {
sku = "P12345"
name = "Android Warhol T-Shirt"
category = "Apparel"
brand = "Google"
variant = "Black"
price = 1
quantity = 1
}
checkoutStep = 1
checkoutStepOption = "Visa"
}
}.send()
}
}
```
## Todo
- [x] Upload bintray
- [x] Support navite
- [x] Support JS
## Installation
Add the measurer bintray repository to your build.gradle
```groovy
repositories {
maven { url "https://dl.bintray.com/soushin/maven" }
}
```
Depending on your type of Kotlin project add one of these dependencies:
**Common**
```groovy
implementation 'com.github.soushin:measurer:0.0.3'
```
**JVM**
```groovy
implementation 'com.github.soushin:measurer-jvm:0.0.3'
```
**Android**
```groovy
implementation 'com.github.soushin:measurer-android:0.0.3'
```
**iOS**
```groovy
implementation 'com.github.soushin:measurer-ios:0.0.3'
```
**js**
```groovy
implementation 'com.github.soushin:measurer-js:0.0.3'
```
## Usage
- Common module
```kotlin
object GoogleAnalytics {
private val httpClient = SampleHttpClient(SampleHttpClientConfig.httpClient, SampleNapierLogger())
suspend fun pageTracking(tid: String) {
val mp = MeasurementProtocol
.Builder(
trackingId = tid,
httpClient = httpClient
).build()
mp.also { ga ->
ga.pageView("mydemo.com", "/home").apply {
clientId = "555"
documentTitle = "homgepage"
contentGroup = ContentGroup(index = 1).apply {
value = "news/sports"
}
}
ga.pageView("mydemo.com", "/home").apply {
clientId = "555"
documentTitle = "homgepage"
contentGroup = ContentGroup(index = 2).apply {
value = "news/finance"
}
}
}.send()
}
}
```
- Android, Jvm
Call tracking method.
```kotlin
GoogleAnalytics.pageTracking(tid: "UA-12345678-1")
```
- iOS
prepare a proxy at Common module.
```kotlin
fun pageTracking(tid: String) {
NativeScope().launch {
GoogleAnalytics().pageTracking(tid)
}
}
```
Call proxy from ios project.
```swift
MeasurerProxyKt.pageTracking(tid: "UA-12345678-1")
```
## Logger
Sample uses [Napier](https://github.com/AAkira/Napier). If you want to use your logging library, implements Logger.
## Licence
Copyright (C) 2019 soushin
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
## Credit
This library is inspired by [brsanthu/google-analytics-java](https://github.com/brsanthu/google-analytics-java).
Thanks for advice.
[@AAkira](https://github.com/AAkira), [@horita-yuya](https://github.com/horita-yuya)