1. Offerwall Securing Callbacks

2. Rewarded Video Securing Callbacks

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.

Eligible Placement & AdSlot Combinations

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

Getting Started

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

• Created an Account

• Added a Placement

• Added an AdSlot

You can find more details here:

Installation

Run the installation command:

Android Setup

Add the following tag to your AndroidManifest.xml , just before the application tag:

Example of completed AndroidManifest.xml:

iOS Setup

Install pods:

Import and initialize the SDK

The externalIdentifier is your user's ID, accessible in conversion callbacks via {external_identifier}. The placementId is found in your dashboard.

Show the Offerwall

To show the offerwall, simply call the showOfferwall method:

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Additional Methods

Show the Surveywall

To show the surveywall, simply call the showSurveywall method:

Fetch Offers

To fetch a list of all offers in JSON format, simply call the getOffers method:

Show Reward Status

The Reward Status page allows users to see their clicked and in-progress offers and allows users to request support / submit tickets. The reward status is also part of the offerwall and the surveywall. To show the reward status page stand-alone, simply call the showRewardStatus method:

Set custom parameters

Set custom parameters for callbacks. Set up to 5 custom parameters.

More information here:

Set Age and Gender

Additionally, you may optionally pass user age and gender to us. This can help us match users to the best and most appropriate offers for them.

Coming soon

Coming soon

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.

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:

Javascript example:

Python example:

Example HMAC calculation

Assuming the below is the callback we sent to you:

1) Get all request parameters

Strip away your domain and get the request parameters.

2) Sort the parameters alphabetically and URL-encode the values

This is crucial because special characters (like spaces) must be encoded (e.g. a space should become +) in order to match the original string that was hashed.

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 a 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 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?

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)?

Offerwall API

The Offerwall API provides a solution for publishers who want to include an offerwall in their application/website but have control over the presentation of the offers. 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, which distinguishes it from the deprecated Live API.

Static API

The Static API is recommended only for special integrations, because not all campaigns are available without more sophisticated device match. If integrated, it should be called each 15-30 minutes to make sure our campaigns are still available, did not run into daily caps or changed targeting / bid. The "Static API key" for requests is adslot specific and available in the adslot details once approved by your account manager.

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.

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.

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 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://offerwall.ayet.io/offers?adSlot={ADSLOT_ID}&externalIdentifier={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:

Eligible Placement & AdSlot Combinations

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

Demo App

Getting Started

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

• Created an Account

• Added a Placement

• Added an AdSlot

You can find more details here:

Adding the SDK Dependency

To add the SDK to your project, simply update your build.gradle.kts file to add the following dependency:

dependencies {
    implementation("io.ayet:android-sdk-v2:1.0.3")
}

Once this has been added, sync your project to apply the changes:

Add the internet permission to AndroidManifest

Add the following tag to your AndroidManifest.xml , just before the application tag:

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

Example of completed AndroidManifest.xml:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

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

    <application
        android:allowBackup="true"
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:fullBackupContent="@xml/backup_rules"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.AyetSDKExample">
        <activity
            android:name=".MainActivity"
            android:exported="true"
            android:label="@string/app_name"
            android:theme="@style/Theme.AyetSDKExample">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

Import and initialize the SDK

In this step, we will import and initialize the SDK in the main activity.

First, import the library:

import com.ayet.sdk.AyetSdk                

Then, call the AyetSdk.init method:

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()

        AyetSdk.init(this, YOUR_PLACEMENT_ID, "USER_EXTERNAL_IDENTIFIER")

        setContent {
            AyetSDKExampleTheme {
                Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding ->
                    MainScreen(modifier = Modifier.padding(innerPadding))
                }
            }
        }
    }
}

Show the Offerwall

To show the offerwall, simply call the showOfferwall method:

val context = LocalContext.current
AyetSdk.showOfferwall(context, "YOUR_OFFERWALL_ADSLOT_NAME")

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Additional Methods

Fetch Offers

To fetch a list of all offers in JSON format, simply call the getOffers method:

