AppLovin MAX Reporting APIs

https://support.axon.ai/en/max/reporting-apis/
Admin
AppLovin MAX Reporting APIs provide access to aggregated ad revenue performance data, user-level...
Tokens:18,854
Snippets:181
Trust Score:7.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### 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 from the API, containing status and URLs for 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"
}
```

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

### CSV Response Format Example

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

This is an example of a CSV formatted response. It includes column headers and comma-separated data rows.

```csv
day,country,application,installs,pub_revenue_7
2019-03-25,gb,"My Test App",142,81.24
2019-03-25,in,"My Test App",921,59.25

```

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

### JSON Response Format Example

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

This is an example of a JSON formatted response. It includes a status code, the number of results, and a list of data objects.

```json
{
  "code": 200,
  "results": [
    {
      "day": "2019-03-25",
      "country": "gb",
      "application": "My Test App",
      "installs": "142",
      "pub_revenue_7": "81.24"
    },
    {
      "day": "2019-03-25",
      "country": "in",
      "application": "My Test App",
      "installs": "921",
      "pub_revenue_7": "59.25”
    }
  ],
  "count": 2
}

```

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

### CSV Response Format Example

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

When `format=csv` is requested, the API returns a comma-separated text file. The column headers are included in the same order as specified in the `columns` parameter.

```text
day,hour,application,impressions
2019-03-25,00:00,"My Test App",987654
2019-03-25,01:00,"My Test App",819127


```

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

### 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.

### Request format

#### 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`.
```

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

### JSON Response Format Example

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

When `format=json` is requested, the API returns a JSON object. This object includes a `code` for the response status, `count` for the number of results, and a `results` array containing the data.

```json
{
  "code": 200,
  "results": [
    {
      "day": "2019-03-25",
      "hour": "00:00",
      "application": "My Test App",
      "impressions": "987654"
    },
    {
      "day": "2019-03-25",
      "hour": "01:00",
      "application": "My Test App",
      "impressions": "819127"
    }
  ],
  "count": 2
}


```

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

### Configure MAX Ad Placer Settings in Objective-C

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

Initialize MAAdPlacerSettings with an ad unit identifier and set the desired placement for ad serving.

```objectivec
MAAdPlacerSettings *settings = [MAAdPlacerSettings settingsWithAdUnitIdentifier: @"«ad-unit-ID»"];
settings.placement = @"«placement»";
```

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

### Configure Native Ads with Ad Placer in Java

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

Initialize and configure settings for native ads using the Ad Placer, including setting the placement for reporting.

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

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

### Configure MAX Ad Placer Settings in Kotlin

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

Initialize MaxAdPlacerSettings with an ad unit ID and set the desired placement for ad serving.

```kotlin
val settings = MaxAdPlacerSettings( "«ad-unit-ID»" )
settings.placement = "«placement»"
```

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

### Create and Set Banner Placement in Lua

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

Initialize a banner ad and set its placement using Lua functions. Provide the ad unit ID and position/placement details.

```lua
applovin.create_banner(«ad-unit-ID», «position»)
applovin.set_banner_placement(«ad-unit-ID», «placement»)
```

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

### Set Banner Placement and Load Ad in Objective-C

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

Configure the placement for a banner ad and initiate ad loading in Objective-C. This is done on an existing ad view instance.

```objectivec
adView.placement = @"«placement»";
[adView loadAd];
```

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

### Create and Set Banner Placement in C#

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

Use these functions to create a banner ad and set its placement. Replace `ad-unit-ID`, `position`, and `placement` with your specific values.

```C#
MaxSdk.CreateBanner(«ad-unit-ID», «position»);
MaxSdk.SetBannerPlacement(«ad-unit-ID», "«placement»");
```

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

### Create and Set Banner Placement in C++

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

Use these functions to create a banner ad and set its placement. Replace `ad-unit-ID`, `position`, and `placement` with your specific values.

```C++
UAppLovinMAX::CreateBanner(«ad-unit-ID», «position»);
UAppLovinMAX::SetBannerPlacement(«ad-unit-ID», «placement»);
```

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

### Show Rewarded Ad in Kotlin

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

Present a rewarded ad in Kotlin. Use the showAd method, providing the placement string.

```kotlin
rewardedAd.showAd( "«placement»" )
```

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

### Show Rewarded Ad (Max SDK)

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

Demonstrates how to display a rewarded ad using the Max SDK with an ad unit identifier, placement, and custom data.

```APIDOC
## MaxSdk.ShowRewardedAd

