1.Access the Dashboard

To create an account click the following link:

2.Create Account

Once you have clicked the link shown above, click on "Create Account".

3.Publisher Account

Select: Publisher (Monetize your apps) from the drop-down menu.

4. Fill in the Information

First, you have to chose if you are business or Person, and then fill in the rest of the information. Enter company and/or your name, last name, address, country and email.

5. Sign up

You have to read through and agree to the Advertiser Terms or Publisher Terms and Privacy Policy

1. Log into your account

To access your Publisher account click on the following link:

2. Account Settings

On the left-hand side of the screen:

• Click on "Account Settings"

• Click on "Personal/Company Information"

3.Fill out / update all of the fields

First, you have to chose if you are business or Person, and then fill in the rest of the information. Enter company and/or your name, last name, address, country and email.

4. Update

Once you are done filling out all of the provided fields, click on "Update Personal/Additional Information"

Update Billing Information

1. Log into your Publisher account

2. Access Account Settings

Under Account setting - (in the bottom right corner of the screen) click on "Billing Setting"

3. Select your preferred method

In the “Payout Method and Currency” section activate the drop-down list and chose your preferred payout method and currency.

Example: If you chose PayPal as the preferred payout method, we will make payments to you that are a minimum of 25$. If you do not reach the minimum threshold in the current month, the amount earned will be transferred to the next.

4. Update Billing Information

Once you have filled out all of the required fields, click on "Update Billing Information"

Credit Notes

Whenever a payout is due - we issue a credit note. You can see the current (pending) credit note in the dashboard.

The current billing cycle includes all accumulated earnings and deductions since the last credit note has been created. If the sum of these positions is greater or equal the threshold for the selected payout method, a credit note is generated.

To check your credit note:

1. Log into your Publisher account

2. Access Account Settings

Under Account setting - (in the bottom right corner of the screen) - click on "Payments"

3. Current Billing Cycle

In this section, you can find Overview of your earnings for each one of your placement(s) in the current billing cycle.

Payments

Whenever a payout threshold is reached - we issue the payout. You can see all the payouts made out to you in the dashboard.

1. Log into your Publisher account

2. Access Account Settings

Under Account setting - (in the bottom right corner of the screen) - click on "Payments"

2. Credit Notes

"Under Credit Notes" you can find all payments made out to you.

You can download the credit notes, and check the status of all historic payouts.

You can sort the credit notes by status (for example "Paid") by selecting it in the field "Status".

You can also download the credit notes, by clicking on "Download" in a row or the respective credit note.

1. Offerwall Callbacks

2. Rewarded Video Callbacks

1. Log into your account

To access your Publisher account click on the following link:

2. Navigate to Sub-Acocunts

On the left-hand side of the screen:

• Click on "Sub-Accounts"

• Click on "Create Sub-Account" on the top right

3. Fill in the Information

• Add the email address of your colleague

• Add First & Last Name of your colleague

• Click "Create"

4. Tell your colleague to finish the setup

• Your colleague will receive an email from ayeT-Studios with instructions to reset their password

• After completing the process, they will be able to log into their account

A Placement is meant to represent your app or website. It indicates the platform that your owned & operated asset is build for and running on.

A Placement can be one of the following:

• Android App

• iOS App

• Website

• Network / API

For example, you create a separate Placement for your Android App and a separate Placement for your IOS app.

While creating a Placement, you also set up the AdSlot, which you select based on the type of integration or ad format you want to use.

Follow the link below to read about AdSlots.

1. Offerwall Securing Callbacks

2. Rewarded Video Securing Callbacks

1. Log in to the dashboard

2. Placements / Apps

On the left-hand side of the screen click on "Placements / Apps"

3. + Add application / Placement

In the upper-right corner of the screen - click on "+ Add Application / Placement"

4. Select the Placement type

In this step you select the type of platform you want to integrate.

5. Fill in the information

For example: Creating a new Android App placement

6. Select your preferred Adslot

Adslot is the HTML markup that defines where an ad appears. You chose adslot type based on the integration (for example Rewarded Video). (The adslot ID is relevant in integration).

7. Fil in the Adslot information

• The name of your currency;

• Adjust the conversion rate;

• Currency decimal places.

8. Create Placement

Once you are done filling out the information - click on "Create Placement"

Eligible Placement & AdSlot Combinations

The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Web Offerwall integration.

Utilization for Desktop, Mobile Web & In-App

Technically, the Offerwall has to be implemented by opening a new browser tab or loading the Offerwall link inside an iframe.

This type of Web Offerwall is intended to be called directly in an actual browser and is not very well suited for webview (in-app) integration. For this type of integration, please take a look at our seamless In-App integrations by checking out our available SDKs, Wrappers and Plugins.

Integration Best Practices

Getting Started

Before you start with the integration, make sure you:

• Create an Account

• Add a Placement

• Add an AdSlot

You will find more details here:

Your Browser Offerwall Link - Mandatory Parameters

The URL template for our web offerwall looks like this:

https://www.ayetstudios.com/offers/web_offerwall/ADSLOT_ID?external_identifier={YOUR_USER_IDENTIFIER}

To retrieve the URL for one of your web offerwall adslots, click on "Edit" next to an AdSlot under Placements / Apps and retrieve the Integration URL in the modal.

URL Parameters:

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Eligible Placement & AdSlot Combinations

The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Android SDK integration.

Getting Started

Before you start with the integration, make sure you have:

• Created an Account

• Added a placement

• Added an AdSlot

You will find more details here:

User Balance

The integration is simple and allows both managed and unmanaged user balances / currencies.

A managed user balance / currency is a user balance that is stored on our servers. We store user information and the amount of virtual currency a user owns. You can use balance listeners to manage the amount of currency each user has on our servers.

