This page shows you how to fill out or update your personal / company information
You can change and update your personal information.
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"
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.
React Native Example
If you created an app via React Native and you compile your production version for both Android and IOS, you would ideally set up the following placement on ayeT-Studios:
Android App
Once you create a Placement, you cannot change the platform type
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.
Creating a Placement
In this section, you can find step-by-step guidance on how to set up placement and get started.
1. Log in to the dashboard
2. Placements / Apps
Callbacks Settings
1. Offerwall Callbacks
2. Rewarded Video Callbacks
Logos and Creatives
1) Offerwall - GameTastic
2) Surveywall - PollTastic
Declined Placements
We decline placements for several reasons. Some of the reasons are listed below:
You didn't set up the placement correctly
Your app / website failed to reach our quality criteria
Offerwall API vs Static API
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.
Publisher Reporting API
Our Publisher Reporting API allows publishers with and without adserver functionality to retrieve detailed statistics on their placement & adslot performance.
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.
IP Whitelist
If you want to restrict postbacks to our callback server IPs, please whitelist the following IPs and check back regularly for possible changes:
Last IP List Update: 2025-01-30
We reached out to you with additional questions, but you didn't get back to us
You set up an API / Network placement for which only selected publishers are eligible
You couldn't find a reason for which we might have declined your placement?
No problem, getting declined isn't the end of the world. We are happy to discuss why we declined your placement in detail. Hopefully, there is a chance to work out a solution together.
In order to find out more, please reach out via email at: [email protected]
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.
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.
Once you have created a Placement - you cannot change the placement type
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.
You can customize your virtual currency:
8. Create Placement
Once you are done filling out the information - click on "Create Placement"
If the button is not clickable - some information is missing
Attention: Requests to the reporting module are limited to 20 calls per hour.
Follow the link to learn more about utilizing the Publisher Reporting API.
What is an AdSlot?
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
You can add 1+n AdSlots for each Placement you created, giving you the room to slice and dice setups within your App or on your Website.
The AdSlot ID is relevant for most of the integrations on the ayeT-Studios platform.
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.
Before creating an AdSlot, you have to create a Placement for your App or Website first.
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.
Flutter Wrapper (v2)
The Flutter Wrapper lets you easily monetize your app and reward your users with in-app currency. Your users get access to our offers and surveys, allowing them to earn rewards for completing offers.
Updates History
2025-12-19: v1.0.0 - Release the Flutter Wrapper for V2 of the SDK
Show the Offerwall
To show the offerwall, simply call the showOfferwall method:
The YOUR_OFFERWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall adslots.
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:
The YOUR_OFFERWALL_API_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall API adslots.
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:
Show the Surveywall
To show the surveywall, simply call the showSurveywall method:
The YOUR_SURVEYWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Surveywall adslots.
Set custom parameters
Set custom parameters for callbacks. Set up to 5 custom parameters.
Note: Custom parameters must also be added to your callback URL to receive them in your S2S callbacks.
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.
Surveywall Checklist
This checklist is supposed to help you to take care of all important and relevant settings before going live with your Surveywall.
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
Optional
Offerwall Checklist
This checklist is supposed to help you to take care of all important and relevant settings before going live with your Offerwall.
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
Android SDK Specific
Optional
Get Offerwall User ID
1. Access the Offerwall
Ask the user to go to the Offerwall using the appropriate device.
2. Go to Offerwall Menu
Ask the user to click on the Offerwall menu - on the top left corner of the Offerwall.
3. Click on "Reward Status"
4. User ID
On the header of the Offerwall you have the Unique User ID (the number highlighted in orange).
Advertiser Reporting API
Our Advertiser Reporting API allows advertisers to retrieve detailed statistics on their pending, active and historic campaigns including impressions, clicks and conversions.
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.
Payments & Billing
This section explains how to Provide us with Billing information, How to update your billing information, and also where to see your current and historic payments.
Update Billing Information
You have to provide the correct billing information during the integration process
Currency Settings
For Offerwall
1. Log into the dashboard
Android SDK (v2)
The Android SDK allows you to easily monetize your app and reward your users with in-app currency. Your users get access to our offers and surveys, allowing them to earn rewards for completing offers.
Updates History
2025-12-02: v1.0.0 - Release the Android SDK v2
iOS SDK (v2)
The iOS SDK allows you to easily monetize your app and reward your users with in-app currency. Your users get access to our offers and surveys, allowing them to earn rewards for completing offers.
Updates History
2025-12-02: v1.0.0 - Release the iOS SDK v2
Failed Redirect Destination
Control the user flow when a redirect is failing.
During a redirect through tracking links, a few things can happen such as:
low user quality
proxy or VPN use
HMAC Security Hash (optional)
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:
Creating Sub-Accounts
Learn how to creat Sub-Accounts to grant access to your dashboard for your colleagues
1. Log into your account
To access your Publisher account click on the following link:
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.
Eligible Placement & AdSlot Combinations
The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Offerwall API integration.
Placement Type
AdSlot Type
Eligible Integration Type
Dynamic Currency Conversion Rate API
Allows publishers to update Currency Conversion Rate, for a specific adslot.
Introduction
With the Dynamic Currency Conversion Rate API 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.
Creating an Account
In this page you can find step-by-step instructions on how to get started
1.Access the Dashboard
To create an account click the following link:
Did you upload your customized virtual currency icon?
Did you add Proguard Rules?
Did you upload your customized virtual currency icon?
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:
Important: Make sure you URL-encode every parameter value. 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.
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.
// Retrieve the GET parameters
$params = $_GET;
// URL-encode each parameter value
$encodedParams = array_map('urlencode', $params);
// Sort the parameters alphabetically by key
ksort($encodedParams, SORT_STRING);
// Build the sorted query string
$sortedQueryString = http_build_query($encodedParams, '', '&');
// Compute the HMAC hash using your API key
$apiKey = 'YOUR PUBLISHER API KEY';
$computedHash = hash_hmac('sha256', $sortedQueryString, $apiKey);
// Compare with the header-provided hash
if (isset($_SERVER['HTTP_X_AYETSTUDIOS_SECURITY_HASH']) &&
$_SERVER['HTTP_X_AYETSTUDIOS_SECURITY_HASH'] === $computedHash) {
// Valid signature: process the callback
} else {
// Invalid signature: reject the callback
}
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.
Note: Each payment method has a different minimum payout threshold (The minimum payout threshold is shown next to the preferred payout method).
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"
If you want to update your existing billing information please inform us at: [email protected]
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.
Once the payout threshold is made - we will make the payment.
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.
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
You set the Currency Conversion Rate depending on how much you want to reward the user for each $1 you earn.
For example, if $1 = 1000 Coins on your end and you want to set a 40% share for the users, you need to fill-in in the conversion rate field: $1 = 400
(40% from 1000 = 400)
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".
To show the surveywall, simply call the showSurveywall method:
The YOUR_SURVEYWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Surveywall adslots.
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:
The YOUR_OFFERWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall adslots.
Fetch Offers
To fetch a list of all offers in JSON format, simply call the getOffers method:
The YOUR_OFFERWALL_API_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall API adslots.
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.
Note: Custom parameters must also be added to your callback URL to receive them in your S2S callbacks.
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.
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.
To show the offerwall, simply call the showOfferwall method:
The YOUR_OFFERWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall adslots.
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:
The YOUR_OFFERWALL_API_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall API adslots.
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:
Show the Surveywall
To show the surveywall, simply call the showSurveywall method:
The YOUR_SURVEYWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Surveywall adslots.
Set custom parameters
Set custom parameters for callbacks. Set up to 5 custom parameters.
Note: Custom parameters must also be added to your callback URL to receive them in your S2S callbacks.
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.
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:
On your own redirect destiantion (landing page), you would be able to show a tailored:
error message to users
simply redirect the user back into your website or app
or anything similar of your choice
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.
Variable
Type
Description
{external_identifier}
string
The user identifier (EXTERNAL IDENTIFIER) originally passed in the tracking link.
{placement_id}
string
The ID of the placement for which the failed redirect happened
{offer_id}
int
ID of the offer for which the redirect failed
{reason_code}
int
Code indicating the type of failed redirect so you can group different reasons and their frequency - e.g. 310
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
If you integrate the Offerwall API while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to make correct API requests.
Getting Started
Before you start with the integration, make sure you:
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.
All transactions on the ayeT-Studios are handled and operated in USD.
So setting a dynamic currency conversion rate is especially helpful if you pay out a crypto currency or real, non-USD currency (i.e. like EUR, GBP or similar) that is subject to fluctuations against the USD.
Enabling the Dynamic Currency Conversion Rate
Go into "Edit AdSlot" and check "Enable Dynamic Currency Conversion Rate" to unlock dynamic currency conversion rates.
Technical Documentation: Dynamic Currency Conversion Rate API
Follow the link to learn all about the publisher set currency conversion rate API.
Attention: Requests to the set_conversion_rate module are limited to 60 calls per hour.
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.
The Android SDK allows you to easily monetize your app and reward your users with in-app currency. Your users get access to our offers and surveys, allowing them to earn rewards for completing offers.
Updates History
2025-12-02: v1.0.0 - Release the Android SDK v2
Show the Offerwall
To show the offerwall, simply call the showOfferwall method:
The YOUR_OFFERWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall adslots.
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:
The YOUR_OFFERWALL_API_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall API adslots.
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:
Show the Surveywall
To show the surveywall, simply call the showSurveywall method:
The YOUR_SURVEYWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Surveywall adslots.
Set custom parameters
Set custom parameters for callbacks. Set up to 5 custom parameters.
Note: Custom parameters must also be added to your callback URL to receive them in your S2S callbacks.
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.
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.
Callback Tester
With the Callback Tester you can verify that you receive back all relevant information you need in order to pay your users and if the added macros are populated correctly.
Why you should utilize the Callback Tester
The Callback Tester was built to help you to verify that you:
added all the macros to your Callback URL that you need to receive back
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.
The example shows that the macros
{external_identifier}
{payout_usd}
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.
In this specific example the ayeT-Studios servers populated only the macros that you previously added to your callback URL:
{external_identifier} = my-test-user-567
Flutter Wrapper (v2)
The Flutter Wrapper lets you easily monetize your app and reward your users with in-app currency. Your users get access to our offers and surveys, allowing them to earn rewards for completing offers.
Updates History
2025-12-19: v1.0.0 - Release the Flutter Wrapper for V2 of the SDK
Show the Surveywall
To show the surveywall, simply call the showSurveywall method:
The YOUR_SURVEYWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Surveywall adslots.
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:
The YOUR_OFFERWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall adslots.
Fetch Offers
To fetch a list of all offers in JSON format, simply call the getOffers method:
The YOUR_OFFERWALL_API_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall API adslots.
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.
Note: Custom parameters must also be added to your callback URL to receive them in your S2S callbacks.
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.
Creating a Currency Sale
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.
You can send an email to [email protected] if you wish to participate in holiday-themed (platform-wide) currency sales.
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.
Turn on currency sale immediately - will turn on the currency sale automatically on the start date you selected
Click on "Save"
D. Turn "ON" Currency Sale
In the "Currency Sale" section of the dashboard a list of all Currency Sales created will be displayed. Locate the one you just created and turn it "ON"
Rewarded Video Checklist
This checklist is supposed to help you to take care of all important and relevant settings before going live with your rewarded video placement.
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
Optional
Design Settings
You can customize the Offerwall to your liking
Custom Theme
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.
Sandbox Identifier
Sandbox Identifiers can be used to test the user and callback flow from initial entering the offerwall until successfully processing a callback.
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".
Get ads.txt
An ads.txt (Authorized Digital Sellers) file is essential for ensuring transparency in digital advertising
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.
Implementing and regularly updating an ads.txt file is a fundamental step in fostering a trustworthy and secure advertising environment.
This is a step by step documentation on how you can get and automatically keep your ads.txt lines updated with ayeT-Studios' platform.
iOS SDK (v2)
The iOS SDK allows you to easily monetize your app and reward your users with in-app currency. Your users get access to our offers and surveys, allowing them to earn rewards for completing offers.
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
The changes you make are displayed in the Offerwall Preview
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
The changes you make are displayed in the Offerwall Preview
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"
For Portrait Image - we recommend 1080px x (120px to 350px)
For Landscape Image - we recommend 1920px x (70px to 200 px)
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"
The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Static API integration.
Placement Type
AdSlot Type
Eligible Integration Type
Website
Static API
Static API
Android App
Static API
Static API
iOS App
Static API
Static API
If you integrate the Offerwall API while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to make correct API requests.
Getting Started
Before you start with the integration, make sure you:
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.
Note: To pass custom parameters from clicks to conversion callbacks, the tracking_link parameter in offer objects can be extended with &custom_1=... to &custom_5=...
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.
Using Sandbox Identifiers for testing helps you to avoid triggering any of the ayeT-Studios Fraud Prevention Checks that would block your device from accessing the offerwall.
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.
Note: If you passed the sandbox identifier correctly, your offerwall will show three test offers (see screenshot below).
In the example below, the testuser123 was passed to a Web Offerwall AdSlot. The offerwall now shows three test offers.
Clicking on one of the test offers will show a detail modal with more instructions.
Clicking on the Earn Button will trigger a test callback.
Once you clicked on an offer, you can see the click ID and additional conversion details. In this case, a test callback with 200 in virtual currency and $0.2 in USD payout was triggered.
You can also see the transaction ID and a describtion where to find more details for the callback in the ayeT-Studios dashboard.
Checking the Test Callback
If you navigate to Reports / Conversions in the ayeT-Studios dashboard, you are able to find the test postback with your sandbox identifier that you just triggered.
Note: Sandbox offer conversions will generate regular callbacks with fake payouts and user currency.
&is_sandbox=1 is appended to every callback url to easily allow discarding test conversions.
If you click on Details for the test callback, you are able to see all details for the test callback.
The Callback Details show a list of available macros and information as well as the callback URL that was triggered, including the is_sandbox=1 macro to identifiy the callback as a test.
If your callback URL is missing information, please navigate to placements and edit your callback URL by adding additional callback macros.
To see a list of available callback macros, please go to the following section:
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
You can either download the entire ads.txt file
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.
Recommened: Using the Permanent URL ensures that you don't have to regularly check on new entries or inform your tech team to update the ads.txt entries regularly.
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:
To show the surveywall, simply call the showSurveywall method:
The YOUR_SURVEYWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Surveywall adslots.
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:
The YOUR_OFFERWALL_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall adslots.
Fetch Offers
To fetch a list of all offers in JSON format, simply call the getOffers method:
The YOUR_OFFERWALL_API_ADSLOT_NAME parameter can be found by clicking on the adslot on your dashboard. This is only available on Offerwall API adslots.
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.
Note: Custom parameters must also be added to your callback URL to receive them in your S2S callbacks.
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.
The ayeT-Studios Publisher Browser Web Offerwall allows you to easily monetize your desktop and mobile traffic and reward your users with virtual currency.
Eligible Placement & AdSlot Combinations
The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Web Offerwall integration.
Placement Type
AdSlot Type
Eligible Integration Type
If you integrate the Web Offerwall while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the Offerwall.
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.
The Web Offerwall can nevertheless be used in-app if you follow a few guidelines
Your placement has to be a "Website" placement
Integration Best Practices
Platform
Integration Best Practise
Offers
Getting Started
Before you start with the integration, make sure you:
You will find more details here:
Your Browser Offerwall Link - Mandatory Parameters
The URL template for our web offerwall looks like this:
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:
Parameter
Mandatory
Description
Conversion Callbacks & Currency Handling
Learn about:
Setting up callbacks
IP Whitelists
Securing callbacks using HMAC Security Hash
Click on the link below:
Best Practise
Following each of the main points below will help you get the most out of your Rewarded Video integration.
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.
Avoid CMPs That Only Offer Cookie Management
When choosing a Consent Management Platform (CMP), it’s essential to look beyond basic cookie management. Some CMPs focus solely on managing cookies, which is not sufficient for effective advertising monetization. Ensure that your CMP includes Vendor Management capabilities to manage and enable demand partners effectively.
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:
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.
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.
Avoid Delayed Initialization:
Never initialize the SDK only when the video button is already visible to the user. SDK initialization can take a few seconds, and users expect immediate responses. Delays at this stage can lead to frustration and disrupt the overall user 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:
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.
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.
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:
Avoid Delays in Ad Loading:
When an ad request is initiated upon the button click, the user must wait for the ad to load. Depending on the network speed and server response time, this delay can disrupt the flow of the app or game and frustrate the user.
Avoid Risk of No Fill:
There is always a possibility of receiving a "no fill" response from the ad network, meaning no ad is available to show. If this occurs after the user has already clicked the button, they might feel misled or disappointed, as they were expecting to watch an ad and earn a reward. This can lead to a negative perception of the app or game.
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.
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.
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.
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.
Avoid Delays in Callbacks:
Rewarding users after a video has been watched should be instant. Avoid delays when using server-to-server callbacks and use client-side callbacks instead.
Reporting
Learn more about the Rewarded Video metrics available in our dashboard and how to use them in your reporting
Group
Metric
Description
Revenue & Costs
Revenue
The publisher's net revenue.
*For AdServer integration the service fees are not considered and revenue is estimated based on Rewarded views (after our own fraud & viewability checks), VAST network configuration or RTB (real-time bidding) exchange eCPM in bid responses.
AdServer Fees
This is the amount deducted from the revenue for the AdServer service.
(*equals 0 if AdServer is not used)
Delivery
Payments & Billing
This section explains how to Provide us with Billing information, How to update your billing information, and also where to see your current and historic payments.
Update Billing Information
You have to provide the correct billing information during the integration process
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.
Note: Each payment method has a different minimum payout threshold (The minimum payout threshold is shown next to the preferred payout method).
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"
If you want to update your existing billing information please inform us at: [email protected]
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.
Once the payout threshold is made - we will make the payment.
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.
VAST Tags
You can bring your own VAST Tag Demand to our Ad Server solution to make direct deals with preferred partners in order to increase your overall eCPMs.
Attribute
Type
Description
Web Surveywall
The Web Surveywall by ayeT-Studios allows you to easily monetize your desktop and mobile traffic with surveys that users can complete in exchange for getting a virtual currency reward.
Eligible Placement & AdSlot Combinations
The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Web Surveywall integration.
Placement Type
AdSlot Type
Eligible Integration Type
Surveywall API
The Surveywall API provides a solution for publishers to include Surveys into their application/website while maintaining full control over look and feel of the Surveys.
Eligible Placement & AdSlot Combinations
The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Surveywall API integration.
Placement Type
AdSlot Type
Eligible Integration Type
Reporting
Learn more about the Offerwall metrics available in our dashboard and how to use them in your reporting
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.
Simpler Implementation:
Client-side callbacks are easier to implement as they do not require complex server infrastructure or robust handling for network issues.
Requests
Number of requested video ads.
Fills
Ad requests with valid fill for at least one network.
No Fills
The network didn't deliver an ad for the request.
Unchecked Fill Status
The fill wasn't checked for this network, because a network higher up in the waterfall already delivered fill.
Playback
Requested Plays
The number of filled ad requests for which playAd was called.
Media Errors
The number of requested plays for which the player was unable to load or initialize the media file.
Started Plays
The media file was loaded and playback started.
Play errors
The number of times video playback was prematurely interrupted (user abort, network errors, interactive ad termination).
Performance
Completed Views
The number of completed video views.
Rewarded Views
The number of rewarded views after server-side fraud and visibility checks.
eCPM
This is the effective Cost Per Mille calculated based on the revenue and rewarded views.
eCPM= Revenue / Rewarded views *1000
TCF
TCF Missing
Consent String is missing
TCF GDPR
GDPR Consent String is available
TCF No GDPR
GDPR Consent String is not available
TCF Rejected
User rejected the Consent
TCF Partial
User partially accepted the Consent
TCF Consented
User fully accepted the Consent
Device manufacturer
{device_model}
string
Device model
{device_ifa}
string
Device advertising id (GAID/IDFA) if known, otherwise empty
{device_os}
string
Device os
{device_osv}
string
Device os version
{country}
string
Country from which the ad request is made.
{ip}
string
IP address from which the ad request is made.
{ua}
string
User Agent from which the ad request is made.
{cat}
string array
Array of IAB content categories of the site.
{bcat}
string array
Array of Blocked IAB content categories of the site.
{site_name}
string
Site name / Placement name as set up in the ayeT dashboard by the publisher .
{site_domain}
string
Domain of the site (e.g., "sub.foobar.com")
{site_url}
string
URL of the site (e.g., "https://sub.foobar.com/abc")
{site_url_encoded}
string
Encoded URL of the site (e.g., "https%3A%2F%2Fsub.foobar.com%2Fabc")
{app_bundle}
string
A platform-specific application identifier intended to be unique to the app and independent of the exchange. On Android, this should be a bundle or package name (e.g., com.foo.mygame). On iOS, it is typically a numeric ID.
{app_name}
string
App name / Placement name as set up in the ayeT dashboard by the publisher.
{app_storeurl}
string
App store URL for an installed app.
{app_storeurl_encoded}
string
Encoded app store URL for an installed app.
{cmp_available}
int
1 if a CMP was detected, 0 if not
{tc_string}
string
Tcf Consent String received from the CMP
{gdpr_applies}
int
1 if the user is from a county where the GDPR applies, 0 if not
{ts}
int
Unix timestamp
{uid_criteo}
string
Macro for passing an external / share User ID from our integrated partner Criteo
{external_identifier}
string
Unique User ID passed to the Video SDK for each user.
{device_uuid}
string
ayeT-Studios internal device identificator
{device_make}
string
Unique Users per calendar day using the offerwall.
Offerwall Requests
Total non-unique requests to the Offerwall (counts users multiple times if they enter the offerwall several times a day).
Unique Offerwall Requests
Unique requests to the Offerwall by users (including users that churned by not accepting the privacy policy).
Unique Offerwall Entries
Unique entries to the Offerwall by users (consisting of users which are accepting the privacy policy or have accepted it already in the past).
Interactions
Impressions
An impression is registered once a user opens the Offerwall (no time delay).
Clicks
This equals the number of offers which were started.
Conversions
A conversion is registered once an offer is completed.
Performance
EPC
The average Earnings per Click calculated from the Revenue divided by the amount of clicks.
eCPM
The average CPM (Cost per Thousand) calculated from Revenue divided by Offerwall Requests times 1000.
ARPDAU
The Average Revenue per Daily Active User.
Revenue & Costs
Revenue
The publisher's net revenue from completed offers.
AdServer Fees
This is the amount deducted from the revenue for the AdServer service.
(*equals 0 if AdServer is not used)
Delivery
DAU
You have link out of your app to open the Web Offerwall in a mobile browser
Please follow the Integration Best Practises.
no
Custom parameter you can pass to the Offerwall Entry Link in the form of: &custom_3={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
custom_4
no
Custom parameter you can pass to the Offerwall Entry Link in the form of: &custom_4={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
custom_5
no
Custom parameter you can pass to the Offerwall Entry Link in the form of: &custom_5={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
Testing callbacks
Website
Offerwall
Web Offerwall
Desktop
Open the web offerwall in a new tab or iframe.
The web Offerwall shows web and mobile offers to the user. Users can send mobile offers to their mobile devices.
Mobile Web
Open the web offerwall in a new tab or iframe.
The web offerwall adjusts its layout if users access via a mobile device. I.e. for accessing via an Android device, users will see elibile Android offers to complete.
In-App
Create a button in your app that leads users into their mobile browser and into the ayeT-Studios Web Offerwall.
The web offerwall shows mobile offers according the the user's device only.
externalIdentifier
yes
Your identifier for the calling user - this is mandatory, has to be minimum 3 characters and allows you to attribute our Server2Server conversion callbacks to a specific user (returned in {uid})
custom_1
no
Custom parameter you can pass to the Offerwall Entry Link in the form of: &custom_1={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
custom_2
no
Custom parameter you can pass to the Offerwall Entry Link in the form of: &custom_2={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
If you integrate the Web Surveywall while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the Surveywall.
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.
The Web Surveywall can nevertheless be used in-app if you follow a few guidelines
Your placement has to be a "Website" placement
You have to link out of your app to open the Web Surveywall in a mobile browser
Please follow the Integration Best Practises.
Integration Best Practices
Platform
Integration Best Practise
Surveys
Desktop
Open the web surveywall in a new tab or iframe.
The web surveywall shows surveys to the user.
Mobile Web
Open the web surveywall in a new tab or iframe.
The web surveywall adjusts its layout if users access via a mobile device. E.g. for accessing via an Android device, users will see a single column layout as oposed to a two-column layout like for desktop.
In-App
Create a button in your app that leads users into their mobile browser and into the ayeT-Studios Web Surveywall.
The web surveywall shows eligible surveys to the user in a mobile optimized layout.
Getting Started
Before you start with the integration, make sure you:
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:
Parameter
Mandatory
Description
external_identifier
yes
Your identifier for the calling user - this is mandatory and allows you to attribute our Server2Server conversion callbacks to a specific user (returned in {uid})
custom_1
no
Custom parameter you can pass to the Surveywall Entry Link in the form of: &custom_1={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
custom_2
no
Custom parameter you can pass to the Surveywall Entry Link in the form of: &custom_2={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
If you integrate the Surveywall API while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to make correct API requests.
Getting Started
Before you start with the integration, make sure you:
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:
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.
The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Flutter integration.
Placement Type
AdSlot Type
Android/iOS
Offerwall
If you integrate the Flutter wrapper while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the SDK.
Demo App
Getting Started
Before you start with the integration, make sure you have:
You can find more details here:
Make sure to use the correct package name that you intend to use for your final app. Alternatively, create a test placement with a different package name that matches the package name of your test app.
If package name of your placement and your actual app don't match, you can't initialize the SDK. Note that your package name may be different on iOS and Android for the same Flutter app.
Adding the SDK Dependency
Add to your pubspec.yaml:
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:
Example of completed AndroidManifest.xml:
iOS Setup
Enable Swift Package Manager:
Then run flutter build ios to fetch dependencies.
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.
Eligible Placement & AdSlot Combinations
The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Flutter integration.
Placement Type
AdSlot Type
Android/iOS
Offerwall
If you integrate the Flutter wrapper while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the SDK.
Demo App
Getting Started
Before you start with the integration, make sure you have:
You can find more details here:
Make sure to use the correct package name that you intend to use for your final app. Alternatively, create a test placement with a different package name that matches the package name of your test app.
If package name of your placement and your actual app don't match, you can't initialize the SDK. Note that your package name may be different on iOS and Android for the same Flutter app.
Adding the SDK Dependency
Add to your pubspec.yaml:
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:
Example of completed AndroidManifest.xml:
iOS Setup
Enable Swift Package Manager:
Then run flutter build ios to fetch dependencies.
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.
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".
iOS SDK
The iOS SDK allows you to easily monetize your app and reward your users with in-app currency. Your users get access to our offerwalls, allowing them to earn currency for completing offers.
Updates History
2024-08-02: v1.7.2 - Updated documentation to replace plist.info new Xcode 13 Info settings, and add up-to-date Xcode screenshots.
Blacklisting Offers
This section explains how to remove offers that you do not wish to show to your players. You can exclude individual offers for a specific placement. You can exclude an offer for all of your placements
Custom parameter you can pass to the Surveywall Entry Link in the form of: &custom_3={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
custom_4
no
Custom parameter you can pass to the Surveywall Entry Link in the form of: &custom_4={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
custom_5
no
Custom parameter you can pass to the Surveywall Entry Link in the form of: &custom_5={YOUR_CUSTOM_PARAMETER}
You can get this variable back via conversion callbacks
If this is the callback url you set for your placement:
A typical conversion callback sent by our server will look like this:
This assumes you set externalIdentifier to username when calling AyetVideoSdk.init(...), the currency amount per view was set to 10 in your rewarded video adslot #16 and the delivered video had an eCPM of $7.00.
Hint: If you send callbacks from multiple different adslots (e.g. rewarded_video and offerwall) make sure to pass and validate {adslot_id} in your callback URL to determine if the conversion was a normal offer or a rewarded video.
Important: Your server must always reply with an HTTP 200 status code to our postbacks. Otherwise we will resend the postback 12 times over a span of one hour before giving up.
Available Macros for Callback URLs:
Note: If the parsing capabilities of your callback endpoint are limited, each of the parameters below is also available in a sanitized version. By suffixing any of the parameters below with _sanitized (for example {external_identifier_sanitized}), any character that is not in 0-9 a-z A-Z - _ will be removed. Whitespaces will be replaced by underscores.
Important:
To ensure each conversion is granted only once to your users, always use {transaction_id}.
Occasional callback resends may occur for various reasons. Utilizing {transaction_id} prevents granting conversions more than once.
Variable
Type
Description
{transaction_id}
string
Unique transaction id - use for duplicate checks.
{payout_usd}
float
The actual conversion payout in USD.
{currency_amount}
float
The amount of currency the user earned (taken from your offerwall currency configuration).
2020-08-11: v1.7.1 - Updated documentation to introduce new parameters to differentiate chargebacks from conversions
2020-07-29: v1.7 - Updated iOS SDK to xcframework, support for Xcode 12, Swift 5.x, iOS 11+, dropped ARMv7 support
2019-10-20: v1.6 - Updated iOS SDK to Xcode 11, iOS 13 SDK, Swift 5.1, full binary support
2019-07-19: v1.5 - Updated iOS SDK with adslot changes, recompiled with Swift 5, re-added x86_64 (simulator) support
2018-09-29: v1.4.2 - Updated iOS SDK to Xcode 10 and Swift 4.2, stripped debug symbols
2018-07-09: v1.4.1 - Removed Simulator Code from iOS SDK, fixed iTunes validation issues with Xcode 9+
2018-05-07: v1.4 - Framework recompiled with Swift 4.1
2018-03-08: v1.3 - You are able to use logs now in order to locate implementation problems
2018-01-20: v1.2 - Added functions that provide current user balances
2017-12-06: v1.0 - Initial Release of our Publisher SDK (iOS)
Eligible Placement & AdSlot Combinations
The below table shows all Placement & AdSlot Type combinations that allow you to utilize the Android SDK integration.
Placement Type
AdSlot Type
Eligible Integration Type
iOS App
Offerwall
iOS SDK
If you integrate the iOS SDK while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the Offerwall.
Getting Started
Before you start with the integration, make sure you have:
You will find more details here:
Make sure to use the correct package name that you intend to use for your final app.
Or create a test placement with a different package name that matches the package name of your test app.
If package name of your placement and your actuall app don't match, you can't initialize the Offerwall.
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:
The status string will be "success" if the balance deduction was successful or "failed" if something went wrong (e.g. insufficient user balance).
Attention: The username or external identifier passed in the init call (e.g. username, hashed email address, etc.) will be accessible in the conversion callbacks through the {external_identifier} parameter.
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:
showOfferwall starts our offerwall activity for the given adslot and displays available tasks for the user to complete.
Logs
If you want to see logs in Xcode debug area, simply call sdkLogEnable before initializing sdk.
@IBAction func purchaseInAppItem(_ sender: Any) {
let deductAmount = 5
AyetSdk.deductBalance(amount: deductAmount , deductCallback: {callback in
if (callback.caseInsensitiveCompare("success") == .orderedSame) {
print("Deduct response is successful");
// TODO: activate the purchased content
}
else {
print("Deduct response is unsuccessful");
// this usually means that the user does not have sufficient balance in his account
}
})
}
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',
);
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',
);
{external_identifier}
string
The user identifier (EXTERNAL IDENTIFIER) originally passed in the web offerwall link
{user_id}
integer
Our internal id for this offerwall user
{placement_identifier}
string
The placement_identifier for which the conversion occured
{adslot_id}
int
The ID of the adslot for which the conversion occured
{sub_id}
string
The ID of the Placement for which the conversion occured
[PL-1...n]
{ip}
string
Converting device's IP address if known, 0.0.0.0 otherwise
{offer_id}
int
Offer ID of the converting offer
{offer_name}
string
Name / title of the converting offer
{device_uuid}
string
ayeT-Studios internal device identificator
{device_make}
string
Device manufacturer
{device_model}
string
Device model
{advertising_id}
string
Device advertising id (GAID/IDFA) if known, otherwise empty
{sha1_android_id}
string
Device sha1 hashed android id if known, otherwise empty
{sha1_imei}
string
Device sha1 hashed imei if known, otherwise empty
{currency_identifier}
string
Shows virtual currency name as set in adslot.
{currency_conversion_rate}
decimal
Shows currency conversion rate used to calculate user currency for the given conversion.
{custom_1}
string
Custom parameter to pass variables to the conversion callbacks
{custom_2}
string
Custom parameter to pass variables to the conversion callbacks
{custom_3}
string
Custom parameter to pass variables to the conversion callbacks
{custom_4}
string
Custom parameter to pass variables to the conversion callbacks
{custom_5}
string
Custom parameter to pass variables to the conversion callbacks
Android SDK
The Android SDK allows you to easily monetize your app and reward your users with in-app currency. Your users get access to our offerwalls, allowing them to earn currency for completing offers.
Updates History
2024-08-16: v3.6 - Removed documentation for deprecated "Native Offer Feed" functionality. Recommended replacement is client or server side "Offerwall API".
2022-04-12: v3.6 - Updated SDK to Android Api 30 (Android 11) and restored compliance with updated privacy requirements
2022-02-11: v3.5.2 - Removed Rewarded Video from documentation
2020-08-11: v3.5.1- Updated documentation to introduce new parameters to differentiate chargebacks from conversions
2019-08-20: v3.4 - Updated Android SDK to support decimal places in payouts (currency amount) for native offers
2019-07-19: v3.3 - Updated Android SDK and documentation to reflect the adslot changes 2019-06-21: v3.2 - Native Offer Feed functionality
2019-02-01: v3.1 - Fixed conversion tracking issues under certain conditions (application lifecycle monitoring improved)
2018-11-29: v3.0 - Full support for API 26+ build targets, bugfixes, simplified use & improved handling under poor network conditions
2018-07-02: v2.1 - Fixed video ad orientation & resolution issues on Android 8.1
2018-06-18: v2.0 - Video Ads & Rewarded Video Ads 2017-11-01: v1.1 - Fixed incompatibilities with present GSON dependencies 2017-10-29: v1.0 - Initial Release of our Publisher SDK (Android)
Eligible Placement & AdSlot Combinations
The table below shows all Placement & AdSlot Type combinations that allow you to utilize the Android SDK integration.
Placement Type
AdSlot Type
Eligible Integration Type
If you integrate the Android SDK while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the Offerwall.
Getting Started
Before you start with the integration, make sure you have:
You will find more details here:
Make sure to use the correct package name that you intend to use for your final app.
Or create a test placement with a different package name that matches the package name of your test app.
If package name of your placement and your actual app don't match, you can't initialize the Offerwall.
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.
We don't recommend a managed user balance!
Managed user balances don't work well alongside additional rewarded ad integrations.
An unmanaged user balance / currency is a user balance that is stored on your servers. You receive callbacks and handle user wallets yourself.
This form of user balance is recommended.
You will find additional information about callbacks at the end of the Adndroid SDK documentation.
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:
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:
Also make sure to check your permissions in the AndroidManifest.xml:
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.
Attention: The username or external identifier passed in the init call (e.g. username, hashed email address, etc.) will be accessible in the conversion callbacks through the {external_identifier} parameter.
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 you want to spend user currency, for example if the user clicks a "purchaseInAppItem" button, you can utilize the deductUserBalance function:
Show the Offerwall
Showing the offerwall for an offerwall adslot is straight-forward, you can simply call showOfferwall from any Activity:
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:
It's always highly recommended to test your release builds before publishing them on Google Play to verify that they behave as intended!
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:
A typical conversion callback sent by our server will look like this:
This assumes you set external_identifier to username in the original Offerwall URL for that user, the currency conversion rate in your placement was 1000 per $1 and the user completed an offer with a $0.36 payout.
Important: Your server must always reply with an HTTP 200 status code to our postbacks. Otherwise we will resend the postback 12 times over a span of one hour before giving up.
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.
For chargebacks the original transaction ID of a conversion is prepended with "r-".
Below is a list of all relevant parameters to use in order to distinguish reversal callbacks from regular callbacks.
Variable
Type
Description
{transaction_id}
string
Unique transaction ID - use for duplicate checks. For chargebacks the original tid is prepended with "r-".
{is_chargeback}
int
Either 0 or 1. Indicator if the callback is a conversion (0) or a chargeback (1).
{chargeback_reason}
string
Reason why chargeback created. Only available if is_chargeback set to 1.
{chargeback_date}
string
Date of chargeback creation. Only available if is_chargeback set to 1.
Available Macros for Callback URLs
Note: If the parsing capabilities of your callback endpoint are limited, each of the parameters below is also available in a sanitized version. By suffixing any of the parameters below with _sanitized (for example {external_identifier_sanitized}), any character that is not in 0-9 a-z A-Z - _ will be removed. Whitespaces will be replaced by underscores.
Important:
To ensure each conversion is granted only once to your users, always use {transaction_id}.
Occasional callback resends may occur for various reasons. Utilizing {transaction_id} prevents granting conversions more than once.
Variable
Type
Description
{transaction_id}
string
Unique transaction ID - use for duplicate checks. For chargebacks the original tid is prepended with "r-".
{payout_usd}
float
The actual conversion payout in USD. If chargeback value is negative.
{currency_amount}
float
The amount of currency the user earned (taken from your offerwall currency configuration). If chargeback value is negative.
Surveywall
Android
Offerwall API
If you integrate the Android SDK while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the SDK.
Demo App
Getting Started
Before you start with the integration, make sure you have:
You can find more details here:
Make sure to use the correct package name that you intend to use for your final app. Alternatively, create a test placement with a different package name that matches the package name of your test app.
If package name of your placement and your actual app don't match, you can't initialize the SDK.
Adding the SDK Dependency
To add the SDK to your project, simply update your build.gradle.kts file to add the following dependency:
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:
Example of completed AndroidManifest.xml:
Import and initialize the SDK
In this step, we will import and initialize the SDK in the main activity.
Note: The externalIdentifierpassed in the init call is the user's identifier on your end. This will be accessible in the conversion callbacks through the {external_identifier} parameter. The placementId is the unique ID assigned to your placement when it's created through our dashboard.
If you integrate the Android SDK while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the SDK.
Demo App
Getting Started
Before you start with the integration, make sure you have:
You can find more details here:
Make sure to use the correct package name that you intend to use for your final app. Alternatively, create a test placement with a different package name that matches the package name of your test app.
If package name of your placement and your actual app don't match, you can't initialize the SDK.
Adding the SDK Dependency
To add the SDK to your project, simply update your build.gradle.kts file to add the following dependency:
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:
Example of completed AndroidManifest.xml:
Import and initialize the SDK
In this step, we will import and initialize the SDK in the main activity.
Note: The externalIdentifierpassed in the init call is the user's identifier on your end. This will be accessible in the conversion callbacks through the {external_identifier} parameter. The placementId is the unique ID assigned to your placement when it's created through our dashboard.
If you integrate the iOS SDK while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the SDK.
Demo App
Getting Started
Before you start with the integration, make sure you have:
You can find more details here:
Make sure to use the correct package name that you intend to use for your final app. Alternatively, create a test placement with a different package name that matches the package name of your test app.
If package name of your placement and your actual app don't match, you can't initialize the SDK.
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.
Note: The externalIdentifierpassed in the init call is the user's identifier on your end. This will be accessible in the conversion callbacks through the {external_identifier} parameter. The placementId is the unique ID assigned to your placement when it's created through our dashboard.
If you integrate the iOS SDK while using a different Placement & AdSlot combination in the ayeT-Studios dashboard, you won't be able to initialize the SDK.
Demo App
Getting Started
Before you start with the integration, make sure you have:
You can find more details here:
Make sure to use the correct package name that you intend to use for your final app. Alternatively, create a test placement with a different package name that matches the package name of your test app.
If package name of your placement and your actual app don't match, you can't initialize the SDK.
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.
Note: The externalIdentifierpassed in the init call is the user's identifier on your end. This will be accessible in the conversion callbacks through the {external_identifier} parameter. The placementId is the unique ID assigned to your placement when it's created through our dashboard.
<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-->
@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 (AyetSdk.isInitialized()) {
Log.d("AyetSdk" , "SDK is ready");
} else {
Log.d("AyetSdk" , "SDK is NOT ready");
}
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
}
});
}
});
-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 { *; }
@main
struct iosSdkV2DemoAppApp: App {
init() {
AyetSDK.shared.initialize(placementId: YOUR_PLACEMENT_ID, externalIdentifier: "USER_EXTERNAL_IDENTIFIER")
}
var body: some Scene {
WindowGroup {
ContentView()
}
}
}
import AyetSDK
@main
struct iosSdkV2DemoAppApp: App {
init() {
AyetSDK.shared.initialize(placementId: YOUR_PLACEMENT_ID, externalIdentifier: "USER_EXTERNAL_IDENTIFIER")
}
var body: some Scene {
WindowGroup {
ContentView()
}
}
}
{external_identifier}
string
The user identifier (EXTERNAL IDENTIFIER) originally passed in the web offerwall link.
{user_id}
integer
Our internal ID for this offerwall user
{placement_identifier}
string
The placement_identifier for which the conversion occured
{survey_id}
unsigned int64
Survey ID of the completed survey
{loi}
float
Length of interview - the time it took the user to complete the survey in minutes
{adslot_id}
int
The ID of the adslot for which the conversion occured
{sub_id}
string
The ID of the Placement for which the conversion occured
[PL-1...n]
{ip}
string
Converting device's IP address if known, 0.0.0.0 otherwise
{offer_id}
int
Offer ID of the converting offer
{offer_name}
string
Name / title of the converting offer
{device_uuid}
string
ayeT-Studios internal device identificator
{device_make}
string
Device manufacturer
{device_model}
string
Device model
{advertising_id}
string
Device advertising id (GAID/IDFA) if known, otherwise empty
{sha1_android_id}
string
Device sha1 hashed android id if known, otherwise empty
{sha1_imei}
string
Device sha1 hashed IMEI, if known, otherwise empty
{is_chargeback}
int
Either 0 or 1. Indicator if the callback is a conversion (0) or a chargeback (1).
{chargeback_reason}
string
Reason why chargeback created. Only available if is_chargeback set to 1.
{chargeback_date}
string
Date of chargeback creation. Only available if is_chargeback set to 1.
{currency_identifier}
string
Shows virtual currency name as set in adslot.
{currency_conversion_rate}
decimal
Shows currency conversion rate used to calculate user currency for the given conversion.
{custom_1}
string
Custom parameter to pass variables to the conversion callbacks.
{custom_2}
string
Custom parameter to pass variables to the conversion callbacks.
{custom_3}
string
Custom parameter to pass variables to the conversion callbacks.
{custom_4}
string
Custom parameter to pass variables to the conversion callbacks.
{custom_5}
string
Custom parameter to pass variables to the conversion callbacks.
Offerwall Callbacks
For Web Offerwalls and SDKs, you have to manually manage your users' currencies on your own servers.
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:
A typical conversion callback sent by our server will look like this:
This assumes you set external_identifier to username in the original Offerwall URL for that user, the currency conversion rate in your placement was 1000 per $1 and the user completed an offer with a $0.36 payout.
Important: Your server must always reply with an HTTP 200 status code to our postbacks. Otherwise we will resend the postback 12 times over a span of one hour before giving up.
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.
For chargebacks the original transaction ID of a conversion is prepended with "r-".
Below is a list of all relevant parameters to use in order to distinguish reversal callbacks from regular callbacks.
Variable
Type
Description
Available Macros for Callback URLs
Note: If the parsing capabilities of your callback endpoint are limited, each of the parameters below is also available in a sanitized version. By suffixing any of the parameters below with _sanitized (for example {external_identifier_sanitized}), any character that is not in 0-9 a-z A-Z - _ will be removed. Whitespaces will be replaced by underscores.
Important:
To ensure each conversion is granted only once to your users, always use {transaction_id}.
Occasional callback resends may occur for various reasons. Utilizing {transaction_id} prevents granting conversions more than once.
Variable
Type
Description
Rewarded Video SDK for HTML5
The ayeT-Studios Rewarded Video SDK for HTML5 allows web publishers to request and run rewarded video ads within their page.
Eligible Placement & AdSlot Combinations
The table below shows all Placement & AdSlot Type combinations which allow you to utilize the Rewarded Video for Web integration.