### Description
Displays a rewarded ad to the user.

### Method
MaxSdk.ShowRewardedAd

### Parameters
- **adUnitIdentifier** (string) - Required - The identifier for the ad unit.
- **placement** (string) - Required - The placement name for the ad.
- **custom data** (string) - Optional - Custom data to be passed with the ad request.
```

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

### Java - Ad Placer Settings

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

Code to configure ad placer settings in Java.

```APIDOC
## Java - Ad Placer Settings

### Description
Configures settings for ad placers.

### Method
MaxAdPlacerSettings settings = new MaxAdPlacerSettings(adUnitId)
settings.setPlacement(placement)

### Parameters
- **adUnitId** (string) - The ID of the ad unit.
- **placement** (string) - The placement for the ad placer.
```

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

### Load Ads with Placement - Swift

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

Set the placement for banner, interstitial, or rewarded ads before loading them. Ensure the placement string is correctly formatted.

```swift
adView.placement = "«placement»"
adView.loadAd()
```

```swift
interstitial.show(forPlacement: "«placement»")
```

```swift
rewardedAd.show(forPlacement: "«placement»")
```

```swift
nativeAdLoader.placement = "«placement»"
```

```swift
let settings = MAAdPlacerSettings(adUnitIdentifier: "«ad-unit-ID»")
settings.placement = @"«placement»"
```

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

### Show Rewarded Ad in Objective-C

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

Present a rewarded ad in Objective-C. Use the showAdForPlacement method, providing the placement string.

```objectivec
[rewardedAd showAdForPlacement: @"«placement»"];
```

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

### Set Placement for Native Ads in Java

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

Configure the placement for a native ad loader. This ensures proper tracking and reporting.

```java
nativeAdLoader.setPlacement( "«placement»" );
```

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

### Show Rewarded Ad (Kotlin)

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

Use this function to present a rewarded ad. Provide the placement and custom data as arguments.

```kotlin
MaxRewardedAd.showAd("placement", "custom data")
```

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

### Objective-C - Native Ads

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

Code snippets for configuring native ads in Objective-C.

```APIDOC
## Objective-C - Native Ads

### Description
Use these properties to configure native ads in Objective-C.

### Properties
- `nativeAdLoader.placement = @"placement"`: Sets the placement for the native ad loader.

### Parameters
- **placement** (NSString): The placement identifier for the native ad.
```

```APIDOC
## Objective-C - Native Ads (Ad Placer)

### Description
Configure native ads using `MAAdPlacerSettings` in Objective-C.

### Class
`MAAdPlacerSettings`

### Class Method
`+ (instancetype)settingsWithAdUnitIdentifier:(NSString *)adUnitIdentifier`

### Properties
- **placement** (NSString): Sets the placement identifier for the ad placer.
```

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

### Lua - Banners

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

Code snippets for creating and configuring banner ads in Lua.

```APIDOC
## Lua - Banners

### Description
Use these functions to create and configure banner ads in Lua.

### Functions
- `applovin.create_banner(adUnitId, position)`: Creates a banner ad.
- `applovin.set_banner_placement(adUnitId, placement)`: Sets the placement for a banner ad.

### Parameters
- **adUnitId** (string): The ID of the ad unit.
- **position** (string): The position of the banner ad.
- **placement** (string): The placement identifier for the banner ad.
```

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

### Set Banner Placement in Kotlin

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

Configure the placement for a banner ad in Kotlin. This is typically done on an existing ad view instance.

```kotlin
adView.setPlacement( "«placement»" )
```

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

### Kotlin - Native Ads

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

Code snippets for configuring native ads in Kotlin applications.

```APIDOC
## Kotlin - Native Ads

### Description
Use these methods to configure native ads in your Kotlin application.

### Methods
- `nativeAdLoader.setPlacement(placement)`: Sets the placement for the native ad loader.

### Parameters
- **placement** (string): The placement identifier for the native ad.
```

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

### Description
Configure native ads using the `MaxAdPlacerSettings` in Kotlin.

### Class
`MaxAdPlacerSettings`

### Constructor
`MaxAdPlacerSettings(adUnitId: String)`

### Properties
- **placement** (string): Sets the placement identifier for the ad placer.
```

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

### Show Rewarded Ad (Java)

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

Call this method to show a rewarded ad. Specify the placement and any custom data you wish to pass.

```java
MaxRewardedAd.showAd("placement", "custom data");
```

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

### Show Rewarded Ad in ActionScript

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