An unmanaged user balance / currency is a user balance that is stored on your servers. You receive callbacks and handle user wallets yourself.

Download the Library

You can download the lastest version of our publisher library here:

Add the library to your Android Studio project

Copy the downloaded jar library to your Android Studio project (in the app/libs/ folder). Go to "Module Settings" (F12 or right-click your app in the Project View) and check the dependencies tab to make sure the library is added as a file dependency and set to "Compile":

Afterwards open your AndroidManifest.xml and add our offerwall activity to your application scope:

<activity
    android:name="com.ayetstudios.publishersdk.OfferwallActivity"
    android:configChanges="orientation|screenSize">
    <intent-filter android:label="offer">
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:scheme="offer" android:host="com.example.myapplication" /> <!-- Replace with your lower case package name -->
    </intent-filter>
</activity>
<activity android:name="com.ayetstudios.publishersdk.VideoActivity" android:configChanges="orientation|screenSize" />	

Another AndroidManifest.xml requirement is your AYET_APP_KEY which you can fetch from our publisher dashboard in your placement or adslot details - add it to the application scope as well:

<meta-data android:name="AYET_APP_KEY" android:value="xxxxxxxxxxxxxxxx" />

Also make sure to check your permissions in the AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" /> <!-- mandatory permission -->
<uses-permölmission android:name="android.permission.READ_PHONE_STATE" /> <!-- optional -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <!-- optional -->
This is an example for a complete AndroidManifest.xml:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.myapplication"> <!-- Replace with your lower case package name -->
<uses-permission android:name="android.permission.INTERNET" /> <!-- mandatory permission -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" /> <!-- optional -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <!-- optional -->
android:allowBackup="true"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:supportsRtl="true"
android:theme="@style/AppTheme">
android:name=".MainActivity"
android:label="@string/app_name">
<action android:name="android.intent.action.MAIN" />
<category android:name="android.intent.category.LAUNCHER" />
<!-- Publisher SDK Specific-->
android:name="com.ayetstudios.publishersdk.OfferwallActivity"
android:configChanges="orientation|screenSize">
<intent-filter android:label="offer">
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="offer" android:host="com.example.myapplication" /> <!-- Replace with your lower case package name -->
<activity android:name="com.ayetstudios.publishersdk.VideoActivity" android:configChanges="orientation|screenSize"></activity>
<meta-data android:name="AYET_APP_KEY" android:value="xxxxxxxxxxxxxxxx" />
<!-- End of: Publisher SDK Specific-->

Initialize the SDK & Managed User Balances

In this step, we are going to initialize the SDK in the main activity. We also use callbacks to track the user's account balance - this is optional and not required if you're planning to manage user balances on your own servers.

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    AyetSdk.init(getApplication(), "username (external identifier)", new UserBalanceCallback() { // UserBalanceCallback is optional if you want to manage balances on your servers
            @Override
            public void userBalanceChanged(SdkUserBalance sdkUserBalance) {
                Log.d("AyetSdk" , "userBalanceChanged - available balance: "+sdkUserBalance.getAvailableBalance()); // this is the new total available balance for the user
            }

            @Override
            public void userBalanceInitialized(SdkUserBalance sdkUserBalance) {
                Log.d("AyetSdk" , "SDK initialization successful");
                Log.d("AyetSdk" , "userBalanceInitialized - available balance: "+sdkUserBalance.getAvailableBalance()); // this is the total available balance for the user
                Log.d("AyetSdk" , "userBalanceInitialized - spent balance: "+sdkUserBalance.getSpentBalance()); // this is the total amount spent with "AyetSdk.deductUserBalance(..)"
                Log.d("AyetSdk" , "userBalanceInitialized - pending balance: "+sdkUserBalance.getPendingBalance()); // this is the amount currently pending for conversion (e.g. user still has offer requirements to meet)
            }

            @Override
            public void initializationFailed() {
                Log.d("AyetSdk", "initializationFailed - please check APP API KEY & internet connectivity");
            }
        });

    setContentView(R.layout.activity_main);
}	                

If you want to make sure the SDK has been initialized and is ready to display the Offerwall or video ads, you can use the following function:

if (AyetSdk.isInitialized()) {
    Log.d("AyetSdk" , "SDK is ready");
} else {
    Log.d("AyetSdk" , "SDK is NOT ready");
}	

If you want to spend user currency, for example if the user clicks a "purchaseInAppItem" button, you can utilize the deductUserBalance function:

mPurchaseInAppItemButton.setOnClickListener(new OnClickListener() {
    @Override
    public void onClick(View view) {
        int amount=100;
        AyetSdk.deductUserBalance(getApplication(), amount, new DeductUserBalanceCallback() {
            @Override
            public void success() {
                Log.d("AyetSdk" , "deductUserBalance - successful, new available balance: "+AyetSdk.getAvailableBalance());
                // TODO: activate the purchased content
            }

            @Override
            public void failed() {
                Log.d("AyetSdk" , "deductUserBalance - failed");
                // this usually means that the user does not have sufficient balance in his account
            }
        });
    }
});

Show the Offerwall

Showing the offerwall for an offerwall adslot is straight-forward, you can simply call showOfferwall from any Activity:

AyetSdk.showOfferwall(getApplication(), "offerwall adslot name");

showOfferwall starts the offerwall activity for the adslot you pass as second parameter and displays available tasks for the user to complete.

Proguard Rules / Release Builds

If you're going to use Proguard in your release build to obfuscate your application, make sure to add the following rules to your proguard-rules.pro files:

-keep class com.ayetstudios.publishersdk.messages.** {*;}
-keep public class com.ayetstudios.publishersdk.AyetSdk
-keepclassmembers class com.ayetstudios.publishersdk.AyetSdk {
   public *;
}
-keep public interface com.ayetstudios.publishersdk.interfaces.UserBalanceCallback { *; }
-keep public interface com.ayetstudios.publishersdk.interfaces.DeductUserBalanceCallback { *; }

