cordova-plugin-appsflyer-sdk - npm Package Compare versions

Comparing version 6.15.1-rc3 to 6.15.1-rc4

docs/API.md

@@ -55,3 +55,4 @@ # API
 | [`setConsentData`](#setConsentData)                                   | `(boolean disable)`                                                       | Use to manually collecting the consent data from the user.                                             |                                           
-| [`enableTCFDataCollection`](#enableTCFDataCollection)                                   | `(boolean enable)`                                                        | instruct the SDK to collect the TCF data from the device. |                                           
+| [`enableTCFDataCollection`](#enableTCFDataCollection)                                   | `(boolean enable)`                                                        | instruct the SDK to collect the TCF data from the device.                                              |                                           
+| [`logAdRevenue`](#logAdRevenue)                                   | `(Object adRevenueData, Object additionalParams)`                         | Log ad revenue event.                                                                                  |                                           
 
@@ -803,2 +804,43 @@
 ---
+
+##### <a id="logAdRevenue"> **`logAdRevenue(adRevenueData, additionalParams): void`**
+log ad-revenue event.
+
+| parameter        | type     | description                                                                                                                                                                                                                                                |
+|------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `adRevenueData`  | `Object` | the object must contain the following fields:<br/>monetizationNetwork: String testMonetizationNetwork<br/> mediationNetwork: MediationNetwork testMediationNetwork<br/>currencyIso4217Code: String currencyByIso4217CodeFormat <br/>revenue:double revenue |
+| `additionalData` | `Object` | additional Params Data map, @Nullable                                                                                                                                                                                                                      |
+
+
+*Example:*
+
+```javascript
+
+let mediationNetwork = MediationNetwork.TOPON;
+let adRevenueData = {
+    'monetizationNetwork': 'testMonetizationNetwork',
+    'mediationNetwork': mediationNetwork,
+    'currencyIso4217Code': 'USD',
+    'revenue': 15.0
+};
+let additionalParams = {
+    'additionalKey1':'additionalValue1',
+    'additionalKey2':'additionalValue2'
+}
+window.plugins.appsFlyer.logAdRevenue(adRevenueData, additionalParams);
+
+
+```
+Here's how you use `appsFlyer.logAdRevenue` within a Cordova app:
+
+1. Prepare the `adRevenueData` object as shown, including any additional parameters you wish to track along with the ad revenue event.
+2. Call the `appsFlyer.logAdRevenue` method with the `adRevenueData` object.
+
+By passing all the required fields in `AFAdRevenueData`, you help ensure accurate tracking within the AppsFlyer platform. This enables you to analyze your ad revenue alongside other user acquisition data to optimize your app's overall monetization strategy.
+
+**Note:** 
+The `additionalParameters` object is optional. You can add any additional data you want to log with the ad revenue event in this object. This can be useful for detailed analytics or specific event tracking later on. Make sure that the custom parameters follow the data types and structures specified by AppsFlyer in their documentation.
+---
+
+
 ### <a id="deep-linking-tracking"> Deep linking Tracking
@@ -805,0 +847,0 @@

package.json

 {
 
   "name": "cordova-plugin-appsflyer-sdk",
-
-  "version": "6.15.1-rc3",
-
+  "version": "6.15.1-rc4",
   "description": "Cordova AppsFlyer SDK Plugin",
-
   "cordova": {
-
     "id": "cordova-plugin-appsflyer-sdk",
-
     "platforms": [
-
       "android",
-
       "ios"
-
     ]
-
   },
-
   "repository": {
-
     "type": "git",
-
     "url": "git+https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk.git"
-
   },
-
   "keywords": [
-
     "cordova",
-
     "appsflyer",
-
     "ecosystem:cordova",
-
     "cordova-android",
-
     "cordova-ios"
-
   ],
-
   "engines": [
-
     {
-
       "name": "cordova",
-
       "version": ">=4.3.0"
-
     }
-
   ],
-
   "author": "Appsflyer",
-
   "license": {
-
     "type": "MIT",
-
     "url": "https://github.com/AppsFlyerSDK/appsflyer-cordova-plugin/blob/master/LICENSE"
-
   },
-
   "bugs": {
-
     "url": "https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk/issues"
-
   },
-
   "homepage": "https://github.com/AppsFlyerSDK/cordova-plugin-appsflyer-sdk#readme",
-
   "scripts": {
-
     "test": "npm run jshint",
-
     "jshint": "node node_modules/jshint/bin/jshint www && node node_modules/jshint/bin/jshint src && node node_modules/jshint/bin/jshint tests",
-
     "setupIonicCordova": "cd examples/ionic-cordova; npm install; ionic cordova plugin rm cordova-plugin-appsflyer-sdk --save; ionic cordova platform rm android; ionic cordova platform rm ios; ionic cordova plugin add cordova-plugin-appsflyer-sdk --save; ionic cordova platform add android; ionic cordova platform add ios",
-
     "runIonicCordovaIos": "cd examples/ionic-cordova; ionic cordova prepare ios; ionic cordova run ios;",
-
     "runIonicCordovaAndroid": "cd examples/ionic-cordova; ionic cordova prepare android; ionic cordova run android;",
-
     "setupCordova": "cd examples/cordova; npm install; cordova plugin rm cordova-plugin-appsflyer-sdk --save; cordova platform rm android; cordova platform rm ios; cordova plugin add cordova-plugin-appsflyer-sdk --save; cordova platform add android; cordova platform add ios",
-
     "runCordovaIos": "cd examples/cordova; cordova prepare ios; cordova run ios;",
-
     "runCordovaAndroid": "cd examples/cordova; cordova prepare android; cordova run android;"
-
   },
-
   "devDependencies": {
-
     "jshint": "^2.6.0"
-
   },
-
   "dependencies": {}
-
 }
 

README.md

@@ -27,2 +27,4 @@
 - From version **6.10.2** the plugin requires using the implementation 'org.jetbrains.kotlin:kotlin-stdlib:1.6.20' in Android.
+- From version **6.14.3** the plugin requires Target version 12 and higher in iOS.
+- From version **6.15.1** the plugin requires adding the value '/usr/lib/swift' to Build Settings 'RunPath Search Paths' key in iOS.
 ----------  
@@ -46,4 +48,9 @@
   
-- iOS AppsFlyerSDK **v6.14.3**  
-- Android AppsFlyerSDK **v6.14.0**
+- iOS AppsFlyerSDK **v6.15.1**  
+- Android AppsFlyerSDK **v6.15.0**
+
+### <a id="breakingChanges"> ❗v6.15.1 Breaking Changes
+
+iOS platform:
+The plugin requires adding the value '/usr/lib/swift' to Build Settings 'RunPath Search Paths' key in iOS, Otherwise there might be some compilation errors.
   
@@ -50,0 +57,0 @@ ### <a id="breakingChanges"> ❗v6.14.3 Breaking Changes

RELEASENOTES.md

 ## 6.15.1
- Release date: *2024-08-29*
+ Release date: *2024-09-02*
 
@@ -4,0 +4,0 @@ - Cordova >> Update Plugin to v6.15.1

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

402828

increased by0.89%

Number of lines in readme file

191

increased by3.8%

No dependency changes