Use this to show a rewarded ad with a specified placement. Replace `ad-unit-ID` and `placement` with your specific values.

```ActionScript
AppLovinMAX.showRewardedAd(«ad-unit-ID», «placement»);
```

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

### Show Rewarded Ad in C#

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

Use this function to show a rewarded ad with a specified placement. Replace `ad-unit-ID` and `placement` with your specific values.

```C#
MaxSdk.ShowRewardedAd(«ad-unit-ID», "«placement»");
```

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

### Set Placement for Banner Ads in Java

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

Set the placement for an existing banner ad view. This is crucial for accurate ad reporting.

```java
adViewAd.setPlacement( "«placement»" );
```

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

### Objective-C - Banners

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

Code snippets for configuring banner ads in Objective-C.

```APIDOC
## Objective-C - Banners

### Description
Use these properties and methods to configure banner ads in Objective-C.

### Properties/Methods
- `adView.placement = @"placement"`: Sets the placement for the banner ad.
- `[adView loadAd]`: Loads the banner ad.

### Parameters
- **placement** (NSString): The placement identifier for the banner ad.
```

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

### Show Rewarded Ad (RewardedAd Class)

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

Initiates the display of a rewarded ad using the RewardedAd class, requiring an ad unit ID, placement, and custom data.

```APIDOC
## RewardedAd.showAd (AdUnitId)

### Description
Displays a rewarded ad using its ad unit ID.

### Method
RewardedAd.showAd

### Parameters
- **adUnitId** (string) - Required - The identifier for the ad unit.
- **placement** (string) - Required - The placement name for the ad.
- **custom data** (string) - Optional - Custom data to be passed with the ad request.
```

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

### Set Native Ad Placement in Kotlin

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

Define the placement for a native ad loader in Kotlin. This helps in tracking and reporting ad performance.

```kotlin
nativeAdLoader.setPlacement( "«placement»" )
```

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

### Show Rewarded Ad (Objective-C)

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

Call this method to display a rewarded ad. Pass the placement and custom data to this method.

```objectivec
-[MARewardedAd showAdForPlacement:customData:]
```

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

### Set Native Ad Placement in ActionScript

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

Use this to set the placement name for native ads. Replace `placement` with your specific value.

```ActionScript
nativeAdLoader.setPlacement(«placement»);
```

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

### Native Ad View Configuration (JavaScript)

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

Configure a NativeAdView component with its ad unit ID and custom data. Additional properties can be passed using '...'.

```javascript
<NativeAdView
  adUnitId={«ad-unit-ID»}
  customData="«custom-data»"
  ⋮
/>
```

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

### Setting an Ad Placement Name

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

These code snippets demonstrate how to set a placement name for an ad unit across different platforms and ad types. The placement name replaces the `{PLACEMENT}` macro in postback requests.

```APIDOC
## Setting an Ad Placement Name

These code snippets demonstrate how to set a placement name for an ad unit across different platforms and ad types. The placement name replaces the `{PLACEMENT}` macro in postback requests.

### ActionScript

```actionscript
AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);
AppLovinMAX.setMRecPlacement(«ad-unit-ID», «placement»);
AppLovinMAX.showInterstitial(«ad-unit-ID», «placement»);
nativeAdLoader.setPlacement(«placement»);
AppLovinMAX.showRewardedAd(«ad-unit-ID», «placement»);
```
```

```APIDOC
### C++

```cpp
UAppLovinMAX::SetBannerPlacement(«ad-unit-ID», «placement»);
UAppLovinMAX::SetMRecPlacement(«ad-unit-ID», «placement»);
UAppLovinMAX::ShowInterstitial(«ad-unit-ID», «placement»);
```
```

```APIDOC
### C#

```csharp
MaxSdk.SetBannerPlacement(«ad-unit-ID», "«placement»");
MaxSdk.SetMRecPlacement(«ad-unit-ID», "«placement»");
MaxSdk.ShowInterstitial(«ad-unit-ID», "«placement»");
MaxSdk.ShowRewardedAd(«ad-unit-ID», "«placement»");
```
```

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

### Kotlin - Banners

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

Code snippets for configuring banner ads in Kotlin applications.

```APIDOC
## Kotlin - Banners

### Description
Use these methods to configure banner ads in your Kotlin application.

### Methods
- `adView.setPlacement(placement)`: Sets the placement for the banner ad.

### Parameters
- **placement** (string): The placement identifier for the banner ad.
```

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

### Create and Configure Banner Ads in Dart

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

