Godot AdMob Plugin

https://poingstudios.github.io/godot-admob-plugin/stable
Admin
Godot AdMob Plugin is a GDScript-based integration tool that enables Godot developers to easily...
Tokens:19,885
Snippets:199
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Implement Anchored Adaptive Banners

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/banner/sizes/anchored_adaptive

Examples for loading and displaying an anchored adaptive banner in Godot.

```GDScript
extends Node2D

var _ad_view : AdView
var _ad_listener := AdListener.new()

func _ready() -> void:
    var on_initialization_complete_listener := OnInitializationCompleteListener.new()
    on_initialization_complete_listener.on_initialization_complete = func(initialization_status : InitializationStatus) -> void:
        _request_ad_view()
    MobileAds.initialize(on_initialization_complete_listener)

    _ad_listener.on_ad_failed_to_load = _on_ad_failed_to_load
    _ad_listener.on_ad_loaded = _on_ad_loaded

func _request_ad_view() -> void:
    var unit_id : String
    if OS.get_name() == "Android":
        unit_id = "ca-app-pub-3940256099942544/6300978111"
    elif OS.get_name() == "iOS":
        unit_id = "ca-app-pub-3940256099942544/6300978111"

    if (_ad_view != null):
        _ad_view.destroy()

    var adaptive_size := AdSize.get_current_orientation_anchored_adaptive_banner_ad_size(AdSize.FULL_WIDTH) 
    _ad_view = AdView.new(unit_id, adaptive_size, AdPosition.Values.TOP)
    _ad_view.ad_listener = _ad_listener

    _ad_view.load_ad(AdRequest.new())

func _on_ad_failed_to_load(load_ad_error : LoadAdError) -> void:
    print("_on_ad_failed_to_load: " + load_ad_error.message)

func _on_ad_loaded() -> void:
    print("_on_ad_loaded")
```

```C#
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Listeners;
using PoingStudios.AdMob.Api.Core;

public partial class AnchoredAdaptiveExample : Node2D
{
    private AdView _adView;
    private AdListener _adListener;

    public override void _Ready()
    {
        var onInitializationCompleteListener = new OnInitializationCompleteListener
        {
            OnInitializationComplete = (InitializationStatus status) => RequestAdView()
        };
        MobileAds.Initialize(onInitializationCompleteListener);

        _adListener = new AdListener
        {
            OnAdFailedToLoad = OnAdFailedToLoad,
            OnAdLoaded = OnAdLoaded
        };
    }

    private void RequestAdView()
    {
        string unitId = null;
        if (OS.GetName() == "Android")
            unitId = "ca-app-pub-3940256099942544/6300978111";
        else if (OS.GetName() == "iOS")
            unitId = "ca-app-pub-3940256099942544/6300978111";

        if (_adView != null)
            _adView.Destroy();

        var adaptiveSize = AdSize.GetCurrentOrientationAnchoredAdaptiveBannerAdSize(AdSize.FullWidth);
        _adView = new AdView(unitId, adaptiveSize, AdPosition.Top);
        _adView.AdListener = _adListener;

        _adView.LoadAd(new AdRequest());
    }

    private void OnAdFailedToLoad(LoadAdError loadAdError)
    {
        GD.Print("_on_ad_failed_to_load: " + loadAdError.Message);
    }

    private void OnAdLoaded()
    {
        GD.Print("_on_ad_loaded");
    }
}
```

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

### Reset Consent State

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/get_started

Resets the SDK state to simulate a first-time install. Use only for testing purposes.

```GDScript
UserMessagingPlatform.consent_information.reset()
```

```C#
UserMessagingPlatform.ConsentInformation.Reset();
```

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

### Update consent information on app start

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/get_started

Request an update of the user's consent information at every app launch to determine if a consent form needs to be displayed.

```GDScript
extends Node

func _ready():
    var request := ConsentRequestParameters.new()
    # Set tag for underage of consent. false means users are not underage.
    request.tag_for_under_age_of_consent = false
    UserMessagingPlatform.consent_information.update(request, _on_consent_info_updated_success, _on_consent_info_updated_failure)

func _on_consent_info_updated_success():
    # The consent information state was updated.
    # You are now ready to check if a form is available.
    pass

func _on_consent_info_updated_failure(form_error : FormError):
    # Handle the error.
    pass
```

```C#
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Ump.Api;
using PoingStudios.AdMob.Ump.Core;

public partial class UmpExample : Node
{
    public override void _Ready()
    {
        var request = new ConsentRequestParameters();
        // Set tag for underage of consent. false means users are not underage.
        request.TagForUnderAgeOfConsent = false;
        UserMessagingPlatform.ConsentInformation.Update(request, OnConsentInfoUpdatedSuccess, OnConsentInfoUpdatedFailure);
    }

    private void OnConsentInfoUpdatedSuccess()
    {
        // The consent information state was updated.
        // You are now ready to check if a form is available.
    }

    private void OnConsentInfoUpdatedFailure(FormError formError)
    {
        // Handle the error.
    }
}
```

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

### Configure FullScreenContentCallback

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/interstitial

Sets up callbacks to handle ad events like clicks, dismissals, and failures before presenting the ad.

