From 2fbd2aaca3a218939cd9147391b51b02ae8d3ff6 Mon Sep 17 00:00:00 2001 From: Dariusz Konieczko <148064035+dariusz-survicate@users.noreply.github.com> Date: Tue, 24 Oct 2023 15:23:11 +0200 Subject: [PATCH 1/5] Update index.md --- .../mobile/kotlin-android/destination-plugins/index.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/index.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/index.md index 06e33baf90..7c62186f06 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/index.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/index.md @@ -69,6 +69,12 @@ plugins: url: https://cdn.filepicker.io/api/file/fb5lNYEhQoWnABOjynZ6 mark: url: https://cdn.filepicker.io/api/file/kWmScDJ3SvK1QBZTChGQ + - name: Survicate + url: connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android/ + logo: + url: https://cdn.filepicker.io/api/file/BUciQq3kSzqCn8EKMtBN + mark: + url: https://cdn.filepicker.io/api/file/0H2JyPoRT4K3CnBQcHPn - name: Quantcast url: connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/quantcast-kotlin-android/ logo: @@ -139,4 +145,4 @@ To test your destination: Segment recommends you to test your destination implementation end-to-end. Send some sample analytics events and ensure that they reach the destination. > info "" -> For more information about the Analytics Kotlin Plugin architecture and how it can help you customize your tracking implementation to suit your needs, refer to the [Plugin Architecture Guide.](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture) \ No newline at end of file +> For more information about the Analytics Kotlin Plugin architecture and how it can help you customize your tracking implementation to suit your needs, refer to the [Plugin Architecture Guide.](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture) From 8d3da26fc2a32f2699f64b01f248e6c674e85e86 Mon Sep 17 00:00:00 2001 From: Dariusz Konieczko <148064035+dariusz-survicate@users.noreply.github.com> Date: Tue, 24 Oct 2023 15:46:53 +0200 Subject: [PATCH 2/5] Create survicate-kotlin-android.md --- .../survicate-kotlin-android.md | 67 +++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md new file mode 100644 index 0000000000..3d85958753 --- /dev/null +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md @@ -0,0 +1,67 @@ +--- +title: Analytics Kotlin Survicate Plugin +strat: kotlin-android +--- + +[Survicate](https://survicate.com/){:target="_blank"} is an all-in-one customer feedback platform that helps you collect and act on feedback from your customers. It helps you understand your customers and improve their experience with your product or service. + +Add Survicate device mode support to your applications using this plugin for [Analytics-Kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank"}. + +## Getting started + +First you need to provide a Survicate workspace key. + +You can do this in 2 ways: + +1. Add the key in the Segment panel -> Destinations -> Your Android app destination -> Settings. You need to put the key inside the Connection Settings as a "Workspace Key". + +2. Alternatively, you can add your Survicate workspace key as a metadata inside AndroidManifest + + ```xml + + + + + ``` +## Adding the dependency +Add Survicate maven: +``` +allprojects { + repositories { + // ... + maven { url 'https://repo.survicate.com' } + } +} +``` + +## Using the Plugin in your App +In order to activate the Survicate plugin, you have to add a `SurvicateDestination` to the Analytics instance. + +```kotlin +analytics = Analytics(segmentKey, applicationContext) { + // ... +} +analytics.add(SurvicateDestination(applicationContext)) +``` + +Make sure to keep only one instance of the `Analytics` (e.g. initialize it inside Application's onCreate method). This is important, because the Survicate SDK underneath can only be initialized once. + +Now you can use the Analytics as usual, having the events mapped to Survicate SDK as described below. + +_**Identify**_ + +In the SurvicateDestination plugin, the `identify` method from Segment is transferred to the `setUserTraits` method of Survicate. You can provide multiple key-value pairs. The `userId` argument of `Analytics.identify` is also set as a user trait with the key "user_id". + +_**Track**_ + +The `track` method from Segment is used as the `invokeEvent` method in Survicate. This means that when you track an event in Segment, it will be invoked in Survicate. + +_**Screen**_ + +Similarly, the screen method from Segment is used as the `enterScreen` method in Survicate. This means that when you track a screen in Segment, it will be entered in Survicate. + +_**Reset**_ + +The `reset` method from Segment is used as the reset method in Survicate. This means that when you reset the Segment client, the Survicate client will also be reset. From 41a5ad95d047c4f697f96a931891ffe6e55c5881 Mon Sep 17 00:00:00 2001 From: Dariusz Konieczko <148064035+dariusz-survicate@users.noreply.github.com> Date: Fri, 27 Oct 2023 14:27:40 +0200 Subject: [PATCH 3/5] Update survicate-kotlin-android.md --- .../survicate-kotlin-android.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md index 3d85958753..9b05e61357 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md @@ -26,7 +26,7 @@ You can do this in 2 ways: ``` ## Adding the dependency -Add Survicate maven: +Define Maven repository ``` allprojects { repositories { @@ -35,7 +35,17 @@ allprojects { } } ``` - + +Add dependency to your app's build.gradle file +``` +dependencies { + // ... + implementation 'com.survicate:survicate-segment-analytics-kotlin:' +} +``` + +You can find current version in the [plugin repository](https://github.com/Survicate/analytics-kotlin-survicate) + ## Using the Plugin in your App In order to activate the Survicate plugin, you have to add a `SurvicateDestination` to the Analytics instance. From 2109ac555e2dc06e1799d2a8b16b0d6eb622695c Mon Sep 17 00:00:00 2001 From: rchinn-segment Date: Thu, 9 Nov 2023 09:39:09 -0800 Subject: [PATCH 4/5] edits --- .../destination-plugins/index.md | 2 +- .../survicate-kotlin-android.md | 41 ++++++++++--------- 2 files changed, 23 insertions(+), 20 deletions(-) diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/index.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/index.md index 7c62186f06..f587027e40 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/index.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/index.md @@ -145,4 +145,4 @@ To test your destination: Segment recommends you to test your destination implementation end-to-end. Send some sample analytics events and ensure that they reach the destination. > info "" -> For more information about the Analytics Kotlin Plugin architecture and how it can help you customize your tracking implementation to suit your needs, refer to the [Plugin Architecture Guide.](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture) +> For more information about the Analytics Kotlin Plugin architecture and how it can help you customize your tracking implementation to suit your needs, refer to the [Plugin Architecture guide](/docs/connections/sources/catalog/libraries/mobile/kotlin-android/kotlin-android-plugin-architecture). diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md index 9b05e61357..73c208dfad 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md @@ -3,19 +3,19 @@ title: Analytics Kotlin Survicate Plugin strat: kotlin-android --- -[Survicate](https://survicate.com/){:target="_blank"} is an all-in-one customer feedback platform that helps you collect and act on feedback from your customers. It helps you understand your customers and improve their experience with your product or service. +[Survicate](https://survicate.com/){:target="_blank"} is an all-in-one customer feedback platform that helps you collect and act on feedback from your customers. With Survicate, you can better understand your customers and improve their experience with your product or service. -Add Survicate device mode support to your applications using this plugin for [Analytics-Kotlin](https://github.com/segmentio/analytics-kotlin){:target="_blank"}. +Add Survicate device mode support to your applications using [this plugin](https://github.com/segmentio/analytics-kotlin){:target="_blank"} for Analytics-Kotlin. ## Getting started -First you need to provide a Survicate workspace key. +To get started, you need to provide a Survicate workspace key. -You can do this in 2 ways: +You can do this in two ways: -1. Add the key in the Segment panel -> Destinations -> Your Android app destination -> Settings. You need to put the key inside the Connection Settings as a "Workspace Key". +1. Add the key in the Segment panel. Navigate to **Connections > Destinations** and locate your Android app destination. Click **Settings**, then enter the key inside the Connection Settings as a "Workspace Key". -2. Alternatively, you can add your Survicate workspace key as a metadata inside AndroidManifest +2. Alternatively, you can add your Survicate workspace key as metadata inside AndroidManifest: ```xml ``` + ## Adding the dependency -Define Maven repository + +To define the Maven repository: + ``` allprojects { repositories { @@ -36,7 +39,7 @@ allprojects { } ``` -Add dependency to your app's build.gradle file +Add the dependency to your app's build.gradle file: ``` dependencies { // ... @@ -44,7 +47,7 @@ dependencies { } ``` -You can find current version in the [plugin repository](https://github.com/Survicate/analytics-kotlin-survicate) +You can find the current version in the [plugin repository](https://github.com/Survicate/analytics-kotlin-survicate){:target="_blank"}. ## Using the Plugin in your App In order to activate the Survicate plugin, you have to add a `SurvicateDestination` to the Analytics instance. @@ -56,22 +59,22 @@ analytics = Analytics(segmentKey, applicationContext) { analytics.add(SurvicateDestination(applicationContext)) ``` -Make sure to keep only one instance of the `Analytics` (e.g. initialize it inside Application's onCreate method). This is important, because the Survicate SDK underneath can only be initialized once. +Only keep one instance of the `Analytics` (for example, initialize it inside the application's `onCreate` method). This is important because the Survicate SDK underneath can only be initialized once. -Now you can use the Analytics as usual, having the events mapped to Survicate SDK as described below. +Now you can use the Analytics, having the events mapped to the Survicate SDK as described below. -_**Identify**_ +#### Identify -In the SurvicateDestination plugin, the `identify` method from Segment is transferred to the `setUserTraits` method of Survicate. You can provide multiple key-value pairs. The `userId` argument of `Analytics.identify` is also set as a user trait with the key "user_id". +In the SurvicateDestination plugin, the Identify method from Segment is transferred to the `setUserTraits` method of Survicate. You can provide multiple key-value pairs. The `userId` argument of `Analytics.identify` is also set as a user trait with the key "user_id". -_**Track**_ +#### Track -The `track` method from Segment is used as the `invokeEvent` method in Survicate. This means that when you track an event in Segment, it will be invoked in Survicate. +The Track method from Segment is used as the `invokeEvent` method in Survicate. This means that when you track an event in Segment, it will be invoked in Survicate. -_**Screen**_ +#### Screen -Similarly, the screen method from Segment is used as the `enterScreen` method in Survicate. This means that when you track a screen in Segment, it will be entered in Survicate. +Similarly, the Screen method from Segment is used as the `enterScreen` method in Survicate. This means that when you track a screen in Segment, it will be entered in Survicate. -_**Reset**_ +#### Reset -The `reset` method from Segment is used as the reset method in Survicate. This means that when you reset the Segment client, the Survicate client will also be reset. +The Reset method from Segment is used as the reset method in Survicate. This means that when you reset the Segment client, the Survicate client is also reset. From 5418f308cd790908b68f72362550374f44efdac3 Mon Sep 17 00:00:00 2001 From: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Date: Thu, 9 Nov 2023 09:40:30 -0800 Subject: [PATCH 5/5] Update header --- .../destination-plugins/survicate-kotlin-android.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md index 73c208dfad..1dc8e339c2 100644 --- a/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md +++ b/src/connections/sources/catalog/libraries/mobile/kotlin-android/destination-plugins/survicate-kotlin-android.md @@ -49,7 +49,7 @@ dependencies { You can find the current version in the [plugin repository](https://github.com/Survicate/analytics-kotlin-survicate){:target="_blank"}. -## Using the Plugin in your App +## Using the plugin in your app In order to activate the Survicate plugin, you have to add a `SurvicateDestination` to the Analytics instance. ```kotlin