Axon

https://support.axon.ai/
Admin
Axon is an advertising and app monetization platform by AppLovin that provides self-serve tools for...
Tokens:224,436
Snippets:2,607
Trust Score:7.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### Basic CocoaPods Setup

Source: https://support.axon.ai/en/max/cordova/preparing-mediated-networks

A basic CocoaPods setup for your project. This serves as a template for adding specific network adapters.

```ruby
# Settings
use_frameworks!
inhibit_all_warnings!


# Pods
target 'YOUR_PROJECT_NAME' do


end


```

--------------------------------

### Frequency Capping Settings Example

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Example of frequency capping settings for an ad unit, specifying time-based limits per day and minute, and session limits.

```json
{
  "type": "time",
  "time_capping_settings": {
    "day_limit": 10,
    "minute_frequency": 10
  },
  "session_capping_settings": {
    "session_limit": 0
  },
  "countries" : {
    "type": "INCLUDE",
    "values" : [
      "ca",
      "us"
    ]
  }
}
```

--------------------------------

### Example app-ads.txt File

Source: https://support.axon.ai/en/max/max-dashboard/account/iab-supply-chain-validation

This is an example of an app-ads.txt file listing authorized ad sources. Each line specifies the network domain, publisher ID, and relationship type.

```text
# Network Name, Publisher/Account ID, Relationship Type
applovin.com, 9eaf9ad6dc92d5fcn6f47c30168fb8fq, DIRECT
mintegral.com, 19435, DIRECT, 0aeed123c80d6423
google.com, pub-3940498599942544, DIRECT, f08c47fec0986fa0

```

--------------------------------

### Example Playable Metrics API Request

Source: https://support.axon.ai/en/growth/promoting-your-apps/api/playable-metrics-api

This example demonstrates how to request playable metrics data, specifying date range, desired columns, format, limit, and sorting.

```HTTP
https://r.applovin.com/playableMetrics?api_key=«your-report-key»&start=2025-10-27&end=2025-10-27&columns=day,asset_id,html_name,impressions,unique_interactions&format=json&limit=100&sort_impressions=desc
```

--------------------------------

### Example Publisher Request

Source: https://support.axon.ai/en/growth/promoting-your-apps/api/reporting-api

An example request for publisher data, specifying date range, columns, and a 'having' clause for filtering.

```APIDOC
Example publisher request:
```
https://r.applovin.com/report?api_key=«your-report-key»&start=2016-07-01&end=2016-07-07&columns=day%2Cplatform%2Ccountry%2Capplication%2Cpackage_name%2Csize%2Cad_type%2Cimpressions%2Cclicks%2Crevenue,device_type&having=impressions%20%3E%200%20AND%20revenue%20%3E%200&format=csv

```
```

--------------------------------

### Full MaxRecyclerAdapter Integration Example (Java)

Source: https://support.axon.ai/en/max/android/ad-formats/native-ads

This example demonstrates the complete integration of MaxRecyclerAdapter in an Android Activity, including initialization, ad loading, and cleanup.

```Java
@Override
public void onCreate(Bundle savedInstanceState)
{
  super.onCreate( savedInstanceState );
  // Create your own recycler view and original adapter
  ⋮

  // Configure ad adapter
  MaxAdPlacerSettings settings = new MaxAdPlacerSettings( "«ad-unit-ID»" );
  settings.setRepeatingInterval( 5 );
  adAdapter = new MaxRecyclerAdapter( settings, originalAdapter, this );

  // Optionally, register listener
  adAdapter.setListener( this );

  // Configure recycler view and load ads
  recyclerView.setAdapter( adAdapter );
  adAdapter.loadAds();
}

@Override
public void onDestroy()
{
  adAdapter.destroy();
  super.onDestroy();
}


```

--------------------------------

### Full MaxRecyclerAdapter Integration Example (Kotlin)

Source: https://support.axon.ai/en/max/android/ad-formats/native-ads

This example demonstrates the complete integration of MaxRecyclerAdapter in an Android Activity using Kotlin, including initialization, ad loading, and cleanup.

```Kotlin
override fun onCreate(savedInstanceState: Bundle?)
{
  super.onCreate(savedInstanceState)
  // Create your own recycler view and original adapter
  ⋮

  // Configure ad adapter
  val settings = MaxAdPlacerSettings("«ad-unit-ID»")
  settings.repeatingInterval = 5
  adAdapter = MaxRecyclerAdapter(settings, originalAdapter, this)

  // Optionally, register listener
  adAdapter.listener = this

  // Configure recycler view and load ads
  recycler.adapter = adAdapter
  adAdapter.loadAds()
}

override fun onDestroy()
{
  adAdapter.destroy()
  super.onDestroy()
}


```

--------------------------------

### Kotlin - Banners

Source: https://support.axon.ai/en/max/advanced-features/s2s-impression-level-api

Code example for setting the placement for banners in Kotlin.

```APIDOC
## Kotlin - Banners

### Description
Code example for setting the placement for banners in Kotlin.

### Method
- `adView.setPlacement("placement")`
```

--------------------------------

### Kotlin - Native Ads

Source: https://support.axon.ai/en/max/advanced-features/s2s-impression-level-api