```GDScript
extends Node2D

var _interstitial_ad : InterstitialAd
var _full_screen_content_callback := FullScreenContentCallback.new()

func _ready() -> void:
    #...
    _full_screen_content_callback.on_ad_clicked = func() -> void:
        print("on_ad_clicked")
    _full_screen_content_callback.on_ad_dismissed_full_screen_content = func() -> void:
        print("on_ad_dismissed_full_screen_content")
    _full_screen_content_callback.on_ad_failed_to_show_full_screen_content = func(ad_error : AdError) -> void:
        print("on_ad_failed_to_show_full_screen_content")
    _full_screen_content_callback.on_ad_impression = func() -> void:
        print("on_ad_impression")
    _full_screen_content_callback.on_ad_showed_full_screen_content = func() -> void:
        print("on_ad_showed_full_screen_content")

func _on_load_pressed():
    #...
    var interstitial_ad_load_callback := InterstitialAdLoadCallback.new()

    #...

    interstitial_ad_load_callback.on_ad_loaded = func(interstitial_ad : InterstitialAd) -> void:
        print("interstitial ad loaded" + str(interstitial_ad._uid))
        _interstitial_ad = interstitial_ad
        _interstitial_ad.full_screen_content_callback = _full_screen_content_callback

    #...
```

```C#
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Core;
using PoingStudios.AdMob.Api.Listeners;

public partial class InterstitialAdExample : Node2D
{
    private InterstitialAd _interstitialAd;
    private FullScreenContentCallback _fullScreenContentCallback;

    public override void _Ready()
    {
        //...
        _fullScreenContentCallback = new FullScreenContentCallback
        {
            OnAdClicked = () => GD.Print("on_ad_clicked"),
            OnAdDismissedFullScreenContent = () => GD.Print("on_ad_dismissed_full_screen_content"),
            OnAdFailedToShowFullScreenContent = (AdError adError) => GD.Print("on_ad_failed_to_show_full_screen_content"),
            OnAdImpression = () => GD.Print("on_ad_impression"),
            OnAdShowedFullScreenContent = () => GD.Print("on_ad_showed_full_screen_content")
        };
    }

    private void OnLoadPressed()
    {
        //...
        var interstitialAdLoadCallback = new InterstitialAdLoadCallback
        {
            //...
            OnAdLoaded = (InterstitialAd interstitialAd) => 
            {
                GD.Print("interstitial ad loaded");
                _interstitialAd = interstitialAd;
                _interstitialAd.FullScreenContentCallback = _fullScreenContentCallback;
            }
        };
        //...
    }
}
```

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

### Initialize Mobile Ads SDK and verify adapter status

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/get_started

Initializes the SDK and iterates through the adapter status map to verify initialization results.

```GDScript
extends Control

func _ready() -> void:
    var on_initialization_complete_listener := OnInitializationCompleteListener.new()
    on_initialization_complete_listener.on_initialization_complete = _on_initialization_complete
    MobileAds.initialize(on_initialization_complete_listener)

func _on_initialization_complete(initialization_status : InitializationStatus) -> void:
    print("MobileAds initialization complete")
    for key in initialization_status.adapter_status_map:
        var adapterStatus : AdapterStatus = initialization_status.adapter_status_map[key]
        prints(
            "Key:", key, 
            "Latency:", adapterStatus.latency, 
            "Initialization Status:", adapterStatus.initialization_status, 
            "Description:", adapterStatus.description
        )
```

```C#
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Listeners;
using PoingStudios.AdMob.Api.Core;

public partial class MediationExample : Control
{
    public override void _Ready()
    {
        var onInitializationCompleteListener = new OnInitializationCompleteListener
        {
            OnInitializationComplete = OnInitializationComplete
        };
        MobileAds.Initialize(onInitializationCompleteListener);
    }

    private void OnInitializationComplete(InitializationStatus initializationStatus)
    {
        GD.Print("MobileAds initialization complete");
        foreach (var kvp in initializationStatus.AdapterStatusMap)
        {
            string key = kvp.Key;
            AdapterStatus adapterStatus = kvp.Value;
            GD.Print(
                "Key: ", key, 
                " Latency: ", adapterStatus.Latency, 
                " Initialization Status: ", adapterStatus.State, 
                " Description: ", adapterStatus.Description
            );
        }
    }
}
```

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

### Create a Smart Banner in GDScript and C#

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/banner/sizes/smart_banner

Initializes an AdView with a smart banner size at the top of the screen.

```GDScript
# Create a Smart Banner at the top of the screen.
var ad_view := AdView.new(unit_id, AdSize.get_smart_banner_ad_size(), AdPosition.Values.TOP)
```

```C#
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Core;

// Create a Smart Banner at the top of the screen.
var adView = new AdView(unitId, AdSize.GetSmartBannerAdSize(), AdPosition.Top);
```

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

### Create an AdView Instance

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/banner/get_started

Initializes the MobileAds SDK and creates an AdView instance with platform-specific unit IDs.

```GDScript
extends Node2D

var _ad_view : AdView

func _ready():
    #The initializate needs to be done only once, ideally at app launch.
    MobileAds.initialize()

func _create_ad_view() -> void:
    #free memory
    if _ad_view:
        destroy_ad_view()

    var unit_id : String
    if OS.get_name() == "Android":
        unit_id = "ca-app-pub-3940256099942544/6300978111"
    elif OS.get_name() == "iOS":
        unit_id = "ca-app-pub-3940256099942544/2934735716"

    _ad_view = AdView.new(unit_id, AdSize.BANNER, AdPosition.Values.TOP)
```