-keep class com.ayetstudios.publishersdk.models.VastTagReqData { *; }

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

An AdSlot is a combination of type of ad, integration and placement of the ad on your website or within your app.

There is a number of AdSlot Types that you can choose from, dependent on if you added an Android App, an iOS App or a Website. AdSlot Types include:

• Offerwall

• Rewarded Video

• Offerwall API

• Static API

• Web Surveywall

The beauty of AdSlots are that you can add n+1 AdSlots to for each of your Placements.

That way you can for example have two offerwalls within your Android App. Each Offerwall can then carry its own virtual currency and its own design.

You can also create more complex setups to run 10 or more offerwalls within your app, while aggregating data.

The same is true for Rewarded Video setups. You can for example add one Website and five AdSlots to have users unlock boosters for AdSlot 1, decrease waiting time for AdSlot 2 and get bonus coins for AdSlot 3.

Read more about how to create a Placement:

Once you have created your first Placement and AdSlot, you can easily add additional AdSlots to your placement.

For Offerwall

1. Log into the dashboard

2.Chose the Placement

In the central part of the screen, all of your Placements will be shown - Locate the Placement which you want to customize

3. Edit Adslot

4. Currency Setup

In the pop-up window click on "Overview".

In this section you can adjust:

• The name of your currency(s);

• Adjust the conversion rate;

• Chose a minimum Offer Payout

For Rewarded Video

1. Log into the dashboard

2.Chose the Placement

In the central part of the screen, all of your Placements will be shown - Locate the Placement which you want to customize

3. Edit Adslot

Once you have located the Placement you want to customize - click on "Edit Adslot" - on the Rewarder Video Adslot of the Placement.

4. Currency Setup In the pop-up window click on "Overview".

In this section you can adjust:

• Rewarded Video Caps (per user / device);

• Video Volume;

• The name of your currency(s);

• Currency Per Completed View (optional).

Custom Theme

1. Log into the dashboard

2. Chose the Placement

In the left-hand side of at the top of the screen - click on "Placements / Apps"

In the central part of the screen, all of your Placements will be shown - Locate the Placement which you want to customize

3. Edit Adslot

Once you have located the Placement you want to customize - click on "Edit Adslot" - on the Offerwall Adslot of the Placement.

4. Offerwall Design

In the pop-up window click on "Offerwall Design".

5. Customize

From the drop-down menu you can select different types of themes. You have predefined themes, but you can also make a custom theme. You can select the colors you preferer.

Custom Banner

1. Log into the dashboard

2. Chose the Placement

In the left-hand side of at the top of the screen - click on "Placements / Apps"

In the central part of the screen, all of your Placements will be shown - Locate the Placement which you want to customize

3. Edit Adslot

Once you have located the Placement you want to customize - click on "Edit Adslot" - on the Offerwall Adslot of the Placement.

4. Offerwall Design

In the pop-up window click on "Offerwall Design".

5. Customize

On top of the Offerwall you can add your custom banner / image

• Chose if you like to upload a Portrait Image or Landscape image

• Next to the respective image type you chose - click on "Chose File"

• Locate and upload the file you want

• Click on "Save"

Custom Coin

1. Log into the dashboard

2. Chose the Placement

In the left-hand side of at the top of the screen - click on "Placements / Apps"

In the central part of the screen, all of your Placements will be shown - Locate the Placement which you want to customize

3. Edit Adslot

Once you have located the Placement you want to customize - click on "Edit Adslot" - on the Offerwall Adslot of the Placement.

4. Offerwall Design

In the pop-up window click on "Offerwall Design".

5. Customize

You can customize your virtual coin as you wish. You can choose a color of your liking, but also upload your designed coin.

• Select Theme - from the drop-down menu click on "Customize"

• Select Custom Coin - From the drop-down menu click on "Upload Custom Image"

• To upload the image click on "Choose File"

Eligible Placement & AdSlot Combinations

The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Android SDK integration.

Getting Started

Before you start with the integration, make sure you have:

• Created an Adslot

• Added a Placement

• Added an AdSlot

You will find more details here:

Download the Library

You can download the lastest version of our publisher library here:

Add the library to your Xcode project

Unzip the downloaded xcframework archive file, preferably somewhere in your project root.

Navigate to your project root in the Project Navigator, select General tab and then expand Frameworks, Libraries, and Embedded Content.

Click on the + sign and add the archive to your project (using select files), then make sure the Embed option is set to Embed & Sign. The final configuration should look like this:

Then, still in your project root in the Project Navigator, select Info tab and expand Custom iOS Target Properties. Right click and select Add Row, and add App Transport Security Settings. Then click on the newly added row, select Add Row again, and add the Allow Arbitrary Loads option. Make sure this is set to YES:

Initialize the SDK & Managed User Balances

You'll need to initialize ayeT SDK before being able to use it. A good place to do this is the application:didFinishLaunchingWithOptions: method in your application delegate:

If you want to spend user currency, for example if the user clicks a button assigned to a purchaseInAppItem function, you can utilize the deductBalance function:

Check User Balances (Managed Currency Handling)

After initializing the SDK, you can check the current user balances anywhere in your code:

Show the Offerwall

Showing the offerwall is straight-forward, you can simply call showOfferwall from your UIViewController:

Logs

If you want to see logs in Xcode debug area, simply call sdkLogEnable before initializing sdk.

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Eligible Placement & AdSlot Combinations

The table below shows all Placement & AdSlot Type combinations that allow you to utilize the React Native SDK integration.

Getting Started

Before you start with the integration, make sure you have:

• Created an Account