Code example for setting the placement for native ads in Kotlin.

```APIDOC
## Kotlin - Native Ads

### Description
Code example for setting the placement for native ads in Kotlin.

### Method
- `nativeAdLoader.setPlacement("placement")`
```

--------------------------------

### Lua - Banners

Source: https://support.axon.ai/en/max/advanced-features/s2s-impression-level-api

Code examples for creating and setting placements for banners in Lua.

```APIDOC
## Lua - Banners

### Description
Code examples for creating and setting placements for banners in Lua.

### Methods
- `applovin.create_banner(adUnitId, position)`
- `applovin.set_banner_placement(adUnitId, placement)`
```

--------------------------------

### Example Reporting API Request

Source: https://support.axon.ai/en/growth/promoting-your-websites/api/reporting-api

This is an example of a GET request to the AppLovin Reporting API to retrieve advertiser data.

```http
https://r.applovin.com/report?api_key=«your-report-key»&start=2024-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,cost,sales&format=json&report_type=advertiser
```

--------------------------------

### Install Axon Pixel using GTM Custom HTML Tag

Source: https://support.axon.ai/en/growth/promoting-your-websites/axon-pixel-integration/google-tag-manager

This script initializes the Axon Pixel. Replace '«your-event-key»' with your actual event key from your Axon Account. Ensure this tag is set to fire on the 'Initialization - All Pages' trigger in GTM.

```html
<script>
  var AXON_EVENT_KEY="«your-event-key»";
  !function(e,r){var t=["https://s.axon.ai/pixel.js","https://res4.applovin.com/p/l/loader.iife.js"];if(!e.axon){var a=e.axon=function(){a.performOperation?a.performOperation.apply(a,arguments):a.operationQueue.push(arguments)};a.operationQueue=[],a.ts=Date.now(),a.eventKey=AXON_EVENT_KEY;for(var n=r.getElementsByTagName("script")[0],o=0;o<t.length;o++){var i=r.createElement("script");i.async=!0,i.src=t[o],n.parentNode.insertBefore(i,n)}}}(window,document);

  axon("init");
</script>
```

--------------------------------

### Reporting API Request Example

Source: https://support.axon.ai/en/growth/promoting-your-websites/api/reporting-api

An example of a GET request to the Reporting API to retrieve advertiser data in JSON format.

```APIDOC
## GET /report

### Description
Retrieves website performance data based on specified parameters.

### Method
GET

### Endpoint
https://r.applovin.com/report

### Query Parameters
- **api_key** (string) - Required - Your API key for authentication.
- **start** (string) - Required - The start date for the report (YYYY-MM-DD).
- **end** (string) - Required - The end date for the report (YYYY-MM-DD or 'now').
- **columns** (string) - Required - A comma-separated list of columns to include in the report.
- **format** (string) - Optional - The desired format for the report (e.g., 'json', 'csv'). Defaults to 'json'.
- **report_type** (string) - Optional - The type of report to generate (e.g., 'advertiser').

### Request Example
```
https://r.applovin.com/report?api_key=«your-report-key»&start=2024-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,cost,sales&format=json&report_type=advertiser
```

### Response
#### Success Response (200)
- The response format depends on the `format` query parameter. For JSON, it will be a JSON object containing the requested report data. For CSV, it will be a CSV formatted string.
```

--------------------------------

### Load Rewarded Ad and Implement Listener (Java)

Source: https://support.axon.ai/en/max/android/ad-formats/rewarded-ads

Demonstrates how to initialize and load a rewarded ad using `MaxRewardedAd.getInstance()` and implement `MaxRewardedAdListener` to handle ad events like loading, failing, displaying, and user rewards. Includes retry logic for ad load failures.

```java
public class ExampleActivity extends Activity
        implements MaxRewardedAdListener
{
  private MaxRewardedAd rewardedAd;
  private int           retryAttempt;

  void createRewardedAd()
  {
    rewardedAd = MaxRewardedAd.getInstance( "«ad-unit-ID»", this );
    rewardedAd.setListener( this );

    rewardedAd.loadAd();
  }

  // MAX Ad Listener
  @Override
  public void onAdLoaded(final MaxAd maxAd)
  {
    // Rewarded ad is ready to be shown. rewardedAd.isReady() will now return 'true'

    // Reset retry attempt
    retryAttempt = 0;
  }

  @Override
  public void onAdLoadFailed(final String adUnitId, final MaxError error)
  {
    // Rewarded ad failed to load
    // AppLovin recommends that you retry with exponentially higher delays up to a maximum delay (in this case 64 seconds)

    retryAttempt++;
    long delayMillis = TimeUnit.SECONDS.toMillis( (long) Math.pow( 2, Math.min( 6, retryAttempt ) ) );

    new Handler().postDelayed( new Runnable()
    {
      @Override
      public void run()
      {
        rewardedAd.loadAd();
      }
    }, delayMillis );
  }

  @Override
  public void onAdDisplayFailed(final MaxAd maxAd, final MaxError error)
  {
    // Rewarded ad failed to display. AppLovin recommends that you load the next ad.
    rewardedAd.loadAd();
  }

  @Override
  public void onAdDisplayed(final MaxAd maxAd) {}

  @Override
  public void onAdClicked(final MaxAd maxAd) {}

  @Override
  public void onAdHidden(final MaxAd maxAd)
  {
    // rewarded ad is hidden. Pre-load the next ad
    rewardedAd.loadAd();
  }

  @Override
  public void onUserRewarded(final MaxAd maxAd, final MaxReward maxReward)
  {
    // Rewarded ad was displayed and user should receive the reward
  }
}

```

