AdIQuity Ad Server API v2.2
COPYRIGHT NOTICE
Copyright © AdIQuity Technologies Pvt. Ltd.
All rights reserved.
This document is confidential and proprietary to AdIQuity Technologies Pvt. Ltd. and no part of it will be reproduced, published,
transmitted or distributed in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, or
stored in any information storage or retrieval system of any nature nor will it be disclosed to third parties without the prior
express written authorization of AdIQuity Technologies Pvt. Ltd.
AdIQuity Technologies Pvt. Ltd.
AdIQuity Ad Server API v2.2
Revision History
Version
Date
0.1
12/11/2010
1.0
13/11/2010
1.1
18/02/2011
Author/Contributor
Harish
Harish
Harish
1.2
22/02/2011
Harish
1.3
17/03/2011
Harish
1.4
01/08/2011
Harish
1.5
19/12/2011
Harish
1.6
07/02/2012
Harish
1.7
09/02/2012
Harish
1.8
1.8.1
19/04/2012
08/05/2013
Harish
Mani
1.9
19/08/2013
Chetan
2.0
01/10/2013
Dinmani Ujjwal
2.1
10/02/2014
Vikas
2.2
06/08/2014
Vikas
Comments
Initial Draft
Unified Site ID –pazid introduced.
Added JSON as an accepted response
format.
Added XML as an accepted response format.
Included API version as a parameter to be
passed.
Modified ad_type in the ad response to
image and text from integers.
1) New parameter for App requests to
identify app platform.
2) New request headers to be passed
with the request.
New parameters:
1) Send hashed Hardware id.
2) To identify a mobile app request.
3) To indicate request origin as device.
4) To request a banner of specific
dimension.
1) New parameters:
a) Application package name
b) Application name
2) API version made mandatory.
3) Bada included in the list of platforms
4) New Error code responses sent.
1) Descriptions on the type of
hardware id to be sent for various
platforms.
2) Added new parameter Zip Code.
Support for ODIN number for mobile apps.
Support for Profile based better targeted
campaigns.
Added new parameters - kind,
strict_adunit and adtype for more control
on ad dimension options.
New parameters impr_pb_url and
click_pb_url.
Support of multiple ads in JSON and XML
format along with markup for each ad
1. Support for Apple's Advertising
Identifier (aka IFA or IDFA)
2. Support for mcc, mnc , ct , adcount
and cnv_pb_url.
Support Video Adtype
1
AdIQuity Ad Server API v2.2
Contents
Contents ........................................................................................................................................................ 2
1
Overview ............................................................................................................................................... 3
2
Request API ........................................................................................................................................... 3
2.1
Request Structure ......................................................................................................................... 3
2.2
Request Headers ........................................................................................................................... 3
2.3
Request Parameters...................................................................................................................... 3
2.4
Sample Request (Post Data)........................................................................................................ 12
2.5
Ad Response................................................................................................................................ 12
2.5.1
Response Format – JSON .................................................................................................... 12
2.5.2
Response Format - XML ...................................................................................................... 15
3
Appendix A .......................................................................................................................................... 17
4
Appendix B .......................................................................................................................................... 17
2
AdIQuity Ad Server API v2.2
1 Overview
This document aims to providing instructions and guidance on how to access and integrate with
AdIQuity Server API from within the server side part of Mobile Device Application or Mobile Website.
2 Request API
2.1 Request Structure
The URL to be used for making requests to fetch ads is:
http://ads.adiquity.com/mapi
All request parameters are to be passed as a HTTP POST request.
2.2 Request Headers
Header Name
X-ADQ-pazid
Content-Type
Header Value
Unique Site ID
application/xwww-formurlencoded
Mandatory
Description
Examples
Yes
Unique Site ID, provided
by AdIQuity.
adqkhhh2-14ej4lj1-d7d7t
Yes
The mime type of the
body of the request
application/x- www-formurlencoded
2.3 Request Parameters
Parameter
Name
Mandatory
pazid
Unique Site Yes
ID
ua
User Agent
impr_pb_url
Impression No
pingback url
click_pb_url
Click
No
pingback url
Yes
Format
Valid Site
ID
Description
Examples
Unique Site ID adqkhhh2-14ej4lj1-d7d7t
provided by
AdIQuity
Valid URL- The browser's
BlackBerry8100%2F4.2.0+
encoded user agent of the Profile%2FMIDP-2.0+Configura
String
device making tion%2FCLDCthe request
1.1+VendorID%2F100
A valid
AdIQuity will
http://ping.ads.com/type=impr
HTTP URL notify this URL as
and when
impression
happens.
A valid
AdIQuity will
http://ping.ads.com/type=click
HTTP URL notify this URL as
and when click
happens.
3
AdIQuity Ad Server API v2.2
Parameter
ip
Name
Mandatory
IP
Address
Yes
(Unless
devipis set
true)
Highly
Recommen
ded
adq_site_coo Your
kie
Mobile
Site
Cookie
devip
Device
Request
Flag
app
App
Request
Flag
No
Yes (For
Mobile
Apps)
Format
Description
Examples
Valid IP
address
The ip address of the carrier gateway over 122.166.7.
which the device is connecting
84
Valid
String
Mobile site user cookie set by you and
123abced5
passed to this api parameter. Highly
677ijkl
recommended for better monetization.
Refer
http://AdIQuity.com/wiki/index.php?title=S
etting_Cookies to know more about this
feature and how to set this cookie on your
site.
Flag to indicate that the IP of the request true
header to be used instead of the “ip”
Parameter.(Typically used when the API is
implemented on the device instead of a
server)
Default: false.
Flag to indicate a mobile app request.
true
It is suggested to provide this value.
Boolean
Boolean
When the kind parameter is unavailable
then the value of the app parameter will
be considered.
hwid
Hardware Yes (For
ID
Mobile
(Unhashe Apps)
d)
hwid:md5
Hardware
ID –
Hashed
using
MD5
hwid:sha1
Valid
String
Yes (For
Valid
Mobile
String
Apps,
if unhashed
hwid is
unavailable)
Hardware Yes (For
Valid
ID –
Mobile
String
Hashed Apps,
using
if unhashed
If the kind and app parameters are
unavailable, then the request will be
considered as a wap request.
Unhashed unique id which identifies the
device the user is using . For
iOS – UDID , Android -AndroidID ,
Windows -DeviceUniqueId
Others – IMEI /MEID / ESN
Hashed (MD5) unique id which identifies
the device the user is using.
For iOS – UDID , Android - AndroidID ,
Windows - DeviceUniqueId
Others – IMEI /MEID / ESN
002ebf12a125-5ddfa73967c3c5d20
177
a774da6b8
a02
4a8c54049
b77
285a78b0
Hashed (SHA1) unique id which
Identifies the device the user is using.
For iOS – UDID , Android -AndroidID ,
Windows -DeviceUniqueId
102280f46
b8552224
5fd8293eb
810c2629c
4
AdIQuity Ad Server API v2.2
SHA1
Parameter
Name
hwid is
unavailable)
Mandatory
Others – IMEI /MEID / ESN
Format
odin
Description
Hardware Yes (For
Valid String Hashed (SHA1)
ID – as per Mobile Apps)
unique id which
ODIN1
identifies the device
specification
the user is using.For
[Refer
iOS – 802.11 MAC
Appendix B]
Address ,Android AndroidID ,
Windows DeviceUniqueId
plat
Platform
Yes (For
One of the Identifies the type
Mobile Apps) following of platform the app is
depending installed on.
on
the
platform:
1) ios
2)
blackberry
3) android
4) j2me
5) symbian
6) palm
7) windows
8) bada
9) others
app_pkg
Application Yes (For
Valid URL- Unique id that
Package
Mobile Apps) encoded identifies your
Name /
String
application on any
Bundle ID
application store
app_name
Application No, but
Valid URL- The name of the
Name
recommended encoded application as its
(For Mobile
String
shown on any
Apps)
application store
hh_{.*}
HTTP
Yes
Valid URL- HTTP headers sent
(multiple
headers
encoded by the requesting
parameters)
String
device. The original
name should be
prefixed with hh_.
5
379bb
Examples
82a53f1222f8
781a5063a773
231d4a7ee41b
dd6f
j2me
com.AdIQuity.example
Angry Birds
hh_HTTP_X_FORWARDE
D_FOR=122.166.7.84
hh_HTTP_X_OPERAMINI
_PHONE_UA=BlackBerry8
100%2F4.2.0+Profile%2F
AdIQuity Ad Server API v2.2
MIDP2.0+Configuration%2FCLD
C-1.1+VendorID%2F100
Parameter
pg
api
adunit
strict_adunit
Name
Mandatory
Format
Description
Page URL
No, but
Valid URL- Url of the page where
recommended encoded the ad was requested
String
API Version Yes
Valid URL- Current AdIQuity API
encoded version
String
Adunit
No
Valid String Dimension of a specific
dimensions
among:
size for a Banners to be
It is
728x90,
retrieved.
mandatory to 468x60,
send adunit 300x250,
parameter if 320x480,
the
320x50,
strict_adunit 320x48,
is set to ‘1’. 300x50,
Otherwise, 300x75,
strict_adunit 216x36,
will behave 216x54,
as ‘0’.
168x28,
168x42,
120x20,
120x30,
120x600
Strict
No
0/1
1 - The adunit
Dimension
parameter given will
be strictly
honored/served.
(Please note that this
could reduce your fill
rates). In this case
adunit parameter is
mandatory.
0 - The system will
attempt to serve the
adunit given in adunit
parameter. In the case
6
Examples
http%3A%2F
%2Fm.guruji. com
1.7
300x50
0
AdIQuity Ad Server API v2.2
of unavailability of the
mentioned ad unit,
ads of any dimension
will be served.
Default value = 0
Parameter
adtype
kind
Name
Ad Type
Interstitial
ads
Mandatory
No
No
Format
tx - for text ad
im – for image/banner ads
o1 - for Richmedia ads of
ORMMA1 type
o2 - for Richmedia ads of
ORMMA2 type
m1 - for Richmedia ads of
MRAID1 type
m2 - for Richmedia ads of
MRAID2 type
vdo - for vast/video ads
Description
The formats of
ads to be
returned.
Examples
Im
or
Comma
tx,im,o1,o2,m1,m2
separated values
can be sent.
Single values is
also
acceptable
Default Value:
Any type of ad
can be served
app/app_int/wap/wap_int app - for app
request and not
Interstitial ad
App
kind parameter is
not applicable for
app_int - for app video ads
request and
Interstitial ad
wap - for wap
Site request and
not Interstitial ad
wap_int - for
wap Site request
and Interstitial
ad
Only one value
should be sent.
This parameter
will override the
7
AdIQuity Ad Server API v2.2
value of app
parameter
defined
previously.
If this parameter
is unavailable,
then the app
parameter will be
considered.
If the kind and
app parameters
are unavailable,
then the request
will be considered
as a wap request.
A feature exists in
the Adiquity userinterface to set
kind parameter
and the UI has a
higher priority.
8
AdIQuity Ad Server API v2.2
Parameter
Name
Mandatory
Format
Description
Cookies that
should be
set/received
on/from the user's
device.
html/json/xml/v Default: html
vxml format for
xml
Examples
adqc_{.*}
AdIQuity
(multiple
Cookies
parameters)
No, but
Valid URLrecommend encoded String
ed
adqc_admobu
u=abcedfg123456
adqc_acookie
=2342ssadfs
fmt
Response
Format
No
html
test
Test Mode
No
idfa
Advertising
Identifier
(Unhashed)
No, but
Valid String
recommend
ed for IOS
devices.
VAST XML
true/false
To get dummy ads.
Default: false
The Unhashed
Apple's Advertising
Identifier on IOS6+
devices (aka IFA
or IDFA).
True
3D1E2DFA89-496A47FD-9941DF1FC4E6484A
The string
representation of
the NSUUID,
including hyphens.
Read More
https://developer.a
pple.com/library/io
s/documentation/F
oundation/Referen
ce/NSUUID_Class/R
eference/Referenc
e.html#//apple_ref
/occ/clm/NSUUID/
UUID
idfa:md5
Advertising
Identifier
(Hashed
using MD5)
No, but
Valid String
recommend
ed for IOS
devices.
9
The Hashed
fb51f233d1b4520b09
(MD5) Apple's
b4811595dbab44
Advertising
Identifier on IOS6+
devices (aka IFA
or IDFA).
- The Hashed
(MD5) string
representation of
the NSUUID.
Read More:
https://developer.
apple.com/library/
AdIQuity Ad Server API v2.2
Parameter
Name
Mandatory
Format
Description
Examples
ios/documentatio
n/Foundation/Ref
erence/NSUUID_Cl
ass/Reference/Ref
erence.html#//app
le_ref/occ/clm/NS
UUID/UUID
idfa:sha1
Advertising
Identifier
(Hashed
using SHA1)
No, but
Valid String
recommend
ed for IOS
devices.
The Hashed
d0b7d4561cdf68f6ad
(SHA1) Apple's
72db0a9692e7bfad71
Advertising
5ac6
Identifier on IOS6+
devices (aka IFA
or IDFA).
- The Hashed
(SHA1) string
representation of
the NSUUID.
Read More :
https://developer.
apple.com/library/
ios/documentatio
n/Foundation/Ref
erence/NSUUID_Cl
ass/Reference/Ref
erence.html#//app
le_ref/occ/clm/NS
UUID/UUID
mcc
Mobile
Country
Code
No, but
Valid String
recommend
ed (For
Blackberry
requests)
10
A mobile country 404
code (MCC) is used
in combination
with a mobile
network code
(MNC) to uniquely
identify a mobile
phone
operator/carrier.
Please
refer http://en.wik
ipedia.org/wiki/M
obile_country_cod
e
AdIQuity Ad Server API v2.2
Parameter
Name
Mandatory
Format
mnc
Mobile
Network
Code
No, but
Valid String
recommend
ed (For
Blackberry
requests)
ct
Connection
Type
No, but
Valid String
recommend
ed
cnv_pb_url
Conversion
ping back
URL
No
adcount
Number of
ads
No
subsiteid
Subsite Id
No
gaid
Gaid
No
Description
Examples
A mobile network 04
code (MNC) is
used in
combination with
a mobile country
code (MCC) to
uniquely identify a
mobile phone
operator/carrier.
Please refer
http://en.wikipedi
a.org/wiki/Mobile
_country_code
0 Unknown
1
1 Ethernet
2 Wifi
3 Cellular data –
Unknown
Generation
4 Cellular data – 2G
5 Cellular data – 3G
6 Cellular data – 4G
Valid URLPublisher will get
encoded String ping back on the
mentioned URL
after successfully
installation
/download the
App.
It will work for
CPI,CPA and CPD
campaigns.
Number
Total number of
ads in request.
applicable only for
multi ad request.
Valid String
Subsite ID of the
Publisher.
Valid String
Google Ad ID
(Newer version)
from Play Store
http://www.ads.adiqu
ity.com/ping
2
1a2b3cf45nh
13566332
User's Profile
dob
Date of Birth No
YYYYMMDD
11
Date of Birth of
19850524
AdIQuity Ad Server API v2.2
Parameter
age
Name
Age
Mandatory
No
gender
Gender
No
loc
Geo location No
of the user
zip
Zip code/Pin No
Code
city
City
state
State/Region No
tags
Keywords
No
No
Format
Description
the requesting
user
Age of the
requesting user
Single natural
number (1- 100)
or range(1-100 to
1-100)
f/m
Gender of the
requesting user
URL encoded Lat GPS Coordinates
and Long in
of the user
Decimal degrees (Latitude and
, separated by a Longitude)
Comma
Valid URLThe Zip or Pin
encoded String code, the user is
located in
Valid URLThe City, user is
encoded String located in.
Valid URLThe State/Region,
encoded String user is located in.
Valid URLWill be used to
encoded comma return a
separated
contextually
Strings
matching Ad
Examples
26
25-30
M
34.131623%2C17.414
113
30385
Bangalore
Ohio
Sports, Business,
Technology
2.4 Sample Request (Post Data)
ip=68.171.236.11&app=true&HTTP_X_FORWARDED_FOR=68.171.236.113&app_pkg=com.risto.photoframe&fmt=json&adunit=
320x50&strict_adunit=1&adtype=tx,im&kind=app_int&test=false&app_name=PicStory&hwid=268a89b5&plat=blackberry&hwi
d:md5=6ec855e9afc3dfaac6e5ffdc333653bc&HTTP_X_OPERAMINI_PHONE_UA=BlackBerry8520%2F5.0.0.1093+Profile%2FMID
P2.1+Configuration%2FCLD1.1+VendorID%2F613&hwid:sha1=1524d4752a8bb1df67ff3a8cdb0d79ad588eb1d4&ua=BlackBerry8
520%2F5.0.0.1093+Profile%2FMIDP-2.1+Configuration%2FCLDC1.1+VendorID%2F613&api=1.8&impr_pb_url=http://ping.ads.com/type=impr&click_pb_url=http://ping.ads.com/type=click&idf
a=3D1E2DFA89-496A-47FD-9941-DF1FC4E6484A
2.5 Ad Response
Ad Response format depends on the value passed for the Request Parameter (fmt) describe above. The
following formats are currently supported:
1) HTML
2) JSON
3) XML
2.5.1 Response Format – HTML
A sample response in HTML format can be seen as below.
12
AdIQuity Ad Server API v2.2
2.5.1.1 Error Response
No HTML tag or error response is sent in the case of a no ad.
2.5.1.2 Valid Response
HTML tag is sent in the case of a valid ad response.
Example: Image response
<a href="http://usclk.adiquity.com/ads.adiquity.com/click?bi=511295&amp;ac=15397992&amp;t=aHR0cDovL2Mudy5pbm1AuMC9kaXIvZUFfi82LzYzNGQzMzEx&amp;ri=YnRGTGAAXHUYY0NJDGNwfQkIZXIIRnwLcUUeAGZZI&amp;ei=66620&amp;rp=143__9102__41__in
__5626__9__6620__null"> <img src="http://ads.adiquity.com/c.as/t/0/api/2.0.0/dir/eA~~/6/c3965269?m=18"/><\a><img
src="http://my.com/exch.pixel.php?h=7804aae00990c"/><img src="http://usast.adiquity.com/txt/YnRGTGAAXHUYhtReFNBAXx_JzV_D1ZOaFI/a/7219_55?ext_user_id=666420" alt="" />
Example: Text response
<a href="http://usclk.adiquity.com/ads.adiquity.com/click?bi=511295&amp;ac=15397992&amp;t=aHR0cDovL2Mudy5pbm1AuMC9kaXIvZUFfi82LzYzNGQzMzEx&amp;ri=YnRGTGAAXHUYY0NJDGNwfQkIZXIIRnwLcUUeAGZZI&amp;ei=66620&amp;rp=143__9102__41__in
__5626__9__6620__null"> ADIQUITY Text ad <\a><img src="http://my.com/exch.pixel.php?h=7804aae00990c"/><img
src="http://us-ast.adiquity.com/txt/YnRGTGAAXHUYhtReFNBAXx_JzV_D1ZOaFI/a/7219_55?ext_user_id=666420" alt="" />
2.5.2 Response Format – JSON
A sample response in JSON format can be seen as below.
2.5.2.1 Error Response
When the server encounters an error it responds with an appropriate error response.
Below the explanation for the parameters as received in a JSON response object in case of error.
 error – Error object comprising the information about the error
 code – Unique error code denoting the type of error.
