Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,26 @@

| Category | Requires | Version |
|:--------:|:-------:|:--------:|
|**Monetization > Advertising**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">1</span>|
|**Deprecated**|<span class="chip chip-any">API 21, Android 5.0 Lollipop</span>|<span class="chip chip-number">2</span>|

!!! danger "Deprecated component"
This component is deprecated. Projects that still contain it will fail to build until it is removed. You can still load existing projects in the Designer and live-test them with the Companion while you migrate, but APK and AAB builds are blocked. Look for an up-to-date replacement in the active component palette.

## Overview

A non-visible component to show ads from AppLovin.

??? example "Permissions"
* [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission.html#INTERNET)
* [android.permission.ACCESS_NETWORK_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_NETWORK_STATE)

!!! info "Commission"
**Type:** Fixed Rate
**Value:** `8%`

## Events

### Ad Closed

Called when an ad was closed.
Deprecated. Never fires.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Ad%20Closed%22,%20%22param%22:%20%5B%5D%7D"></div>

### Ad Failed To Load

Called when an ad request failed to load. The message will display the error code and error message.
Deprecated. Never fires.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Ad%20Failed%20To%20Load%22,%20%22param%22:%20%5B%22error%20Code%22,%20%22error%20Message%22%5D%7D"></div>

Expand All @@ -39,25 +34,25 @@ Called when an ad request failed to load. The message will display the error cod

### Ad Loaded

Called when an ad is received.
Deprecated. Never fires.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Ad%20Loaded%22,%20%22param%22:%20%5B%5D%7D"></div>

### Ad Opened

Called when an ad was opened.
Deprecated. Never fires.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Ad%20Opened%22,%20%22param%22:%20%5B%5D%7D"></div>

### Ad Started

Called when an ad was started.
Deprecated. Never fires.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Ad%20Started%22,%20%22param%22:%20%5B%5D%7D"></div>

### Error

Called when an ad request failed. The message will display the reason for why the ad failed.
Deprecated. Never fires.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Error%22,%20%22param%22:%20%5B%22error%20Code%22,%20%22error%20Message%22%5D%7D"></div>

Expand All @@ -70,27 +65,27 @@ Called when an ad request failed. The message will display the reason for why th

### Initialize

Initialize the AppLovin SDK. You should call this function before loading ads to ensure proper initialization.
Deprecated. Does nothing.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Initialize%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

### Is European User

<span class="chip chip-boolean">Returns: <i>Boolean</i></span>

Returns true if the current app user is located in europe. If true you must ask the user as example in a dialog if he give his consent for personalized ads.
Deprecated. Always returns false.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Is%20European%20User%22,%20%22output%22:%20true,%20%22param%22:%20%5B%5D%7D"></div>

### Load Ad

Loads a new ad.
Deprecated. Does nothing.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Load%20Ad%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

### Show Ad

Shows an ad to the user.
Deprecated. Does nothing.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Show%20Ad%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

Expand All @@ -108,7 +103,7 @@ Property for SdkKey

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>False</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

With AppLovin SDK 13.2.0+, test mode must be configured through the AppLovin dashboard. This property is maintained for backwards compatibility but has no effect.
Deprecated. Does nothing.

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Test%20Mode%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22Test%20Mode%22,%20%22getter%22:%20false%7D"></div>
Expand All @@ -117,7 +112,7 @@ With AppLovin SDK 13.2.0+, test mode must be configured through the AppLovin das

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Blocks</span></span>

If set to true the user allowed the ad network to show personalized ads. You only need to request the consent from european users.
Deprecated. Does nothing.

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22User%20Consent%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Interstitial%22,%20%22name%22:%20%22User%20Consent%22,%20%22getter%22:%20false%7D"></div>
7 changes: 6 additions & 1 deletion docs/components/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,12 @@
- AdColony Interstitial: components/monetization/advertising/adcolony-interstitial.md
- Amazon Banner: components/monetization/advertising/amazon-banner.md
- Amazon Interstitial: components/monetization/advertising/amazon-interstitial.md
- AppLovin Interstitial: components/monetization/advertising/applovin-interstitial.md
- AppLovin Max App Open: components/monetization/advertising/applovin-max-app-open.md
- AppLovin Max Banner: components/monetization/advertising/applovin-max-banner.md
- AppLovin Max Interstitial: components/monetization/advertising/applovin-max-interstitial.md
- AppLovin Max MREC: components/monetization/advertising/applovin-max-mrec.md
- AppLovin Max Native: components/monetization/advertising/applovin-max-native.md
- AppLovin Max Rewarded: components/monetization/advertising/applovin-max-rewarded.md
- Facebook Banner: components/monetization/advertising/facebook-banner.md
- Facebook Interstitial: components/monetization/advertising/facebook-interstitial.md
- Facebook Rewarded Video: components/monetization/advertising/facebook-rewarded-video.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@ A non-visible component that shows AdColony ads as full-screen advertisements.
* [android.permission.ACCESS_NETWORK_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_NETWORK_STATE)
* [android.permission.VIBRATE](https://developer.android.com/reference/android/Manifest.permission.html#VIBRATE)

!!! info "Commission"
**Type:** Fixed Rate
**Value:** `8%`
!!! info "Subscription"
This component requires an active **Kodular Premium** subscription. See [my.kodular.io/premium](https://my.kodular.io/premium).

## Events

Expand Down
5 changes: 2 additions & 3 deletions docs/components/monetization/advertising/amazon-banner.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ AdAmazon component allows you to monetize your app. You must have a valid publis
* [android.permission.ACCESS_NETWORK_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_NETWORK_STATE)
* [android.permission.ACCESS_WIFI_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_WIFI_STATE)

!!! info "Commission"
**Type:** Fixed Rate
**Value:** `6%`
!!! info "Subscription"
This component requires an active **Kodular Premium** subscription. See [my.kodular.io/premium](https://my.kodular.io/premium).

## Events

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ An interstitial ad is a full-page ad. AdAmazonInterstitial component allows you
* [android.permission.ACCESS_NETWORK_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_NETWORK_STATE)
* [android.permission.ACCESS_WIFI_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_WIFI_STATE)

!!! info "Commission"
**Type:** Fixed Rate
**Value:** `9%`
!!! info "Subscription"
This component requires an active **Kodular Premium** subscription. See [my.kodular.io/premium](https://my.kodular.io/premium).

## Events

Expand Down
108 changes: 108 additions & 0 deletions docs/components/monetization/advertising/applovin-max-app-open.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
# AppLovin Max App Open

{>> Non-Visible component<<}

| Category | Requires | Version |
|:--------:|:-------:|:--------:|
|**Monetization > Advertising**|<span class="chip chip-any">API 24, Android 7.0 Nougat</span>|<span class="chip chip-number">1</span>|

==This component requires a higher **Minimum Android SDK** in your app (_API 21, Android 5.0 Lollipop_ -> _API 24, Android 7.0 Nougat_)==

## Overview

Shows AppLovin MAX app open ads when the app returns to the foreground. Requires an AppLovin SDK key in the project settings and a MAX app open ad unit ID.

??? example "Permissions"
* [com.google.android.gms.permission.AD_ID](https://developer.android.com/reference/android/Manifest.permission.html#com.google.android.gms.permission.AD_ID)
* [android.permission.INTERNET](https://developer.android.com/reference/android/Manifest.permission.html#INTERNET)
* [android.permission.ACCESS_NETWORK_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_NETWORK_STATE)
* [android.permission.ACCESS_WIFI_STATE](https://developer.android.com/reference/android/Manifest.permission.html#ACCESS_WIFI_STATE)

!!! info "Kodular Monetize"
This component requires **Kodular Monetize** to be activated. See [my.kodular.io/monetize](https://my.kodular.io/monetize) and the [Monetize rates](https://kodul.ar/monetize-rates).

## Events

### Ad Clicked

Event raised when an ad was clicked.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Ad%20Clicked%22,%20%22param%22:%20%5B%5D%7D"></div>

### Ad Closed

Event raised when an ad was closed.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Ad%20Closed%22,%20%22param%22:%20%5B%5D%7D"></div>

### Ad Opened

Event raised when an ad was opened.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Ad%20Opened%22,%20%22param%22:%20%5B%5D%7D"></div>

### Failed To Load

Event raised when an ad could not be loaded.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Failed%20To%20Load%22,%20%22param%22:%20%5B%22error%20Message%22%5D%7D"></div>

| Param | Type |
|--------|------|
|error Message|<span class="chip chip-text">Text</span>|

### Failed To Show

Event raised when an ad could not be shown.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Failed%20To%20Show%22,%20%22param%22:%20%5B%22error%20Message%22%5D%7D"></div>

| Param | Type |
|--------|------|
|error Message|<span class="chip chip-text">Text</span>|

### Loaded

Event raised when an ad was loaded successfully.

<div class="block" ai2-block="event" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Loaded%22,%20%22param%22:%20%5B%5D%7D"></div>

## Methods

### Load

Loads an app open ad and prepares it for showing.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Load%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

### Show

Displays a previously loaded app open ad.

<div class="block" ai2-block="method" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Show%22,%20%22output%22:%20false,%20%22param%22:%20%5B%5D%7D"></div>

## Properties

### Ad Unit Id

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-text">Text</span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

Sets the MAX ad unit ID for app open ads.

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Ad%20Unit%20Id%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22Ad%20Unit%20Id%22,%20%22getter%22:%20false%7D"></div>

### AutoShowOnForeground

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>False</i></span> :heavy_minus_sign: <span class="chip chip-rw">Read</span> <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span> <span class="chip chip-bd">Blocks</span></span>

If enabled, a loaded app open ad is automatically shown when the app returns to the foreground.

<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22AutoShowOnForeground%22,%20%22getter%22:%20true%7D"></div>
<div class="block" ai2-block="property" not-rendered="true" value="%7B%22componentName%22:%20%22AppLovin%20Max%20App%20Open%22,%20%22name%22:%20%22AutoShowOnForeground%22,%20%22getter%22:%20false%7D"></div>

### Test Mode

<span style="user-select: none; white-space:pre-wrap;"><span class="chip chip-boolean">Boolean</span> <span class="chip chip-boolean">Default: <i>False</i></span> :heavy_minus_sign: <span class="chip chip-rw">Write</span> - <span class="chip chip-bd">Designer</span></span>

If enabled, the ad is treated as a test ad. Always enabled in companion. Note: AppLovin MAX test ads are configured through the MAX dashboard (test device GAIDs); this property only controls Kodular-side test behavior.
Loading
Loading