Home App Developers Publishers Advertisers Media Agencies
Home > Publishers > Publishers Code

Publishers Code

AdFalcon offers web site integration code for the most well-known programing languages to integrate with AdFalcon. You simply need to paste the code below where you want the ad to appear in the page, and follow the instructions provided in the comments.

Mandatory Parameters

There are a collection of parameters that are mandatory in all ad requests. If you do not fill the required parameters in a correct way, AdFalcon network will not be able to respond back with an appropriate ad.

  • Site ID (R_SID)
    This parameter is the unique ID for your application or web site in AdFalcon system.
  • Ad Format (R_F)
    AdFalcon supports the following types of ad formats related to mobile web sites integration which are

    FormatDescription
    BASIC_HTML Simple HTML without JavaScript
    XHTML XHTML 1.1 with JavaScript format.
  • IP (R_IP)
    This parameter is the IP Address of the mobile devices to which the Ad will be delivered. The IP Address helps AdFalcon to identify the country and carrier of the device.

    You can get the IP Address of the device making the request from the HTTP header REMOTE_ADDR.

    If you have an intermediate server (proxy) between the device and your server you can get the device IP address from HTTP header X_FORWARDED_FOR.
  • User agent (D_UA)
    The User agent of the device making the request. This helps AdFalcon to identify the device's specifications and capabilities.

    You can get the user-agent of the device making the request from HTTP header USER-AGENT.
  • Version (R_V)
    The version of the AdFalcon Server API on which the integration has been implemented. The current version is: api-all-1.0.0
  • User ID (R_UUID)
    This parameter is used to get the unique ID for the device user. you can get this value in two ways:
    • If you have your own unique ID for each user you can always pass this ID.
    • If you do not have a unique ID for each user then you can do the following:

      A - Send the first ad request without R_UUID and D_UDID parameters.

      B - When AdFalcon receive the request without a unique ID, the system will generate a new unique user id and send it back as follows:

      • Set the HTTP header “X-ADFALCON-UUID”
      • Set a persistent cookie
      • Set UUID field in JSON responses.

      C - Get the generated user unique id from X-ADFALCON-UUID HTTP header or from the UUID JSON field.

      D - Thereafter, pass the user unique id in the R_UUID in all ad requests that are submitted on behalf of the same user.

  • HTTP Headers of end-user browser (R_HH_HEADERNAME)
    HTTP headers sent by the user's device. In order to pass header values use the following format: R_HH_HEADERNAME = header value. Header name should be in capital letters only.

    Example

    R_HH_REMOTE-ADDR=94.249.59.107&R_HH_USER-AGENT=keep-alive…etc

Optional Parameters

The optional parameters are extra information related to the user and device which helps AdFalcon's ads selector engine to get the most relevant ads for the user.

The most important optional parameters are:

  • Test Mode (R_TM)
    A boolean intended to inform AdFalcon network about application or web is under the development or maintenance mode. Ex. R_TM: true

    Note: Ensure Test Mode Parameter is set to false before releasing your application to the public.

  • Ad Unit size (R_AS)
    This parameter identifies the ad unit size to be delivered by AdFalcon. Below are the supported sizes.
    Ad sizeValue
    320x48 1
    300x50 2
    216x36 3
    168x28 4
    120x20 5
    480x60 6
    728x90 7
    300x250 8
    120x600 9

    Note: If this Ad Unit Size parameter is not specified, AdFalcon server will choose the best ad size that is suitable for the device's screen resolution.

  • Language (U_LN)
    The language of the requested ad in ISO 639-1 language codes format (Two Letters code); for Arabic language, pass ar code for language parameter U_LN=ar.
  • Age or birthdate (U_AGE or U_BD)
    You can add one of these two parameters to determine the age of the user.

    In the case you pass a birthdate you must send it in the dd.MM.yyyy format
  • Gender (U_G)
    This parameter represents the Gender of the user
    GenderValue
    Male m
    female f
  • Keywords (U_KW)
    This parameter is used to list a collection of keywords in comma separated format. These keywords can be useful since AdFalcon's ads selector engine will search for ads containing these keywords.
  • Country Code (U_CC)
    County code of the end user in ISO 3166-1 alpha-2 format code (two-letter code)
  • Area Code (U_AC)
    A parameter containing the user's area code
  • Postal Code (U_PC)
    A parameter containing the user's postal/ZIP code
  • Geolocation (D_LA, D_LO)
    A parameter containing the geolocation information of the device. The location information is divided into two double values; latitude (D_LA) and longitude (D_LO).

    Example

    D_LA=35.54454548&D_LO=58.981