AyetSdk.getOffers("YOUR_OFFERWALL_API_ADSLOT_NAME") { offersJson ->
    if (offersJson != null) {
        Log.d("MainActivity", "Offers received: $offersJson")
    } else {
        Log.w("MainActivity", "Failed to get offers - null response")
    }
}

Show Reward Status

The Reward Status page allows users to see their clicked and in-progress offers and allows users to request support / submit tickets. The reward status is also part of the offerwall and the surveywall. To show the reward status page stand-alone, simply call the showRewardStatus method:

val context = LocalContext.current
AyetSdk.showRewardStatus(context)

Show the Surveywall

To show the surveywall, simply call the showSurveywall method:

val context = LocalContext.current
AyetSdk.showSurveywall(context, "YOUR_SURVEYWALL_ADSLOT_NAME")

Set custom parameters

Set custom parameters for callbacks. Set up to 5 custom parameters.

AyetSdk.setTrackingCustom1("custom1")
AyetSdk.setTrackingCustom2("custom2")
AyetSdk.setTrackingCustom3("custom3")
AyetSdk.setTrackingCustom4("custom4")
AyetSdk.setTrackingCustom5("custom5")

More information here:

Set Age and Gender

Additionally, you may optionally pass user age and gender to us. This can help us match users to the best and most appropriate offers for them.

AyetSdk.setGender(Gender.MALE)
AyetSdk.setGender(Gender.FEMALE)
AyetSdk.setAge(25)

Notes

• When calling certain SDK methods, context must be passed. When passing context from onCreate for example, this will simply be this. If calling from elsewhere, the context will need to be provided from LocalContext.current.

Eligible Placement & AdSlot Combinations

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

Demo App

Getting Started

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

• Created an Account

• Added a Placement

• Added an AdSlot

You can find more details here:

Adding the SDK Dependency

To integrate the iOS SDK into your project, add the package dependency to your app.

In Xcode, with your project open, click File and Add Package Dependencies...