--------------------------------

### Example GET Response for Risky Rules

Source: https://support.axon.ai/en/max/ad-review/rules-management-api

This example shows the structure of a successful response when retrieving existing risky content rules. It includes active and paused rules with their associated properties.

```json
[
  {
    "name": "android title rule",
    "platform": "android",
    "package_names":["com.test.my_first_app","com.test.my_second_app"],
    "rule_type": "title",
    "value": ["solitaire", "block", "com.games.solitaire", "com.bestgames.Bricks"],
    "is_active": "true"
  },
  {
    "name": "ios title rule",
    "platform": "ios",
    "rule_type": "title",
    "value": ["1449713068"],
    "is_active": "false"
  }
]


```

--------------------------------

### Cohort API Endpoints

Source: https://support.axon.ai/en/max/reporting-apis/cohort-api

MAX provides three API endpoints with which you can get user performance data based on when the user installed your app.

```APIDOC
## Cohort API

MAX provides three API endpoints with which you can get user performance data based on when the user installed your app:
  1. Send a request to the `/maxCohort` endpoint to determine how much revenue users are generating with respect to when they install.
  2. Send a request to the `/maxCohort/imp` endpoint to learn how many impressions users are seeing.
  3. Send a request to the `/maxCohort/session` endpoint to retrieve session information.

### Target URLs
  * `https://r.applovin.com/maxCohort` (Ad revenue performance)
  * `https://r.applovin.com/maxCohort/imp` (Ad impressions information)
  * `https://r.applovin.com/maxCohort/session` (Session information)

### Parameters
Name| Description| Example  
---|---|---  
`api_key`| Your Report Key.| `api_key=Hyfi8Mkct…WiWP466a1VBL7eUfUlD9JBh`  
`columns`| Which columns to report (see the tables of columns below). Comma-separated.| `columns=day,application,country`  
`end`1| Last day you want included in the report, in `«YYYY»-«MM»-«DD»` format.| `end=2023-03-29`  
`filter_«x»`| Filter column x by a value.| `filter_platform=ios`  
`format`| Response format: `csv` or `json`.| `format=csv`  
`limit`| Limit the results set to some fixed number of items.| `limit=100`  
`not_zero`| Set to `1` to filter results in which all numerical metrics have a value of 0.| `not_zero=1`  
`offset`| Skip the first offset items. You can use this (along with limit) for pagination. If paginating, set `offset=0` on the first request to preserve result order.| `offset=500`  
`sort_«x»`| Sort the response by column x (see the tables of columns below). You can add multiple sorts with multiple `sort_«x»` parameters, and these will execute in the order in which the parameters appear in the query string. `ASC` (ascending) or `DESC` (descending).| `sort_installs=DESC`  
`start`1| First day you want included in the report, in `«YYYY»-«MM»-«DD»` format.| `start=2023-03-25`  
1 This API has a request window of 45 days. Make sure the date parameters are in the last 45 days.

### `/maxCohort` columns
Name| Description| Example  
---|---|---  
`ads_pub_revenue_«x»`| Revenue generated from ads in x1 days since the install.| `18.12`  
`ads_rpi_«x»`| Revenue per install generated from ads in x1 days since the install.| `.07`  
`application`| Name of the application.| `My App`  
`banner_pub_revenue_«x»`| Revenue generated from banner ads in x1 days since the install.| `2.54`  
`banner_rpi_«x»`| Revenue per install generated from banner ads in x1 days since the install.| `.03`  
`country`| Two-letter ISO Country Code.| `gb`  
`day`| Day of the data, in `«YYYY»-«MM»-«DD»` format.| `2019-03-25`  
`iap_pub_revenue_«x»`| Revenue generated from IAP in x1 days since the install.| `21.23`  
`iap_rpi_«x»`| Revenue per install generated from IAP in x1 days since the install.| `.08`  
`installs`| Number of new installers.| `2842`  
`inter_pub_revenue_«x»`| Revenue generated from (non-rewarded) interstitial ads in x1 days since the install.| `6.10`  
`inter_rpi_«x»`| Revenue per install generated from (non-rewarded) interstitial ads in x1 days since the install.| `.04`  
`mrec_pub_revenue_«x»`| Revenue generated from MREC ads in x1 days since the install.| `.48`  
`mrec_rpi_«x»`| Revenue per install generated from MREC ads in x1 days since the install.| `.02`  
`package_name`| Package Name/Bundle ID of the application.| `com.my.test.app`  
`platform`| Platform of the application: `android`, `fireos`, or `ios`.| `android`  
`pub_revenue_«x»`| Revenue generated in x1 days since the install.| `39.35`  
`reward_pub_revenue_«x»`| Revenue generated from rewarded ads in x1 days since the install.| `9.12`  
`reward_rpi_«x»`| Revenue per install generated from rewarded ads in x1 days since the install.| `.05`  
`rpi_«x»`| Revenue per install generated in x1 days since the install.| `.15`  
1 There is a fixed set of values for which you can track date ranges. x can be one of: `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `10`, `14`, `18`, `21`, `24`, `27`, `30`, `45`.
```