Use these functions to create and set the placement for banner ads in your Dart application. Ensure you have the AppLovinMAX SDK initialized.

```dart
AppLovinMAX.createBanner(«ad-unit-ID», «position»);
AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);
```

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

### Set Native Ad Placement in Objective-C

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

Define the placement for a native ad loader in Objective-C. This aids in tracking and reporting ad performance.

```objectivec
nativeAdLoader.placement = @"«placement»";
```

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

### Set Custom Data for Native Ads (Kotlin/Objective-C)

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

Sets custom data for a native ad loader in Kotlin or Objective-C.

```APIDOC
## nativeAdLoader.customData

### Description
Sets or gets the custom data for the native ad loader.

### Method
nativeAdLoader.customData

### Parameters
- **custom data** (string) - Required - The custom data to set.
```

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

### Create and Configure Banner Ads in GDScript

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

Use these functions to create and set the placement for banner ads in your GDScript application. Ensure you have the AppLovinMAX SDK initialized.

```gdscript
AppLovinMAX.createBanner(«ad-unit-ID», «position»);
AppLovinMAX.set_banner_placement(«ad-unit-ID», «placement»);
```

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

### Show Rewarded Ad (C#)

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

Use this method to display a rewarded ad. Ensure you provide the ad unit identifier, placement, and custom data.

```csharp
MaxSdk.ShowRewardedAd("adUnitIdentifier", "placement", "custom data");
```

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

### Show Rewarded Ad (Swift)

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

This method displays a rewarded ad. Ensure you provide the placement and custom data.

```swift
rewardedAd.show(forPlacement: "«placement»" customData: "«custom-data»")
```

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

### Java - Native Ads

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

Code to set placement for native ads in Java.

```APIDOC
## Java - Native Ads

### Description
Sets the placement for native ads.

### Method
nativeAdLoader.setPlacement(placement)

### Parameters
- **placement** (string) - The placement of the native ad.
```

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

### Show Rewarded Ad in Lua

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

Present a rewarded ad to users in Lua. Use the show_rewarded_ad function, providing the ad unit ID and placement.

```lua
applovin.show_rewarded_ad(«ad-unit-ID», «placement»);
```

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

### Show Rewarded Ad (Objective-C)

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

Objective-C method to show a rewarded ad for a given placement and custom data.

```APIDOC
## MARewardedAd.showAdForPlacement

### Description
Shows a rewarded ad using Objective-C, specifying placement and custom data.

### Method
-[MARewardedAd showAdForPlacement:customData:]

### Parameters
- **placement** (NSString *) - Required - The placement name for the ad.
- **customData** (NSString *) - Optional - Custom data to be passed with the ad request.
```

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

### Set Banner Placement in ActionScript

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

Use this to set the placement name for banner ads. Replace `ad-unit-ID` and `placement` with your specific values.

```ActionScript
AppLovinMAX.setBannerPlacement(«ad-unit-ID», «placement»);
```

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

### Set Custom Data for Native Ad Loader (Java)

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

Set custom data for the native ad loader. This data can be used for tracking or targeting purposes.

```java
nativeAdLoader.setCustomData( "«custom data»" );
```

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

### Create and Set MREC Placement in Lua

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

Create an MREC ad and set its placement in Lua. Ensure the ad unit ID and position/placement are correctly specified.

```lua
applovin.create_mrec(«ad-unit-ID», «position»)
applovin.set_mrec_placement(«ad-unit-ID», «placement»)
```

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

### Show Rewarded Ad (Swift)

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

Swift method to display a rewarded ad for a specific placement and custom data.

```APIDOC
## MARewardedAd.showAd (Swift)

### Description
Shows a rewarded ad in Swift, specifying placement and custom data.

### Method
rewardedAd.show(forPlacement:customData:)

### Parameters
- **placement** (String) - Required - The placement name for the ad.
- **customData** (String) - Optional - Custom data to be passed with the ad request.
```

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

### Lua - Rewarded Ads

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

Code snippet for showing rewarded ads in Lua.

```APIDOC
## Lua - Rewarded Ads

### Description
Use this function to show rewarded ads in Lua.

### Function
`applovin.show_rewarded_ad(adUnitId, placement)`

### Parameters
- **adUnitId** (string): The ID of the ad unit.
- **placement** (string): The placement identifier for the rewarded ad.
```

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

### Java - Banner Ads

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

Code to set placement for banner ads in Java.