• Added a Placement

• Added an AdSlot

You will find more details here:

Integration Docs

Example App

You can check out our example app here:

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Eligible Placement & AdSlot Combinations

The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Flutter SDK integration.

Getting Started

Before you start with the integration, make sure you:

• Created an Account

• Added a Placement

• Added an AdSlot

You will find more details here:

Flutter Package

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Eligible Placement & AdSlot Combinations

The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Unity SDK integration.

Getting Started

Before you start with the integration, make sure you have:

• Created an Account

• Added a Placement

• Added an AdSlot

You will find more details here:

Download the SDK

You can download the lastest version of our publisher package here:

Add The Package To Your Unity Project

Open your Unity Project

1. Assets -> Import Package -> Custom Package

2. Select the AyetUnityPlugin_vVersion.unitypackage file

3. Press the "Import" button to complete the process

*Android Specific: Update Or Create AndroidManifest.xml File

If you're planning to build against Android, please make sure you have an AndroidManifest.xml file in Assets/Plugins/Android/. If no AndroidManifest exists, you can check out the following template: Appendix: AndroidManifest.xml Template.

Add these app permissions to the manifest:

<uses-permission android:name="android.permission.INTERNET" /> <!-- mandatory permission -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" /> <!-- optional -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <!-- optional -->

Add our Offerwall activity to your scope:

<activity
    android:name="com.ayetstudios.publishersdk.OfferwallActivity"
    android:configChanges="orientation|screenSize">
    <intent-filter android:label="offer">
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data android:scheme="offer" android:host="com.example.myapplication" /> <!-- Replace with your lower case package name -->
    </intent-filter>
</activity>
<activity android:name="com.ayetstudios.publishersdk.VideoActivity" android:configChanges="orientation|screenSize" />	    

Initialize The SDK & Managed User Balances

First, the SDK needs to be initialized like this (APP_KEY is the placement identifier you can find in your dashboard in the android or ios placement details):

#if UNITY_IOS
AyetSdk.init ("<YOUR_IOS_PLACEMENT_APP_KEY>", "<username (external identifier)>", this);
#endif
#if UNITY_ANDROID
AyetSdk.init ("<YOUR_ANDROID_PLACEMENT_APP_KEY>", "<username (external identifier)>", this);
#endif

Implement the SdkUserBalance interface in order to get notified when user balance changes occur:

public void userBalanceInitialized (int available_currency, int pending_currency, int spent_currency){
        Debug.Log("Your::Script::userBalanceInitialized => available_currency: " + available_currency.ToString() + "  pending_currency: "+pending_currency.ToString() + "  spent_currency: " + spent_currency.ToString() );
}

userBalanceInitialized is triggered after calling AyetSdk.init().

public void userBalanceChanged (int available_currency, int pending_currency, int spent_currency){
        Debug.Log("YourScript::userBalanceChanged => available_currency: " + available_currency.ToString() + "  pending_currency: "+pending_currency.ToString() + "  spent_currency: " + spent_currency.ToString() );
}

userBalanceChanged is triggered if the user balance changes while running the app.

If you want to spend user currency, for example if the user clicks a "purchaseInAppItem" button, you can utilize the deductUserBalance function:

AyetSdk.deductUserBalance (<DEDUCT_AMOUNT>, this);

Implement the SdkDeductCallback interface in order to get notified if a deduction succeeded:

public void deductSuccess (){
    Debug.Log ("YourScript::deductSuccess");
}
public void deductFailed (){
    Debug.Log ("YourScript::deductFailed");
}

Check User Balances (Managed Currency Handling)

After initializing the SDK, you can check the current user balances anywhere in your code:

AyetSdk.getAvailableCurrency();
AyetSdk.getPendingCurrency ();
AyetSdk.getSpentCurrency ();

Show the Offerwall

AyetSdk.showOfferwall("your offerwall adslot name");

showOfferwall starts our offerwall activity and displays available tasks for the user to complete.

Unity Example Script

using System.Collections;
using System.Collections.Generic;
using UnityEngine;

public class ExampleScript : MonoBehaviour , SdkUserBalance  , SdkDeductCallback  {

    public void userBalanceInitialized (int available_currency, int pending_currency, int spent_currency){

        Debug.Log("ExampleScript::userBalanceInitialized => available_currency: " + available_currency.ToString() + "  pending_currency: "+pending_currency.ToString() + "  spent_currency: " + spent_currency.ToString() );
    }

    public void userBalanceChanged (int available_currency, int pending_currency, int spent_currency){

        Debug.Log("ExampleScript::userBalanceChanged => available_currency: " + available_currency.ToString() + "  pending_currency: "+pending_currency.ToString() + "  spent_currency: " + spent_currency.ToString() );
    }

    public void deductSuccess (){

        Debug.Log ("ExampleScript::deductSuccess");
    }

    public void deductFailed (){

        Debug.Log ("ExampleScript::deductFailed");
    }

    void Start () {
    }

    void Update () {

        if (Input.touchCount == 1) {

            Touch touch = Input.touches [0];

            if (touch.phase == TouchPhase.Ended) {

                if (Input.GetTouch (0).position.y > (Screen.height/2)) {
                    //sdk initialization
                    AyetSdk.init ("abcde123abcde123abcde123", "user_id_123", this);

                } else {

                    if (Input.GetTouch (0).position.x < (Screen.width/3)) {
                        //show offerwall
                        AyetSdk.showOfferwall("offerwall adslot name");
                    }
                    else if(Input.GetTouch (0).position.x > ((Screen.width/3)*2)){
                        //show user current balance
                        Debug.Log ("ExampleScript  Available currency: " + AyetSdk.getAvailableCurrency());
                        Debug.Log ("ExampleScript  Pending currency: " + AyetSdk.getPendingCurrency ());
                        Debug.Log ("ExampleScript  Spent currency: " + AyetSdk.getSpentCurrency ());
                    }
                    else {
                        int amount = 1;
                        //deduct balance
                        AyetSdk.deductUserBalance (amount, this);
                    }
                }
            }
        }

    }
}

