Merge pull request #600 from adjust/docs-sdk2sdk-unity-helium

SDK to SDK docs for Unity and Helium Chartboost

Author: uerceg

doc/english/sdk-to-sdk/helium-chartboost.md

@@ -0,0 +1,40 @@
+# Track Helium Chartboost ad revenue with Adjust SDK
+
+[Adjust iOS SDK README][ios-readme]
+
+Minimum SDK version required for this feature:
+
+- **Adjust SDK v4.29.7**
+
+If you want to track your ad revenue with the Helium SDK, you can use our SDK-to-SDK integration to pass this information to the Adjust backend. To do this, you will need to construct an Adjust ad revenue object containing the information you wish to record, then pass the object to the `trackAdRevenue` method.
+
+> Note: If you have any questions about ad revenue tracking with Helium Chartboost, please contact your dedicated account manager or send an email to [support@adjust.com](mailto:support@adjust.com).
+
+### Example
+
+```objc
+[NSNotificationCenter.defaultCenter addObserverForName:kHeliumDidReceiveILRDNotification
+                                                object:nil
+                                                 queue:nil
+                                            usingBlock:^(NSNotification * _Nonnull notification) {
+    // extract the ILRD payload
+    HeliumImpressionData *ilrd = (HeliumImpressionData *)notification.object;
+    NSDictionary *json = ilrd.jsonData;
+    // mandatory fields
+    NSNumber *ad_revenue = [json objectForKey:@"ad_revenue"];
+    NSString *currency_type = [json objectForKey:@"currency_type"];
+    ADJAdRevenue *adjustAdRevenue = [[ADJAdRevenue alloc] initWithSource:ADJAdRevenueSourceHeliumChartboost];
+    [adjustAdRevenue setRevenue:ad_revenue currency:currency_type];
+    // optional fields
+    NSString *network_name = [json objectForKey:@"network_name"];     // Helium demand network name
+    NSString *placement_name = [json objectForKey:@"placement_name"]; // Helium placement name
+    NSString *line_item_name = [json objectForKey:@"line_item_name"]; // Helium line item name
+    [adjustAdRevenue setAdRevenueNetwork:network_name];
+    [adjustAdRevenue setAdRevenueUnit:placement_name];
+    [adjustAdRevenue setAdRevenuePlacement:line_item_name];
+    // track Adjust ad revenue
+    [Adjust trackAdRevenue:adjustAdRevenue];
+}
+```
+
+[ios-readme]:    ../../../README.md

doc/english/sdk-to-sdk/unity.md

@@ -0,0 +1,52 @@
+# Track Unity ad revenue with Adjust SDK
+
+[Adjust iOS SDK README][ios-readme]
+
+Minimum SDK version required for this feature:
+
+- **Adjust SDK v4.29.7**
+
+If you want to track your ad revenue with the Unity SDK, you can use our SDK-to-SDK integration to pass this information to the Adjust backend. To do this, you will need to construct an Adjust ad revenue object containing the information you wish to record, then pass the object to the `trackAdRevenue` method.
+
+> Note: If you have any questions about ad revenue tracking with Unity, please contact your dedicated account manager or send an email to [support@adjust.com](mailto:support@adjust.com).
+
+For more information, see the Unity Mediation [API documentation](https://docs.unity.com/mediation/APIReferenceIOS.html) and [impression event documentation](https://docs.unity.com/mediation/SDKIntegrationIOSImpressionEvents.html).
+
+### Example
+
+```objc
+@interface ViewController()
+
+@property(nonatomic, strong) UMSImpressionListenerWithBlocks * listener;
+
+@end
+
+@implementation ViewController
+
+- (void) viewDidLoad {
+    [super viewDidLoad];
+
+    self.listener = [[UMSImpressionListenerWithBlocks alloc] init];
+    self.listener.onImpressionBlock = ^ (NSString *adUnitId, UMSImpressionData *impressionData) {
+        if (impressionData) {
+            NSLog(@ "impressionData: %@", [impressionData getJsonRepresentation]);
+            // send impression data to Adjust
+            ADJAdRevenue *adjustAdRevenue = [[ADJAdRevenue alloc] initWithSource:ADJAdRevenueSourceUnity];
+            adjustAdRevenue.setRevenue([impressionData.revenue doubleValue], impressionData.currency);
+            // optional fields
+            adjustAdRevenue.setAdRevenueNetwork(impressionData.adSourceName);
+            adjustAdRevenue.setAdRevenueUnit(impressionData.adUnitId);
+            adjustAdRevenue.setAdRevenuePlacement(impressionData.adSourceInstance);
+            // track Adjust ad revenue
+            Adjust.trackAdRevenue(adjustAdRevenue);
+        } else {
+            NSLog(@ "Data does not exist due to not enabling User-Level Reporting");
+        }
+    };
+    [UMSImpressionEventPublisher subscribe: self.listener];
+}
+
+@end
+```
+
+[ios-readme]:    ../../../README.md