```APIDOC
## Java - Banner Ads

### Description
Sets the placement for banner ads.

### Method
adViewAd.setPlacement(placement)

### Parameters
- **placement** (string) - The placement of the banner ad.
```

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

### Create and Set MRec Placement in C#

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

Use these functions to create an MRec ad and set its placement. Replace `ad-unit-ID`, `position`, and `placement` with your specific values.

```C#
MaxSdk.CreateMRec(«ad-unit-ID», «position»);
MaxSdk.SetMRecPlacement(«ad-unit-ID», "«placement»");
```

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

### Show Rewarded Ads in Java

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

Display a rewarded ad and specify its placement for reporting purposes.

```java
rewardedAd.showAd( "«placement»" );
```

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

### Create and Set MRec Placement in C++

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

Use these functions to create an MRec ad and set its placement. Replace `ad-unit-ID`, `position`, and `placement` with your specific values.

```C++
UAppLovinMAX::CreateMRec(«ad-unit-ID», «position»);
UAppLovinMAX::SetMRecPlacement(«ad-unit-ID», «placement»);
```

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

### Lua - MRECs

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

Code snippets for creating and configuring MREC ads in Lua.

```APIDOC
## Lua - MRECs

### Description
Use these functions to create and configure MREC ads in Lua.

### Functions
- `applovin.create_mrec(adUnitId, position)`: Creates an MREC ad.
- `applovin.set_mrec_placement(adUnitId, placement)`: Sets the placement for an MREC ad.

### Parameters
- **adUnitId** (string): The ID of the ad unit.
- **position** (string): The position of the MREC ad.
- **placement** (string): The placement identifier for the MREC ad.
```

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

### Set Custom Data for Native Ads (Java/JavaScript)

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

Sets custom data for a native ad loader in Java or JavaScript.

```APIDOC
## nativeAdLoader.setCustomData

### Description
Sets custom data for the native ad loader.

### Method
nativeAdLoader.setCustomData

### Parameters
- **custom data** (string) - Required - The custom data to set.
```

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

### Set Custom Data for Native Ad Loader (Kotlin)

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

Assign custom data to the native ad loader. This is useful for passing additional information with ad requests.

```kotlin
nativeAdLoader.setCustomData( "«custom data»" )
```

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

### Objective-C - Rewarded Ads

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

Code snippet for showing rewarded ads in Objective-C.

```APIDOC
## Objective-C - Rewarded Ads

### Description
Use this method to show rewarded ads in Objective-C.

### Method
`[rewardedAd showAdForPlacement: placement]`

### Parameters
- **placement** (NSString): The placement identifier for the rewarded ad.
```

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

### Set Custom Data for Banners and MRECs - Multiple Languages

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

Add custom String data to postbacks for banner and MREC ads. This data replaces the `{CUSTOM_DATA}` macro. Ensure custom data is set before loading the ad.

```csharp
MaxSdk.SetBannerCustomData("«ad-unit-ID»", "«custom-data»"); // Banners
MaxSdk.SetMRecCustomData("«ad-unit-ID»", "«custom-data»"); // MRECs
```

```java
adViewAd.setCustomData( "«custom-data»" );
```

```kotlin
BannerAd.setCustomData("«ad-unit-ID»", "«custom-data»"); // Banners
MRec.setCustomData("«ad-unit-ID»", "«custom-data»"); // MRECs
```

```objective-c
adView.customData = @"«custom-data»";
```

```swift
adView.customData = "«custom-data»"
```

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

### Show Interstitial Ad in Kotlin

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

Display an interstitial ad in Kotlin. Call the showAd method with the specified placement.

```kotlin
interstitial.showAd( "«placement»" )
```

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

### Setting Custom Data for Banners & MRECs

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

Add custom String data to postbacks for Banners and MRECs. This data replaces the `{CUSTOM_DATA}` macro. AppLovin recommends that your string contain fewer than 8192 characters. You must set custom data before you load an ad.

```APIDOC
## Custom data for Banners & MRECs
The following code snippets show you how to add custom String data to postbacks. This String data replaces the `{CUSTOM_DATA}` macro in these postbacks. AppLovin recommends that your string contain fewer than 8192 characters.
Note: You must set custom data before you load a banner ad or MREC ad. Otherwise that data will not appear in the postbacks associated with the ad.

### Swift
```swift
adView.customData = "«custom-data»"
```

### C#
```csharp
MaxSdk.SetBannerCustomData("«ad-unit-ID»", "«custom-data»"); // Banners
MaxSdk.SetMRecCustomData("«ad-unit-ID»", "«custom-data»"); // MRECs
```

### Java
```java
adViewAd.setCustomData( "«custom-data»" );
```

### JavaScript
```javascript
BannerAd.setCustomData("«ad-unit-ID»", "«custom-data»"); // Banners
MRec.setCustomData("«ad-unit-ID»", "«custom-data»"); // MRECs
```

### Kotlin
```kotlin
adView.setCustomData( "«custom-data»" )
```

### Objective-C
```objectivec
adView.customData = @"«custom-data»";
```
```

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