Proguard Rules / Release Builds

If you're going to use Proguard in your release build to obfuscate your application, make sure to add the following rules to your proguard-rules.pro files:

-keep class com.ayetstudios.publishersdk.messages.** {*;}
-keep public class com.ayetstudios.publishersdk.AyetSdk
-keepclassmembers class com.ayetstudios.publishersdk.AyetSdk {
   public *;
}
-keep public interface com.ayetstudios.publishersdk.interfaces.UserBalanceCallback { *; }
-keep public interface com.ayetstudios.publishersdk.interfaces.DeductUserBalanceCallback { *; }

-keep class com.ayetstudios.publishersdk.models.VastTagReqData { *; }

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Appendix: Assets/Plugins/Android/AndroidManifest.xml Template

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.example.myapplication" <!-- Replace with your lower case package name -->
	android:versionCode="1" android:versionName="1.0" xmlns:tools="http://schemas.android.com/tools" android:installLocation="preferExternal">

    <supports-screens android:smallScreens="true" android:normalScreens="true" android:largeScreens="true" android:xlargeScreens="true" android:anyDensity="true" />

    <application android:theme="@style/UnityThemeSelector" android:icon="@drawable/app_icon" android:label="@string/app_name">
        <activity android:name="com.unity3d.player.UnityPlayerActivity" android:label="@string/app_name">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
            <meta-data android:name="unityplayer.UnityActivity" android:value="true" />
        </activity>

        <activity android:name="com.ayetstudios.publishersdk.OfferwallActivity"
	    android:configChanges="orientation|screenSize">
	    <intent-filter android:label="offer">
	        <action android:name="android.intent.action.VIEW" />
	        <category android:name="android.intent.category.DEFAULT" />
	        <category android:name="android.intent.category.BROWSABLE" />
	        <data android:scheme="offer" android:host="com.example.myapplication" /> <!-- Replace with your lower case package name -->
	    </intent-filter>
	</activity>

    </application>
    <uses-permission android:name="android.permission.INTERNET" /> <!-- mandatory permission -->
    <uses-permission android:name="android.permission.READ_PHONE_STATE" /> <!-- optional -->
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> <!-- optional -->
</manifest>	                

Eligible Placement & AdSlot Combinations

The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Static API integration.

Getting Started

Before you start with the integration, make sure you:

• Created an Account

• Added a Placement

• Added an AdSlot

You will find more details here:

Technical Documentation: Static API

API calls return a list of currently running campaigns on our platform which suit your adslot configuration. Can be filtered by additional parameters.

Follow the link below to get to the detailed technical documentation.

CPE Offer Status

If you also request Multi-Reward Offers (CPE Offers) to display them to your users, you can use the CPE Offer Status API to track user progress and build a user journey displaying completed and available tasks.

Follow the link to learn more about the CPE Offer Status API.

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Eligible Placement & AdSlot Combinations

The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Offerwall API integration.

Getting Started

Before you start with the integration, make sure you:

• Created an Account

• Added a Placement

• Added an AdSlot

You will find more details here:

Technical Offerwall API Documentation

For API Calls, all offers matching the parameters provided will be returned and can be displayed to the user.

The Offerwall API supports both server and client-side calls.

Follow the link below to get to the detailed technical documentation.

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Here are the articles in this section:

Eligible Placement & AdSlot Combinations

The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Surveywall API integration.

Getting Started

Before you start with the integration, make sure you:

• Created an Account

• Added a Placement

• Added an AdSlot

You will find more details here:

Technical Surveywall API Documentation

For API Calls, all surveys matching the parameters provided will be returned and can be displayed to the user.

The Surveywall API supports both server and client-side calls.

Follow the link below to get to the detailed technical documentation.

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Eligible Placement & AdSlot Combinations

The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Web Surveywall integration.

Utilization for Desktop, Mobile Web & In-App

Technically, the Surveywall has to be implemented by opening a new browser tab or loading the Surveywall link inside an iframe.

This type of Web Surveywall is intended to be called directly in an actual browser and is not very well suited for webview (in-app) integration.

(COMING SOON) For in-app integrations, please take a look at our seamless In-App integrations by checking out our available SDKs, Wrappers and Plugins.

Integration Best Practices

Getting Started

Before you start with the integration, make sure you:

• Create an Account

• Add a Placement

• Add an AdSlot

You will find more details here:

Your Web Survewall Link - Mandatory Parameters

The URL template for our web surveywall looks like this:

To retrieve the URL for one of your web surveywall adslots, click on "Edit" next to an AdSlot under Placements / Apps and retrieve the Integration URL in the modal.

URL Parameters:

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Eligible Placement & AdSlot Combinations

The table below shows all Placement & AdSlot Type combinations which allow you to utilize the Rewarded Video for Web integration.

Getting Started

Before you start with the integration, make sure you:

• Created an Account

• Added a Placement

• Added an AdSlot

You will find more details here:

Ads.txt

You can find the relevant ads.txt lines that you have to add to www.your-website.com/ads.txt under "Edit Placements" in your publisher dashboard.

CMP

We highly recommend using a CMP (Consent Management Platform) on your website.

There are two different options for you to integrate a CMP:

1. Self-Hosted CMP

   • Look for a CMP that suits you

   • Follow the integration docs of that CMP

2. CMP from Google AdSense (free of charge)

   • Create a Google AdSense account

   • Setup and integrate the Google CMP

   • Our Team can assist with the setup

Supported Features