```C#
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Core;
using PoingStudios.AdMob.Api.Listeners;

public partial class BannerAd : Node2D
{
    private AdView _adView;

    public override void _Ready()
    {
        //The initializate needs to be done only once, ideally at app launch.
        MobileAds.Initialize();
    }

    private void CreateAdView()
    {
        //free memory
        if (_adView != null)
            DestroyAdView();

        string unitId = null;
        if (OS.GetName() == "Android")
            unitId = "ca-app-pub-3940256099942544/6300978111";
        else if (OS.GetName() == "iOS")
            unitId = "ca-app-pub-3940256099942544/2934735716";

        _adView = new AdView(unitId, AdSize.Banner, AdPosition.Top);
    }
}
```

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

### Initialize Google Mobile Ads SDK

Source: https://poingstudios.github.io/godot-admob-plugin/stable

Call the initialization method during the app's launch phase to prepare the SDK for ad loading.

```GDScript
func _ready() -> void:
    MobileAds.initialize()
```

```C#
public override void _Ready()
{
    MobileAds.Initialize();
}
```

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

### Configure Runpath Search Paths for iOS

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/meta

Add this path to the target's Build Settings under Runpath Search Paths.

```text
/usr/lib/swift
```

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

### Configure Library Search Paths for iOS

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/meta

Add these paths to the target's Build Settings under Library Search Paths to resolve compile errors.

```text
$(TOOLCHAIN_DIR)/usr/lib/swift/$(PLATFORM_NAME)
$(SDKROOT)/usr/lib/swift
```

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

### Load a Rewarded Interstitial Ad

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/rewarded_interstitial

Demonstrates initializing the mobile ads service, handling ad loading, and cleaning up memory for rewarded interstitial ads.

```GDScript
extends Node2D

var _rewarded_interstitial_ad : RewardedInterstitialAd

func _ready() -> void:
    #The initializate needs to be done only once, ideally at app launch.
    MobileAds.initialize()

func _on_load_pressed():
    #free memory
    if _rewarded_interstitial_ad:
        #always call this method on all AdFormats to free memory on Android/iOS
        _rewarded_interstitial_ad.destroy()
        _rewarded_interstitial_ad = null

    var unit_id : String
    if OS.get_name() == "Android":
        unit_id = "ca-app-pub-3940256099942544/5354046379"
    elif OS.get_name() == "iOS":
        unit_id = "ca-app-pub-3940256099942544/6978759866"

    var rewarded_interstitial_ad_load_callback := RewardedInterstitialAdLoadCallback.new()
    rewarded_interstitial_ad_load_callback.on_ad_failed_to_load = func(adError : LoadAdError) -> void:
        print(adError.message)

    rewarded_interstitial_ad_load_callback.on_ad_loaded = func(rewarded_interstitial_ad : RewardedInterstitialAd) -> void:
        print("rewarded interstitial ad loaded" + str(rewarded_interstitial_ad._uid))
        _rewarded_interstitial_ad = rewarded_interstitial_ad

    RewardedInterstitialAdLoader.new().load(unit_id, AdRequest.new(), rewarded_interstitial_ad_load_callback)
```

```C#
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Core;
using PoingStudios.AdMob.Api.Listeners;

public partial class RewardedInterstitialAdExample : Node2D
{
    private RewardedInterstitialAd _rewardedInterstitialAd;

    public override void _Ready()
    {
        //The initializate needs to be done only once, ideally at app launch.
        MobileAds.Initialize();
    }

    private void OnLoadPressed()
    {
        //free memory
        if (_rewardedInterstitialAd != null)
        {
            //always call this method on all AdFormats to free memory on Android/iOS
            _rewardedInterstitialAd.Destroy();
            _rewardedInterstitialAd = null;
        }

        string unitId = null;
        if (OS.GetName() == "Android")
            unitId = "ca-app-pub-3940256099942544/5354046379";
        else if (OS.GetName() == "iOS")
            unitId = "ca-app-pub-3940256099942544/6978759866";

        var rewardedInterstitialAdLoadCallback = new RewardedInterstitialAdLoadCallback
        {
            OnAdFailedToLoad = (LoadAdError adError) => GD.Print(adError.Message),
            OnAdLoaded = (RewardedInterstitialAd rewardedInterstitialAd) => 
            {
                GD.Print("rewarded interstitial ad loaded");
                _rewardedInterstitialAd = rewardedInterstitialAd;
            }
        };

        new RewardedInterstitialAdLoader().Load(unitId, new AdRequest(), rewardedInterstitialAdLoadCallback);
    }
}
```

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

### Configure Vungle Rewarded Mediation Extras

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/vungle

Provide a list of placements to the Vungle SDK for rewarded ads.

```GDScript
var vungle_mediation_extras := VungleRewardedMediationExtras.new()

if OS.get_name() == "iOS":
    vungle_mediation_extras.all_placements = ["ios_placement1", "ios_placement2"]
elif OS.get_name() == "Android":
    vungle_mediation_extras.all_placements = ["android_placement1", "android_placement2"]

var ad_request := AdRequest.new()
ad_request.mediation_extras.append(vungle_mediation_extras)
```

```C#
var vungleMediationExtras = new VungleRewardedMediationExtras();

if (OS.GetName() == "iOS")
{
    vungleMediationExtras.AllPlacements = new string[] { "ios_placement1", "ios_placement2" };
}
else if (OS.GetName() == "Android")
{
    vungleMediationExtras.AllPlacements = new string[] { "android_placement1", "android_placement2" };
}

var adRequest = new AdRequest();
adRequest.MediationExtras.Add(vungleMediationExtras);
```

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

