Skip to content

Commit 66f57ce

Browse files
committed
docs: update README
1 parent d7b3100 commit 66f57ce

File tree

1 file changed

+35
-9
lines changed

1 file changed

+35
-9
lines changed

README.md

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ This is the Flutter SDK of Adjust™. You can read more about Adjust™ at [adju
5656
* [AppTrackingTransparency framework](#af-att-framework)
5757
* [App-tracking authorisation wrapper](#af-ata-wrapper)
5858
* [Get current authorisation status](#af-ata-getter)
59+
* [Check for ATT status change](#af-att-status-change)
5960
* [SKAdNetwork framework](#af-skadn-framework)
6061
* [Update SKAdNetwork conversion value](#af-skadn-update-conversion-value)
6162
* [Conversion value updated callback](#af-skadn-cv-updated-callback)
@@ -81,6 +82,8 @@ This is the Flutter SDK of Adjust™. You can read more about Adjust™ at [adju
8182
* [Enable third-party sharing](#af-enable-third-party-sharing)
8283
* [Measurement consent](#af-measurement-consent)
8384
* [Data residency](#af-data-residency)
85+
* [COPPA compliance](#af-coppa-compliance)
86+
* [Play Store Kids Apps](#af-play-store-kids-apps)
8487

8588
### License
8689

@@ -131,12 +134,6 @@ Please add the following permissions, which the Adjust SDK needs, if they are no
131134
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
132135
```
133136

134-
If you are **not targeting the Google Play Store**, please also add the following permission:
135-
136-
```xml
137-
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
138-
```
139-
140137
#### <a id="gps-adid-permission"></a>Add permission to gather Google advertising ID
141138

142139
If you are targeting Android 12 and above (API level 31), you need to add the `com.google.android.gms.AD_ID` permission to read the device's advertising ID. Add the following line to your `AndroidManifest.xml` to enable the permission.
@@ -183,7 +180,7 @@ In order to correctly attribute an install of your app to its source, Adjust nee
183180
In order to support this in your app, please make sure to add following dependency to your app's `build.gradle` file for Android platform:
184181

185182
```
186-
implementation 'com.android.installreferrer:installreferrer:1.0'
183+
implementation 'com.android.installreferrer:installreferrer:2.2'
187184
```
188185

189186
Also, make sure that you have paid attention to the [Proguard settings](#qs-proguard) chapter and that you have added all the rules mentioned in it, especially the one needed for this feature:
@@ -222,7 +219,6 @@ Make sure that following iOS frameworks are linked with your iOS app:
222219
* `iAd.framework` - in case you are running iAd campaigns
223220
* `AdServices.framework` - in case you are running iAd campaigns
224221
* `AdSupport.framework` - for reading iOS Advertising Id (IDFA)
225-
* `CoreTelephony.framework` - for reading MCC and MNC information
226222
* `StoreKit.framework` - for communication with SKAdNetwork framework
227223
* `AppTrackingTransparency.framework` - to ask for user's consent to be tracked and obtain status of that consent
228224

@@ -703,6 +699,16 @@ To get the current app tracking authorization status you can call `getAppTrackin
703699
* `3`: The user authorized access to IDFA
704700
* `-1`: The status is not available
705701

702+
### <a id="att-status-change"></a>Check for ATT status change
703+
704+
**Note**: This feature exists only in iOS platform.
705+
706+
In cases where you are not using [Adjust app-tracking authorization wrapper](#af-ata-wrapper), Adjust SDK will not be able to know immediately upon answering the dialog what is the new value of app-tracking status. In situations like this, if you would want Adjust SDK to read the new app-tracking status value and communicate it to our backend, make sure to make a call to this method:
707+
708+
```dart
709+
Adjust.checkForNewAttStatus();
710+
```
711+
706712
### <a id="af-skadn-framework"></a>SKAdNetwork framework
707713

708714
**Note**: This feature exists only in iOS platform.
@@ -1233,6 +1239,26 @@ adjustConfig.urlStrategy = AdjustConfig.DataResidencyTR; // for Turkey data resi
12331239
adjustConfig.urlStrategy = AdjustConfig.DataResidencyUS; // for US data residency region
12341240
```
12351241

1242+
### <a id="af-coppa-compliance"></a>COPPA compliance
1243+
1244+
By default Adjust SDK doesn't mark app as COPPA compliant. In order to mark your app as COPPA compliant, make sure to set `coppaCompliantEnabled` member of `AdjustConfig` instance to `true`:
1245+
1246+
```dart
1247+
adjustConfig.coppaCompliantEnabled = true;
1248+
```
1249+
1250+
**Note:** By enabling this feature, third-party sharing will be automatically disabled for the users. If later during the app lifetime you decide not to mark app as COPPA compliant anymore, third-party sharing **will not be automatically re-enabled**. Instead, next to not marking your app as COPPA compliant anymore, you will need to explicitly re-enable third-party sharing in case you want to do that.
1251+
1252+
### <a id="af-play-store-kids-apps"></a>Play Store Kids Apps
1253+
1254+
**Note**: This feature exists only in Android platform.
1255+
1256+
By default Adjust SDK doesn't mark Android app as Play Store Kids App. In order to mark your app as the app which is targetting kids in Play Store, make sure to set `playStoreKidsAppEnabled` member of `AdjustConfig` instance to `true`:
1257+
1258+
```dart
1259+
adjustConfig.playStoreKidsAppEnabled = true;
1260+
```
1261+
12361262
[dashboard]: https://adjust.com
12371263
[adjust.com]: https://adjust.com
12381264

@@ -1256,7 +1282,7 @@ adjustConfig.urlStrategy = AdjustConfig.DataResidencyUS; // for US data residenc
12561282

12571283
The Adjust SDK is licensed under the MIT License.
12581284

1259-
Copyright (c) 2018-2021 Adjust GmbH, https://www.adjust.com
1285+
Copyright (c) 2018-Present Adjust GmbH, https://www.adjust.com
12601286

12611287
Permission is hereby granted, free of charge, to any person obtaining a copy of
12621288
this software and associated documentation files (the "Software"), to deal in

0 commit comments

Comments
 (0)