Enter the repository URL (https://github.com/ayetstudios/ios-sdk-v2-repo) in the search bar and click Add Package:

Select the target for your app, then click Add Package again:

Import and initialize the SDK

In this step, we will import and initialize the SDK in the app.

First, import the library:

import AyetSDK           

Then, call the AyetSDK.shared.initialize method:

@main
struct iosSdkV2DemoAppApp: App {
    init() {
        AyetSDK.shared.initialize(placementId: YOUR_PLACEMENT_ID, externalIdentifier: "USER_EXTERNAL_IDENTIFIER")
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Show the Offerwall

To show the offerwall, simply call the showOfferwall method:

await AyetSDK.shared.showOfferwall(adSlotName: "YOUR_OFFERWALL_ADSLOT_NAME")

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Additional Methods

Fetch Offers

To fetch a list of all offers in JSON format, simply call the getOffers method:

if let offersJson = await AyetSDK.shared.getOffers(adSlotName: "YOUR_OFFERWALL_API_ADSLOT_NAME") {
    print("Offers received: \(offersJson)")
} else {
    print("Failed to get offers - null response")
}

Show Reward Status

The Reward Status page allows users to see their clicked and in-progress offers and allows users to request support / submit tickets. The reward status is also part of the offerwall and the surveywall. To show the reward status page stand-alone, simply call the showRewardStatus method:

await AyetSDK.shared.showRewardStatus()

Show the Surveywall

To show the surveywall, simply call the showSurveywall method:

await AyetSDK.shared.showSurveywall(adSlotName: "YOUR_SURVEYWALL_ADSLOT_NAME")

Set custom parameters

Set custom parameters for callbacks. Set up to 5 custom parameters.

AyetSDK.shared.setTrackingCustom1("custom1")
AyetSDK.shared.setTrackingCustom2("custom2")
AyetSDK.shared.setTrackingCustom3("custom3")
AyetSDK.shared.setTrackingCustom4("custom4")
AyetSDK.shared.setTrackingCustom5("custom5")

More information here:

Set Age and Gender

Additionally, you may optionally pass user age and gender to us. This can help us match users to the best and most appropriate offers for them.

AyetSDK.shared.setGender(.male)
AyetSDK.shared.setGender(.female)
AyetSDK.shared.setAge(25)

Eligible Placement & AdSlot Combinations

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

Demo App

Getting Started

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

• Created an Account

• Added a Placement

• Added an AdSlot

You can find more details here:

Adding the SDK Dependency

Add to your pubspec.yaml:

dependencies:
  ayet_sdk_v2: ^1.0.4

Once this has been added, run flutter pub get to fetch the package.

Android Setup

Add the following tag to your AndroidManifest.xml , just before the application tag:

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

Example of completed AndroidManifest.xml:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

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

    <application
        android:allowBackup="true"
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:fullBackupContent="@xml/backup_rules"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.AyetSDKExample">
        <activity
            android:name=".MainActivity"
            android:exported="true"
            android:label="@string/app_name"
            android:theme="@style/Theme.AyetSDKExample">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

iOS Setup

Enable Swift Package Manager:

flutter config --enable-swift-package-manager

Then run flutter build ios to fetch dependencies.

Import and initialize the SDK

import 'package:ayet_sdk_v2/ayet_sdk_v2.dart';

final sdk = AyetSdkV2();

// Initialize with your placement ID and user identifier
await sdk.init(
  placementId: YOUR_PLACEMENT_ID,
  externalIdentifier: 'USER_EXTERNAL_IDENTIFIER',
);

The externalIdentifier is your user's ID, accessible in conversion callbacks via {external_identifier}. The placementId is found in your dashboard.

Show the Offerwall

To show the offerwall, simply call the showOfferwall method:

await sdk.showOfferwall('YOUR_OFFERWALL_ADSLOT_NAME');

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Additional Methods

Fetch Offers

To fetch a list of all offers in JSON format, simply call the getOffers method:

final offersJson = await sdk.getOffers('YOUR_OFFERWALL_API_ADSLOT_NAME');

Show Reward Status

The Reward Status page allows users to see their clicked and in-progress offers and allows users to request support / submit tickets. The reward status is also part of the offerwall and the surveywall. To show the reward status page stand-alone, simply call the showRewardStatus method:

await sdk.showRewardStatus();

Show the Surveywall

To show the surveywall, simply call the showSurveywall method:

await sdk.showSurveywall('YOUR_SURVEYWALL_ADSLOT_NAME');

Set custom parameters

Set custom parameters for callbacks. Set up to 5 custom parameters.

await sdk.setTrackingCustom1('custom1');
await sdk.setTrackingCustom2('custom2');
await sdk.setTrackingCustom3('custom3');
await sdk.setTrackingCustom4('custom4');
await sdk.setTrackingCustom5('custom5');

More information here:

Set Age and Gender

Additionally, you may optionally pass user age and gender to us. This can help us match users to the best and most appropriate offers for them.

await sdk.setAge(25);
await sdk.setGender(AyetGender.male);
await sdk.setGender(AyetGender.female);

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 Android SDK integration.

Demo App

Getting Started

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

• Created an Account

• Added a Placement

• Added an AdSlot

You can find more details here:

Adding the SDK Dependency

To add the SDK to your project, simply update your build.gradle.kts file to add the following dependency:

dependencies {
    implementation("io.ayet:android-sdk-v2:1.0.3")
}

Once this has been added, sync your project to apply the changes:

Add the internet permission to AndroidManifest

Add the following tag to your AndroidManifest.xml , just before the application tag:

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

Example of completed AndroidManifest.xml:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

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

    <application
        android:allowBackup="true"
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:fullBackupContent="@xml/backup_rules"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.AyetSDKExample">
        <activity
            android:name=".MainActivity"
            android:exported="true"
            android:label="@string/app_name"
            android:theme="@style/Theme.AyetSDKExample">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

Import and initialize the SDK

In this step, we will import and initialize the SDK in the main activity.

First, import the library:

import com.ayet.sdk.AyetSdk                

Then, call the AyetSdk.init method:

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()

        AyetSdk.init(this, YOUR_PLACEMENT_ID, "USER_EXTERNAL_IDENTIFIER")

        setContent {
            AyetSDKExampleTheme {
                Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding ->
                    MainScreen(modifier = Modifier.padding(innerPadding))
                }
            }
        }
    }
}

Show the Surveywall