Our JavaScript library supports the following features:

• OpenRTB header bidding with bundled prebid.js

• Ad server functionality with custom waterfall demand sources, bid buckets and back fill

• Consecutive waterfall VAST tag validation and fallback handling for no-bid scenarios

• Content isolation and parent page protection using iframe playback

• Native browser video rendering

• Automatic detection of external CMPs and support for TCF2 / GDPR consent handling

• Both S2S and signed client-side callbacks for user rewards

Integration

To integrate our video SDK on your site, add the following script to the <head></head> section of your web / app or pages where videos are supposed to be played:

The script above is around 35kb in size and will load additional required scripts (bidders, players, configuration) upon initialization.

Next, please verify that the ads.txt on your server contains all requested entries listed for your placement in our dashboard in the Placement Details > Overview page.

Initialization & Global Callback Handlers

To initialize the SDK for a user, make the following asynchronous call that returns a Promise:

externalIdentifier is a string (up to 64 chars, min. 3 characters) you set to uniquely identify your user. It might be a UUID, a hashed email address or anything that allows you to persistently identify a user.

optionalParameter is an optional string (up to 32 chars) you can use to add an additional reporting dimension to the video statistics. It can be accessed and filtered in the video adslot statistics and the reporting API.

To receive notifications for video playback events, the following global callbacks can be configured:

Requesting Video Ads

To request a video ad for your AdSlot, make the following asynchronous call:

Make sure not to call requestAd before the initialization of the SDK is complete, otherwise the call will fail. Also note, that after a success callback, a video ad is ready to be played. Depending on your video demand sources, successful bids will timeout after a while (usually 1-60 minutes). It's advisable to make a requestAd call just in time when a video should be played.

Playing Video Ads

After a video ad has been successfully requested, the following calls are available to play an ad. Please note, that these functions should be called from a user-interaction (for example a click event) or from the requestAd success callback which itself has been called from a user-interaction. Otherwise, video autoplay will be rejected by most browsers and we must render an additional button over the video for the user to click, which lowers the acceptance and usability.

The different play...Ad functions will silently abort if an ad is already playing. In all other cases, they make use of the global callback handlers described in the Initialization & Global Callback Handlers section.

Additionally, it makes sense to check if a video is ready to play, especially if there's a bigger expected delay between requestAd and play...Ad, for example:

While a video is playing, it's possible to externally interrupt the ad and destroy the player by making a call to destroy:

Rewarding Users

There are two ways to reward users for rewarded video views, (1) Clientside Video SDK Callbacks and (2) Server2Server Conversion Callbacks.

The S2S Callbacks are usually sent to your server within 60 seconds after a completed & rewarded video view.

Server2Server Conversion Callbacks

For more information on Server2Server Conversion Callbacks please use this link:

Clientside Video SDK Callbacks

The Clientside SDK Callbacks are received through the global AyetVideoSdk.callbackRewarded function shown in Initialization & Global Callback Handlers:

You can send the callback response to your server and validate the callback signature serverside. The signature can be verified serverside with your publisher API key (found in our Dashboard > Account Settings > Api Key), like the following example (in PHP). If custom parameters are present in the callback, they are also part of the signature. Signature calculation example:

Passing Custom Parameters

To pass custom parameters to server-side conversion callbacks and clientside callbacks, the function AyetVideoSdk.setCustomParameter('custom_n', 'value') is available.

Where:

custom_n can be one of these: custom_1, custom_2, custom_3, custom_4, custom_5. value is a string (up to 64 chars).

AyetVideoSdk.setCustomParameter can be called any time with the most recent content used when a video view is completed.

Error Handling / Error Codes

There are two different callback methods for errors in the ayetvideosdk:

1. The global AyetVideoSdk.callbackError function that can be configured and is invoked for any type of callback errors: AyetVideoSdk.callbackError = function(e) {console.log("callbackError: "+JSON.stringify(e));};

2. The local error function in AyetVideoSdk.requestAd(adslotName, successFunction, errorFunction); that is invoked if an ad request did not succeed

Possible error messages for AyetVideoSdk.callbackError:

Possible error messages for the AyetVideoSdk.requestAd(...) error callback:

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Coming soon

Coming soon

Hosted on a publisher's server, it lists authorized sellers of ad inventory, preventing fraud by verifying legitimate transactions. This file safeguards both publishers and advertisers, instilling confidence in the ad buying process and maintaining the integrity of the advertising ecosystem.

This is a step by step documentation on how you can get and automatically keep your ads.txt lines updated with ayeT-Studios' platform.

1. Log into your Publisher account

2. Access Placement/Apps Settings

In the top right corner of the screen click on “Placements/Apps”

3. Edit Placement

Locate your rewarded video placement, and click on edit (right-hand side of the screen)

4. Get ads.txt

In the pop-up window, click on “ads.txt”

Two options to keep your ads.txt entries updated

You should update your ads.txt regularly, since ayeT-Studios might add new partners to sell your traffic for higher CPMs. If you don't update regularly, you might miss out on additional revenue opportunities.

You have two options to keep your ads.txt entries updated on your website:

Option A: Regular Manual Updates

1. You can either download the entire ads.txt file

2. Or you can copy the missing entries

You then have to manually add these lines to your ads.txt site on your domain.

Regular Manual Updates

Option B: Automated Updates / Permanent URL

You can use the Permanent URL option to automate keeping the ads.txt entries on your site updated.

Tell your tech to write a few lines of code to e.g. crawl the permanent URL once a day to search for updated ads.txt entries. Once you fetch changes, automaically update the ads.txt entries on your website.

For more information on the API integration please go to the following link:

CMP Integration & User Consent

Why is a CMP integration with enabled vendor management essential to collect GDPR & CCPA compliant user consents to increase fill rates?