### Java - Rewarded Ads

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

Code to show rewarded ads in Java.

```APIDOC
## Java - Rewarded Ads

### Description
Shows rewarded ads.

### Method
rewardedAd.showAd(placement)

### Parameters
- **placement** (string) - The placement of the rewarded ad.
```

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

### NativeAdView Component

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

Configuration for a NativeAdView component, including ad unit ID and custom data.

```APIDOC
## NativeAdView

### Description
React Native component for displaying native ads.

### Props
- **adUnitId** (string) - Required - The identifier for the ad unit.
- **customData** (string) - Optional - Custom data to be passed with the ad request.
```

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

### Show Interstitial Ad in ActionScript

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

Use this to show an interstitial ad with a specified placement. Replace `ad-unit-ID` and `placement` with your specific values.

```ActionScript
AppLovinMAX.showInterstitial(«ad-unit-ID», «placement»);
```

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

### Lua - Interstitials

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

Code snippet for showing interstitial ads in Lua.

```APIDOC
## Lua - Interstitials

### Description
Use this function to show interstitial ads in Lua.

### Function
`applovin.show_interstitial(adUnitId, placement)`

### Parameters
- **adUnitId** (string): The ID of the ad unit.
- **placement** (string): The placement identifier for the interstitial ad.
```

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

### Show Rewarded Ad (JavaScript)

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

Invoke this function to display a rewarded ad. The ad unit ID, placement, and custom data are required parameters.

```javascript
RewardedAd.showAd(adUnitId, "«placement»", "«custom data»");
```

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

### Kotlin - Rewarded Ads

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

Code snippet for showing rewarded ads in Kotlin applications.

```APIDOC
## Kotlin - Rewarded Ads

### Description
Use this method to show rewarded ads in your Kotlin application.

### Method
`rewardedAd.showAd(placement)`

### Parameters
- **placement** (string): The placement identifier for the rewarded ad.
```

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

### Set Custom Data for Native Ad Loader (Swift)

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

Set custom data for the native ad loader. This property allows you to pass extra information with ad requests.

```swift
nativeAdLoader.customData = "«custom data»"
```

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

### Show Rewarded Ad (MaxRewardedAd)

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

Shows a rewarded ad using the MaxRewardedAd class, specifying placement and custom data.

```APIDOC
## MaxRewardedAd.showAd (Placement)

### Description
Shows a rewarded ad for a specified placement.

### Method
MaxRewardedAd.showAd

### Parameters
- **placement** (string) - Required - The placement name for the ad.
- **custom data** (string) - Optional - Custom data to be passed with the ad request.
```

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

### Show Rewarded Ad in React Native

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

Present a rewarded ad to users. Use the showAd method with the appropriate ad unit ID and placement.

```javascript
import { RewardedAd } from 'react-native-applovin-max';
⋮
rewardedAd.showAd(«ad-unit-ID», "«placement»");
```

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

### Render Native Ad using React Native NativeAdView

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

Integrate native ads using the NativeAdView component. Provide the ad unit ID and placement.

```javascript
<NativeAdView
  adUnitId={«ad-unit-ID»}
  placement="«placement»"
  ⋮
/>
```

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

### JavaScript (React Native) - Banners

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

Code snippets for creating and configuring banners in React Native applications using AppLovinMAX.

```APIDOC
## JavaScript (React Native) - Banners

### Description
Use these methods to create and configure banner ads in your React Native application.

### Methods
- `AppLovinMAX.createBanner(adUnitId, position)`: Creates a banner ad.
- `AppLovinMAX.setBannerPlacement(adUnitId, placement)`: Sets the placement for a banner ad.

### Parameters
- **adUnitId** (string): The ID of the ad unit.
- **position** (string): The position of the banner ad (e.g., 'top', 'bottom').
- **placement** (string): The placement identifier for the banner ad.
```

