Skip to content

Commit bdf2abb

Browse files
committed
update README
1 parent 8cf3029 commit bdf2abb

File tree

1 file changed

+59
-14
lines changed

1 file changed

+59
-14
lines changed

README.md

Lines changed: 59 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ Read this in other languages: [English][en-readme], [中文][zh-readme], [日本
6262
* [Get current authorisation status](#ad-ata-getter)
6363
* [SKAdNetwork framework](#ad-skadn-framework)
6464
* [Update SKAdNetwork conversion value](#ad-skadn-update-conversion-value)
65+
* [Conversion value updated callback](#ad-skadn-cv-updated-callback)
6566
* [Push token (uninstall tracking)](#ad-push-token)
6667
* [Attribution callback](#ad-attribution-callback)
6768
* [Ad revenue tracking](#ad-ad-revenue)
@@ -83,7 +84,7 @@ Read this in other languages: [English][en-readme], [中文][zh-readme], [日本
8384
* [Disable third-party sharing](#ad-disable-third-party-sharing)
8485
* [Enable third-party sharing](#ad-enable-third-party-sharing)
8586
* [Measurement consent](#ad-measurement-consent)
86-
* [Data residency](#ad-data-residency)
87+
* [[beta] Data residency](#ad-data-residency)
8788

8889
### Testing and troubleshooting
8990
* [Debug information in iOS](#tt-debug-ios)
@@ -621,6 +622,32 @@ You can use Adjust SDK wrapper method `updateConversionValue` to update SKAdNetw
621622
Adjust.updateConversionValue(6);
622623
```
623624

625+
### <a id="ad-skadn-cv-updated-callback"></a>Conversion value updated callback
626+
627+
You can register callback to get notified each time when Adjust SDK updates conversion value for the user.
628+
629+
```cs
630+
using com.adjust.sdk;
631+
632+
public class ExampleGUI : MonoBehaviour {
633+
void OnGUI() {
634+
if (GUI.Button(new Rect(0, 0, Screen.width, Screen.height), "callback")) {
635+
AdjustConfig adjustConfig = new AdjustConfig("{Your App Token}", AdjustEnvironment.Sandbox);
636+
adjustConfig.setLogLevel(AdjustLogLevel.Verbose);
637+
adjustConfig.setConversionValueUpdatedDelegate(ConversionValueUpdatedCallback);
638+
639+
Adjust.start(adjustConfig);
640+
}
641+
}
642+
643+
private void ConversionValueUpdatedCallback(int conversionValue)
644+
{
645+
Debug.Log("Conversion value update reported!");
646+
Debug.Log("Conversion value: " + conversionValue);
647+
}
648+
}
649+
```
650+
624651
### <a id="ad-push-token"></a>Push token (uninstall tracking)
625652

626653
Push tokens are used for Audience Builder and client callbacks; they are also required for uninstall and reinstall tracking.
@@ -685,20 +712,35 @@ The callback function will be called when the SDK receives final attribution dat
685712

686713
### <a id="ad-ad-revenue"></a>Ad revenue tracking
687714

688-
You can track ad revenue information with the Adjust SDK by using the following method:
689-
690-
```csharp
691-
Adjust.trackAdRevenue(source, payload);
715+
**Note**: This ad revenue tracking API is available only in the native SDK v4.29.0 and above.
716+
717+
You can track ad revenue information with Adjust SDK by invoking the following method:
718+
719+
```objc
720+
// initialise with AppLovin MAX source
721+
AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue("source");
722+
// set revenue and currency
723+
adjustAdRevenue.setRevenue(1.00, "USD");
724+
// optional parameters
725+
adjustAdRevenue.setAdImpressionsCount(10);
726+
adjustAdRevenue.setAdRevenueNetwork("network");
727+
adjustAdRevenue.setAdRevenueUnit("unit");
728+
adjustAdRevenue.setAdRevenuePlacement("placement");
729+
// callback & partner parameters
730+
adjustAdRevenue.addCallbackParameter("key", "value");
731+
adjustAdRevenue.addPartnerParameter("key", "value");
732+
// track ad revenue
733+
Adjust.trackAdRevenue(adjustAdRevenue);
692734
```
693735

694-
The method parameters you need to pass are:
736+
Currently we support the below `source` parameter values:
695737

696-
- `source` - `string` object which indicates the source of ad revenue info.
697-
- `payload` - `string` object which contains ad revenue JSON in string form.
738+
- `AdjustConfig.AdjustAdRevenueSourceAppLovinMAX` - representing AppLovin MAX platform.
739+
- `AdjustConfig.AdjustAdRevenueSourceMopub` - representing MoPub platform.
740+
- `AdjustConfig.AdjustAdRevenueSourceAdMob` - representing AdMob platform.
741+
- `AdjustConfig.AdjustAdRevenueSourceIronSource` - representing IronSource platform.
698742

699-
Currently we support the following `source` parameter values:
700-
701-
- `AdjustConfig.AdjustAdRevenueSourceMopub` - represents the [MoPub mediation platform][sdk2sdk-mopub]
743+
**Note**: Additional documentation which explains detailed integration with every of the supported sources will be provided outside of this README. Also, in order to use this feature, additional setup is needed for your app in Adjust dashboard, so make sure to get in touch with our support team to make sure that everything is set up correctly before you start to use this feature.
702744

703745
### <a id="ad-subscriptions"></a>Subscription tracking
704746

@@ -1127,14 +1169,17 @@ Adjust.trackMeasurementConsent(true);
11271169

11281170
Upon receiving this information, Adjust changes sharing the specific user's data to partners. The Adjust SDK will continue to work as expected.
11291171

1130-
### <a id="ad-data-residency"></a>Data residency
1172+
### <a id="ad-data-residency"></a>[beta] Data residency
11311173

1132-
In order to enable data residency feature, make sure to make a call to `setUrlStrategy` method of the `AdjustConfig` instance with one of the following constants:
1174+
In order to enable data residency feature, make sure to make a call to `setUrlStrategy:` method of the `ADJConfig` instance with one of the following constants:
11331175

1134-
```csharp
1176+
```objc
11351177
adjustConfig.setUrlStrategy(AdjustConfig.AdjustDataResidencyEU); // for EU data residency region
1178+
adjustConfig.setUrlStrategy(AdjustConfig.AdjustDataResidencyTR); // for Turkey data residency region
11361179
```
11371180

1181+
**Note:** This feature is currently in beta testing phase. If you are interested in getting access to it, please contact your dedicated account manager or write an email to [email protected]. Please, do not turn this setting on before making sure with the support team that this feature is enabled for your app because otherwise SDK traffic will get dropped.
1182+
11381183
## Testing and troubleshooting
11391184

11401185
### <a id="tt-debug-ios"></a>Debug information in iOS

0 commit comments

Comments
 (0)