### Configure Vungle Interstitial Mediation Extras

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/vungle

Provide a list of placements to the Vungle SDK for interstitial ads.

```GDScript
var vungle_mediation_extras := VungleInterstitialMediationExtras.new()

if OS.get_name() == "iOS":
    vungle_mediation_extras.all_placements = ["ios_placement1", "ios_placement2"]
elif OS.get_name() == "Android":
    vungle_mediation_extras.all_placements = ["android_placement1", "android_placement2"]

var ad_request := AdRequest.new()
ad_request.mediation_extras.append(vungle_mediation_extras)
```

```C#
var vungleMediationExtras = new VungleInterstitialMediationExtras();

if (OS.GetName() == "iOS")
{
    vungleMediationExtras.AllPlacements = new string[] { "ios_placement1", "ios_placement2" };
}
else if (OS.GetName() == "Android")
{
    vungleMediationExtras.AllPlacements = new string[] { "android_placement1", "android_placement2" };
}

var adRequest = new AdRequest();
adRequest.MediationExtras.Add(vungleMediationExtras);
```

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

### Show Rewarded Ad with Listener

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/rewarded

Use OnUserEarnedRewardListener to handle reward events when showing a rewarded ad.

```GDScript
extends Node2D

var _rewarded_ad : RewardedAd
var on_user_earned_reward_listener := OnUserEarnedRewardListener.new()

func _ready() -> void:
    #...
    on_user_earned_reward_listener.on_user_earned_reward = func(rewarded_item : RewardedItem):
        print("on_user_earned_reward, rewarded_item: rewarded", rewarded_item.amount, rewarded_item.type)

#...
func _on_show_pressed():
    if _rewarded_ad:
        _rewarded_ad.show(on_user_earned_reward_listener)
```

```C#
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Core;
using PoingStudios.AdMob.Api.Listeners;

public partial class RewardedAdExample : Node2D
{
    private RewardedAd _rewardedAd;
    private OnUserEarnedRewardListener _onUserEarnedRewardListener;

    public override void _Ready()
    {
        //...
        _onUserEarnedRewardListener = new OnUserEarnedRewardListener
        {
            OnUserEarnedReward = (RewardedItem rewardedItem) =>
            {
                GD.Print($"on_user_earned_reward, rewarded_item: rewarded {rewardedItem.Amount} {rewardedItem.Type}");
            }
        };
    }

    //...
    private void OnShowPressed()
    {
        if (_rewardedAd != null)
            _rewardedAd.Show(_onUserEarnedRewardListener);
    }
}
```

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

### Presenting the Consent Form in GDScript and C#

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/get_started

Use the ConsentForm instance to show the form if consent is required, and handle the dismissal callback to proceed with ad requests.

```GDScript
var _consent_form : ConsentForm

func load_form():
    UserMessagingPlatform.load_consent_form(_on_consent_form_load_success, _on_consent_form_load_failure)

func _on_consent_form_load_success(consent_form : ConsentForm):
    _consent_form = consent_form
    if UserMessagingPlatform.consent_information.get_consent_status() == UserMessagingPlatform.consent_information.ConsentStatus.REQUIRED:
        consent_form.show(_on_consent_form_dismissed)

func _on_consent_form_load_failure(form_error : FormError):
    # Handle the error.
    pass

func _on_consent_form_dismissed(form_error : FormError):
    if UserMessagingPlatform.consent_information.get_consent_status() == UserMessagingPlatform.consent_information.ConsentStatus.OBTAINED:
        # App can start requesting ads.
        pass
    # Handle dismissal by reloading form
    load_form()
```

```C#
private ConsentForm _consentForm;

private void LoadForm()
{
    UserMessagingPlatform.LoadConsentForm(OnConsentFormLoadSuccess, OnConsentFormLoadFailure);
}

private void OnConsentFormLoadSuccess(ConsentForm consentForm)
{
    _consentForm = consentForm;
    if (UserMessagingPlatform.ConsentInformation.GetConsentStatus() == ConsentStatus.Values.Required)
        consentForm.Show(OnConsentFormDismissed);
}

private void OnConsentFormLoadFailure(FormError formError)
{
    // Handle the error.
}

private void OnConsentFormDismissed(FormError formError)
{
    if (UserMessagingPlatform.ConsentInformation.GetConsentStatus() == ConsentStatus.Values.Obtained)
    {
        // App can start requesting ads.
    }
    // Handle dismissal by reloading form
    LoadForm();
}
```

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

### Add Optional Android Permissions

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/ad_colony

Include these permissions in the AndroidManifest.xml file for optimal AdColony performance.

```xml
<uses-permission android:name="android.permission.VIBRATE" />
```

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

### Configure Test Device IDs Programmatically

Source: https://poingstudios.github.io/godot-admob-plugin/stable/enable_test_ads

Register test device IDs during the application initialization phase to ensure test ads are served.

```gdscript
func _ready() -> void:
    var request_configuration := RequestConfiguration.new()
    request_configuration.test_device_ids = ["2077ef9a63d2b398840261c8221a0c9b"]
    MobileAds.set_request_configuration(request_configuration)
```

```csharp
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Core;

public partial class TestAdsExample : Node2D
{
    public override void _Ready()
    {
        var requestConfiguration = new RequestConfiguration();
        requestConfiguration.TestDeviceIds.Add("2077ef9a63d2b398840261c8221a0c9b");
        MobileAds.SetRequestConfiguration(requestConfiguration);
    }
}
```

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

