Overview

Volume11's AMPLify platform is an engagement-based advertising platform for use in organic and value-exchange (virtual currency) environments. As a publisher on the AMPLify platform, you will have access to a wide variety of engagements, including click-to-view video, app installs, product demos, surveys, and many others. Each engagement is unique, targeted, and very high quality ensuring the maximum exposure for the brand, best user experience, and maximum revenue for you.

There are 3 basic steps necessary to integrate with an AMPLify Product:

• 1. Create a placement
• 2. If you are integrating an iframe product, simply drop the iframe tag in your game, blog, or application. If you are using JSON, write the backend code necessary to pull campaigns from our JSON feed.
• 3. If applicable, write a callback handler to receive completion notifications

Products

• SponsorX - A hosted content unlocking platform utilizing CPV video to gain access to premium content.
• V-Path - A hosted single video CPV iframe placement.
• V-Cast - Volume11's video feed utilizing JSON.
• V-Pop - A hosted lightbox placement with a customizable trigger.

Engagement TypesOur engagements are broken up into categories so that you can choose the type of user experience you want to offer. If you want to disable any of these categories, please click on the Engagement Control link above. Check this list often...it can change.

• 1 - Single click - The simplest engagement we offer
• 2 - Single click w/ Pre-qual - Simple engagement but we pre-qualify the user with a short survey
• 3 - Multi-click / Pop-out - The engagement either requires multiple clicks or takes the user out of the iframe
• 4 - Opt-in / Personalized - The user must opt-in with personal information (FB Connect) or install a non-download app
• 5 - Transactional / Download / CPA - These engagements require the user to download and install something on their system

Creating a PlacementClick on the "Placements" link in the main nav bar followed by "Create a New Placement". This will take you to our New Placement form, explained below:

• Placement Name - An identifying name for the placement.
• Product - Which product you will be placing.
• App - Which app you are placing the product in.
• Platform - Web or mobile.
• Virtual Currency name - Plural name of the currency to be given to your users. Ex: chips, credits, etc.
• Virtual Currency Exchange Rate - Exchange rate between $1 USD and your currency.
• Callback URL - URL to which Volume11 will post to notify you of an engagement completion. Explained below.

Iframes

Required Parameters

• k - 32-character unique placement key. Do not change this value.
• uid - your user's unique ID. Must be 32 characters or fewer and contain only numbers, letters, dashes (-), and underscores (_). This allows for hashing or encoding keys in Base64 for URL variant .

• Targeting Parameters - optional. Used for engagement targeting.

• gender - 'm' or 'f'
• dob - yyyy-mm-dd format
• email

• Custom Parameters - optional

• subid1 (255-char string) - optional custom parameter passed back after conversion. Can be set to any 255-character string.
• subid2 (255-char string)
• subid3 (255-char string)

Advanced Parameters

• currency - name of currency. Will override default placement setting.
• cnv - exchange rate of currency. Will override default placement setting. Requires "sig" param below.
• sig - request signature. All params passed over the query string are required to calculate the md5 signature. Sig is required for sensitive parameters and calculated according to the following PHP function:
• 
$args = array(
'uid' => 12345,
'k' => 12121212121212121212121212121212,
'email' => 'hello@example.com',
'subid1' => 'app1',
'cnv' => '1000',
);
ksort($args);

foreach($args as $key => $value){
$str .= "$key=$value";
}
$str .= $secret_key; // found at the bottom of the Placement Settings page

$sig = md5($str);



Json

Version Differences

Basic Parameters

• k (required) - 32-character unique placement key. You can find this in your panel url and in the json url. The url in my example is our test placement key, don't use this for your live site.
• uid (required) - your user's unique ID. Must be 32 characters or fewer and contain only numbers, letters, dashes (-), and underscores (_). This allows for hashing or encoding keys in Base64 for URL variant.
• ip - standard format, used for location lookups
• types - this must be set to "video"

Targeting Parameters - optional

• gender - 'm' or 'f'
• dob - yyyy-mm-dd format
• useragent - the browser useragent string url encoded, used to target browser and operating system

Engagement Type Filtering

• maxw - this is an integer value for the max pixel width of an engagement (useful mainly with videos so you only show videos you have enough room for, our standard is 600)
• maxh - this is exactly the same as maxw but the for the height and our standard size height is 400

JSON Response

• id - engagement id
• title - engagement text title
• subtitle - engagement text subtitle
• body - engagement text body
• click_url - You can either put this as the iframe source (ex. videos) or you could open a new tab with it
• image_url - URL to engagement thumbnail image
• cpa - payment amount in virtual currency (if applicable)
• engagement_type - engagement type id (see engagement types here)
• image_width - width of thumbnail image
• image_height - height of thumbnail image
• currency - name of the virtual currency (if applicable)
• gender - gender restriction for engagements, either 'm' or 'f' if set, null otherwise
• max_age - the max age in years if set, null otherwise
• min_age - the min age in years, if set null otherwise
• is_vc_ok - flag specifying whether the engagement allows virtual currency
• width - width of the engagement embed iframe
• height - height of the engagement embed iframe
• length - the length in seconds of video engagements if set, null otherwise
• is_autoplay - if the engagement contains a video, does it autoplay

CallbackOn your placement settings page, you can provide an optional callback URL. The query string parameters that we currently pass are as follows:

• ocid (int) - unique click identifier
• uid (32-char string) - your user's unique ID
• amount (int) - total amount of virtual currency earned
• time - unix timestamp for the transaction
• oid (int) - Engagement ID. Use this for your own tracking.
• cnv (int) - conversion rate of the placement.
• bonus_amount (int) - portion of virtual currency amount that was earned due to bonuses
• amount_usd (int) - net revenue in US Dollars.
• subid1 (255-char string) - see Volume11 Payment Panel above
• subid2 (255-char string)
• subid3 (255-char string)
• pending - will be set to 1 in the case that the callback is from a customer service credit, otherwise this param will not be passed at all.
• sig - a md5 hash calculated with the function below. Your secret key is found found at the bottom of the Placement Settings page
  
$sig = md5($uid.$amount.$time.$oid.$secret);

Results in an example callback of:

• http://example.com/callback?uid=21&amount=2000&time=1229281667&oid=1021
• On reception of the post, your script should echo one of the following codes and no other text or HTML.
  • ERROR:FATAL
  • ERROR:RESEND
  If our callback handler receives no response from your script or the error code ERROR:RESEND, it will attempt to resend within 24 hours.