Implementing a Consent Management Platform (CMP) is crucial for maximizing ad fill rates and ensuring demand partners actively bid on your inventory. A CMP facilitates compliance with data protection regulations, such as the General Data Protection Regulation (GDPR) in the European Union and the California Consumer Privacy Act (CCPA) in the United States. Without a compliant CMP and without requesting consent from affected GDPR & CCPA users, both fill rate and eCPM will be impacted significantly or no ads will be delivered at all.

Importance of Vendor Management in Your CMP

Enabling vendor management within your CMP is essential. This feature allows you to control which advertising partners can access user data, ensuring that only trusted vendors participate in the bidding process. Proper vendor management enhances transparency and trust, leading to higher fill rates and better eCPM.

Key Regions Where CMP Implementation Is Critical

Implementing a CMP is particularly important in regions with stringent data protection laws, including:

• European Union (EU): Under the GDPR, user consent is mandatory for data processing activities, including targeted advertising.

• United States (US): The CCPA requires businesses to obtain user consent before collecting personal information for advertising purposes.

By integrating a CMP with robust vendor management capabilities, you ensure compliance with these regulations, maintain user trust, and optimize your ad monetization strategy.

To optimize your setup:

• Request a detailed introduction to Vendor Management from your CMP provider.

• Contact our Account Managers to receive a curated list of the most relevant vendors to enable in your CMP solution.

By focusing on comprehensive Vendor Management, you can maximize ad demand, increase fill rates, and comply with data privacy regulations effectively.

SDK Initialization

When should you initialize the SDK?

To provide a seamless experience and avoid user frustration, it’s essential to initialize the SDK at an appropriate time. This ensures the rewarded video is ready to play when users reach the relevant point in your app or game. Follow these recommendations:

1. Early Initialization: Initialize the SDK as early as possible, such as when the user opens your app or game. This proactive approach ensures the SDK is ready well before users reach the video placement.

2. Contextual Initialization: If initializing at app launch isn't feasible, do it when the user is nearing the section where the video will be displayed. This minimizes wait times and ensures a smoother experience.

Ad Requests

When should you make an Ad Request?

It is a much better user experience to make ad requests before the user interacts with the video play button. Here’s why:

1. Improved User Experience Pre-loading ads ensures they are ready to play instantly when the user clicks the button, eliminating waiting times and providing a seamless experience.

2. Ensure Availability By making the ad request in advance, you can verify whether an ad is available (a "fill") before even displaying the button to the user. If no ad is available, the button can remain hidden, avoiding any user confusion or dissatisfaction.

3. Logical Button Display Build a logic in your app or game to display the play button only if an ad is ready to be shown. For example:

   • Make the ad request in advance (e.g., during app initialization or when the user is approaching the rewarded video placement).

   • Display the button only if an ad is available, ensuring users can always watch a video upon clicking.

   • Check the availability of the ad (whether there is a "fill") when the user clicks on the button. If there is a no fill or the ad expired, re-request an ad.

Callbacks

Why should you choose Client-Side Callbacks over Server-to-Server Callbacks?

For scenarios where speed and user satisfaction are critical—such as rewarding users after a video ad— client-side callbacks are the superior choice.

1. Immediate User Feedback: Client-side callbacks provide instant feedback to the user. When a rewarded video ends, the user immediately sees their reward, maintaining engagement and avoiding frustration caused by delays.

2. No Network Dependency: Unlike S2S callbacks, client-side callbacks do not rely on external server communications. This eliminates risks associated with server downtime, network instability, or latency.

3. Enhanced User Experience: Users expect immediate rewards after completing a task. Delays caused by S2S callbacks may lead to complaints, reduced trust, and a negative impression of the app.

4. Simpler Implementation: Client-side callbacks are easier to implement as they do not require complex server infrastructure or robust handling for network issues.

If you want to restrict postbacks to our callback server IPs, please whitelist the following IPs and check back regularly for possible changes:

51.79.101.241
158.69.185.134
158.69.185.154  
35.165.166.40
35.166.159.131
52.40.3.140

Last IP List Update: 2025-01-30

Adding your Callback URL

You can configure a conversion callback URL in our publisher dashboard. To do so, navigate to Placements / Apps, edit your placement and set the Callback URL to your server's postback URL:

If this is the callback URL you set for your offerwall placement:

https://your-server.com/callback?network=ayetstudios&amount={currency_amount}&external_identifier={external_identifier}&payout_usd={payout_usd}

A typical conversion callback sent by our server will look like this:

https://your-server.com/callback?network=ayetstudios&amount=360&external_identifier=username&payout_usd=0.36

Enabling & Processing Reversal Callbacks

You can automatically process Reversals made to your account and placements by enabling Reversal Callbacks.

Simply navigate to Placements / Apps, edit your placement and check the box Enable Reversal Callbacks.

Once enabled we will send reversal callbacks directly to the callback URL you set up for your placements.

The unique transaction ID we send for each conversion will carry an "r-" prepended to the ID for each reversal callback.

Below is a list of all relevant parameters to use in order to distinguish reversal callbacks from regular callbacks.

Available Macros for Callback URLs

Adding your Callback URL

You can configure a conversion callback URL in our publisher dashboard. To do so, navigate to Placements / Apps, edit your placement and set the Callback URL to your server's postback URL:

If this is the callback URL you set for your offerwall placement:

https://your-server.com/callback?network=ayetstudios&amount={currency_amount}&external_identifier={external_identifier}&payout_usd={payout_usd}

A typical conversion callback sent by our server will look like this:

https://your-server.com/callback?network=ayetstudios&amount=360&external_identifier=username&payout_usd=0.36

Enabling & Processing Reversal Callbacks

You can automatically process Reversals made to your account and placements by enabling Reversal Callbacks.