### Load an AdView Banner

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/banner/get_started

Creates an AdRequest and triggers the load process for the banner.

```GDScript
func _on_load_banner_pressed():
    if _ad_view == null:
        _create_ad_view()
    var ad_request := AdRequest.new()
    _ad_view.load_ad(ad_request)
```

```C#
private void OnLoadBannerPressed()
{
    if (_adView == null)
        CreateAdView();
    var adRequest = new AdRequest();
    _adView.LoadAd(adRequest);
}
```

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

### AdColonyAppOptions

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/ad_colony

Configuration class for setting AdColony SDK-level options such as User ID, test mode, and privacy settings.

```APIDOC
## AdColonyAppOptions

### Description
Provides methods to configure global AdColony SDK settings, including user identification, test mode, and GDPR compliance parameters.

### Methods
- **set_user_id(string)**: Sets the User ID for the AdColony SDK.
- **set_test_mode(bool)**: Enables or disables test mode.
- **set_privacy_framework_required(framework, bool)**: Configures privacy framework requirements.
- **set_privacy_consent_string(framework, string)**: Sets the privacy consent string for a specific framework.
```

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

### RewardedAd.full_screen_content_callback

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/rewarded

Configures the callback object to handle events related to the display of the rewarded ad.

```APIDOC
## RewardedAd.full_screen_content_callback

### Description
Assigns a FullScreenContentCallback instance to the rewarded ad to listen for lifecycle events such as clicks, dismissals, impressions, and show failures.

### Properties
- **on_ad_clicked** (Action) - Triggered when the ad is clicked.
- **on_ad_dismissed_full_screen_content** (Action) - Triggered when the ad is dismissed.
- **on_ad_failed_to_show_full_screen_content** (Action<AdError>) - Triggered when the ad fails to show.
- **on_ad_impression** (Action) - Triggered when an ad impression is recorded.
- **on_ad_showed_full_screen_content** (Action) - Triggered when the ad is successfully shown.
```

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

### Register AdListener for AdView

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/banner/get_started

Connect to ad lifecycle events by assigning an AdListener to the AdView instance.

```GDScript
func register_ad_listener() -> void:
    if _ad_view != null:
        var ad_listener := AdListener.new()

        ad_listener.on_ad_failed_to_load = func(load_ad_error : LoadAdError) -> void:
            print("_on_ad_failed_to_load: " + load_ad_error.message)
        ad_listener.on_ad_clicked = func() -> void:
            print("_on_ad_clicked")
        ad_listener.on_ad_closed = func() -> void:
            print("_on_ad_closed")
        ad_listener.on_ad_impression = func() -> void:
            print("_on_ad_impression")
        ad_listener.on_ad_loaded = func() -> void:
            print("_on_ad_loaded")
        ad_listener.on_ad_opened = func() -> void:
            print("_on_ad_opened")

        _ad_view.ad_listener = ad_listener
```

```C#
private void RegisterAdListener()
{
    if (_adView != null)
    {
        _adView.AdListener = new AdListener
        {
            OnAdFailedToLoad = (LoadAdError loadAdError) => GD.Print("_on_ad_failed_to_load: " + loadAdError.Message),
            OnAdClicked = () => GD.Print("_on_ad_clicked"),
            OnAdClosed = () => GD.Print("_on_ad_closed"),
            OnAdImpression = () => GD.Print("_on_ad_impression"),
            OnAdLoaded = () => GD.Print("_on_ad_loaded"),
            OnAdOpened = () => GD.Print("_on_ad_opened")
        };
    }
}
```

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

### Configure Server-Side Verification Options

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/rewarded

Sets custom data and user ID on a rewarded ad object before it is loaded. The custom data is passed to the SSV callback query parameters.

```GDScript
rewarded_ad_load_callback.on_ad_loaded = func(rewarded_ad : RewardedAd) -> void:
    print("rewarded ad loaded" + str(rewarded_ad._uid))

    var server_side_verification_options := ServerSideVerificationOptions.new()
    server_side_verification_options.custom_data = "TEST PURPOSE"
    server_side_verification_options.user_id = "user_id_test"
    rewarded_ad.set_server_side_verification_options(server_side_verification_options)

    _rewarded_ad = rewarded_ad
```

```C#
rewardedAdLoadCallback.OnAdLoaded = (RewardedAd rewardedAd) => 
{
    GD.Print("rewarded ad loaded");

    var serverSideVerificationOptions = new ServerSideVerificationOptions();
    serverSideVerificationOptions.CustomData = "TEST PURPOSE";
    serverSideVerificationOptions.UserId = "user_id_test";
    rewardedAd.SetServerSideVerificationOptions(serverSideVerificationOptions);

    _rewardedAd = rewardedAd;
};
```

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

### Identify Test Device ID from Logs

Source: https://poingstudios.github.io/godot-admob-plugin/stable/enable_test_ads

Check the log output after initiating an ad request to find the unique device ID required for programmatic registration.

```text
I/Ads: Use RequestConfiguration.Builder.setTestDeviceIds(Arrays.asList("33BE2250B43518CCDA7DE426D04EE231")) 
to get test ads on this device."
```

```text
<Google> To get test ads on this device, set:
GADMobileAds.sharedInstance.requestConfiguration.testDeviceIdentifiers =
@[ @"2077ef9a63d2b398840261c8221a0c9b" ];
```

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

### set_app_volume(volume: float)

Source: https://poingstudios.github.io/godot-admob-plugin/stable/volume_controls