--------------------------------

### Initialize AppLovin SDK in Defold

Source: https://support.axon.ai/en/max/defold/overview/integration

Initialize the AppLovin SDK on app launch by setting a callback function for SDK events and calling the `initialize` function with your SDK key. This ensures mediated networks can cache ads.

```lua
local function applovin_callback(self, name, params)
  if name == "OnSdkInitializedEvent" then
    -- AppLovin SDK is initialized, start loading ads
⋮
end

function init(self)
  applovin.set_callback(applovin_callback)
  applovin.initialize("«your-SDK-key»")
⋮
end

```

--------------------------------

### Set Ad Review Delegate in Objective-C

Source: https://support.axon.ai/en/max/ad-review/ad-review-advanced-settings

Set the `MAAdReviewDelegate` on your ad object to receive creative ID generation events. This example shows the setup within `viewDidLoad`.

```objectivec
@interface ExampleViewController()<MAAdReviewDelegate>

@end

@implementation ExampleViewController

- (void)viewDidLoad
{
  [super viewDidLoad];
```

--------------------------------

### Initialize and Load Native Ad

Source: https://support.axon.ai/en/max/android/ad-formats/native-ads

Set up the MaxNativeAdLoader and initiate the ad loading process. Ensure to provide a valid ad unit ID and implement listeners for ad events.

```java
public class ExampleActivity
        extends Activity
        implements MaxAdRevenueListener
{
  private ViewGroup         nativeAdContainerView;
  private MaxNativeAdLoader nativeAdLoader;
  private MaxAd             loadedNativeAd;

  ⋮

  private void createNativeAdLoader()
  {
    nativeAdLoader = new MaxNativeAdLoader( "«ad-unit-ID»", this );
    nativeAdLoader.setRevenueListener( this );
    nativeAdLoader.setNativeAdListener( new NativeAdListener() );
  }

  private void loadNativeAd()
  {
    nativeAdLoader.loadAd(createNativeAdView() );
  }

  @Override
  public void onAdRevenuePaid(final MaxAd ad) { }

  private class NativeAdListener
          extends MaxNativeAdListener
  {
    @Override
    public void onNativeAdLoaded(final MaxNativeAdView nativeAdView, final MaxAd nativeAd)
    {
      // Destroy any pre-existing native ad to prevent memory leaks.
      if ( loadedNativeAd != null )
      {
        nativeAdLoader.destroy( loadedNativeAd );
      }

      // Save ad for cleanup.
      loadedNativeAd = nativeAd;

      nativeAdContainerView.removeAllViews();
      nativeAdContainerView.addView( nativeAdView );
    }

    @Override
    public void onNativeAdLoadFailed(final String adUnitId, final MaxError error)
    {
      // Native ad load failed.
      // AppLovin recommends retrying with exponentially higher delays up to a maximum delay.
    }

    @Override
    public void onNativeAdClicked(final MaxAd nativeAd) { }

    @Override
    public void onNativeAdExpired(final MaxAd nativeAd)
    {
      // Native ad has expired, which can occur after four hours.
      // Load the next ad.
      nativeAdLoader.loadAd(createNativeAdView() );
    }
  }

  @Override
  protected void onDestroy()
  {
    // Destroy the native ad and native ad loader to prevent memory leaks.
    if ( loadedNativeAd != null )
    {
      nativeAdLoader.destroy( loadedNativeAd );
    }

    nativeAdLoader.destroy();
    super.onDestroy();
  }
}

```

```kotlin
class ExampleActivity : Activity(), MaxAdRevenueListener
{
  private val nativeAdContainerView: ViewGroup? = null
  private var nativeAdLoader: MaxNativeAdLoader? = null
  private var loadedNativeAd: MaxAd? = null

  ⋮

  private fun createNativeAdLoader()
  {
    nativeAdLoader = MaxNativeAdLoader("«ad-unit-ID»", this)
    nativeAdLoader?.setRevenueListener(this)
    nativeAdLoader?.setNativeAdListener(NativeAdListener())
  }

  private fun loadNativeAd()
  {
    nativeAdLoader?.loadAd(createNativeAdView())
  }

  override fun onAdRevenuePaid(ad: MaxAd) {}

  private inner class NativeAdListener : MaxNativeAdListener()
  {

```

--------------------------------

### Reporting API Endpoint

Source: https://support.axon.ai/en/growth/promoting-your-apps/api/reporting-api

Make report requests by sending HTTP GET requests to the base URL. Required parameters include api_key, start date, end date, desired columns, and report type. Optional parameters allow for filtering, pagination, and real-time metric adjustments.