```APIDOC
## React Native UI Component - Banner Ad

### Description
Utilize the `AdView` component for rendering banner ads within your React Native UI.

### Component
`<AdView />`

### Props
- **adUnitId** (string): Required. The ID of the ad unit.
- **adFormat** (AdFormat): Required. Must be set to `AdFormat.BANNER`.
- **placement** (string): Optional. The placement identifier for the banner ad.
```

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

### Show Interstitial Ad in C#

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

Use this function to show an interstitial ad with a specified placement. Replace `ad-unit-ID` and `placement` with your specific values.

```C#
MaxSdk.ShowInterstitial(«ad-unit-ID», "«placement»");
```

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

### Setting Custom Data for Interstitials

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

Add custom String data to postbacks for Interstitials. This data replaces the `{CUSTOM_DATA}` macro. AppLovin recommends that your string contain fewer than 8192 characters.

```APIDOC
## Custom data for Interstitials
The following code snippets show you how to add custom String data to postbacks. This String data replaces the `{CUSTOM_DATA}` macro in these postbacks. AppLovin recommends that your string contain fewer than 8192 characters.

### Swift
```swift
[interstitialAd showAdForPlacement: @"«placement»" customData: @"«custom-data»"];
```

### C#
```csharp
MaxSdk.ShowInterstitial(«adUnitIdentifier», «placement», «custom data»);
```

### Java
```java
MaxInterstitialAd.showAd(«placement», «custom data»)
```

### JavaScript
```javascript
InterstitialAd.showAd(interAdUnitId, "«placement»", "«custom data»");
```

### Kotlin
```kotlin
MaxInterstitialAd.showAd(«placement», «custom data»)
```

### Objective-C
```objectivec
-[MAInterstitialAd showAdForPlacement:customData:]
```
```

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

### Kotlin - Interstitials

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

Code snippet for showing interstitial ads in Kotlin applications.

```APIDOC
## Kotlin - Interstitials

### Description
Use this method to show interstitial ads in your Kotlin application.

### Method
`interstitial.showAd(placement)`

### Parameters
- **placement** (string): The placement identifier for the interstitial ad.
```

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

### Show Interstitial Ad in C++

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

Use this function to show an interstitial ad with a specified placement. Replace `ad-unit-ID` and `placement` with your specific values.

```C++
UAppLovinMAX::ShowInterstitial(«ad-unit-ID», «placement»);
```

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

### Show Interstitial Ads in Java

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

Display an interstitial ad and specify its placement for reporting purposes.

```java
interstitial.showAd( "«placement»" );
```

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

### GDScript - Banner Ads

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

Code to create and set placement for banner ads in GDScript.

```APIDOC
## GDScript - Banner Ads

### Description
Creates and configures banner ads.

### Method
AppLovinMAX.createBanner(ad_unit_id, position)
AppLovinMAX.set_banner_placement(ad_unit_id, placement)

### Parameters
- **ad_unit_id** (string) - The ID of the ad unit.
- **position** (string) - The position of the banner.
- **placement** (string) - The placement of the banner.
```

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

### Create and Set MREC Placement in React Native

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

Use MRecAd functions to create an MREC ad and set its placement. Provide the ad unit ID and position/placement details.

```javascript
import { MRecAd } from 'react-native-applovin-max';
⋮
MRecAd.createAd(«ad-unit-ID», «position»);
MRecAd.setPlacement(«ad-unit-ID», «placement»);
```

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

### Set Custom Data for Interstitials - Multiple Languages

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

Add custom String data to postbacks for interstitial ads. This data replaces the `{CUSTOM_DATA}` macro. The string should contain fewer than 8192 characters.

```csharp
MaxSdk.ShowInterstitial(«adUnitIdentifier», «placement», «custom data»);
```

```java
MaxInterstitialAd.showAd(«placement», «custom data»);
```

```kotlin
InterstitialAd.showAd(interAdUnitId, "«placement»", "«custom data»");
```

```objective-c
-[MAInterstitialAd showAdForPlacement:customData:]
```

```swift
[interstitialAd showAdForPlacement: @"«placement»" customData: @"«custom-data»"];
```

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

### Create and Configure MRec Ads in GDScript

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

Use these functions to create and set the placement for MRec ads in your GDScript application. Ensure you have the AppLovinMAX SDK initialized.

```gdscript
AppLovinMAX.createMRec(«ad-unit-ID», «position»);
AppLovinMAX.set_mrec_placement(«ad-unit-ID», «placement»);
```

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

### Objective-C - Interstitials

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

Code snippet for showing interstitial ads in Objective-C.