JSP PHP Curl C#

JSP


<%@ page import="java.util.*,java.io.*,java.net.*,java.net.InetAddress;"%>
<%
//AdFalcon URL which used to get ads
 String adf_adFalconURL ="http://api.adfalcon.com/AdRequest/GetAd";
//Parameters is a variable that contains "get method request" paramerts
 String adf_parameters ="";
/*
 * You must fill the following required parameters because 
 * adfalcon will not send ads without having those values
 */
String adf_siteId ="Site ID";

/*
* Ensure this is set to false once you release your web site to the public
*/
boolean adf_testMode =true;
/*
* Fill only in case specific ad sizes are required; otherwise remove this line of code, and AdFalcon will determine the best ad size for the device
*/
int adf_adUnitSize =1;

/*
* Unique User Identification:
* AdFalcon will need to uniquely identify each user, therefore if you have 
* a User unique ID for your web site users, then provide it here
* Otherwise, replies on AdFalcon to generate a unique ID for the which should be * save it in a persistent cookie/session with following properties
* - Cookie value: AdFalcon's UUID or any unique value for user
* - Expires : maximum as possible
* - Path : /
*/

/* 
* If you have your own user unique value, assign your value to userUniqueId variable
* note: remove all codes related to cookie when using your own user unique value
*/
String adf_userUniqueId ="";

/*
* this will get the user unique id generated by AdFalcon from the cookie in case this  was saved in a previous ad request 
*/
for (Cookie cookie : request.getCookies()) 
{
    if (cookie.getName().equalsIgnoreCase("ADFALCON-UUID"))
    {
        adf_userUniqueId =cookie.getValue();
    }
}

/*
 * You can help adfalcon to get better targeting ads by filling optional parameters, * these parameters are demographics and device information.
 * you will find name of parameters in AdFalcon Server API integration guide at appendix A
 */
Hashtable<String, String>adf_optionalParams =null;
//adf_optionalParams = new Hashtable<String, String>();
 //adf_optionalParams.put("U_LN", "ar");
 //adf_optionalParams.put("U_KW", "sport, mobile");
 /*
 * Collects all needed information and builds "GET method request" URL
 */
adf_parameters +="R_SID=" +adf_siteId;
adf_parameters +="&R_IP=" +URLEncoder.encode(request.getRemoteAddr(), "UTF-8");
adf_parameters +="&R_F=XHTML";
adf_parameters +="&R_V=api-all-1.0.0";
adf_parameters +="&D_UA=" +URLEncoder.encode(request.getHeader("User-Agent"), "UTF-8");
//adf_parameters +="&R_AS=" +Integer.toString(adf_adUnitSize);
adf_parameters +="&R_TM=" +Boolean.toString(adf_testMode);
adf_parameters +="&R_UUID=" +URLEncoder.encode(adf_userUniqueId, "UTF-8");
if (adf_optionalParams !=null) 
{
    for (String key : adf_optionalParams.keySet()) 
    {
        adf_parameters +="&" +"" +URLEncoder.encode(key, "UTF-8") +"=" +URLEncoder.encode(adf_optionalParams.get(key), "UTF-8");
    }
}
//get end user's browser header names and add them to the request adf_parameters
 Enumeration adf_headerNames =request.getHeaderNames();