To show the surveywall, simply call the showSurveywall method:

val context = LocalContext.current
AyetSdk.showSurveywall(context, "YOUR_SURVEYWALL_ADSLOT_NAME")

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Additional Methods

Show the Offerwall

To show the offerwall, simply call the showOfferwall method:

val context = LocalContext.current
AyetSdk.showOfferwall(context, "YOUR_OFFERWALL_ADSLOT_NAME")

Fetch Offers

To fetch a list of all offers in JSON format, simply call the getOffers method:

AyetSdk.getOffers("YOUR_OFFERWALL_API_ADSLOT_NAME") { offersJson ->
    if (offersJson != null) {
        Log.d("MainActivity", "Offers received: $offersJson")
    } else {
        Log.w("MainActivity", "Failed to get offers - null response")
    }
}

Show Reward Status

The Reward Status page allows users to see their clicked and in-progress offers and allows users to request support / submit tickets. The reward status is also part of the offerwall and the surveywall. To show the reward status page stand-alone, simply call the showRewardStatus method:

val context = LocalContext.current
AyetSdk.showRewardStatus(context)

Set custom parameters

Set custom parameters for callbacks. Set up to 5 custom parameters.

AyetSdk.setTrackingCustom1("custom1")
AyetSdk.setTrackingCustom2("custom2")
AyetSdk.setTrackingCustom3("custom3")
AyetSdk.setTrackingCustom4("custom4")
AyetSdk.setTrackingCustom5("custom5")

More information here:

Set Age and Gender

Additionally, you may optionally pass user age and gender to us. This can help us match users to the best and most appropriate offers for them.

AyetSdk.setGender(Gender.MALE)
AyetSdk.setGender(Gender.FEMALE)
AyetSdk.setAge(25)

Notes

• When calling certain SDK methods, context must be passed. When passing context from onCreate for example, this will simply be this. If calling from elsewhere, the context will need to be provided from LocalContext.current.

Eligible Placement & AdSlot Combinations

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

Demo App

Getting Started

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

• Created an Account

• Added a Placement

• Added an AdSlot

You can find more details here:

Adding the SDK Dependency

Add to your pubspec.yaml:

dependencies:
  ayet_sdk_v2: ^1.0.4

Once this has been added, run flutter pub get to fetch the package.

Android Setup

Add the following tag to your AndroidManifest.xml , just before the application tag:

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

Example of completed AndroidManifest.xml:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

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

    <application
        android:allowBackup="true"
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:fullBackupContent="@xml/backup_rules"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.AyetSDKExample">
        <activity
            android:name=".MainActivity"
            android:exported="true"
            android:label="@string/app_name"
            android:theme="@style/Theme.AyetSDKExample">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

iOS Setup

Enable Swift Package Manager:

flutter config --enable-swift-package-manager

Then run flutter build ios to fetch dependencies.

Import and initialize the SDK

import 'package:ayet_sdk_v2/ayet_sdk_v2.dart';

final sdk = AyetSdkV2();

// Initialize with your placement ID and user identifier
await sdk.init(
  placementId: YOUR_PLACEMENT_ID,
  externalIdentifier: 'USER_EXTERNAL_IDENTIFIER',
);

The externalIdentifier is your user's ID, accessible in conversion callbacks via {external_identifier}. The placementId is found in your dashboard.

Show the Surveywall

To show the surveywall, simply call the showSurveywall method:

await sdk.showSurveywall('YOUR_SURVEYWALL_ADSLOT_NAME');

Conversion Callbacks & Currency Handling

Learn about:

• Setting up callbacks

• IP Whitelists

• Securing callbacks using HMAC Security Hash

• Testing callbacks

Click on the link below:

Additional Methods

Show the Offerwall

To show the offerwall, simply call the showOfferwall method:

await sdk.showOfferwall('YOUR_OFFERWALL_ADSLOT_NAME');

Fetch Offers

To fetch a list of all offers in JSON format, simply call the getOffers method:

final offersJson = await sdk.getOffers('YOUR_OFFERWALL_API_ADSLOT_NAME');

Show Reward Status