```APIDOC
## Objective-C - Interstitials

### Description
Use this method to show interstitial ads in Objective-C.

### Method
`[interstitialAd showAdForPlacement: placement]`

### Parameters
- **placement** (NSString): The placement identifier for the interstitial ad.
```

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

### Java - Interstitial Ads

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

Code to show interstitial ads in Java.

```APIDOC
## Java - Interstitial Ads

### Description
Shows interstitial ads.

### Method
interstitial.showAd(placement)

### Parameters
- **placement** (string) - The placement of the interstitial ad.
```

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

### Render Banner Ad using React Native AdView

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

Integrate banner ads using the AdView component. Specify the ad unit ID, format as BANNER, and set the placement.

```javascript
import { AdView, AdFormat } from 'react-native-applovin-max';
⋮
<AdView adUnitId={«ad-unit-ID»}
        adFormat={AdFormat.BANNER} 
        placement={«placement»} />
```

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

### Show Interstitial Ad in Objective-C

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

Display an interstitial ad in Objective-C. Call the showAdForPlacement method with the specified placement.

```objectivec
[interstitialAd showAdForPlacement: @"«placement»"];
```

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

### Create and Configure MRec Ads in Dart

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

Use these functions to create and set the placement for MRec ads in your Dart application. Ensure you have the AppLovinMAX SDK initialized.

```dart
AppLovinMAX.createMRec(«ad-unit-ID», «position»);
AppLovinMAX.setMRecPlacement(«ad-unit-ID», «placement»);
```

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

### Dart - Banner Ads

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

Code to create and set placement for banner ads in Dart.

```APIDOC
## Dart - Banner Ads

### Description
Creates and configures banner ads.

### Method
AppLovinMAX.createBanner(adUnitId, position)
AppLovinMAX.setBannerPlacement(adUnitId, placement)

### Parameters
- **adUnitId** (string) - The ID of the ad unit.
- **position** (string) - The position of the banner.
- **placement** (string) - The placement of the banner.
```

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

### Show Rewarded Ads in GDScript

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

Call this function to display a rewarded ad. Provide the ad unit ID and the desired placement for reporting.

```gdscript
AppLovinMAX.show_rewarded_ad(«ad-unit-ID», «placement»);
```

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

### Show Interstitial Ad in React Native

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

Display an interstitial ad by calling the showAd method. Ensure the ad unit ID and placement are correctly configured.

```javascript
import { InterstitialAd } from 'react-native-applovin-max';
⋮
InterstitialAd.showAd(«ad-unit-ID», "«placement»");
```

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

### JavaScript (Cordova) - Banner Ads

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

Code to create and set placement for banner ads in JavaScript (Cordova).

```APIDOC
## JavaScript (Cordova) - Banner Ads

### Description
Creates and configures banner ads.

### Method
AppLovinMAX.createBanner(adUnitId, position)
AppLovinMAX.setBannerPlacement(adUnitId, placement)

### Parameters
- **adUnitId** (string) - The ID of the ad unit.
- **position** (string) - The position of the banner.
- **placement** (string) - The placement of the banner.
```

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

### Setting a User ID

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

Tag users with your own internal User ID. The maximum size of the User ID string is 8192 characters.

```APIDOC
## Setting an internal user ID
The following code snippets show how to tag users with your own internal User ID. The maximum size of the User ID string is 8192 characters.

### Swift
```swift
AppLovinMAX.setUserId("«user-ID»")
```

### Kotlin
```kotlin
val settings = AppLovinSdk.getInstance( this ).settings
settings.userIdentifier = "«user-ID»"
```

### C#
```csharp
MaxSdk.SetUserId("«user-ID»");
```

### Java
```java
AppLovinMAX.setUserId("«user-ID»");
```

### JavaScript
```javascript
applovin.set_user_id("«user-ID»")
```

### Objective-C
```objectivec
ALSdkSettings *settings = [ALSdk shared].settings;
settings.userIdentifier = @"«user-ID»";
```
```

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

### Set Custom Data for Native Ad Loader (Objective-C)

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

Assign custom data to the native ad loader. This property is used to pass additional information with ad requests.

```objectivec
nativeAdLoader.customData = @"«custom data»";
```

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

### Show Rewarded Ads in Dart

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

Call this function to display a rewarded ad. Provide the ad unit ID and the desired placement for reporting.

```dart
AppLovinMAX.showRewardedAd(«ad-unit-ID», placement: «placement»);
```
Tokens:
Raw