Please refer Appendix A for the list of error codes and their corresponding descriptions. Example:
2.5.2.2 Valid Response
Find below the explanation for each of the parameters as received in a JSON response object in case of
success. All parameters if presents (including optional) should be process.

ads – array of ads in response each entry in array will have below fields
1. ad_type- Possible values "image" or "text" or “rm”. "image" corresponds to "Banner
Ads" and "text"corresponds to "Text ads" and "rm" for other types like rich media.
13
AdIQuity Ad Server API v2.2
2. ad_text-(optional for banner ads)Advertising text
3. img_url-(available only when ad_type is "image")URL where the banner has to be
fetched from.
4. cli_url- Destination URL where the user has to be redirected when the ad is clicked
5. beacons- Array of tracking URLs that have to be requested when the ad is displayed.
6. resp_html :: complete html markup of ad
7. cookies -(optional) Array of JSON objects
 c_name- Name of the cookie that has to be set on the device.
 c_value- Value of the cookie that has to be set on the device.
Example: Image response
{
ads: [
{
ad_type: “image”,
ad_text: “click here to search for more songs!”,
resp_html: “<a
href=\"http://72.20.109.46/ads.AdIQuity.com/click?bi=10&amp;ac=1536&amp;t=aHR0cDovL2FkaXF1aXR5LmNvbQ&amp;reqid
=YntARWMIWX8YZUNJC2R6dAMKZHUMSnUceUYAC2VSexlfe1BDRSE2Jnx9&amp;n=1\"> <img
src=\"http://72.20.109.46/img/FBY1RRB0LHZ4aktIDWR0fwkMY.gif\" alt=\"\"/></a><img
src=\"http://ast.AdIQuity.com/FBY1831RR023LHZ4aktIDW/n1/4642_10\"/>”,
img_url: ”http://72.20.109.46/img/FBY1RRB0LHZ4aktIDWR0fwkMY.gif”,
cli_url: ”http://72.20.109.46/ads.AdIQuity.com/click?bi=10&ac=1536” ,
beacons: [
http://ast.AdIQuity.com/FBY1831RR023LHZ4aktIDW/n1/4642_1
],
cookies: [
{
c_name: “adqc_admobuu”,
c_value: “abcdef1234”
},
{
c_name: “adqc_cookie”,
c_value: “243432dfs”
},
]
}
]
}
Example: Text response
{
ads: [
{
ad_type: “text”,
ad_text: “click here to search for more songs!”,
resp_html: “<a
href=\"http://72.20.109.46/ads.AdIQuity.com/click?bi=10&amp;ac=1536&amp;t=aHR0cDovL2FkaXF1aXR5LmNvbQ&amp;reqid
=YntARWMIWX8YZUNJC2R6dAMKZHUMSnUceUYAC2VSexlfe1BDRSE2Jnx9&amp;n=1\">click here to search for more songs!
14
AdIQuity Ad Server API v2.2
</a><img src=\"http://ast.AdIQuity.com/FBY1831RR023LHZ4aktIDW/n1/4642_10\"/>”,
cli_url: ”http://72.20.109.46/ads.AdIQuity.com/click?bi=10&ac=1536” ,
beacons: [
http://ast.AdIQuity.com/FBY1831RR023LHZ4aktIDW/n1/4642_10
],
cookies: [
{
c_name: “adqc_admobuu”,
c_value: “abcdef1234”
},
{
c_name: “adqc_cookie”,
c_value: “243432dfs”
},
]
}
]
}
Note: For Interstitial ad and for rich media ad ad_type:”rm” will come in response object.
2.5.3
Response Format - XML
A sample response in XML format can be seen as below.
2.5.3.1 Error Response
When the server encounters an error it responds with an appropriate error response.
Below the explanation for the tag as received in a XML response object in case of error.