Sets the relative volume for ad playback. Values are clamped between 0.0 (silent) and 1.0 (current device volume).

```APIDOC
## set_app_volume(volume: float)

### Description
Sets the relative volume for ad playback. Values are clamped to the range 0.0 (silent) to 1.0 (current device volume).

### Parameters
- **volume** (float) - Required - The volume level to set, ranging from 0.0 to 1.0.
```

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

### Load Rewarded Ad

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/rewarded

Implementation of loading a rewarded ad, including memory management and callback handling for success or failure.

```gdscript
extends Node2D

var _rewarded_ad : RewardedAd

func _ready() -> void:
    #The initializate needs to be done only once, ideally at app launch.
    MobileAds.initialize()

func _on_load_pressed():
    #free memory
    if _rewarded_ad:
        #always call this method on all AdFormats to free memory on Android/iOS
        _rewarded_ad.destroy()
        _rewarded_ad = null

    var unit_id : String
    if OS.get_name() == "Android":
        unit_id = "ca-app-pub-3940256099942544/5224354917"
    elif OS.get_name() == "iOS":
        unit_id = "ca-app-pub-3940256099942544/1712485313"

    var rewarded_ad_load_callback := RewardedAdLoadCallback.new()
    rewarded_ad_load_callback.on_ad_failed_to_load = func(adError : LoadAdError) -> void:
        print(adError.message)

    rewarded_ad_load_callback.on_ad_loaded = func(rewarded_ad : RewardedAd) -> void:
        print("rewarded ad loaded" + str(rewarded_ad._uid))
        _rewarded_ad = rewarded_ad

    RewardedAdLoader.new().load(unit_id, AdRequest.new(), rewarded_ad_load_callback)
```

```csharp
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Core;
using PoingStudios.AdMob.Api.Listeners;

public partial class RewardedAdExample : Node2D
{
    private RewardedAd _rewardedAd;

    public override void _Ready()
    {
        //The initializate needs to be done only once, ideally at app launch.
        MobileAds.Initialize();
    }

    private void OnLoadPressed()
    {
        //free memory
        if (_rewardedAd != null)
        {
            //always call this method on all AdFormats to free memory on Android/iOS
            _rewardedAd.Destroy();
            _rewardedAd = null;
        }

        string unitId = null;
        if (OS.GetName() == "Android")
            unitId = "ca-app-pub-3940256099942544/5224354917";
        else if (OS.GetName() == "iOS")
            unitId = "ca-app-pub-3940256099942544/1712485313";

        var rewardedAdLoadCallback = new RewardedAdLoadCallback
        {
            OnAdFailedToLoad = (LoadAdError adError) => GD.Print(adError.Message),
            OnAdLoaded = (RewardedAd rewardedAd) => 
            {
                GD.Print("rewarded ad loaded");
                _rewardedAd = rewardedAd;
            }
        };

        new RewardedAdLoader().Load(unitId, new AdRequest(), rewardedAdLoadCallback);
    }
}
```

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

### Load Consent Form

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/get_started

Load the consent form using the UserMessagingPlatform class.

```GDScript
var _consent_form : ConsentForm

func load_form():
    UserMessagingPlatform.load_consent_form(_on_consent_form_load_success, _on_consent_form_load_failure)

func _on_consent_form_load_success(consent_form : ConsentForm):
    _consent_form = consent_form

func _on_consent_form_load_failure(form_error : FormError):
    # Handle the error.
    pass
```

```C#
private ConsentForm _consentForm;

private void LoadForm()
{
    UserMessagingPlatform.LoadConsentForm(OnConsentFormLoadSuccess, OnConsentFormLoadFailure);
}

private void OnConsentFormLoadSuccess(ConsentForm consentForm)
{
    _consentForm = consentForm;
}

private void OnConsentFormLoadFailure(FormError formError)
{
    // Handle the error.
}
```

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

### Configure Vungle Rewarded Mediation Extras

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/vungle

Use VungleRewardedMediationExtras to set parameters for rewarded ad requests on iOS and Android.

```GDScript
var vungle_mediation_extras := VungleRewardedMediationExtras.new()

if OS.get_name() == "iOS":
    vungle_mediation_extras.all_placements = ["ios_placement1", "ios_placement2"]
    vungle_mediation_extras.sound_enabled = true
    vungle_mediation_extras.user_id = "ios_user_id"
elif OS.get_name() == "Android":
    vungle_mediation_extras.all_placements = ["android_placement1", "android_placement2"]
    vungle_mediation_extras.sound_enabled = true
    vungle_mediation_extras.user_id = "android_user_id"

var ad_request := AdRequest.new()
ad_request.mediation_extras.append(vungle_mediation_extras)
```

```C#
var vungleMediationExtras = new VungleRewardedMediationExtras();

if (OS.GetName() == "iOS")
{
    vungleMediationExtras.AllPlacements = new string[] { "ios_placement1", "ios_placement2" };
    vungleMediationExtras.SoundEnabled = true;
    vungleMediationExtras.UserId = "ios_user_id";
}
else if (OS.GetName() == "Android")
{
    vungleMediationExtras.AllPlacements = new string[] { "android_placement1", "android_placement2" };
    vungleMediationExtras.SoundEnabled = true;
    vungleMediationExtras.UserId = "android_user_id";
}

var adRequest = new AdRequest();
adRequest.MediationExtras.Add(vungleMediationExtras);
```

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