Simply navigate to Placements / Apps, edit your placement and check the box Enable Reversal Callbacks.

Once enabled we will send reversal callbacks directly to the callback URL you set up for your placements.

The unique transaction ID we send for each conversion will carry an "r-" prepended to the ID for each reversal callback.

Below is a list of all relevant parameters to use in order to distinguish reversal callbacks from regular callbacks.

Available Macros for Callback URLs

HMAC Security Hash

Our server will always add a custom header, X-Ayetstudios-Security-Hash, containing a SHA256 HMAC hash of the request parameters and your publisher api key. Your API key can be found in your dashboard at ayetstudios.com under settings.

To verify the hash, perform the following steps:

1. Get all request parameters

2. Order the request parameters alphabetically

3. Build and compare the HMAC hash using the ordered request parameter string and your API key

PHP Example:

Example HMAC calculation

Assuming the below is the callback we sent to you:

1) Get all request parameters

Strip away your domain and order the request parameters alphabetically.

In this example the parameters are already ordered alphabetically.

2) Order the request parameters alphabetically

This is the ordered request parameter string for the HMAC hash calculation:

Your API Key from the ayeT dashboard:

3) Build and compare the HMAC hash using the ordered request parameter string and your API key

Hashing the ordered request parameter string with your Secret Key (API Key) with SHA256, you will get the following HASH Key:

Compare the HASH Key you calculated to the X-Ayetstudios-Security-Hash our server will always add as custom header for each conversion.

Please go through the list to see if you can check each box. If you can check each box, you are most likely good to go live.

Most Important

• Your Placement & AdSlot combination is matching your Technical Integration (see technical integration docs)

• Are you using the correct AdSlot ID?

• Are you using the correct AdSlot Name?

• Did you adjust the currency conversion rate of your AdSlot to your needs?

• Did you add a callback URL to your placement?

• Did you add all necessary macros to your callback URL in order to pay your users?

• Are you processing callbacks correctly (responding with http200 to the ayeT-Studios servers)?

Optional

• Did you enable reversal callbacks?

• Did you add macros to your callback URL for reversal callbacks?

• Did you create a Surveywall Design matching your Website's or App's look and feel?

• Did you upload your customized virtual currency icon?

• Did you set decimals for the virtual currency displayed on the surveywall buttons?

Please go through the list to see if you can check each box. If you can check each box, you are most likely good to go live.

Most Important

• Your Placement & AdSlot combination is matching your Technical Integration (see technical integration docs)

• Are you passing an externalIdentifier to the Rewarded Video SDK?

• Are you using the correct Placement ID?

• Are you using the correct AdSlot Name to make an ad request?

• Did you add the ads.txt files to your domain?

• Did you integrate a CMP?

• Do you initialize the CMP in all relevant places of your website to pass a user consent to the Rewarded Video SDK?

• Did you talk to your account manager to finalize the Demand Setup in order to get real ads before you go live?

• Are callbacks working correctly? Either Client-Side Callbacks or S2S Callbacks. For S2S Callbacks, please also check the "Optional" section.

• How do you handle "No Fills"? "No Fills" are something entirely normal and the mean that an ad is currently not available for this user, because no advertiser wanted to buy the specific user impression. Integrate Rewarded Video in a way for which a "No Fill" doesn't disturb the user flow.

• Make sure to not pay users if they didn't watch the videos until the end, otherwise they will exploit the setup to earn coins faster without you getting paid by the advertisers.

Optional

• If you want to payout virtual currency, relying on ayeT's callbacks, did you set the amount of currency paid out to a user per completed view in your AdSlot Settings?

• If you want to use S2S callbacks, did you enabled "Send S2S Callbacks for Video Views" in your AdSlot settings?

• Did you add a callback URL to your placement?

• Did you add all necessary macros to your callback URL in order to pay your users?

• Are you processing callbacks correctly (responding with http200 to the ayeT-Studios servers)?

Please go through the list to see if you can check each box. If you can check each box, you are most likely good to go live.

Most Important

• Your Placement & AdSlot combination is matching your Technical Integration (see technical integration docs)

• Are you using the correct AdSlot ID?

• Are you using the correct AdSlot Name?

• Did you adjust the correct currency conversion rate for your AdSlot to your needs?

• Did you add a callback URL to your placement?

• Did you add all necessary macros to your callback URL in order to pay your users?

• Are you processing callbacks correctly (responding with http200 to the ayeT-Studios servers)?

Android SDK Specific

• Is your package name for the placement in the ayeT-Studios dashboard matching the package name for your release build?

• Are you using the correct AYET_APP_KEY?

• Are you using the correct ADSLOT_NAME?

• Did you add Proguard Rules?

Optional

• Did you enable reversal callbacks?

• Did you add macros to your callback URL for reversal callbacks?

• Did you create an Offerwall Design matching your Website's or App's look and feel?

• Did you upload your customized virtual currency icon?

• Did you set decimals for the virtual currency displayed on the offerwall buttons?

Why you should utilize Sandbox Identifiers

A Sandbox Identifier is basically an external identifier (a User ID) that you define. Appending or passing this identifier to the offerwall will trigger the offerwall to run in sandbox mode.

Sandbox Identifiers will help you to test the offerwall across multiple devices and in different GEOs for certain predefined "Identifiers".

Defining Sandbox Identifiers

Click on Edit Placement in the ayeT-Studios Publisher Dashboard and enter a identifier of your choice for the Sandbox Identifiers feature.

In the example below, the sandbox identifier is set to testuser123.

You can enter several identifiers if needed to make it easer to test with different devices and in different GEOs across your team.

Triggering a Test Callback

Now that the sandbox identifier is set, you have to pass the sandbox identifier to your Offerwall AdSlot that you want to test.