error – Error tag comprising the information about the error.
code – Unique error code denoting the type of error.
Please refer Appendix A for the list of error codes and their corresponding descriptions.
2.5.3.2 Valid Response
Find below the explanation for each of the tags and attributes as received in a XML response object. All
parameters if presents (including optional) should be process.
 adq_resp- root tag having api version information under “version” parameter.
 ads – parent tag of all ads i.e all ads will be put inside this tag. It has 3 parameters
“count,w,h”... (count = number of ads w= width of ads and h = height of ads)
15
AdIQuity Ad Server API v2.2
 ad – tag to indicate beginning of an ad having below chield tags containing ad detail.
1. ad_type- Possible values "image" or "text" or “rm”. "image" corresponds to "Banner Ads"
and "text"corresponds to "Text ads" and "rm" for other types like rich media
2. resp_html - complete html markup of ad
3. ad_text-(optional for banner ads)Advertising text
4. img_url-(available only when ad_type is "image")URL where the banner has to be fetched
from.
5. cli_url- Destination URL where the user has to be redirected when the ad is clicked
6. beacons -flanks a set of <beacon> elements
beacon - URLs that have to be requested when the ad is displayed
7. cookies -(optional)flanks a set of <cookie> elements
cookie – Specifies the name of the cookie and its corresponding value with attributes
1. c_name– Attribute -Name of the cookie that has to be set on the device.
2. c_value– Attribute - Value of the cookie that has to be set on the device.
Example: Image response
<?xml version="1.0" encoding="UTF-8"?>
<adq_resp version="2.0">
<ads count="2" w="300" h="50">
<ad>
<ad_type>image</ad_type>
<img_url><![CDATA[http://72.20.109.46/img/FBY1RRBoLHZ4aktIDWR0fwkMY.gif]]></img_url>
<cli_url><![CDATA[http://72.20.109.46/ads.AdIQuity.com/click?bi=10&amp;ac=1536]]></cli_url>
<resp_html><![CDATA[<a
href="http://72.20.109.46/ads.AdIQuity.com/click?bi=10&amp;ac=1536&amp;t=aHR0cDovL2FkaXF1aXR5LmNvbQ&amp;reqid=
YntARWMIWX8YZUNJC2R6dAMKZHUMSnUceUYAC2VSexlfe1BDRSE2Jnx9&amp;n=1"> <img
src="http://72.20.109.46/img/FBY1RRB0LHZ4aktIDWR0fwkMY.gif"/></a><img
src="http://ast.AdIQuity.com/FBY1831RR023LHZ4aktIDW/n1/4642_10"/>]]></resp_html>
<beacons>
<beacons><![CDATA[http://ast.AdIQuity.com/FBY1831RRB023LHZ4aktIDW/n1/4642_10]]></beacons>
</beacons>
<cookies>
<cookies cname="adqc_admobuu" c_value="abcdef1234" />
<cookies cname="adqc_cookie" c_value="243432" />
</cookies>
</ad>
<ad>
<ad_type>text</ad_type>
<ad_text><![CDATA[click here to search for more songs!]]></ad_text>
<img_url><![CDATA[http://72.20.109.46/img/FBY1RRBoLHZ4aktIDWR0fwkMY]]></img_url>
<cli_url><![CDATA[http://72.20.109.46/ads.AdIQuity.com/click?bi=10&amp;ac=1536]]></cli_url>
<resp_html><![CDATA[<a
href="http://72.20.109.46/ads.AdIQuity.com/click?bi=10&amp;ac=1536&amp;t=aHR0cDovL2FkaXF1aXR5LmNvbQ&amp;reqid=
YntARWMIWX8YZUNJC2R6dAMKZHUMSnUceUYAC2VSexlfe1BDRSE2Jnx9&amp;n=1"> click here to search for more songs!
</a><img src="http://ast.AdIQuity.com/FBY1831RR023LHZ4aktIDW/n1/4642_10"/>]]></resp_html>
<beacons>
<beacon><![CDATA[http://ast.AdIQuity.com/FBY1831RRB023LHZ4aktIDW/n1/4642_10]]></beacon>
</beacons>
<cookies>
<cookie cname="adqc_admobuu" c_value="abcdef1234" />
<cookie cname="adqc_cookie" c_value="243432" />
</cookies>
</ad>
16
AdIQuity Ad Server API v2.2
</ads>
</adq_resp>
Note: For Interstitial ad and for rich media ad ad_type:”rm” will come in response.
Important points regarding multiple ad request:
1.
2.
3.
4.
Only JSON and XML response formats are supported for multiple ads.
If we have less number of ads for a request then we replicate few ads and send in response.
If adcount parameter does not contain +ve integer value then we discard the request.
Currently we are providing maximum of 10 ads if request comes for multiple ads.
3 Appendix A
Error Code
100
111
112
113
114
115
116
117
118
131
133
134
135
150
Description
No ads available.
Mandatory parameter pazid is missing or empty
Mandatory parameter ua is missing or empty
Mandatory parameter ip is missing or empty
Mandatory parameter hwid/odin is missing or empty
Mandatory parameter plat is missing or empty
Mandatory HTTP Header X-ADQ-pazid is missing or empty
Mandatory parameter api is missing or empty
Mandatory parameter app_pkg is missing or empty
Invalid value for pazid
Invalid value for ip
Invalid value for ua
Invalid value for adunit
Account has been suspended
4 Appendix B
In the wake of Apple's decision to deprecate UDID, ODIN seems to be a more widely accepted solution
apart from replacements like OpenUDID, SecureUDID and other proprietary solutions.
For iOS mobile apps, since the acceptance of ODIN and the deprecated UDID is still fragmented
among advertisers and adnetworks, we strongly recommend publishers to send us both the hwid
and odin parameters to ensure better fill rates and eCPMs.
Platform
Identifier Seed
iOS
802.11 MAC Address
Android
ANDROID_ID
17
Windows Phone
DeviceUniqueId
AdIQuity Ad Server API v2.2
Ensure that the final data that is sent is SHA1 hashed resulting in a 40 byte string in lowercase.
Please refer ODIN1's spec page for more information:
http://code.google.com/p/odinmobile/wiki/ODIN1
18