The Reward Status page allows users to see their clicked and in-progress offers and allows users to request support / submit tickets. The reward status is also part of the offerwall and the surveywall. To show the reward status page stand-alone, simply call the showRewardStatus method:

await sdk.showRewardStatus();

Set custom parameters

Set custom parameters for callbacks. Set up to 5 custom parameters.

await sdk.setTrackingCustom1('custom1');
await sdk.setTrackingCustom2('custom2');
await sdk.setTrackingCustom3('custom3');
await sdk.setTrackingCustom4('custom4');
await sdk.setTrackingCustom5('custom5');

More information here:

Set Age and Gender

Additionally, you may optionally pass user age and gender to us. This can help us match users to the best and most appropriate offers for them.

await sdk.setAge(25);
await sdk.setGender(AyetGender.male);
await sdk.setGender(AyetGender.female);

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.

Passing Profiling Information via the Surveywall API

If you already collect profiling data from your users, you can optionally pass this information to us through the Surveywall API call. While not required, providing profiling details can improve targeting and survey performance.

To enable this feature, open the Edit Adslot modal for your Surveywall API adslot in the dashboard and generate a Profiling Data Validation Hash.

Available Questions and Answers

You can find the complete list of supported profiling questions and acceptable answer formats here: 👉 Profiling Questions & Answers Please check this document regularly for updates.

How to Pass Profiling Information

To include profiling data in your API call, append the appropriate question and answer parameters to the request URL. You'll also need to generate a cryptographic hash to validate the data.

For example, to pass the following information:

• Gender: Male

• ZIP Code: 20500

• Birthdate: 1995-05-31

The API call would look like this:

https://www.ayetstudios.com/surveys/surveywall_api/{adslotId}?external_identifier={YOUR_USER_IDENTIFIER}&q5=1995-05-31&q6=20500&q7=8&hash=88cd2108b5347d973cf39cdf9053d7dd42704876d8c9a9bd8e2d168259d3ddf7

Hash Generation

The hash parameter is calculated as a SHA256 HMAC, using the Profiling Data Validation Hash as the secret key. The input string is a URL-encoded query string of all parameters except the hash itself, sorted by key.

Here’s a PHP example:

function generateHash($requestParams, $profilingDataValidationHash) {
    // Remove the 'hash' parameter
    unset($requestParams['hash']);

    // Sort parameters by key
    ksort($requestParams);

    // Build query string
    $queryString = http_build_query($requestParams);

    // Calculate HMAC-SHA256 hash
    $expectedHash = hash_hmac('sha256', $queryString, $profilingDataValidationHash);

    return $expectedHash;
}

// Input data
$profilingDataValidationHash = "your-key";
$requestParams = [
    "external_identifier" => "testuser1234",
    "q5" => "1995-05-31",
    "q6" => "20500",
    "q7" => "8"
];

echo "https://www.ayetstudios.com/surveys/surveywall_api/1234?external_identifier=testuser1234&q5=1995-05-31&q6=20500&q7=8&hash=" . generateHash($requestParams, $profilingDataValidationHash);

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

   • Go to https://iabeurope.eu/cmp-list/

   • 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

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:

<script src="https://cdn.ayet.io/offerwall/js/ayetvideosdk.min.js"></script>	

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:

var placementId=3; // This is the numeric id of your web placement
var externalIdentifier="{your user identifier}";
var optionalParameter=null; // or a string(32)
AyetVideoSdk.init(placementId, externalIdentifier, optionalParameter).then(function() {
	console.log("finished initialization!");
});

