YaAdRequest adRequest = new YAAdRequest();
adRequest.addCustomParam("param_key", "param_value");
rewardedVideoAd.setAdRequest(adRequest);

YouAPPi.getInstance().setDynamicUserId("best_user_ever");

Age and Gender support (optional)

In order to get better supply that allocated specifically to the user, user’s age and gender could be forwarded to our server throughout YouAppi SDK. You can use YAAdRequest object and setGender() / setAge() methods accordingly before loading ads.

YAAdRequest adRequest = new YAAdRequest()
        .setGender(YAAdRequest.Gender.Female)
        .setAge("40");

Implementation example for Rewarded Video

Please note: this example is for rewarded video. Other products work in a similar way.

• Create a rewarded video instance:

  YARewardedVideoAd rewardedVideoAd = YouAPPi.getInstance().rewardedVideoAd("test_rewarded_video_ad");

• Add rewarded video event listener:

  rewardedVideoAd.setRewardedVideoAdListener(new YARewardedVideoAd.RewardedVideoAdListener() {
              @Override
              public void onRewarded(String s) {
                  
              }
   
              @Override
              public void onVideoStart(String s) {
   
              }
   
              @Override
              public void onVideoEnd(String s) {
   
              }
   
              @Override
              public void onVideoSkipped(String s, int i) {
   
              }
   
              @Override
              public void onCardShow(String s) {
   
              }
   
              @Override
              public void onCardClose(String s) {
   
              }
   
              @Override
              public void onCardClick(String s) {
   
              }
   
              @Override
              public void onLoadSuccess(String s) {
   
              }
   
              @Override
              public void onLoadFailure(String s, YAErrorCode yaErrorCode, Exception e) {
   
              }
   
              @Override
              public void onShowFailure(String s, YAErrorCode yaErrorCode, Exception e) {
   
              }
   
              @Override
              public void onAdStarted(String s) {
   
              }
   
              @Override
              public void onAdEnded(String s) {
   
              }
          });

• Add custom parameters / age / gender (if needed) and load rewarded video ad:

  YAAdRequest adRequest = new YAAdRequest()
           .addCustomParam("user_id", "user100")
           .addCustomParam("reward_value", "25")
           .addCustomParam("reward_type", "coins")
           .setGender(YAAdRequest.Gender.Female)
           .setAge("40");
  rewardedVideo.setAdRequest(adRequest);
  rewardedVideoAd.load();

• Once ad is loaded, the event onLoadSuccess is called, set dynamic usr id (if needed) and show ads:

  YouAPPi.getInstance().setDynamicUserId("best_user_ever");
  rewardedVideoAd.show();

• Ad availability can also be checked by calling:

  rewardedVideoAd.isAvailable();

  If you’re using proguard in your application the following entries should be added to your proguard file:

  -keep class com.google.gson.**{ *;}
  -keep class com.google.android.gms.**{*;}
  -keep class com.youappi.sdk.**{*;}
  -keep interface com.youappi.sdk.**{*;}
  -keep enum com.youappi.sdk.**{*;}
  -keepclassmembers class * {
     @android.webkit.JavascriptInterface <methods>;
  }

Android App Bundle

In order to upload your app’s compiled code and resources to Google Play using Android App Bundle without generating APK, exclude Android Manifest from the package options of your build.gradle:

packagingOptions {
    exclude 'AndroidManifest.xml'
}

Device Orientation

If the app developer fixes the app orientation to a specific orientation (portrait or landscape), then the specific orientation needs to be added to the AndroidManifest.xml file:

<activity android:name="com.youappi.sdk.AdActivity"
    android:screenOrientation="landscape"/>

GDPR User’s Consent

The USER_CONSENT value should be determined by the app developer according to the User’s response to a Consent Request. The DOES_GDPR_APPLY value should be set according to the user being subject to the GDPR rules (e.g.: an EU residence). The DOES_GDPR_APPLY flag value signals to YouAppi the permission to process and store the user’s Personal Information (e.g.: Advertising ID and IP address). In case that the flag value is false, YouAppi may decide not to respond to the ad request, since the user cannot be detected and his actions cannot be attributed to the user and hence also to YouAppi and to the app developer.

GDPR user consent can be passed in the following ways:

• It is mandatory to pass user consent in SDK init:

YouAPPi.init(context, "<YOUR_APP_TOKEN>", USER_CONSENT, DOES_GDPR_APPLY);

• USER_CONSENT can be set by using:

YouAPPi.getInstance().setUserConsent(true);

• DOES_GDPR_APPLY can be set by using:

YouAPPi.getInstance().setgdpr(false);

• If the user is known to be in an age restricted class (e.g.: under the age of 16 in some countries or under the age of 13 in other countries ) then the age restricted indication should be passed:

YouAPPi.getInstance().setAgeRestrictedUser(true);

Logging and troubleshooting

After initializing the SDK you can set LogListener to get detailed log events from YouAppi’s SDK:

YouAPPi.getInstance().setLogListener(new Logger.LogListener()
   {
       @Override
       public void log(String tag, String message)
       {
           // This will be called each time YouAppi SDK generates a log message.
       }
   });

Load and Show best practices

• Make sure to init the SDK as soon as the app starts. It might take few seconds to complete the init process.
• Make sure to load the ad about 30 seconds before you want to show it since it takes time for the ad and assets to be prepared.
• Make sure to show an ad as close as possible to its load, in order to have a better fill rate and relevant ads.
• Make sure not to wait too long before showing an ad, since the ad will be expired 5 hours after being called for. In other words, “show” must be performed no more than 5 hours after the “load”.
• Use ad event listeners in order to be notified when an ad is ready to be shown.
• Use ad event listeners to handle load and show.
• Loading an ad too many times without showing it might cause YouAppi servers to block the SDK from requests.

Demo App

A demo app showing a simple usage of the SDK can be found in the following Github repository:

https://github.com/YouAppi/youappi-sdk-android-demo

The demo app contains 4 modules:

• app-demo – Shows how to use YouAppi’s SDK
• app-demo-admob – Shows how to use YouAppi’s SDK with AdMob adapter
• app-demo-mopub – Shows how to use YouAppi’s SDK with MoPub adapter
• app-demo-nativeads – Shows how to use YouAppi’s SDK Native Ads

Please make sure to read the README.md file for further instructions.