```APIDOC
## GET https://r.applovin.com/report

### Description
Retrieves aggregated campaign data.

### Method
GET

### Endpoint
https://r.applovin.com/report

### Parameters
#### Query Parameters
- **api_key** (string) - Required - Your Report Key.
- **start** (string) - Required - The start date of the report (YYYY-MM-DD or Unix timestamp). Request window is 45 days.
- **end** (string) - Required - The end date of the report (YYYY-MM-DD, Unix timestamp, or 'now'). Request window is 45 days.
- **format** (string) - Required - The format for the report ('json' or 'csv').
- **columns** (string) - Required - A comma-separated list of columns for the report (e.g., 'day,campaign').
- **report_type** (string) - Optional - Specifies 'publisher' or 'advertiser' data. Defaults to 'publisher'.
- **day_column** (string) - Optional - Set to 'day' to pull metrics under cohort; metrics are real-time by default.
- **limit** (integer) - Optional - The maximum number of rows to return for pagination.
- **offset** (integer) - Optional - The starting row offset for pagination.
- **having** (string) - Optional - Filters results based on numeric values (URL-encoded, e.g., 'impressions%20%3E%200'). Slows response and increases timeout likelihood.
- **not_zero** (integer) - Optional - Set to 1 to filter out results where all numerical metrics are 0.

### Allowed Publisher Columns
- `ad_type` (string)
- `application` (string)
- `application_is_hidden` (boolean)
- `bidding_integration` (string)
- `clicks` (integer)
- `country` (string)
- `ctr` (float)
- `day` (string)
- `device_type` (string)
- `ecpm` (float)
- `hour` (string)
- `impressions` (integer)
- `package_name` (string)
- `placement_type` (string)
- `platform` (string)
- `revenue` (float)
- `size` (string)
- `store_id` (string)
- `zone` (string)
- `zone_id` (string)

### Example Request
```
GET https://r.applovin.com/report?api_key=YOUR_API_KEY&start=2023-01-01&end=2023-01-31&columns=day,impressions,clicks,revenue&format=json&report_type=publisher
```

### Response
#### Success Response (200)
Returns a JSON or CSV object containing the requested report data based on the specified columns and filters.
```

--------------------------------

### Kotlin - Native Ads (Ad Placer)

Source: https://support.axon.ai/en/max/advanced-features/s2s-impression-level-api

Code examples for setting up native ads with Ad Placer in Kotlin.

```APIDOC
## Kotlin - Native Ads (Ad Placer)

### Description
Code examples for setting up native ads with Ad Placer in Kotlin.

### Class
- `MaxAdPlacerSettings`

### Properties
- `placement` (string)
```

--------------------------------

### Start Auto-Refresh in Kotlin

Source: https://support.axon.ai/en/max/android/ad-formats/banner-and-mrec-ads

Start auto-refresh for an ad. This is used to resume automatic ad loading after it has been stopped.

```kotlin
adView.startAutoRefresh()
```

--------------------------------

### Initialize MAX SDK and App Open Manager

Source: https://support.axon.ai/en/max/android/ad-formats/app-open-ads

Initialize the AppLovin SDK and create an instance of the App Open Manager in your Application class. This should be done once when the application starts.

```kotlin
class MyApplication : Application()
{
  private lateinit var appOpenManager: ExampleAppOpenManager


  override fun onCreate()
  {
    super.onCreate()


    AppLovinSdk.getInstance( this ).initializeSdk({ configuration: AppLovinSdkConfiguration ->
      appOpenManager = ExampleAppOpenManager(applicationContext)
    })
  }
}
```

--------------------------------

### Java: Configure MaxAdPlacerSettings

Source: https://support.axon.ai/en/max/advanced-features/s2s-impression-level-api

Configure MaxAdPlacerSettings with an ad unit ID and placement in Java.

```java
MaxAdPlacerSettings settings = new MaxAdPlacerSettings( "«ad-unit-ID»" );
settings.setPlacement( "«placement»" );
```

--------------------------------

### Start Auto-Refresh in Java

Source: https://support.axon.ai/en/max/android/ad-formats/banner-and-mrec-ads

Start auto-refresh for an ad. This is used to resume automatic ad loading after it has been stopped.

```java
adView.startAutoRefresh();
```

--------------------------------

### Initialize SDK and Show Mediation Debugger

Source: https://support.axon.ai/en/max/cordova/testing-networks/mediation-debugger

Call this to display the Mediation Debugger. Ensure the SDK is initialized with your SDK key first.

```javascript
AppLovinMAX.initialize(«SDK-key», (configuration) => {
  AppLovinMAX.showMediationDebugger();
});

```

--------------------------------

### Start MREC Auto-Refresh

Source: https://support.axon.ai/en/max/defold/ad-formats/banner-and-mrec-ads

Starts the automatic refresh for a MREC ad. Call this after stopping it or to resume normal ad behavior.

```lua
applovin.start_mrec_auto_refresh(«ad-unit-ID»)
```

--------------------------------

### Start Banner Auto-Refresh

Source: https://support.axon.ai/en/max/defold/ad-formats/banner-and-mrec-ads

Starts the automatic refresh for a banner ad. Call this after stopping it or to resume normal ad behavior.

```lua
applovin.start_banner_auto_refresh(«ad-unit-ID»)
```

--------------------------------

### Example Advertiser Request

