From c93caf6f082f629292091c49fee31d1d2337fff9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Tue, 23 Jan 2024 15:00:44 +0100 Subject: [PATCH 1/6] Add AD(X) docs for Unity --- .../docs/en/sdk/unity/features/ad-revenue.mdx | 2 +- .../docs/en/sdk/unity/integrations/adx.mdx | 35 +++++++++++++++++++ 2 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 src/content/docs/en/sdk/unity/integrations/adx.mdx diff --git a/src/content/docs/en/sdk/unity/features/ad-revenue.mdx b/src/content/docs/en/sdk/unity/features/ad-revenue.mdx index 269f1b73c..de8d8303f 100644 --- a/src/content/docs/en/sdk/unity/features/ad-revenue.mdx +++ b/src/content/docs/en/sdk/unity/features/ad-revenue.mdx @@ -50,6 +50,7 @@ To send ad revenue to Adjust: | `AdjustConfig.AdjustAdRevenueSourceUnity` | Unity | | `AdjustConfig.AdjustAdRevenueSourceHeliumChartboost` | Helium Chartboost | | `AdjustConfig.AdjustAdRevenueSourcePublisher` | Generic source | +| `AdjustConfig.AdjustAdRevenueSourceAdx` | AD(X) | @@ -162,7 +163,6 @@ This example demonstrates how to set up and record an ad revenue object with the - A callback parameter: `"key1" = "value1"` - A partner parameter: `"key2" = "value2"` - ```c# AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AdjustAdRevenueSourceAppLovinMAX); adjustAdRevenue.setRevenue(1.00, "EUR"); diff --git a/src/content/docs/en/sdk/unity/integrations/adx.mdx b/src/content/docs/en/sdk/unity/integrations/adx.mdx new file mode 100644 index 000000000..bd8e98538 --- /dev/null +++ b/src/content/docs/en/sdk/unity/integrations/adx.mdx @@ -0,0 +1,35 @@ +--- +title: AD(X) SDK integration +description: Use the Ad(X) integration to pass AD(X) information to Adjust's servers. +slug: en/sdk/unity/integrations/adx +--- + +You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` instance. To do this: + +1. Create a new function that triggers when the `rewardedAd.OnPaidEvent` method is called in the AD(X) SDK. This function should receive the eCPM (Effective Cost Per Mille) amount as an argument +2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/unity/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx` +3. Fill in the details of your `AdjustAdRevenue` object. Divide the `ecpm` value by 1000 to return the estimated revenue for the ad +4. Send the ad revenue information to Adjust by calling the `trackAdRevenue` method + + + +For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](https://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#4.-a-d-revenue-onpaidevent). + + + +## Example + +```cs +rewardedAd.OnPaidEvent += RewardedAd_OnPaidEvent; + +void RewardedAd_OnPaidEvent(double ecpm) +{ + double revenue = ecpm / 1000f; + + AdjustAdRevenue adRevenue = new AdjustAdRevenue(AdjustConfig.AdRevenueSourceAdx); + adRevenue.setRevenue(revenue, "USD"); + adRevenue.setAdRevenueUnit("ADX Rewarded Ad"); + + Adjust.trackAdRevenue(adRevenue); +} +``` From 32cebb6c89c191342079b53ad652bfe2fa8d1000 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Fri, 26 Jan 2024 12:11:23 +0100 Subject: [PATCH 2/6] Add missing periods --- src/content/docs/en/sdk/unity/integrations/adx.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/content/docs/en/sdk/unity/integrations/adx.mdx b/src/content/docs/en/sdk/unity/integrations/adx.mdx index bd8e98538..b2b4f0069 100644 --- a/src/content/docs/en/sdk/unity/integrations/adx.mdx +++ b/src/content/docs/en/sdk/unity/integrations/adx.mdx @@ -6,10 +6,10 @@ slug: en/sdk/unity/integrations/adx You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` instance. To do this: -1. Create a new function that triggers when the `rewardedAd.OnPaidEvent` method is called in the AD(X) SDK. This function should receive the eCPM (Effective Cost Per Mille) amount as an argument -2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/unity/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx` -3. Fill in the details of your `AdjustAdRevenue` object. Divide the `ecpm` value by 1000 to return the estimated revenue for the ad -4. Send the ad revenue information to Adjust by calling the `trackAdRevenue` method +1. Create a new function that triggers when the `rewardedAd.OnPaidEvent` method is called in the AD(X) SDK. This function should receive the eCPM (Effective Cost Per Mille) amount as an argument. +2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/unity/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx`. +3. Fill in the details of your `AdjustAdRevenue` object. Divide the `ecpm` value by 1000 to return the estimated revenue for the ad. +4. Send the ad revenue information to Adjust by calling the `trackAdRevenue` method. From aa49229311b4c10849ebdfb74bd13982a082bf64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Mon, 29 Jan 2024 15:00:28 +0100 Subject: [PATCH 3/6] Added version marker for Ad(X) --- src/content/docs/en/sdk/unity/integrations/adx.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/content/docs/en/sdk/unity/integrations/adx.mdx b/src/content/docs/en/sdk/unity/integrations/adx.mdx index b2b4f0069..06f271e0b 100644 --- a/src/content/docs/en/sdk/unity/integrations/adx.mdx +++ b/src/content/docs/en/sdk/unity/integrations/adx.mdx @@ -4,8 +4,12 @@ description: Use the Ad(X) integration to pass AD(X) information to Adjust's ser slug: en/sdk/unity/integrations/adx --- + + You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` instance. To do this: + + 1. Create a new function that triggers when the `rewardedAd.OnPaidEvent` method is called in the AD(X) SDK. This function should receive the eCPM (Effective Cost Per Mille) amount as an argument. 2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/unity/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx`. 3. Fill in the details of your `AdjustAdRevenue` object. Divide the `ecpm` value by 1000 to return the estimated revenue for the ad. From 40002846835925a1d0781dc76ee99e2529b0bdc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Wed, 31 Jan 2024 11:30:41 +0100 Subject: [PATCH 4/6] Add initial iOS and Android docs --- .../en/sdk/android/features/ad-revenue.mdx | 31 +++++----- .../docs/en/sdk/android/integrations/adx.mdx | 59 +++++++++++++++++++ .../docs/en/sdk/ios/features/ad-revenue.mdx | 1 + .../docs/en/sdk/ios/integrations/adx.mdx | 39 ++++++++++++ 4 files changed, 115 insertions(+), 15 deletions(-) create mode 100644 src/content/docs/en/sdk/android/integrations/adx.mdx create mode 100644 src/content/docs/en/sdk/ios/integrations/adx.mdx diff --git a/src/content/docs/en/sdk/android/features/ad-revenue.mdx b/src/content/docs/en/sdk/android/features/ad-revenue.mdx index 67db17f4a..810e97ef6 100644 --- a/src/content/docs/en/sdk/android/features/ad-revenue.mdx +++ b/src/content/docs/en/sdk/android/features/ad-revenue.mdx @@ -40,16 +40,17 @@ To send ad revenue to Adjust: -| Parameter | Source | -| ------------------------------------ | ----------------- | +| Parameter | Source | +| ------------------------------------------- | ----------------- | | `AdjustConfig.AD_REVENUE_APPLOVIN_MAX` | AppLovin MAX | -| `AdjustConfig.AD_REVENUE_MOPUB` | Mopub | -| `AdjustConfig.AD_REVENUE_ADMOB` | AdMob | -| `AdjustConfig.AD_REVENUE_IRONSOURCE` | ironSource | -| `AdjustConfig.AD_REVENUE_ADMOST` | AdMost | -| `AdjustConfig.AD_REVENUE_UNITY` | Unity | +| `AdjustConfig.AD_REVENUE_MOPUB` | Mopub | +| `AdjustConfig.AD_REVENUE_ADMOB` | AdMob | +| `AdjustConfig.AD_REVENUE_IRONSOURCE` | ironSource | +| `AdjustConfig.AD_REVENUE_ADMOST` | AdMost | +| `AdjustConfig.AD_REVENUE_UNITY` | Unity | | `AdjustConfig.AD_REVENUE_HELIUM_CHARTBOOST` | Helium Chartboost | -| `AdjustConfig.AD_REVENUE_SOURCE_PUBLISHER` | Generic source | +| `AdjustConfig.AD_REVENUE_SOURCE_PUBLISHER` | Generic source | +| `AdjustConfig.AD_REVENUE_ADX` | Ad(X) |
@@ -197,14 +198,14 @@ Adjust.trackAdRevenue(adjustAdRevenue); ```js -let adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX) -adjustAdRevenue.setRevenue(1.00, 'EUR'); +let adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_APPLOVIN_MAX); +adjustAdRevenue.setRevenue(1.0, "EUR"); adjustAdRevenue.setAdImpressionsCount(10); -adjustAdRevenue.setAdRevenueNetwork('network1'); -adjustAdRevenue.setAdRevenueUnit('unit1'); -adjustAdRevenue.setAdRevenuePlacement('banner'); -adjustAdRevenue.addCallbackParameter('key1', 'value1'); -adjustAdRevenue.addPartnerParameter('key2', 'value2'); +adjustAdRevenue.setAdRevenueNetwork("network1"); +adjustAdRevenue.setAdRevenueUnit("unit1"); +adjustAdRevenue.setAdRevenuePlacement("banner"); +adjustAdRevenue.addCallbackParameter("key1", "value1"); +adjustAdRevenue.addPartnerParameter("key2", "value2"); Adjust.trackAdRevenue(adjustAdRevenue); ``` diff --git a/src/content/docs/en/sdk/android/integrations/adx.mdx b/src/content/docs/en/sdk/android/integrations/adx.mdx new file mode 100644 index 000000000..93b356481 --- /dev/null +++ b/src/content/docs/en/sdk/android/integrations/adx.mdx @@ -0,0 +1,59 @@ +--- +title: AD(X) SDK integration +description: Use the Ad(X) integration to pass AD(X) information to Adjust's servers. +slug: en/sdk/android/integrations/adx +--- + + + +You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` instance. To do this: + + + +1. Create a new function that triggers when the `rewardedAd.OnPaidEvent` method is called in the AD(X) SDK. This function should receive the eCPM (Effective Cost Per Mille) amount as an argument. +2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/unity/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx`. +3. Fill in the details of your `AdjustAdRevenue` object. Divide the `ecpm` value by 1000 to return the estimated revenue for the ad. +4. Send the ad revenue information to Adjust by calling the `trackAdRevenue` method. + + + +For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](https://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#4.-a-d-revenue-onpaidevent). + + + +## Example + + + + +```kotlin +override fun onPaidEvent(double ecpm) { + double revenue = ecpm / 1000 + + AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_ADX) + adjustAdRevenue.setRevenue(revenue, "USD") + adjustAdRevenue.setAdRevenueUnit("ADX Rewarded Ad") + + Adjust.trackAdRevenue(adjustAdRevenue) +} + +``` + + + + +```java +@Override +public void onPaidEvent(double ecpm) { + double revenue = ecpm / 1000; + + AdjustAdRevenue adjustAdRevenue = new AdjustAdRevenue(AdjustConfig.AD_REVENUE_ADX); + adjustAdRevenue.setRevenue(revenue, "USD"); + adjustAdRevenue.setAdRevenueUnit("ADX Rewarded Ad"); + + Adjust.trackAdRevenue(adjustAdRevenue); +} +``` + + + diff --git a/src/content/docs/en/sdk/ios/features/ad-revenue.mdx b/src/content/docs/en/sdk/ios/features/ad-revenue.mdx index 896096cbc..2ac80fca0 100644 --- a/src/content/docs/en/sdk/ios/features/ad-revenue.mdx +++ b/src/content/docs/en/sdk/ios/features/ad-revenue.mdx @@ -50,6 +50,7 @@ To send ad revenue to Adjust: | `ADJAdRevenueSourceUnity` | Unity | | `ADJAdRevenueSourceHeliumChartboost` | Helium Chartboost | | `ADJAdRevenueSourcePublisher` | Generic source | +| `ADJAdRevenueSourceADX` | Ad(X) | diff --git a/src/content/docs/en/sdk/ios/integrations/adx.mdx b/src/content/docs/en/sdk/ios/integrations/adx.mdx new file mode 100644 index 000000000..f08682bbb --- /dev/null +++ b/src/content/docs/en/sdk/ios/integrations/adx.mdx @@ -0,0 +1,39 @@ +--- +title: AD(X) SDK integration +description: Use the Ad(X) integration to pass AD(X) information to Adjust's servers. +slug: en/sdk/ios/integrations/adx +--- + + + +You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` instance. To do this: + + + +1. Create a new function that triggers when the `rewardedAd.OnPaidEvent` method is called in the AD(X) SDK. This function should receive the eCPM (Effective Cost Per Mille) amount as an argument. +2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/unity/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx`. +3. Fill in the details of your `AdjustAdRevenue` object. Divide the `ecpm` value by 1000 to return the estimated revenue for the ad. +4. Send the ad revenue information to Adjust by calling the `trackAdRevenue` method. + + + +For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](https://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#4.-a-d-revenue-onpaidevent). + + + +## Example + +```cs +rewardedAd.OnPaidEvent += RewardedAd_OnPaidEvent; + +void RewardedAd_OnPaidEvent(double ecpm) +{ + double revenue = ecpm / 1000f; + + AdjustAdRevenue adRevenue = new AdjustAdRevenue(AdjustConfig.AdRevenueSourceAdx); + adRevenue.setRevenue(revenue, "USD"); + adRevenue.setAdRevenueUnit("ADX Rewarded Ad"); + + Adjust.trackAdRevenue(adRevenue); +} +``` From cd09d9500eac9cf2b7c3b981eb35981b56b4e3c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Wed, 31 Jan 2024 13:51:42 +0100 Subject: [PATCH 5/6] Update all platform documentation --- .../docs/en/sdk/android/integrations/adx.mdx | 8 +--- .../docs/en/sdk/ios/integrations/adx.mdx | 44 ++++++++++++------- .../docs/en/sdk/unity/integrations/adx.mdx | 2 +- 3 files changed, 30 insertions(+), 24 deletions(-) diff --git a/src/content/docs/en/sdk/android/integrations/adx.mdx b/src/content/docs/en/sdk/android/integrations/adx.mdx index 93b356481..cee13230e 100644 --- a/src/content/docs/en/sdk/android/integrations/adx.mdx +++ b/src/content/docs/en/sdk/android/integrations/adx.mdx @@ -11,16 +11,10 @@ You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` 1. Create a new function that triggers when the `rewardedAd.OnPaidEvent` method is called in the AD(X) SDK. This function should receive the eCPM (Effective Cost Per Mille) amount as an argument. -2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/unity/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx`. +2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/android/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx`. 3. Fill in the details of your `AdjustAdRevenue` object. Divide the `ecpm` value by 1000 to return the estimated revenue for the ad. 4. Send the ad revenue information to Adjust by calling the `trackAdRevenue` method. - - -For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](https://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#4.-a-d-revenue-onpaidevent). - - - ## Example diff --git a/src/content/docs/en/sdk/ios/integrations/adx.mdx b/src/content/docs/en/sdk/ios/integrations/adx.mdx index f08682bbb..133845c52 100644 --- a/src/content/docs/en/sdk/ios/integrations/adx.mdx +++ b/src/content/docs/en/sdk/ios/integrations/adx.mdx @@ -4,36 +4,48 @@ description: Use the Ad(X) integration to pass AD(X) information to Adjust's ser slug: en/sdk/ios/integrations/adx --- - + You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` instance. To do this: 1. Create a new function that triggers when the `rewardedAd.OnPaidEvent` method is called in the AD(X) SDK. This function should receive the eCPM (Effective Cost Per Mille) amount as an argument. -2. Instantiate an [`AdjustAdRevenue` object](/en/sdk/unity/features/ad-revenue) with the source `AdjustConfig.AdRevenueSourceAdx`. +2. Instantiate an [`ADJAdRevenue` object](/en/sdk/ios/features/ad-revenue) with the source `ADJAdRevenueSourceADX`. 3. Fill in the details of your `AdjustAdRevenue` object. Divide the `ecpm` value by 1000 to return the estimated revenue for the ad. 4. Send the ad revenue information to Adjust by calling the `trackAdRevenue` method. - +## Example -For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](https://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#4.-a-d-revenue-onpaidevent). + + - +```swift +func rewardedAd.paidEventHandler(ecpm: double) { + let revenue: double = ecpm / 1000; -## Example + let adjustAdRevenue = AJDAdRevenue(source: ADJAdRevenueSourceADX); + adjustAdRevenue.setRevenue(revenue, currency: "USD"); + adjustAdRevenue.setAdRevenueUnit("ADX Rewarded Ad"); -```cs -rewardedAd.OnPaidEvent += RewardedAd_OnPaidEvent; + Adjust.trackAdRevenue(adjustAdRevenue); +} +``` -void RewardedAd_OnPaidEvent(double ecpm) -{ - double revenue = ecpm / 1000f; + + - AdjustAdRevenue adRevenue = new AdjustAdRevenue(AdjustConfig.AdRevenueSourceAdx); - adRevenue.setRevenue(revenue, "USD"); - adRevenue.setAdRevenueUnit("ADX Rewarded Ad"); +```objc +rewardedAd.paidEventHandler = ^(double ecpm) { + double revenue = ecpm / 1000; - Adjust.trackAdRevenue(adRevenue); -} + ADJAdRevenue *adjustAdRevenue = [[ADJAdRevenue alloc] initWithSource: ADJAdRevenueSourceADX]; + [adjustAdRevenue setRevenue:revenue currency:@"USD"]; + [adjustAdRevenue setAdRevenueUnit:@"ADX Rewarded Ad"]; + + [Adjust trackAdRevenue: adjustAdRevenue]; +}; ``` + + + diff --git a/src/content/docs/en/sdk/unity/integrations/adx.mdx b/src/content/docs/en/sdk/unity/integrations/adx.mdx index 06f271e0b..2b891bddf 100644 --- a/src/content/docs/en/sdk/unity/integrations/adx.mdx +++ b/src/content/docs/en/sdk/unity/integrations/adx.mdx @@ -17,7 +17,7 @@ You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` -For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](https://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#4.-a-d-revenue-onpaidevent). +For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](hhttps://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#id-4.-a-d-revenue-onpaidevent) From ff44c238071c4a8fb62544d159049956eea34341 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Thu, 1 Feb 2024 17:38:46 +0100 Subject: [PATCH 6/6] Update src/content/docs/en/sdk/unity/integrations/adx.mdx MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Uglješa Erceg --- src/content/docs/en/sdk/unity/integrations/adx.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/docs/en/sdk/unity/integrations/adx.mdx b/src/content/docs/en/sdk/unity/integrations/adx.mdx index 2b891bddf..b8d7adf6f 100644 --- a/src/content/docs/en/sdk/unity/integrations/adx.mdx +++ b/src/content/docs/en/sdk/unity/integrations/adx.mdx @@ -17,7 +17,7 @@ You can use the Adjust SDK to send AD(X) data to Adjust as an `AdjustAdRevenue` -For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](hhttps://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#id-4.-a-d-revenue-onpaidevent) +For more information about the `rewardedAd.OnPaidEvent` method, see [AD(X)'s rewarded ad documentation](https://docs.adxcorp.kr/unity/sdk-integration/ad-formats/rewarded-ad/ad-x#id-4.-a-d-revenue-onpaidevent)