externalIdentifier is a string (up to 128 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:

/* An error occured when trying to play a video ad. After this callback, no video is being rendered and a new ad has to be requested first: */
AyetVideoSdk.callbackError = function(e) {console.log("callbackError: "+JSON.stringify(e));};

/* After this callback, a video will start playing: */
AyetVideoSdk.callbackPlaying = function() {console.log("callbackPlaying");};

/* After this callback, playing the video is finished and the player is closed: */
AyetVideoSdk.callbackComplete = function() {console.log("callbackComplete");};

/* This callback is sent once a second while a video is being played: */
AyetVideoSdk.callbackProgress = function(remainingSeconds) {console.log("callbackProgress: "+Math.round(remainingSeconds)+"s remaining");};

/* This callback is sent if a video has been completed and the impression has gone through fraud checks (see "Rewarding Users" for more details): */
AyetVideoSdk.callbackRewarded = function(details) {appendLog("callbackRewarded: "+JSON.stringify(details));};

Requesting Video Ads

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

AyetVideoSdk.requestAd(
	'{your_rewarded_video_adslot_name}',
	function() { // success callback function
		console.log("requestAd successful");
	},
	function(msg) { // error callback function
		appendLog("requestAd failed: "+msg);
	}
);	  

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.

/* Play the ad in a pre-defined div (consult your account manager to determine if size & location is appropriate for all demand partners): */
AyetVideoSdk.playInPageAd('video_div');

/* Play the ad full size (100% of your page viewport): */
AyetVideoSdk.playFullsizeAd();

/* Play the ad fullscreen (this temporarily switches the browser to fullscreen mode): */
AyetVideoSdk.playFullscreenAd();

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:

/* This example assumes an ad was requested a longer time ago and we're unsure if the bid expired already */
if (AyetVideoSdk.isAdAvailable()) {
	AyetVideoSdk.playInPageAd('{your_html_video_div_id}');
} else {
	/* Either abort and notify the user or request and play a fresh ad: */
	AyetVideoSdk.requestAd(
		'{your_rewarded_video_adslot_name}',
		function() { // success callback function
			AyetVideoSdk.playInPageAd('{your_html_video_div_id}');
		},
		function(msg) { // error callback function
			appendLog("requestAd failed: "+msg);
		}
	);
}

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

/* Interrupt a playing ad and destroy the player (to play another ad later, a new call to AyetVideoSdk.requestAd is required) */
AyetVideoSdk.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:

/* This callback is sent if a video has been completed and the impression has gone through fraud checks: */
AyetVideoSdk.callbackRewarded = function(details) {appendLog("callbackRewarded: "+JSON.stringify(details));};

/* Example output:
callbackRewarded: {"status":"success","rewarded":true,"externalIdentifier":"your user identifier","currency":10,"conversionId":"aef8cd370cfe-video-u94-adbcec159f76","signature":"f98c35ae4facef42dce5b31f6a5f9f0e8819b8ec"}
*/

/* Example output if custom parameters were set:
callbackRewarded: {"status":"success","rewarded":true,"externalIdentifier":"your user identifier","currency":10,"conversionId":"aef8cd370cfe-video-u94-adbcec159f76","custom_1":"bar", "custom_3":"foo","signature":"e35d78be4facef42dce5b31f6a5f9f0e8821c3de"}
*/

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:

$signature = hash_hmac('sha1',
	$response['externalIdentifier'] .
	$response['currency'] .
	$response['conversionId'] .
	(isset($response['custom_1']) ? isset($response['custom_1'] : '') .
	(isset($response['custom_2']) ? isset($response['custom_2'] : '') .
	(isset($response['custom_3']) ? isset($response['custom_3'] : '') .
	(isset($response['custom_4']) ? isset($response['custom_4'] : '') .
	(isset($response['custom_5']) ? isset($response['custom_5'] : '')
	, $user->publisher->user->api_key);

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.

/* Example of setting custom parameters: */
AyetVideoSdk.setCustomParameter("custom_1", "bar");
AyetVideoSdk.setCustomParameter("custom_3", "foo");

/* Example of unsetting custom parameter: */
AyetVideoSdk.setCustomParameter("custom_1", null);

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:

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:

Adding your Callback URL

To handle video conversions with S2S Callbacks, first make sure your callback URL is setup correctly in your publisher placement. To do so, navigate to Placements / Apps, edit your placement and set the Callback Url to your server's postback url:

Also make sure that "Send S2S Callbacks" for video views is enabled for your Rewarded Video AdSlot in "AdSlot Details" > "Overview".

If this is the callback url you set for your placement:

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

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

https://your-server.com/callback?network=ayetstudios&amount=10&external_identifier=username&payout_usd=0.007&adslot_id=16

Available Macros for Callback URLs:

During a redirect through tracking links, a few things can happen such as:

• low user quality

• proxy or VPN use

• wrong GEO targeting

• wrong device or browser version

This prevents users from successful redirect to the final destination - the Play Store, the App Store or the intended Landing Page.

Setting your custom Redirect Destination

You can configure an https redirect target for failed offer redirects in our publisher dashboard.

This will override the standard "Error Page" (we call it "Share Offer" page) displayed in case of redirect errors.

To do so, navigate to Placements / Apps, edit your placement and set the Failed Redirect Destination:

A typical redirect destination may look like this:

https://your-redirect-destination.com/redirect?user_id={external_identifier}&offer_id={offer_id}&reason_code={reason_code}&reason_message={reason_message}

Available Macros

Below is a list of available macros to use in your redirect URL to better understand why a certain click is failing to get redirected. That way you can improve your integration down the road.

Why you should utilize the Callback Tester

The Callback Tester was built to help you to verify that you:

1. added all the macros to your Callback URL that you need to receive back

2. that those macros are populated by ayeT-Studios' servers as expected

Check Available Macros

You can check all availabe macros that can be added to your callback URL here:

Send Test Postback

Click on Edit Placement in order to open the detail modal. Here you can change your postback URL and i.e. add additional macros.

In addition you can send a test postback to your servers.

When you click Send Test Postback, you will a list of fields and the information with which we will populate the macros you added to your callback URL.

For a few of those fields you can input values yourself. A few other fields are locked and only the information displayed can be passed.

Clicking on Send Postback will send the test postback.

Check Test Postback

Clicking on Check Postback Status afterwards, will lead you to Reports / Conversions, where the callback that just got sent will be displayed.

If you click on Details, you will be able to see the entire payload we sent and your Callback URL with populated macros.

Allows publishers to update Currency Conversion Rate, for a specific adslot.

Introduction

With the Currency Conversion Rate publishers can adjust the exchange rate used to calculate payouts to users. You can define the amount of virtual currency paid out to users for each USD you earn.

All transactions on the ayeT-Studios are handled and operated in USD.

Updating the Currency Conversion Rate

Go into "Edit AdSlot" and edit Currency Conversion Rate ($1 = X virtual currency). Dont forget to hit save.

Technical Documentation: Publisher Reporting API

Retrieves all statistics for the account for the given date range and filtered by optional parameters. The returned data includes the impressions, clicks, conversions, revenue etc. statistics for the specified date range for each day grouped by country. If optional parameters (placements, adslots, etc.) are set, only metrics matching those parameters will be returned.

Follow the link to learn more about utilizing the Publisher Reporting API.

Technical Documentation: Advertiser Reporting API

Retrieves all statistics for the account for the given date range and filtered for an optional identifier. The returned data includes the number of currently running and active (pending, running, review) campaigns as well as impressions, clicks and transaction statistics for the specified date range. If identifier is set, only campaigns matching "identifier" are inspected.

Follow the link to learn more about utilizing the Advertiser Reporting API.

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

In the bottom left 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.

What is a Currency Sale?

A virtual currency sale is a limited-time event aimed at boosting performance for publishers and advertisers alike. During the event, the digital currency exchange rates for rewards are increased with a multiplier between 1.3x and 2x in order to create a stronger incentive for users to use the Offerwall. aye-T Studios regularly organizes currency sales with partnering publishers during holiday periods like Easter or Christmas for example.

Custom Currency Sale

1. Log into your dashboard

2. Overview

In the top left corner of the screen under "Overview" - click on "Currency Sale"

3. Create Currency Sale

On the right-hand side of the screen - click on "Currency Sale"

4. Setup

A. You have to fill in the missing information, such as:

• Name your currency sale

• Description (not mandatory)

• Select your Placement for which you want to run a currency sale

B. Targeting

You can also make your currency sale country-specific - by entering the country name in the box

You can also exclude certain countries from your currency sale - by entering the country name in the box and ticking the box "Exclude Selected Countries"

You can also exclude certain countries from your currency sale - by entering the country name in the box and ticking the box "Exclude Selected Countries"

C. Schedule

You can customize the start and the end date of your currency sale by clicking on the calendar icon.

D. Turn "ON" Currency Sale