ArrayList adf_ignoreHeaders =new ArrayList();
adf_ignoreHeaders.add("CACHE-CONTROL");
adf_ignoreHeaders.add("CONNECTION");
adf_ignoreHeaders.add("COOKIE");
adf_ignoreHeaders.add("PRAGMA");
adf_ignoreHeaders.add("USER-AGENT");
while (adf_headerNames.hasMoreElements()) 
{
    String name =adf_headerNames.nextElement().toString();
    if (!adf_ignoreHeaders.contains(name.toUpperCase())) 
    {
        String value =request.getHeader(name);
        if (name !=null &&value !=null) 
        {
            adf_parameters +="&" +"R_HH_" +URLEncoder.encode(name.toUpperCase(), "UTF-8") +"=" +URLEncoder.encode(value, "UTF-8");
        }
    }
}
//fill page query string
 adf_parameters +=(request.getQueryString() !=null ? "&" +request.getQueryString() : "");
//create GET method URL
 URL adf_url =new URL(adf_adFalconURL +"?" +adf_parameters);
/*
 *Open http connection with adfalcon server and get new ad
 */
HttpURLConnection adf_httpURLConnection =null;
InputStream adf_inputStream =null;
InputStreamReader adf_inputStreamReader =null;
BufferedReader adf_bufferedReader =null;
try 
{
    adf_httpURLConnection =(HttpURLConnection) adf_url.openConnection();
    adf_httpURLConnection.setConnectTimeout(10000);
    adf_httpURLConnection.setReadTimeout(10000);
    adf_httpURLConnection.setDoInput(true);
    adf_httpURLConnection.setDoOutput(true);
    adf_httpURLConnection.setUseCaches(false);
    adf_httpURLConnection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
    adf_httpURLConnection.setRequestProperty("charset", "UTF-8");
    adf_httpURLConnection.setRequestMethod("GET");
    if (adf_httpURLConnection.getResponseCode() ==HttpURLConnection.HTTP_OK) 
    {
        /*
 * in case a request was not completed successfully;
 * adfalcon will send two header's parameters
 * - X-ADFALCON-ERROR-CODE: status code of the request
 * - X-ADFALCON-ERROR-MESSAGE: message descripes the status code
 */
        if (adf_httpURLConnection.getHeaderField("X-ADFALCON-ERROR-CODE") !=null) 
        {
            out.println(
            adf_httpURLConnection.getHeaderField("X-ADFALCON-ERROR-CODE") +":"
            +adf_httpURLConnection.getHeaderField("X-ADFALCON-ERROR-MESSAGE"));
        }else 
        {
            /*
 * Receive an ad from adfalcon server and fill it in adf_adFalconResponse variable
 */
            adf_inputStream =adf_httpURLConnection.getInputStream();
            adf_inputStreamReader =new InputStreamReader(adf_inputStream);
            adf_bufferedReader =new BufferedReader(adf_inputStreamReader);
            String adf_adFalconResponse ="";
            while (adf_bufferedReader.ready()) 
            {
                adf_adFalconResponse +=adf_bufferedReader.readLine();
            }
            /*
 * If adf_adFalconResponse variable is not null or empty, print it at page
 */
            if (adf_adFalconResponse !=null &&!adf_adFalconResponse.trim().isEmpty())
            {
                out.append(adf_adFalconResponse);
            }
            /*
 * Check if adfalcon server has sent UUID, * if yes, you should save it in presistent cookie/session
 * 
 */
            if (adf_httpURLConnection.getHeaderField("X-ADFALCON-UUID") !=null) 
            {
                /*
 * if you want to use the adfalcon UUID and set it to cookie, still activate the following code
 */
                Cookie cookie =new Cookie("ADFALCON-UUID", adf_httpURLConnection.getHeaderField("X-ADFALCON-UUID"));
                cookie.setMaxAge(10 *365 *24 *60 *60);
                cookie.setPath("/");
                response.addCookie(cookie);
                /*
 * else set adfalcon UUID wherever you want 
 */
            }
        }
    }
}catch (Exception ex)
{}
finally
{
    if (adf_inputStream !=null)
    {
        adf_inputStream.close();
    }
    if (adf_inputStreamReader !=null) 
    {
        adf_inputStreamReader.close();
    }
    if (adf_bufferedReader !=null) 
    {
        adf_bufferedReader.close();
    }
    if (adf_httpURLConnection !=null) 
    {
        adf_httpURLConnection.disconnect();
    }
}
%>
About Us - Careers - Terms - Contact Us
Copyright © 2012 AdFalcon - By Noqoush