# Rewarded Ads

## What are Rewarded Ads? <a href="#bannerads6.0.0-initializeinitializeabannerview" id="bannerads6.0.0-initializeinitializeabannerview"></a>

Rewarded Ad Units reward a user within the app in exchange for completing the ad. This opt-in ad unit provides a less disruptive user experience along with high engagement from users.

## How to Display Rewarded Ads <a href="#bannerads6.0.0-initializeinitializeabannerview" id="bannerads6.0.0-initializeinitializeabannerview"></a>

Before you start, make sure you have correctly integrated and initialized the HyprMX SDK. To integrate and initialize HyprMX, see our [Setup Guide](/sdk-integration-guides/android-amazon.md).

### Loading Rewarded Ads <a href="#quickstart-loading_adsloadinganddisplayingadvertisements" id="quickstart-loading_adsloadinganddisplayingadvertisements"></a>

HyprMX utilizes placements to load and display an ad. Placements are used to represent a point in your application's workflow where you'd like to show an ad. To load an ad to a placement, follow the steps below.

{% hint style="info" %}
If you don't have your placement information, please reach out to your account manager to configure your rewarded placements. In return, they will provide the names of the new placements.
{% endhint %}

{% stepper %}
{% step %}
Use the `getPlacement` API to retrieve a placement from HyprMX.

{% tabs %}
{% tab title="Java" %}

```java
rewardedPlacement = HyprMX.INSTANCE.getPlacement("YOUR_REWARDED_PLACEMENT_NAME");
```

{% endtab %}

{% tab title="Kotlin" %}

```kotlin
rewardedPlacement = HyprMX.getPlacement("YOUR_REWARDED_PLACEMENT_NAME")
```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
To check for availability, run the following:

{% tabs %}
{% tab title="Java" %}

```java
rewardedPlacement.loadAd(new HyprMXLoadAdListener() {
  @Override
  public void onAdLoaded(boolean isAdAvailable) {
    if(isAdAvailable) {
      // You can show the ad
   }
  }
});
```

{% endtab %}

{% tab title="Java (Lambda)" %}

```java
rewardedPlacement.loadAd(isAdAvailable -> {
   if(isAdAvailable) {
      // You can show the ad
   }
});
```

{% endtab %}

{% tab title="Kotlin" %}

```kotlin
rewardedPlacement.loadAd { isAdAvailable ->
   if(isAdAvailable) {
      // You can show the ad
   }
}
```

{% endtab %}

{% tab title="Kotlin (Coroutines)" %}

```kotlin
val isAdAvailable = rewardedPlacement.loadAd()

if(isAdAvailable) {
    // You can show the ad
}
```

{% endtab %}
{% endtabs %}

loadAd() will call back to your `listener` with `isAdAvailable == true` when an ad is available or `false` when there is no inventory.
{% endstep %}

{% step %}
To receive notification that the loaded ad has expired, implement the `HyprMXPlacementExpiryListener`

{% tabs %}
{% tab title="Java" %}

```java
private HyprMXPlacementExpiryListener listener = new HyprMXPlacementExpiryListener() {
  @Override
  public void onAdExpired(@NonNull Placement placement) {
      // Do something on expiration
  }
}

rewardedPlacement.setPlacementExpiryListener(listener);
```

{% endtab %}

{% tab title="Java (Lambda)" %}

```java
rewardedPlacement.setPlacementExpiryListener(placement -> {
   // Do something on expiration
});
```

{% endtab %}

{% tab title="Kotlin" %}

```kotlin
val listener = object : HyprMXPlacementExpiryListener {
    override fun onAdExpired(placement: Placement) {
       // Do something on expiration
    }
}

rewardedPlacement.setPlacementExpiryListener(listener)
```

{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}

### Displaying Rewarded Ads <a href="#quickstart-loading_adsloadinganddisplayingadvertisements" id="quickstart-loading_adsloadinganddisplayingadvertisements"></a>

{% stepper %}
{% step %}
Before calling `showAd` on a placement, you should confirm the ad state is still valid by running the following.

{% tabs %}
{% tab title="Java" %}

```java
rewardedPlacement.isAdAvailable();
```

{% endtab %}

{% tab title="Kotlin" %}

```kotlin
rewardedPlacement.isAdAvailable()
```

{% endtab %}
{% endtabs %}

When an ad is displaying, it is important to disable all in-game music and sounds so they do not interfere with the ads. You can disable them when your activity transitions to `onStop` and resume when your activity transitions to `onResume`.
{% endstep %}

{% step %}
When you are ready to display an ad, call `showAd` to begin the presentation of an ad.

{% tabs %}
{% tab title="Java" %}

```java
if (rewardedPlacement.isAdAvailable()) {
  rewardedPlacement.showAd(this);
}
```

{% endtab %}

{% tab title="Kotlin" %}

```kotlin
if (rewardedPlacement.isAdAvailable()) {
  rewardedPlacement.showAd(this)
}
```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}
To receive an ad reward and display status, implement the `HyprMXRewardedShowListener`:

{% tabs %}
{% tab title="Java" %}

```java
/**
 * Called when an ad is shown for the given placement. Your application should pause here.
 */
@Override
public void onAdStarted(Placement placement) {}

/**
 * Called when an ad is closed. Your application should resume here.
 */
@Override
public void onAdClosed(Placement placement, boolean finished) {}

/**
 * Called when there was an error displaying the ad.
 */
@Override
public void onAdDisplayError(Placement placement, HyprMXErrors hyprMXError) {}

/**
 * Called when the ad was impressed.
 */
@Override
public void onAdImpression(Placement placement) {}
  
/**
 * Called when the user should be rewarded for the given rewarded placement.
 */
@Override
public void onAdRewarded(Placement placement, String rewardName, Int rewardValue) {}
```

{% endtab %}

{% tab title="Kotlin" %}

```kotlin
/**
 * Called when an ad is shown for the given placement. Your application should pause here.
 */
override fun onAdStarted(placement: Placement) {}

/**
 * Called when an ad is closed. Your application should resume here.
 */
override fun onAdClosed(placement: Placement, finished: Boolean) {}

/**
 * Called when there was an error displaying the ad.
 */
override fun onAdDisplayError(placement: Placement, hyprMXError: HyprMXErrors) {}

/**
 * Called when the ad was impressed.
 */
override fun onAdImpression(placement: Placement) {}

/**
 * Called when the user should be rewarded for the given rewarded placement.
 */
override fun onAdRewarded(placement: Placement, rewardName: String, rewardValue: Int) {}
```

{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}

If you'd like, we can send server-to-server calls when ads are completed. Contact your account manager at HyprMX for more details.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.hyprmx.com/sdk-integration-guides/android-amazon/ad-formats/rewarded-ads.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.