Source: https://support.axon.ai/en/growth/promoting-your-apps/api/reporting-api

An example request for advertiser data, specifying date range, columns, format, and report type.

```APIDOC
## Example requests
Example advertiser request:
```
https://r.applovin.com/report?api_key=«your-report-key»&start=2015-04-20&end=now&columns=day,campaign,impressions,clicks,ctr,conversions,conversion_rate,app_id_external,cost,sales&format=json&report_type=advertiser

```
```

--------------------------------

### Initialize AppLovin MAX SDK

Source: https://support.axon.ai/en/max/cordova/overview/integration

Initialize the AppLovin MAX SDK with your SDK key. This should be done on app startup to allow mediated networks to cache ads.

```javascript
var AppLovinMAX = cordova.require('cordova-plugin-applovin-max.AppLovinMAX');

⋮

AppLovinMAX.initialize("«SDK-key»", function (configuration) {
  // SDK is initialized, start loading ads
});
```

--------------------------------

### Create and Load a Banner Ad in Java

Source: https://support.axon.ai/en/max/android/ad-formats/banner-and-mrec-ads

Implement this code to create, configure, and load a MAX Banner ad. Ensure the ad unit ID and background color are set correctly. The ad view should stretch to the screen width and have a predefined height.

```Java
public class ExampleActivity extends Activity
        implements MaxAdViewAdListener
{
  private MaxAdView adView;

  void createBannerAd()
  {
    adView = new MaxAdView( "«ad-unit-ID»", this );
    adView.setListener( this );

    // Stretch to the width of the screen for banners to be fully functional
    int width = ViewGroup.LayoutParams.MATCH_PARENT;

    // Banner height on phones and tablets is 50 and 90, respectively
    int heightPx = getResources().getDimensionPixelSize( R.dimen.banner_height );

    adView.setLayoutParams( new FrameLayout.LayoutParams( width, heightPx ) );

    // Set background color for banners to be fully functional
    adView.setBackgroundColor( «background-color» );

    ViewGroup rootView = findViewById( android.R.id.content );
    rootView.addView( adView );

    // Load the ad
    adView.loadAd();
  }

  // MAX Ad Listener
  @Override
  public void onAdLoaded(final MaxAd maxAd) {}

  @Override
  public void onAdLoadFailed(final String adUnitId, final MaxError error) {}

  @Override
  public void onAdDisplayFailed(final MaxAd maxAd, final MaxError error) {}

  @Override
  public void onAdClicked(final MaxAd maxAd) {}

  @Override
  public void onAdExpanded(final MaxAd maxAd) {}

  @Override
  public void onAdCollapsed(final MaxAd maxAd) {}

  @Override
  public void onAdDisplayed(final MaxAd maxAd) { /* DO NOT USE - THIS IS RESERVED FOR FULLSCREEN ADS ONLY AND WILL BE REMOVED IN A FUTURE SDK RELEASE */ }

  @Override
  public void onAdHidden(final MaxAd maxAd) { /* DO NOT USE - THIS IS RESERVED FOR FULLSCREEN ADS ONLY AND WILL BE REMOVED IN A FUTURE SDK RELEASE */ }
}

```

--------------------------------

### Install Pods with Repository Update

Source: https://support.axon.ai/en/max/cordova/preparing-mediated-networks

Run this command to install or update CocoaPods dependencies, ensuring you have the latest repository versions.

```bash
pod install --repo-update
```

```bash
pod install --repo-update
```

--------------------------------

### Countries Object Example

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

Example of a countries object used for whitelisting or blacklisting specific countries for an ad network ad unit.

```json
{
  "type": "INCLUDE",
  "values" : [
    "ca",
    "us"
  ]
}
```

--------------------------------

### Basic Gradle Configuration

Source: https://support.axon.ai/en/max/cordova/preparing-mediated-networks

This snippet shows a minimal Gradle configuration with only Google and Maven Central repositories and an empty dependencies block. It can serve as a base for further customization.

```groovy
// build.gradle
repositories {
    google()
    mavenCentral()


}


dependencies {


}

```

--------------------------------

### Load Rewarded Ad and Implement Listener (Kotlin)

Source: https://support.axon.ai/en/max/android/ad-formats/rewarded-ads

Shows how to initialize and load a rewarded ad in Kotlin, implementing `MaxRewardedAdListener` for ad lifecycle events. Includes logic for retrying ad loads with exponential backoff.

```kotlin
class ExampleActivity : Activity(), MaxRewardedAdListener
{
  private lateinit var rewardedAd: MaxRewardedAd
  private var retryAttempt = 0.0

  fun createRewardedAd()
  {
    rewardedAd = MaxRewardedAd.getInstance( "«ad-unit-ID»", this )
    rewardedAd.setListener( this )

    rewardedAd.loadAd()
  }

  // MAX Ad Listener
  override fun onAdLoaded(maxAd: MaxAd)
  {
    // Rewarded ad is ready to be shown. rewardedAd.isReady() will now return 'true'

    // Reset retry attempt
    retryAttempt = 0.0
  }

  override fun onAdLoadFailed(adUnitId: String?, error: MaxError?)
  {
    // Rewarded ad failed to load
    // AppLovin recommends that you retry with exponentially higher delays up to a maximum delay (in this case 64 seconds)

    retryAttempt++
    val delayMillis = TimeUnit.SECONDS.toMillis( Math.pow( 2.0, Math.min( 6.0, retryAttempt ) ).toLong() )

    Handler().postDelayed( { rewardedAd.loadAd() }, delayMillis )
  }

  override fun onAdDisplayFailed(ad: MaxAd?, error: MaxError?)
  {
    // Rewarded ad failed to display. AppLovin recommends that you load the next ad.
    rewardedAd.loadAd()
  }

  override fun onAdDisplayed(maxAd: MaxAd) {}

```