### Meta Audience Network Adapter Classes

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/meta

Adapter classes used to access ResponseInfo for troubleshooting ad response errors.

```Android
com.google.ads.mediation.facebook.FacebookAdapter
com.google.ads.mediation.facebook.FacebookMediationAdapter
```

```iOS
GADMAdapterFacebook
GADMediationAdapterFacebook
```

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

### Delay App Measurement in iOS

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/gdpr_iab_support

Add this key-value pair to the Info.plist file to delay app measurement initialization.

```xml
<key>GADDelayAppMeasurementInit</key>
<true/>
```

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

### Configure AdColony CCPA settings

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/ad_colony

Set privacy framework requirements and consent strings using AdColonyAppOptions. These configurations must be applied before initializing the Google Mobile Ads SDK.

```GDScript
var adcolony_app_options := AdColonyAppOptions.new()

# Set CCPA consent parameters
adcolony_app_options.set_privacy_framework_required(AdColonyAppOptions.CCPA, true)
adcolony_app_options.set_privacy_consent_string(AdColonyAppOptions.CCPA, "myPrivacyConsentString")
```

```C#
var adColonyAppOptions = new AdColonyAppOptions();

// Set CCPA consent parameters
adColonyAppOptions.SetPrivacyFrameworkRequired(AdColonyAppOptions.Ccpa, true);
adColonyAppOptions.SetPrivacyConsentString(AdColonyAppOptions.Ccpa, "myPrivacyConsentString");
```

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

### Configure AdColony App Options and Mediation Extras

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/ad_colony

Set user IDs, test modes, and mediation popup preferences using AdColonyAppOptions and AdColonyMediationExtras.

```gdscript
# Using AdColonyAppOptions
var adcolony_app_options := AdColonyAppOptions.new()
adcolony_app_options.set_user_id("your_user_id")
adcolony_app_options.set_test_mode(true)

# Using AdColonyMediationExtras
var ad_request := AdRequest.new()

var ad_colony_mediation_extras := AdColonyMediationExtras.new()
ad_colony_mediation_extras.show_post_popup = false
ad_colony_mediation_extras.show_pre_popup = true

ad_request.mediation_extras.append(ad_colony_mediation_extras)
```

```csharp
// Using AdColonyAppOptions
var adColonyAppOptions = new AdColonyAppOptions();
adColonyAppOptions.SetUserId("your_user_id");
adColonyAppOptions.SetTestMode(true);

// Using AdColonyMediationExtras
var adRequest = new AdRequest();

var adColonyMediationExtras = new AdColonyMediationExtras();
adColonyMediationExtras.ShowPostPopup = false;
adColonyMediationExtras.ShowPrePopup = true;

adRequest.MediationExtras.Add(adColonyMediationExtras);
```

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

### Test Ad Unit IDs for Banners

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/banner/get_started

Use these specific ad unit IDs during development to avoid account suspension. Replace them with production IDs before publishing.

```Android
ca-app-pub-3940256099942544/6300978111
```

```iOS
ca-app-pub-3940256099942544/2934735716
```

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

### Configure Vungle Interstitial Mediation Extras

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/vungle

Use VungleInterstitialMediationExtras to set parameters for interstitial ad requests on iOS and Android.

```GDScript
var vungle_mediation_extras := VungleInterstitialMediationExtras.new()

if OS.get_name() == "iOS":
    vungle_mediation_extras.all_placements = ["ios_placement1", "ios_placement2"]
    vungle_mediation_extras.sound_enabled = true
    vungle_mediation_extras.user_id = "ios_user_id"
elif OS.get_name() == "Android":
    vungle_mediation_extras.all_placements = ["android_placement1", "android_placement2"]
    vungle_mediation_extras.sound_enabled = true
    vungle_mediation_extras.user_id = "android_user_id"

var ad_request := AdRequest.new()
ad_request.mediation_extras.append(vungle_mediation_extras)
```

```C#
var vungleMediationExtras = new VungleInterstitialMediationExtras();

if (OS.GetName() == "iOS")
{
    vungleMediationExtras.AllPlacements = new string[] { "ios_placement1", "ios_placement2" };
    vungleMediationExtras.SoundEnabled = true;
    vungleMediationExtras.UserId = "ios_user_id";
}
else if (OS.GetName() == "Android")
{
    vungleMediationExtras.AllPlacements = new string[] { "android_placement1", "android_placement2" };
    vungleMediationExtras.SoundEnabled = true;
    vungleMediationExtras.UserId = "android_user_id";
}

var adRequest = new AdRequest();
adRequest.MediationExtras.Add(vungleMediationExtras);
```

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

### RewardedAd.set_server_side_verification_options

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/rewarded

Configures server-side verification options, including custom data and user ID, for a rewarded ad object.

```APIDOC
## RewardedAd.set_server_side_verification_options

### Description
Sets the server-side verification options for a rewarded ad. The custom data provided is sent to the SSV callback as a query parameter.

### Parameters
- **options** (ServerSideVerificationOptions) - Required - An object containing `custom_data` (string) and `user_id` (string).
```

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

### Configure Child-Directed Treatment

Source: https://poingstudios.github.io/godot-admob-plugin/stable/advanced_topics/targeting

Sets the child-directed treatment flag to true to comply with COPPA regulations.

```GDScript
var request_configuration := RequestConfiguration.new()
request_configuration.tag_for_child_directed_treatment = RequestConfiguration.TagForChildDirectedTreatment.TRUE
MobileAds.set_request_configuration(request_configuration)
```

