Skip to content

Commit e20627a

Browse files
authored
Merge branch 'workstation/6.0-Release' into feat/removing-deprecations
2 parents 5357b3c + 5cbfc12 commit e20627a

31 files changed

Lines changed: 191 additions & 198 deletions

File tree

.trunk/trunk.yaml

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -67,27 +67,6 @@ lint:
6767
paths:
6868
- "**/gradlew"
6969
- scripts/install-start-emulator.sh
70-
- kits/adjust/adjust-5/**
71-
- kits/adobe/adobe-5/**
72-
- kits/adobemedia/adobemedia-5/**
73-
- kits/apptentive/apptentive-6/**
74-
- kits/appsflyer/appsflyer-6/**
75-
- kits/apptimize/apptimize-3/**
76-
- kits/branch/branch-5/**
77-
- kits/braze/braze-38/**
78-
- kits/clevertap/clevertap-7/**
79-
- kits/comscore/comscore-6/**
80-
- kits/iterable/iterable-3/**
81-
- kits/ga/ga-23/**
82-
- kits/ga4/ga4-23/**
83-
- kits/kochava/kochava-5/**
84-
- kits/leanplum/leanplum-7/**
85-
- kits/localytics/localytics-6/**
86-
- kits/onetrust/onetrust/**
87-
- kits/optimizely/optimizely-3/**
88-
- kits/radar/radar-3/**
89-
- kits/rokt/rokt/**
90-
- kits/singular/singular-12/**
9170
- kits/urbanairship/urbanairship-20/**
9271
actions:
9372
enabled:

kits/adjust/adjust-5/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Adjust Kit Integration
1+
# Adjust Kit Integration
22

3-
This repository contains the [Adjust](https://www.adjust.com/) integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
3+
This repository contains the [Adjust](https://www.adjust.com/) integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
44

5-
### Adding the integration
5+
## Adding the integration
66

77
1. Add the kit dependency to your app's build.gradle:
88

@@ -11,13 +11,14 @@ This repository contains the [Adjust](https://www.adjust.com/) integration for t
1111
implementation 'com.mparticle:android-adjust-kit:5+'
1212
}
1313
```
14+
1415
2. Follow the mParticle Android SDK [quick-start](https://github.com/mParticle/mparticle-android-sdk), then rebuild and launch your app, and verify that you see `"Adjust detected"` in the output of `adb logcat`.
1516
3. Reference mParticle's integration docs below to enable the integration.
1617
17-
### Documentation
18+
## Documentation
1819
1920
[Adjust integration](https://docs.mparticle.com/integrations/adjust/event/)
2021
21-
### License
22+
## License
2223
2324
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)

kits/adobe/adobe-5/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Adobe Kit Integration
1+
# Adobe Kit Integration
22

33
This repository contains the Adobe integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
44

5-
### Adding the integration
5+
## Adding the integration
66

77
1. Add the kit dependency to your app's build.gradle:
88

@@ -11,14 +11,15 @@ This repository contains the Adobe integration for the [mParticle Android SDK](h
1111
implementation 'com.mparticle:android-adobe-kit:5+'
1212
}
1313
```
14+
1415
2. Follow the mParticle Android SDK [quick-start](https://github.com/mParticle/mparticle-android-sdk), then rebuild and launch your app, and verify that you see `"Adobe detected"` in the output of `adb logcat`.
1516
3. Reference mParticle's integration docs below to enable the integration.
1617
4. Reference Adobe's integration doc below for more features.
1718
18-
### Documentation
19+
## Documentation
1920
2021
[Adobe integration](https://docs.mparticle.com/integrations/amc/event/)
2122
22-
### License
23+
## License
2324
2425
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Adobe Media Kit Integration
1+
# Adobe Media Kit Integration
22

33
This repository contains the [Adobe Media](https://docs.adobe.com/content/help/en/media-analytics/using/media-overview.html) integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
44

5-
Please note that the `adobemedia-kit` contains all the functionality of the `adobe-kit`. The presence of both will result in Duplicate Class errors and a failed build due to the overlap.
5+
Please note that the `adobemedia-kit` contains all the functionality of the `adobe-kit`. The presence of both will result in Duplicate Class errors and a failed build due to the overlap.
66

7-
### Adding the integration
7+
## Adding the integration
88

99
1. Add the kit dependency to your app's build.gradle:
1010

@@ -13,13 +13,14 @@ Please note that the `adobemedia-kit` contains all the functionality of the `ado
1313
implementation 'com.mparticle:android-adobemedia-kit:5+'
1414
}
1515
```
16+
1617
2. Follow the mParticle Android SDK [quick-start](https://github.com/mParticle/mparticle-android-sdk), then rebuild and launch your app, and verify that you see `"Adobe Media detected"` in the output of `adb logcat`.
1718
3. Reference mParticle's integration docs below to enable the integration.
1819
19-
### Documentation
20+
## Documentation
2021
2122
[Example integration](https://github.com/mParticle/mparticle-media-samples/tree/master/android)
2223
23-
### License
24+
## License
2425
2526
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## AppsFlyer Kit Integration
1+
# AppsFlyer Kit Integration
22

33
This repository contains the [AppsFlyer](https://www.appsflyer.com/) integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
44

5-
### Adding the integration
5+
## Adding the integration
66

77
1. Add the kit dependency to your app's build.gradle:
88

@@ -11,21 +11,21 @@ This repository contains the [AppsFlyer](https://www.appsflyer.com/) integration
1111
implementation 'com.mparticle:android-appsflyer-kit:5+'
1212
}
1313
```
14+
1415
2. Follow the mParticle Android SDK [quick-start](https://github.com/mParticle/mparticle-android-sdk), then rebuild and launch your app, and verify that you see `"AppsFlyer detected"` in the output of `adb logcat`.
1516
3. Reference mParticle's integration docs below to enable the integration.
1617
4. If you wish to utilize Appsflyers InstallReferrer capabilities, add a dependency for Play Install Referrer library in you app's build.gradle. For more information visit the [Appsflyer SDK's documentation page](https://support.appsflyer.com/hc/en-us/articles/207032066#attribution) on the subject:
1718
18-
```groovy
19-
dependencies {
20-
implementation "com.android.installreferrer:installreferrer:2.2"
21-
}
22-
```
23-
19+
```groovy
20+
dependencies {
21+
implementation "com.android.installreferrer:installreferrer:2.2"
22+
}
23+
```
2424
25-
### Documentation
25+
## Documentation
2626
2727
[AppsFlyer integration](http://docs.mparticle.com/integrations/appsflyer/event/)
2828
29-
### License
29+
## License
3030
31-
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
31+
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Apptentive Kit Integration
1+
# Apptentive Kit Integration
22

33
This repository contains the [Apptentive](https://www.apptentive.com/) integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
44

5-
### Adding the integration
5+
## Adding the integration
66

77
1. Add the kit dependency to your app's build.gradle:
88

@@ -11,21 +11,22 @@ This repository contains the [Apptentive](https://www.apptentive.com/) integrati
1111
implementation 'com.mparticle:android-apptentive-kit:5+'
1212
}
1313
```
14+
1415
2. Follow the mParticle Android SDK [quick-start](https://github.com/mParticle/mparticle-android-sdk), then rebuild and launch your app, and verify that you see `"Apptentive detected"` in the output of `adb logcat`.
1516
3. Reference mParticle's integration docs below to enable the integration.
1617
4. Reference Apptentive's integration doc below for more features.
1718
5. Check out the example app below.
1819
19-
### Documentation
20+
## Documentation
2021
2122
[Apptentive integration](https://docs.mparticle.com/integrations/apptentive/event/)
2223
2324
[Apptentive-mParticle Integration](https://learn.apptentive.com/knowledge-base/mparticle-integration-android)
2425
25-
### Example App
26+
## Example App
2627
2728
[Apptentive Android mParticle Example](https://github.com/apptentive/android-mparticle-example)
2829
29-
### License
30+
## License
3031
3132
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Apptimize Kit Integration
1+
# Apptimize Kit Integration
22

33
This repository contains the [Apptimize](https://www.apptimize.com/) integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
44

5-
### Adding the integration
5+
## Adding the integration
66

77
1. The Apptimize Kit requires that you add Apptimize's Maven server to your buildscript:
88

@@ -13,20 +13,22 @@ This repository contains the [Apptimize](https://www.apptimize.com/) integration
1313
}
1414
}
1515
```
16+
1617
2. Add the kit dependency to your app's build.gradle:
1718
1819
```groovy
1920
dependencies {
2021
implementation 'com.mparticle:android-apptimize-kit:5+'
2122
}
2223
```
24+
2325
3. Follow the mParticle Android SDK [quick-start](https://github.com/mParticle/mparticle-android-sdk), then rebuild and launch your app, and verify that you see `"Apptimize detected"` in the output of `adb logcat`.
2426
4. Reference mParticle's integration docs below to enable the integration.
2527
26-
### Documentation
28+
## Documentation
2729
2830
[Apptimize integration](https://docs.mparticle.com/integrations/apptimize)
2931
30-
### License
32+
## License
3133
3234
[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)

kits/branch/branch-5/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Branch Kit Integration
1+
# Branch Kit Integration
22

33
This repository contains the [Branch](https://www.branch.io/) integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
44

5-
### Adding the integration
5+
## Adding the integration
66

77
1. Add the kit dependency to your app's build.gradle:
88

@@ -11,13 +11,14 @@ This repository contains the [Branch](https://www.branch.io/) integration for th
1111
implementation 'com.mparticle:android-branch-kit:5+'
1212
}
1313
```
14+
1415
2. Follow the mParticle Android SDK [quick-start](https://github.com/mParticle/mparticle-android-sdk), then rebuild and launch your app, and verify that you see `"Branch Metrics detected"` in the output of `adb logcat`.
1516
3. Reference mParticle's integration docs below to enable the integration.
1617
17-
### Documentation
18+
## Documentation
1819
1920
[Branch integration](https://docs.mparticle.com/integrations/branch-metrics/event/)
2021
21-
### License
22+
## License
2223
2324
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
##mParticle-Branch Example
1+
# mParticle-Branch Example
22

3-
###Overview
3+
## Overview
44

55
This sample app demonstrates:
66

@@ -11,4 +11,3 @@ This sample app demonstrates:
1111
• How to Branch deep links are handled in an app when using branch with mParticle.
1212

1313
• How event tracking is handled in mParticle and Branch.
14-

kits/braze/braze-38/README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
## Braze (formerly Appboy) Kit Integration
1+
# Braze (formerly Appboy) Kit Integration
22

33
This repository contains the [Braze](https://www.braze.com/) integration for the [mParticle Android SDK](https://github.com/mParticle/mparticle-android-sdk).
44

5-
### Example App
5+
## Example App
66

77
This repository contains an [example app](https://github.com/mparticle-integrations/mparticle-android-integration-appboy/tree/master/example) showing how to implement mParticle, Braze, and Firebase Cloud Messaging. The key changes you need to make to your app are below, and please also reference mParticle and Braze's documentation:
88

99
- [Instrumenting Push](https://docs.mparticle.com/developers/sdk/android/push-notifications)
1010
- [Braze Documentation](https://docs.mparticle.com/integrations/braze/event)
1111

12-
### 1. Adding the integration
12+
## 1. Adding the integration
1313

1414
[See a full build.gradle example here](https://github.com/mparticle-integrations/mparticle-android-integration-appboy/blob/master/example/build.gradle)
1515

1616
1. The Braze Kit requires that you add Braze's Maven server to your buildscript:
1717

18-
```
18+
```groovy
1919
repositories {
2020
maven { url "https://appboy.github.io/appboy-android-sdk/sdk" }
2121
//Braze's library depends on the Google Support Library
@@ -32,26 +32,28 @@ This repository contains an [example app](https://github.com/mparticle-integrati
3232
}
3333
```
3434
35-
### 2. Registering for Push
35+
## 2. Registering for Push
3636
3737
mParticle's SDK takes care of registering for push notifications and passing tokens or instance IDs to the Braze SDK. [Follow the mParticle push notification documentation](https://docs.mparticle.com/developers/sdk/android/push-notifications#register-for-push-notifications) to instrument the SDK for push registration. You can skip over [this section of Braze's documentation](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/push_notifications/integration/#registering-for-push).
3838
39-
### 3. Displaying Push
39+
## 3. Displaying Push
4040
4141
[See a full example of an AndroidManifest.xml here](https://github.com/mparticle-integrations/mparticle-android-integration-appboy/blob/master/example/src/main/AndroidManifest.xml).
4242
4343
mParticle's SDK also takes care of capturing incoming push notifications and passing the resulting `Intent` to Braze's `BrazePushReceiver`. Follow the [mParticle push notification documentation](https://docs.mparticle.com/developers/sdk/android/push-notifications#display-push-notifications) to ensure you add the correct services and receivers to your app's AndroidManifest.xml.
4444
45-
### 4. Reacting to Push and Deeplinking
45+
## 4. Reacting to Push and Deeplinking
4646
4747
There are a wide variety of implementation options available in Braze to deeplink a user when they tap a notification. There are **two specific requirements** to ensure automatic deeplinking works as intended.
4848
4949
- `BrazePushReceiver`
5050
5151
Whereas up until now you should have nothing Braze-specific in your `AndroidManifest.xml`, using Braze's automatic deeplinking does require you to add their `BrazePushReceiver`. Note that you do not need to specify any Intent filters (for example to receive push tokens, since mParticle takes care of that). You just need to add the following:
5252
53-
<receiver android:name="com.braze.push.BrazePushReceiver" />
54-
53+
```xml
54+
<receiver android:name="com.braze.push.BrazePushReceiver" />
55+
```
56+
5557
- `braze.xml`
5658
5759
For automatic deep-linking, you need to add a boolean resource named `com_braze_handle_push_deep_links_automatically`. This can be in any resource file, or you can name it `braze.xml`:
@@ -63,9 +65,8 @@ There are a wide variety of implementation options available in Braze to deeplin
6365
</resources>
6466
```
6567
66-
6768
From here you should be able to successfully test push via Braze! Braze offers many client-side configurable options via xml resources and otherwise. Please see review the rest of [their documentation here](https://www.braze.com/docs/developer_guide/platform_integration_guides/android/push_notifications/integration/#step-3-add-deep-links) for more information.
6869
69-
### License
70+
## License
7071
7172
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)

0 commit comments

Comments
 (0)