--------------------------------

### Ad Network Object Example

Source: https://support.axon.ai/en/max/advanced-features/ad-unit-management-api

An example of an Ad Network Object within the `ad_network_settings` array. This shows configuration for the AdMob network.

```json
{
  "ADMOB_NETWORK": {
    "disabled": true,
    "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981",
    "ad_network_ad_units": []
  }
}
```

--------------------------------

### API Response Body Example

Source: https://support.axon.ai/en/max/reporting-apis/user-level-ad-revenue-api

This is an example of the JSON response body returned by the API, containing status and URLs for the ad revenue reports.

```json
{
  "status": 200,
  "url": "https://applovin-externalreports.s3.amazonaws.com/%2Fmediation_reports/report_date%3D1549756800/pub_id%3D12345/mediation_app_id%3D12345/user_report.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190216T000208Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=dataio.amazon.s3.access_key%2F20190216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e45bdfbd88cbcf4e[…]927dd"
  "ad_revenue_report_url": "https://applovin-externalreports.s3.amazonaws.com/%2Fmediation_reports/report_date%3D1549756800/pub_id%3D12345/mediation_app_id%3D12345/user_report.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190216T000208Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=dataio.amazon.s3.access_key%2F20190216%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=e45bdfbd88cbcf4e[…]927dd"
}
```

--------------------------------

### Enable Verbose Logging - Defold

Source: https://support.axon.ai/en/max/defold/overview/advanced-settings

Enable verbose logging for the AppLovin SDK to aid in debugging. Check SDK logs for confirmation.

```lua
applovin.set_verbose_logging_enabled(true)
```

--------------------------------

### Initialize MAX SDK with Configuration

Source: https://support.axon.ai/en/max/android/overview/integration

Use this code to initialize the AppLovin MAX SDK with custom configurations, including mediation provider and segment settings. Ensure you replace placeholder values with your actual SDK key.

```Java
// Create the initialization configuration
AppLovinSdkInitializationConfiguration initConfig = AppLovinSdkInitializationConfiguration.builder( "«SDK-key»" )
    .setMediationProvider( AppLovinMediationProvider.MAX )
    .setSegmentCollection( MaxSegmentCollection.builder()
                             .addSegment( new MaxSegment( 849, Arrays.asList( 1, 3 ) ) )
                             .build() )
    .build();

// Configure the SDK settings if needed before or after SDK initialization.
val settings = AppLovinSdk.getInstance( this ).getSettings();
settings.setUserIdentifier( "«user-ID»" );
settings.setExtraParameter( "uid2_token", "«token-value»" );
settings.getTermsAndPrivacyPolicyFlowSettings().setEnabled( true );
settings.getTermsAndPrivacyPolicyFlowSettings().setPrivacyPolicyUri( Uri.parse( "«https://your-company-name.com/privacy-policy»" ) );
settings.getTermsAndPrivacyPolicyFlowSettings().setTermsOfServiceUri( Uri.parse( "«https://your-company-name.com/terms-of-service»" ) );

// Initialize the SDK with the configuration
AppLovinSdk.getInstance( this ).initialize( initConfig, new AppLovinSdk.SdkInitializationListener()
{
  @Override
  public void onSdkInitialized(final AppLovinSdkConfiguration sdkConfig)
  {
    // Start loading ads
  }
} );

```

```Kotlin
// Create the initialization configuration
val initConfig = AppLovinSdkInitializationConfiguration.builder("«SDK-key»")
    .setMediationProvider(AppLovinMediationProvider.MAX)
    .setSegmentCollection(MaxSegmentCollection.builder()
                            .addSegment(MaxSegment(849, listOf(1, 3)))
                            .build()
    )
    .build()

// Configure the SDK settings if needed before or after SDK initialization.
val settings = AppLovinSdk.getInstance(this).settings
settings.userIdentifier = "«user-ID»"
settings.setExtraParameter("uid2_token", "«token-value»")
settings.termsAndPrivacyPolicyFlowSettings.apply {
  isEnabled = true
  privacyPolicyUri = Uri.parse("«https://your-company-name.com/privacy-policy»")
  termsOfServiceUri = Uri.parse("«https://your-company-name.com/terms-of-service»")
}

// Initialize the SDK with the configuration
AppLovinSdk.getInstance(this).initialize(initConfig) { sdkConfig ->
  // Start loading ads
}

```

--------------------------------

### Initialize MAX SDK and Adjust SDK in Java

Source: https://support.axon.ai/en/max/android/overview/terms-and-privacy-policy-flow