```C#
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Api.Core;

var requestConfiguration = new RequestConfiguration();
requestConfiguration.ChildDirectedTreatment = RequestConfiguration.TagForChildDirectedTreatment.True;
MobileAds.SetRequestConfiguration(requestConfiguration);
```

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

### Configure GDPR Consent for AdColony

Source: https://poingstudios.github.io/godot-admob-plugin/stable/mediate/integrate_partner_networks/ad_colony

Pass GDPR consent information to the AdColony SDK before initializing the Google Mobile Ads SDK.

```gdscript
var adcolony_app_options := AdColonyAppOptions.new()

# Set GDPR consent parameters
adcolony_app_options.set_privacy_framework_required(AdColonyAppOptions.GDPR, true)
adcolony_app_options.set_privacy_consent_string(AdColonyAppOptions.GDPR, "myPrivacyConsentString")
```

```csharp
var adColonyAppOptions = new AdColonyAppOptions();

// Set GDPR consent parameters
adColonyAppOptions.SetPrivacyFrameworkRequired(AdColonyAppOptions.Gdpr, true);
adColonyAppOptions.SetPrivacyConsentString(AdColonyAppOptions.Gdpr, "myPrivacyConsentString");
```

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

### Generate an AdView with a Custom Size

Source: https://poingstudios.github.io/godot-admob-plugin/stable/ad_formats/banner/get_started

Defines a custom AdSize object to override default banner dimensions.

```GDScript
var ad_size := AdSize.new(200, 200)
_ad_view := AdView.new(unit_id, ad_size, AdPosition.Values.TOP)
```

```C#
var adSize = new AdSize(200, 200);
_adView = new AdView(unitId, adSize, AdPosition.Top);
```

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

### Enable Google RDP Signal

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/regulatory_solutions/us_states_privacy_laws

Set the 'rdp' extra parameter to 1 to notify Google to enable restricted data processing.

```GDScript
var ad_request := AdRequest.new()
ad_request.extras["rdp"] = 1
```

```C#
var adRequest = new AdRequest();
adRequest.Extras.Add("rdp", "1");
```

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

### Present Consent Form

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/gdpr_iab_support

Methods to display the consent form and handle dismissal by reloading the form.

```gdscript
var _consent_form : ConsentForm

func present_form() -> void:
    _consent_form.show(_on_consent_form_dismissed)

func _on_consent_form_dismissed(form_error : FormError):
    # Handle dismissal by reloading form.
    load_form()
```

```csharp
private ConsentForm _consentForm;

private void PresentForm()
{
    _consentForm.Show(OnConsentFormDismissed);
}

private void OnConsentFormDismissed(FormError formError)
{
    // Handle dismissal by reloading form.
    LoadForm();
}
```

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

### Configure Debug Geography

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/get_started

Use ConsentDebugSettings to force a specific geography for testing. Requires adding the test device's hashed ID.

```GDScript
extends Node

func _ready():
    var request := ConsentRequestParameters.new()
    var consent_debug_settings := ConsentDebugSettings.new()
    consent_debug_settings.debug_geography = DebugGeography.Values.EEA
    consent_debug_settings.test_device_hashed_ids.append("test_device_hashed_id")
    request.consent_debug_settings = consent_debug_settings

    UserMessagingPlatform.consent_information.update(request, _on_consent_info_updated_success, _on_consent_info_updated_failure)

func _on_consent_info_updated_success():
    # The consent information state was updated.
    # You are now ready to check if a form is available.
    pass

func _on_consent_info_updated_failure(form_error : FormError):
    # Handle the error.
    pass
```

```C#
using Godot;
using PoingStudios.AdMob.Api;
using PoingStudios.AdMob.Ump.Api;
using PoingStudios.AdMob.Ump.Core;

public partial class UmpExample : Node
{
    public override void _Ready()
    {
        var request = new ConsentRequestParameters();
        var consentDebugSettings = new ConsentDebugSettings();
        consentDebugSettings.DebugGeography = DebugGeography.Eea;
        consentDebugSettings.TestDeviceHashedIds.Add("test_device_hashed_id");
        request.ConsentDebugSettings = consentDebugSettings;

        UserMessagingPlatform.ConsentInformation.Update(request, OnConsentInfoUpdatedSuccess, OnConsentInfoUpdatedFailure);
    }

    private void OnConsentInfoUpdatedSuccess()
    {
        // The consent information state was updated.
        // You are now ready to check if a form is available.
    }

    private void OnConsentInfoUpdatedFailure(FormError formError)
    {
        // Handle the error.
    }
}
```

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

### Update Info.plist for ATT

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/idfa_support

Add the NSUserTrackingUsageDescription key to your Info.plist to provide a custom message for the iOS system tracking dialog.

```xml
<key>NSUserTrackingUsageDescription</key>
<string>This identifier will be used to deliver personalized ads to you.</string>
```

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

### Delay App Measurement in Android

Source: https://poingstudios.github.io/godot-admob-plugin/stable/privacy/user_messaging_tools/gdpr_iab_support

Add this meta-data tag to the AndroidManifest.xml to prevent app measurement until the SDK is initialized.

```xml
<manifest>
    <application>
    <!-- Delay app measurement until MobileAds.initialize() is called. -->
    <meta-data
        android:name="com.google.android.gms.ads.DELAY_APP_MEASUREMENT_INIT"
        android:value="true"/>
    </application>
</manifest>
```
Tokens:
Raw