APS integration (legacy)

Integrate Amazon Publisher Services (APS) with Unity LevelPlay by configuring your APS account and setting up the integration with ironSource.

読み終わるまでの所要時間 4 分

最終更新 1日前

重要

The following documentation discusses products or services (“Third-party Products”) not developed, owned, or operated by Unity. This information might be outdated or incomplete and is provided for your convenience. Your use of any Third-party Product is subject to its own terms. Unity makes no warranties regarding these products and isn't liable for any damages or losses arising from their use, including issues related to content, advertising, or materials from Third-party providers.

注

This guide applies to legacy LevelPlay SDK versions (8.0.0+). For the most up-to-date documentation covering version 9.0.0 and later, refer to APS integration.

注

To view the adapter changelog for this mediation network, refer to Mediation Networks for Android.

Prerequisites

Amazon Publisher Services (APS) is an invitation-only program. To integrate the APS, you will need to integrate and initialize both the LevelPlay SDK and APS SDK. Make sure you perform the full integration flow as detailed below to display APS ads in your application.

Step 1. Create an APS account

Reach out to APS to set up your app’s account. To create an APS account, go to the APS website, select contact us and open a request.
If your APS request is approved, you will receive an invitation link to sign up and create your account with APS.
The above steps must be completed before you proceed to set up APS in LevelPlay.

Step 2. Set up your slots in APS Network

Choose the right application from the apps menu and select setup
Choose ironSource LevelPlay as your monetization service setup menu
Add slots and define for each slot :
1. Name
2. Ad size
3. Price points (auto/manual)
Finish adding all slots and pick up your credentials:
1. Get your app id
2. Download the price point CSV file

Step 3. Activate APS Network

Inside the ironSource platform, access the SDK Networks setup to configure APS parameters into your LevelPlay account.

After you have the credentials mentioned above, log in to your LevelPlay account and go to Monetize > Setup > SDK Networks
Select APS from the table of Available Networks and select Activate.

Select APS from the list of ad networks and select Setup.

Enter your APS app ID and upload CSV file as is.

Step 4. Add the APS adapter to your build

Gradle

Ensure that the following Maven URL exists in your build.gradle script of your app module
```
repositories {	mavenCentral()}
```

Add the adapter's Maven name to your build.gradle script of your app module.


dependencies {implementation 'com.unity3d.ads-mediation:aps-adapter:4.3.17'implementation 'com.amazon.android:aps-sdk:11.0.0+'implementation 'com.iabtcf:iabtcf-decoder:2.0.10'}

Step 5. Update AndroidManifest.xml

Manifest Permissions:


<uses-permission android:name="android.permission.INTERNET" /><uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" /><uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

Manifest Activities:


<activity android:name="com.amazon.device.ads.DTBInterstitialActivity"/><activity android:name="com.amazon.device.ads.DTBAdActivity"/>

For Proguard Users Only

If you are using ProGuard with the APS adapter, you must add the following code to your ProGuard file:


-keep class com.amazon.device.ads.** { *; }

Step 6. Init APS SDK

The APS network requires that you initialize both the ironSource and APS SDKs to display APS ads. Initialize the APS SDK as soon as your application is opened and before initializing the LevelPlay SDK. Use the APS App ID, defined in Step 2 of the APS setup.


AdRegistration.getInstance(APS_APP_ID, this);//Where 'this' is an activity context.

Before loading each ad, call the APS API to get the load info that is required for LevelPlay SDK to load an ad. These are the required steps:

Load the APS ad request before each ironSource ad unit load.
Call SetNetworkData to share the APS bid info with ironSource.
Load the relevant ad unit using LevelPlay mediation APIs.

注

Starting APS Android SDK 10.0.0+, the DTBAdRequest object takes a new parameter called DTBAdNetworkInfo. Note the implementation differences in the following examples.

Call the APS banner ad request before each ironSource ad unit load. Use the Slot UUID when creating the load ad request.

APS Android SDK 10.0.0+:


DTBAdNetworkInfo adNetworkInfo = new DTBAdNetworkInfo(DTBAdNetwork.UNITY_LEVELPLAY); final DTBAdRequest loader = new DTBAdRequest(adNetworkInfo);loader.setSizes(new DTBAdSize(SLOT_WIDTH, SLOT_HEIGHT, "Your_Slot_UUID"));loader.loadAd(new DTBAdCallback());

APS Android SDK below 10.0.0:


final DTBAdRequest loader = new DTBAdRequest();loader.setSizes(new DTBAdSize(SLOT_WIDTH, SLOT_HEIGHT, "Your_Slot_UUID"));loader.loadAd(new DTBAdCallback());

If the APS ad was loaded successfully, share the ad data with ironSource. This should include the following parameters:

Bid Info: Information required for the Amazon ad to be displayed
Price Point Encoded: The winning ad price, as returned from APS
UUID: Slot unique identifier
Width: The banner width
Height: The banner height


public void onSuccess(DTBAdResponse dtbAdResponse) {    // Append the APS bid parameters to LevelPlay mediation to add APS to the next ad request     JSONObject apsDataJsonBN = new JSONObject();    apsDataJsonBN.put("bidInfo", SDKUtilities.getBidInfo(dtbAdResponse));    apsDataJsonBN.put("pricePointEncoded", SDKUtilities.getPricePoint(dtbAdResponse));    apsDataJsonBN.put("uuid", slotUUID);    apsDataJsonBN.put("width", dtbAdResponse.getDTBAds().get(0).getWidth());    apsDataJsonBN.put("height", dtbAdResponse.getDTBAds().get(0).getHeight());    // Define APS data per interstitial ad unit     JSONObject apsDataJson = new JSONObject();     apsDataJson.put(IronSource.AD_UNIT.BANNER.toString(), apsDataJsonBN);    IronSource.setNetworkData("APS", apsDataJson);}

If APS returns no fill, call LevelPlay’s loadBanner()

Load ironSource banner ad. Learn more here.

注

If you choose to use ironSource’s automatic refresh mechanism, make sure to call APS load ads after each impression. This will ensure that the APS banners will be able to participate in the next auction, as well. If you do not want to maintain this logic, cancel the refresh mechanism and load each ad manually after destroying the previous ad.

Load Interstitial ads

Call APS interstitial ad request, before each ironSource ad-unit load. Use the Slot UUID when creating the load ad request.

APS Android SDK 10.0.0+:


DTBAdNetworkInfo adNetworkInfo = new DTBAdNetworkInfo(DTBAdNetwork.UNITY_LEVELPLAY); final DTBAdRequest loader = new DTBAdRequest(adNetworkInfo);loader.setSizes(new DTBAdSize.DTBInterstitialAdSize(YOUR_INTERSTITIAL_UUID));loader.loadAd(new DTBAdCallback());

APS Android SDK below 10.0.0:


final DTBAdRequest loader = new DTBAdRequest();loader.setSizes(new DTBAdSize.DTBInterstitialAdSize(YOUR_INTERSTITIAL_UUID));loader.loadAd(new DTBAdCallback());

LevelPlay supports APS interstitial video ads, starting from APS adapter 4.3.3. To load an interstitial video, call the following method: if your app is in portrait mode:

APS Android SDK 10.0.0+:


DTBAdNetworkInfo adNetworkInfo = new DTBAdNetworkInfo(DTBAdNetwork.UNITY_LEVELPLAY); final DTBAdRequest loader = new DTBAdRequest(adNetworkInfo);loader.setSizes(new DTBAdSize.DTBVideo(320, 480, YOUR_INTERSTITIAL_VIDEO_UUID)); loader.loadAd(new DTBAdCallback());

APS Android SDK below 10.0.0:


final DTBAdRequest loader = new DTBAdRequest();loader.setSizes(new DTBAdSize.DTBVideo(320, 480, YOUR_INTERSTITIAL_VIDEO_UUID));loader.loadAd(new DTBAdCallback());

If your app is in landscape mode:

APS Android SDK 10.0.0+:


DTBAdNetworkInfo adNetworkInfo = new DTBAdNetworkInfo(DTBAdNetwork.UNITY_LEVELPLAY); final DTBAdRequest loader = new DTBAdRequest(adNetworkInfo);loader.setSizes(new DTBAdSize.DTBVideo(480, 320, YOUR_INTERSTITIAL_VIDEO_UUID));loader.loadAd(new DTBAdCallback());

APS Android SDK below 10.0.0:


final DTBAdRequest loader = new DTBAdRequest();loader.setSizes(new DTBAdSize.DTBVideo(480, 320, YOUR_INTERSTITIAL_VIDEO_UUID));loader.loadAd(new DTBAdCallback());

If the APS ad was loaded successfully, share the ad data with ironSource. This should include the following parameters:

Bid Info: Information required for the Amazon ad to be displayed
Price Point Encoded: The winning ad price, as returned from APS
UUID: Slot unique identifier


public void onSuccess(DTBAdResponse dtbAdResponse) {   // Append the APS bid parameters to LevelPlay mediation to add APS to the next ad request    JSONObject apsDataJsonIS = new JSONObject();    apsDataJsonIS.put("bidInfo", SDKUtilities.getBidInfo(dtbAdResponse));   apsDataJsonIS.put("pricePointEncoded", SDKUtilities.getPricePoint(dtbAdResponse));   apsDataJsonIS.put("uuid", slotUUID);   // Define APS data per interstitial ad unit    JSONObject apsDataJson = new JSONObject();    apsDataJson.put(IronSource.AD_UNIT.INTERSTITIAL.toString(), apsDataJsonIS);   IronSource.setNetworkData("APS", apsDataJson);}

If APS returns no fill, call LevelPlay’s loadInterstitial().

Load ironSource interstitial ad. Learn more here.

Rewarded ads

The APS integration differs according to the rewarded operation mode that you implement in your app.

Manual loading mode: This is the recommended setup to integrate with APS. This will require you to call APS ad requests before each rewarded load.
Rewarded ads default mode (automatic): When using the LevelPlay default mode for displaying rewarded ads, you'll need to load the first APS ad, before initializing the LevelPlay SDK, and after initializing the APS SDK. In addition, we recommend calling the next APS load request before each show, to affect the next waterfall request.

Load Rewarded ads

Call the APS rewarded ad request before each ironSource ad unit load (or before the show, in automatic mode). Use the Slot UUID when creating the load ad request. if your app is in portrait mode:

APS Android SDK 10.0.0+:


DTBAdNetworkInfo adNetworkInfo = new DTBAdNetworkInfo(DTBAdNetwork.UNITY_LEVELPLAY); final DTBAdRequest loader = new DTBAdRequest(adNetworkInfo);loader.setSizes(new DTBAdSize.DTBVideo(320, 480, YOUR_REWARDED_VIDEO_UUID)); loader.loadAd(new DTBAdCallback());

APS Android SDK below 10.0.0:


final DTBAdRequest loader = new DTBAdRequest();loader.setSizes(new DTBAdSize.DTBVideo(320, 480, YOUR_REWARDED_VIDEO_UUID));loader.loadAd(new DTBAdCallback());

If your app is in landscape mode:

APS Android SDK 10.0.0+:


DTBAdNetworkInfo adNetworkInfo = new DTBAdNetworkInfo(DTBAdNetwork.UNITY_LEVELPLAY); final DTBAdRequest loader = new DTBAdRequest(adNetworkInfo);loader.setSizes(new DTBAdSize.DTBVideo(480, 320, YOUR_REWARDED_VIDEO_UUID)); loader.loadAd(new DTBAdCallback());

APS Android SDK below 10.0.0:


final DTBAdRequest loader = new DTBAdRequest();loader.setSizes(new DTBAdSize.DTBVideo(480, 320, YOUR_REWARDED_VIDEO_UUID));loader.loadAd(new DTBAdCallback());

If the APS ad was loaded successfully, share the ad data with ironSource. This should include the following parameters:

Bid Info: Information required for the Amazon ad to be displayed
Price Point Encoded: The winning ad price, as returned from APS

UUID: Slot unique identifier


public void onSuccess(DTBAdResponse dtbAdResponse) {   // Append the APS bid parameters to LevelPlay mediation to add APS to the next ad request    JSONObject apsDataJsonRV = new JSONObject();    apsDataJsonRV.put("bidInfo", SDKUtilities.getBidInfo(dtbAdResponse));   apsDataJsonRV.put("pricePointEncoded", SDKUtilities.getPricePoint(dtbAdResponse));   apsDataJsonRV.put("uuid", slotUUID);   // Define APS data per rewarded ad unit    JSONObject apsDataJson = new JSONObject();    apsDataJson.put(IronSource.AD_UNIT.REWARDED_VIDEO.toString(), apsDataJsonRV);   IronSource.setNetworkData("APS", apsDataJson);}

If APS returns no fill, call LevelPlay’s loadManualRewardedVideo().

ドキュメント

Development

User Acquisition

Monetization

産業

ドキュメント

Development

User Acquisition

Monetization

産業

LevelPlay SDK - Android

Unity SDK

Android SDK

iOS SDK

Adobe AIR SDK

Flutter SDK

React Native SDK

LevelPlay SDK - Android

APS integration (legacy)

Prerequisites

Step 1. Create an APS account

Step 2. Set up your slots in APS Network

Step 3. Activate APS Network

Step 4. Add the APS adapter to your build

Gradle

Step 5. Update AndroidManifest.xml

For Proguard Users Only

Step 6. Init APS SDK

Load banner/MREC ads

Load Interstitial ads

Rewarded ads

APS integration (legacy)

Prerequisites

Step 1. Create an APS account

Step 2. Set up your slots in APS Network

Step 3. Activate APS Network

Step 4. Add the APS adapter to your build

Gradle

Step 5. Update AndroidManifest.xml

For Proguard Users Only

Step 6. Init APS SDK

Step 7. Share APS Bid info with LevelPlay mediation per ad

Load banner/MREC ads

Load Interstitial ads

Rewarded ads