Initialize the AppLovin MAX SDK with a mediation provider and set the user ID. Then, within the SDK initialization callback, initialize the Adjust SDK. This ensures third-party SDKs are initialized after user consent.

```java
package com.applovin.apps.test;

import com.adjust.sdk.Adjust;
import com.adjust.sdk.AdjustConfig;
import com.adjust.sdk.LogLevel;
import com.applovin.sdk.AppLovinMediationProvider;
import com.applovin.sdk.AppLovinSdk;
import com.applovin.sdk.AppLovinSdkConfiguration;
import com.applovin.sdk.AppLovinSdkInitializationConfiguration;
import com.applovin.sdk.AppLovinSdkSettings;

import lombok.val;

public class MyApplication
       extends Application
{
  @Override
  public void onCreate()
  {
    super.onCreate();

    // Create the initialization configuration
    AppLovinSdkInitializationConfiguration initConfig = AppLovinSdkInitializationConfiguration.builder( "«SDK-key»" )
        .setMediationProvider( AppLovinMediationProvider.MAX )
        .build();

    // Set the user ID
    val settings = AppLovinSdk.getInstance( this ).getSettings();
    settings.setUserIdentifier( "«user-ID»" );

    // Initialize the SDK with the configuration
    AppLovinSdk.getInstance( this ).initialize( initConfig, new AppLovinSdk.SdkInitializationListener()
    {
      @Override
      public void onSdkInitialized(final AppLovinSdkConfiguration sdkConfig)
      {
        // Initialize the Adjust SDK inside the AppLovin SDK's initialization callback
        AdjustConfig adjustConfig = new AdjustConfig( this, "«your-Adjust-app-token»", AdjustConfig.ENVIRONMENT_SANDBOX or AdjustConfig.ENVIRONMENT_PRODUCTION );
        Adjust.onCreate( adjustConfig );

        // Start loading ads
      }
    } );
  }
}

```

```java
package com.applovin.apps.test;


import com.adjust.sdk.Adjust;
import com.adjust.sdk.AdjustConfig;
import com.adjust.sdk.LogLevel;
import com.applovin.sdk.AppLovinMediationProvider;
import com.applovin.sdk.AppLovinSdk;
import com.applovin.sdk.AppLovinSdkConfiguration;
import com.applovin.sdk.AppLovinSdkInitializationConfiguration;
import com.applovin.sdk.AppLovinSdkSettings;


import lombok.val;


public class MyApplication
       extends Application
{
  @Override
  public void onCreate()
  {
    super.onCreate();


    // Create the initialization configuration
    AppLovinSdkInitializationConfiguration initConfig = AppLovinSdkInitializationConfiguration.builder( "«SDK-key»" )
        .setMediationProvider( AppLovinMediationProvider.MAX )
        .build();


    // Set the user ID
    val settings = AppLovinSdk.getInstance( this ).getSettings();
    settings.setUserIdentifier( "«user-ID»" );


    // Initialize the SDK with the configuration
    AppLovinSdk.getInstance( this ).initialize( initConfig, new AppLovinSdk.SdkInitializationListener()
    {
      @Override
      public void onSdkInitialized(final AppLovinSdkConfiguration sdkConfig)
      {
        // Initialize the Adjust SDK inside the AppLovin SDK's initialization callback
        AdjustConfig adjustConfig = new AdjustConfig( this, "«your-Adjust-app-token»", AdjustConfig.ENVIRONMENT_SANDBOX or AdjustConfig.ENVIRONMENT_PRODUCTION );
        Adjust.onCreate( adjustConfig );


        // Start loading ads
      }
    } );
  }
}

```

--------------------------------

### Initialize AppLovin SDK (Kotlin)

Source: https://support.axon.ai/en/max/android/overview/integration

Initialize the AppLovin SDK with the created configuration in your Activity's onCreate() method. This allows the SDK maximum time to cache ads.

```kotlin
class MainActivity : Activity()
{
  override fun onCreate(savedInstanceState: Bundle?)
  {
    // Create the initialization configuration
    val initConfig = AppLovinSdkInitializationConfiguration.builder("«SDK-key»")
                     .setMediationProvider(AppLovinMediationProvider.MAX)
                     .build()

    // Initialize the SDK with the configuration
    AppLovinSdk.getInstance(this).initialize(initConfig) { sdkConfig ->
      // Start loading ads
    }
  }
}
```

--------------------------------

### Configure Repositories and Dependencies

Source: https://support.axon.ai/en/max/cordova/preparing-mediated-networks

Ensure your project's build.gradle file includes Google and Maven Central repositories. This snippet shows the basic structure for repositories and an empty dependencies block.

```gradle
repositories {
    google()
    mavenCentral()


}


dependencies {


}
```

--------------------------------

### Limit GET Requests for Rules

Source: https://support.axon.ai/en/max/ad-review/rules-management-api

Use the `limit` query parameter to control the number of rules returned in a GET request and prevent timeouts. Use `offset` for pagination.

```http
GET /v1/rules/risky?limit=10&offset=0
```

```http
GET /v1/rules/risky?limit=10&offset=10
```

```http
GET /v1/rules/risky?limit=10&offset=20
```
Tokens:
Raw