Ad Feed Parameters

From Mocean Mobile Wiki

Jump to: navigation, search

Contents

Overview

At this page the third party parameters are listed for users to better understand the integration process.

Besides, the Mocean Mobile platform allows for ad feeds parameters translation. I.e. it is available to pass custom parameters/values to the 3rd party ad server/network to ensure the most relevant ad is matched with the ad request.

Parameters that translation is supported for at the moment are listed in a separate table for each individual feed. (Download XLS)

* Ad feed partners the translation layer is implemented to are marked with an asterisk.

** Ad feed parameters that can not be translated in any way are marked with a double asterisk.

Forbidden Headers

Some HTTP headers coming with the ad request are generally forbidden and filtered out when sending a request to third parties. However, if a third party requires headers which are forbidden, the headers will be sent to the third party.

Forbidden headers:

  • "accept",
  • "accept-encoding",
  • "cache-control",
  • "connection",
  • "content-length",
  • "content-type",
  • "cookie",
  • "host",
  • "keep-alive",
  • "pragma",
  • "true-client-ip",
  • "user-agent",
  • "x-forwarded-for",
  • "x-forwarded-proto",
  • "x-images-host".

4INFO

caption


Base URL

http://api.adhaven.com/AdHaven/v1/getAd


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
api_key Identifies the publisher. Yes 4INFO_API_KEY (specified in GUI) api_key=242d136ac0e5c5c2
date A timestamp in RFC 1123 format. Yes. (today) Replaced with the current date. date=Wed, 08 Feb 2012 08:46:05 GMT
placement_id Identifies an ad placement with publisher's network. Yes 4INFO_PLACEMENT_ID (specified in GUI) placement_id=165
header_HTTP Publisher should pass in all values from the mobile web header. Yes* (if available) (request headers passed in) HTTP headers received in the request are parsed and passed to 4INFO.
NOTE: Forbidden headers won't be sent.
user_agent The client user agent. Not required if header is passed in. No ua Standard Mocean ad request API parameter.

NOTE: If no 'ua' parameter passed, user agent will be detected automatically.

user_agent=Mozilla/5.0 (X11; Linux i686) AppleWebKit/535.2 (KHTML, like Gecko) Ubuntu/10.04 Chromium/15.0.874.106 Chrome/15.0.874.106 Safari/535.2
client_ip IP address of the device. Not required if header is passed in. No ip Standard Mocean ad request API parameter.

NOTE: If no 'ip' parameter passed, client IP address will be detected from request headers.

client_ip=91.221.60.18
user_id The user ID that is defined by the publisher. No udid Standard Mocean ad request API parameter.

NOTE: If no 'udid' parameter passed, unique user ID will be generated automatically.

user_id = -7603686cd3d2dd371983f 01795f8cedee6c5c8ea
keyword One or more keywords describing the content, comma-separated. No keywords Standard Mocean ad request API parameter. keyword=music, box
country The country that the user is in or the phone is registered for. ISO 3166-1 alpha-3 codes (ex: USA, GBR). No ip

or mcc (if passed) or country (if passed)

At first, a country is determined by IP address of the request. Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”. country = RUS
lat_lon The user latitude and longitude. Comma-separated. No lat, long Standard Mocean ad request API parameters lat and long (comma-separated). NOTE: If no “lat” and “long” parameters passed, "lat_lon" will not be sent. lat_lon=56.5,84.966705

Addictive

Logo


Base URL

http://adfarm.addictivemobility.com/ads.php

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
appkey Yes ADDICTIVE_APP_KEY (specified in GUI) appkey=dca7d44f63634b5fef13a6806b16b62e
ad_size The width and height of the ad creative requested. Yes. size_x x size_y Standard Mocean ad request API parameters “size_x” and “size_y” (separated by x). Note: If no “size_x” and “size_y” parameters passed in, the size of the ad returned will be determined automatically by zone default ad sizes (if set) or by device. ad_size=300x50
ad_type A type of ad returned: “image” - a url pointing to a hosted image will be passed back to you as the ad_creative_image return field; “html” - yield an html string passed back via the ad_creative_html return field. Yes image Default value is used. ad_type=image
zone ID of the Addictive zone requested. Yes ADDICTIVE_ZONE (specified in GUI) zone=456687
rm Can this ad request fulfill a richmedia mobile ad in-app using a browser overlay view? If this parameter holds the value “yes”, the post_click_inapp_rm return field will be populated with a url. Yes no Default value is used. rm=no
udid A unique device identifier visible on the client side: UDID on iOS; EMEI on Android, BlackBerry; Any other replicable hash generated for a given device. No udid Standard Mocean ad request API parameter. NOTE: If no “udid” parameter passed, unique user ID will be generated automatically. udid=d3ca01cccaf06ec169db9f8ecd7d80f8bbc0169d
ip IP address of the device. No ip Standard Mocean ad request API parameter. NOTE: If no “ip” parameter passed, client IP address will be detected automatically. ip=122.166.7.84
os A user device OS. No ua Detected automatically on the basis of device user agent form “ua” parameter received (or detected automatically if no “ua” passed in). os=iPhone+OS
model A user device model. No ua Detected automatically on the basis of device user agent form “ua” parameter received (or detected automatically if no “ua” passed in). model=iPhone
geo A custom parameter specifying a user device geolocation. No lat, long Standard Mocean ad request API parameters lat and long (comma-separated). Note: If no “lat” and “long” parameters passed, user geolocation will be detected automatically. geo=location%2F37.4429%2C-122.1514
tags A custom parameter providing tags associated with the content the user is viewing. No keywords Standard Mocean ad request API parameter. tags=content%2Fauto,prius,hybrid

AdFalcon *

Logo



Base URL

http://api.adfalcon.com/AdRequest/GetAd

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
R_SIDThis parameter is the unique ID for your application or website in AdFalcon system.YesADFALCON_R_SIDYes(specified in UI) R_SID=54645456421537421324153421354
R_F**Ad format. AdFalcon supports three types of ad formats which are: JSON (JSON formatted response), BASIC_HTML (Simple HTML without Java Script), XHTML (XHTML 1.1 with Java Script format). Yes“BASIC_HTML” or “XHTML”Yes“XHTML” is used if R_ADTYPE contains “rm”. In other cases “BASIC_HTML” is used by default. R_F=BASIC_HTML
R_IPThis 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.YesipYesStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
R_IP=192.168.2.1
D_UAThe User agent of the device making the request. This helps AdFalcon to identify the device’s specifications and capabilities.YesuaYesStandard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected automatically.
D_UA=Mozilla%2F5.0%20(iPad%3B%20CPU%20OS%20
6_0%20like%20Mac%20OS%20X)%20AppleWebKit%2F
536.26%20(KHTML%2C%20like%20Gecko)%20Version%2F
6.0%20Mobile%2F10A5376e%20Safari%2F8536.25%20
R_VThe version of the AdFalcon Server API on which the integration has been implemented. The current version is: api-all-2.0.0Yesapi-all-2.0.0YesDefault value is used.R_V=api-all-2.0.0
R_URLThe URL of the page that is originating the ad request.Yes* (mandatory for mobile web)urlNoStandard Mocean ad request API parameter is used.R_URL=www.domain.com
R_HH_{*}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.Yes (request headers received) No HTTP headers.
NOTE: Forbidden headers won't be sent.
R_HH_ACCEPT-ENCODING=gzip%2Cdeflate
R_TMA boolean intended to inform AdFalcon network about application or web is under the development or maintenance mode.NotestNoStandard Mocean request API parameter; is used only for unit tests. R_TM=true
R_ADTYPEThis parameter is used to specify what ad types are supported by the client requesting the ad. The ad types are presented in comma separated list (b - Banner, t - Text, ph - Plain HTML, rm - Rich Media).
NOTE: If this parameter is not specified, AdFalcon assumes the client supports all types and the ad server will choose an ad regardless of its type. On the other side, sending more than one Ad type (separated by comma, such as “b,t,ph”) means that AdFalcon will only return ads of the specified types.
NotypeNoStandard Mocean ad request API parameter.
NOTE: If “type” contains “1”, “t” will be added to R_ADTYPE, if “type” contains “2”, “b” will be added to R_ADTYPE. In case of “4” - “rm” will be added.
R_ADTYPE=t%2Cb%2Crm
D_RMSupportThis parameter is used to list the supported rich media standards in comma separated format. The possible values are: MRAID1 - m1, MRAID2 - m2.
ээNOTE: If this parameter is not specified, AdFalcon server will consider that the device is not supporting any rich media standard.
NoADFALCON_D_RMSUPPORTNo(specified in UI)D_RMSupport=m1
R_ASThis parameter identifies the ad unit size to be delivered by AdFalcon. The possible values are: 320x50 - 10, 300x50 - 2, 216x36 - 3, 168x28 - 4, 120x20 - 5, 468x60 - 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 but not an Interstitial ad.
NoADFALCON_R_AS OR
size_x, size_y
NoSpecified in UI. If ADFALCON_R_AS is not specified, standard Mocean ad request API parameters (“size_x” and “size_y”) will be used to determine appropriate value for ad sizes.
NOTE: If “size_x” and “size_y” parameters are not passed in, the width and height of the ad returned will be determined automatically by zone default ad sizes (if set).
R_AS=6
R_UUIDThis parameter is used to get the unique ID for the device user.NoudidNoStandard Mocean ad request API parameter.
NOTE: If no “udid” parameter passed, R_UUID won't be sent.
R_UUID=1bef50453858d317a8471087aaf1614a
D_UID_MD5_MACiOS Identifier Parameter. MD5 of the MAC address represented in human readable format with capital characters such as 1A:2B:3C:4D:5E:6FNomacaddressNoMD5 hash of the standard Mocean ad request API parameter - "macaddress". D_UID_MD5_MAC=20665acd5f59a8e22275c78e1490dcc7
D_UID_MD5_ANDRAndroid Identifier. MD5 of the ANDROID_ID value.NoandroididNoMD5 hash of the standard Mocean ad request API parameter - "androidid". D_UID_MD5_ANDR=202cb962ac5975b964b7152d234b70
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
language U_LN
English en
French fr
Spanish es
Portuguese pt
Italian it
Russian ru
German de
Greek el
Vietnamese vi
Chinese Traditional zh
Chinese Simplified zh
Czech cs
Arabic ar
Polish pl
Dutch nl
Lithuanian lt
Turkish tr
Serbian sr
Romanian ro
Chinese zh
Filipino tl
Belarusian be
Croatian hr
Hungarian hu
Danish da
Ukrainian uk
Parisian French fr
Albanian sq
Bulgarian bg
Zulu zu
area U_AC
age U_AGE
birthday U_BD
yyyy-MM-dd dd.MM.yyyy
gender U_G
keywords U_KW
zip U_PC
lat D_LA
long D_LO
odin1 D_UID_ODIN1
openudid D_UID_OPENUDID
idfa D_UID_IDFA

Adfonic *

Logo


Base URL

http://adfonic.net/ad/<ADFONIC_AD_SLOT_ID>

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
ADFONIC_AD_SLOT_ID (specified in GUI)
r.id It is a clear text unique identifier for the device or user (ex: iPhone UDID). Yes* udid Yes Standard Mocean ad request API parameter; is sent only if udid, androidid, idfa, openudid, odin1 are not specified.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

r.id=f1s22223s3dd
d.dpid If you are able to access the iOS UDID or Android Secure.ANDROID_ID it should be sent as a SHA-1 hash and should be used instead of the r.id. If you cannot supply a device identifier then see r.id. Yes* (if in app) udid, androidid Yes Standard Mocean ad request API parameter. d.dpid = a68ac79e8365d04f3d97ec9af2372fcf9e3a7a3e
d.hifa Yes* idfa Yes Standard Mocean ad request API parameter. d.hifa =
d.openudid Yes* openudid Yes Standard Mocean ad request API parameter. d.openudid = 0d943976b24c85900c764dd9f75ce054dc5986ff
d.odin-1 Yes* odin1 YesStandard Mocean ad request API parameter. d.odin-1 = 82a53f1222f8781a5063a773231d4a7ee41bdd6f
r.ip IP address of the end user. Yes. ip Yes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

r.ip=122.166.7.84
h.user-agent HTTP headers sent by the end user’s browser where “h.user-agent” identifies the user’s device. Yes ua YesStandard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

h.user-agent=BlackBerry8100%2F4.2.0+Profile %2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100
s.test Test mode (0=false, 1=true). The default is 0. Yes 0 No Default value is used. s.test=0
t.format The format to use for the response (ex: urlencode/xml/json/html). The default is html. Yes htmlNo Default value is always used. t.format=html
t.markup If set to ‘1’ (enabled, the default), the response will contain a chunk of basic HTML code (anchor, href, image etc) that can be rendered on the user’s device. If disabled, you must parse the various ad components in the response in order to present them to the user. Yes 1 No The default value 1 is always passed in. t.markup=1
u.latitude A user's device latitude. No lat NoStandard Mocean ad request API parameter.

NOTE: If no “lat” parameter passed, user geolocation latitude will not be sent.

u.latitude= 43.716589
u.longitude A user's device longitude. No long No Standard Mocean ad request API parameter.

NOTE: If no “long” parameter passed, user geolocation longitude will not be sent.

u.longitude=-79.340686
p.tags Keywords in lowercase (comma-separated) to use when selecting an ad to display. No keywords NoStandard Mocean ad request API parameter. p.tags=mobile, device
r.client A arbitrary string identifying the client originating the request. We advise you to include at the miminum company/product name, platform and version e.g. Adfonic/Android/1.0.2.1 No ADFONIC_CLIENT No(specified in GUI) r.client = android
t.constraintsThe height and width values set within the UI. If not specified, the parameter is not sent.NoADFONIC_WIDTH, ADFONIC_HEIGHT No The parameter is determined by width and height specified in UI. t.constraints = width%3D320%3Bheight%3D50
h{.*} HTTP headers sent by the end user’s browser. The header-name in parameter name should be all lowercase. Most important of these is “h.user-agent” which identifies the user’s device, but all HTTP headers should be proxied in the request as h.* parameters unless the request is coming directly from the user agent. Yes (request headers received) No HTTP headers.
NOTE: All forbidden headers except for “user-agent” (which is processed manually) won't be sent.
h.x-real-ip = 91.221.60.18


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
gender u.gender
birthdayu.dob
yyyy-MM-dd yyyyMMdd
age u.age
lat u.latitude
latitude u.latitude
long u.longitude
longitude u.longitude

Adiquity *

Logo


Base URL

http://ads.adiquity.com/mapi

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
pazid Unique Site ID provided by AdIQuity Yes ADIQUITY_SITE_ID Yes (specified in GUI) pazid=adqkhhh2-14ej4lj1-d7d7t
ua The client user agent Yes ua Yes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

ua=BlackBerry8100%2F4.2.0+Profile
%2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100
hh_{.*} HTTP headers. Yes (Request headers received) No The headers received in the request are parsed and passed to Adiquity.

NOTE: the following headers won't be sent:
"accept",
"accept-encoding",
"x-forwarded-for",
"x-forwarded-proto",
"true-client-ip",
"x-images-host",
"host",
"keep-alive",
"connection",
"cookie",
"cache-control",
"content-type",
"content-length",
"user-agent"

hh_HTTP_ACCEPT_CHARSET=utf8
ip The IP address of the carrier gateway over which the device is connecting. Yes ip Yes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

ip=122.166.7.84
api** Current Adiquity API version. Yes "2.2" No Default value is used. api=2.2
app Flag to indicate a mobile app request. It is suggested to provide this value.
If the app parameter is unavailable, then the request will be considered as a wap request.
Yes* (For Mobile Apps) Yes* (For Mobile Apps) If the type of the site determined by the requested zone corresponds to mobile web site, app will be set to “false”. Otherwise, app is set to “true”. app=true
plat Identifies the type of platform the app is installed on. Possible values are ios/blackberry/android/j2me/symbian/palm/windows/bada/others. Yes* (For Mobile Apps) ua Yes* (For Mobile Apps) Detected by WURFL on the base of device user agent from “ua” parameter received.
NOTE: If no “ua” parameter passed, it will be detected from the headers.
plat=ios
hwid Hardware ID, a unique id which identifies the device the user is using. Yes* (For Mobile Apps; one of hwid, hwid:md5, hwid:sha1 or odin is required.) androidid, wuid Yes* (For Mobile Apps) Standard Mocean ad request API parameters. hwid=002ebf12a125-5ddfa73967c3
c5d20177
hwid:md5 The MD5 hash of hwid Yes* (For Mobile Apps; one of hwid, hwid:md5, hwid:sha1 or odin is required.) androidid_md5,androidid, wuid_md5, wuid Yes* (For Mobile Apps) Standard Mocean ad request API parameters.
NOTE: If no special device ID parameters passed, the device identifier configurable at the network level, or "udid" is used by default. If no defined, unique device ID will be generated automatically as a hash of "ip" and "ua".
hwid:md5=a774da6b8a024a8c54049
b77285a78b0
hwid:sha1 The SHA1 hash of hwid Yes* (For Mobile Apps; one of hwid, hwid:md5, hwid:sha1 or odin is required.) androidid_sha1, androidid, wuid_sha1, wuid Yes* (For Mobile Apps) Standard Mocean ad request API parameters.
NOTE: If no special device ID parameters passed, the device identifier configurable at the network level, or "udid" is used by default. If no defined, unique device ID will be generated automatically as a hash of "ip" and "ua".
hwid:sha1=102280f46b85522245fd
8293eb810c2629c379bb
odin Hashed (with SHA1) unique id which identifies the device the user is using. Yes* (For Mobile Apps; one of hwid, hwid:md5, hwid:sha1 or odin is required.) odin1 Yes* (For Mobile Apps) Standard Mocean ad request API parameter. odin=82a53f1222f8781a5063a7732
31d4a7ee41bdd6f
idfa The Unhashed Apple's Advertising Identifier on IOS6+ devices (aka IFA or IDFA). No idfa No Standard Mocean ad request API parameter. idfa=3D1E2DFA89-496A-47FD-9941-DF1FC4E6484A
idfa:md5 The MD5 hash of idfa No idfa_md5, idfa No Standard Mocean ad request API parameter; is sent only if idfa is not specified. idfa:md5=fb51f233d1b4520b09b48
11595dbab44
idfa:sha1 The SHA1 hash of idfa No idfa_sha1, idfa No Standard Mocean ad request API parameter; is sent only if idfa and idfa:md5 are not specified. idfa:sha1=d0b7d4561cdf68f6ad72
db0a9692e7bfad715ac6
app_pkg Application Package Name / Bundle ID that identifies an application on any application store No APP_PACKAGE_NAME Yes* (For Mobile Apps) (specified in GUI) app_pkg=com.adiquity.example
app_name The name of the application as its shown on any application store No* (but recommended) APP_NAME No (specified in GUI) app_name=Angry%20Birds
pg Url of the page where the ad was requested No* (but recommended) url No Standard Mocean ad request API parameter.
If not passed, but site domain is specified, site domain will be returned.
pg=http%3A%2F%2Fm.guruji.com
adunit Dimension of a specific size for banners to be retrieved. Supported sizes: 728x90, 468x60, 320x480, 320x50, 320x48, 300x250, 300x75, 300x50, 216x54, 216x36, 168x42, 168x28, 120x600, 120x30, 120x20. No No The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings

The largest supported size within the requested size is returned.

adunit=300x50
adtype The formats of ads to be returned. Comma separated values can be send. Single values is also acceptable. Supported values:
tx - for text ad;
im – for image/banner ads.
No type No Standard Mocean ad request API parameter. adtype=tx,im
loc Geo location of the user. No lat, long No Standard Mocean ad request API parameters lat and long (comma-separated). loc=34.131623,17.414113
city The City, user is located in. No city No Standard Mocean ad request API parameter.
NOTE: The value of standard parameter consists of two parts separated by a comma and space (", "). The first part will be sent as city value.
city=Bangalore
state The State/Region, user is located in. No city No Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated a comma and space ", ". The second part will be sent as state value.
state=Ohio
fmt** Response format: html/json/xml No "xml" No Default value is used. fmt=xml
test Test Mode. No test No Standard Mocean ad request API parameter or zone settings are used to define this parameter. Use "true" for unit tests.
Default value is "false".
test=false
tag Keywords used to return a contextually matching Ad. No keywords No Standard Mocean ad request API parameter. tags=Sports,Business,Technology
adcount** Total number of ads in request. Applicable only for multi ad request. No "1" No Default value is used. adcount=1
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
X-ADQ-pazid Unique Site ID, provided by AdIQuity. Yes ADIQUITY_SITE_ID (Specified in GUI) X-ADQ-pazid=adqkhhh2-14ej4lj1-d7d7t
Content-Type The mime type of the body of the request Yes application/x-www-form-urlencoded Default value is used. Content-Type=application/x-www-form-urlencoded
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
birthday dob
yyyy-MM-dd yyyyMMdd
ageage
gender gender
zipzip
region state
keywordstags
mcc mcc
mncmnc

Aditic

Logo


Base URL

http://generic.aditic.net/?

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
alid Ad Location unique identifier supplied by ADITIC. Yes ADITIC_ALID (specified in GUI) alid=1235
pid Publisher unique identifier supplied by ADITIC. Yes ADITIC_PID (specified in GUI) pid=456gf24561g45d
ua User agent. Yes us Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+ Configuration%2FCLDC-1.1+VendorID%2F100
support Publication support. One of the following: wap/ iphone/ android/ ipad/ j2me/ bada/ blackberry Yes us Standard Mocean ad request API parameter. support=wap
srcip IP of the mobile. ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

srcip=17.148.221.102
format The available formats depend on the support used. No xml Default value is used. format=xml

AdMarketplace *

Logo


Base URL

http://<ADMARKETPLACE_PARTNER_NAME>.ampfeed.com/xmlamp/feed

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
partner Name of your publisher account assigned by adMarketplace.
NOTE: These are unique to each publisher feed, so a single publisher account may have multiple partner names.
Yes ADMARKETPLACE_PARTNER_NAME Yes (specified in GUI)
NOTE: In case the values are redefined via translation layer, the 'partner' should contain the 'pub_' prefix - 'pub_partner'.
partner=pub_testpub
sub1 Unique identifier for different areas of inventory or associated affiliates.
This is also referred to as a top level Sub ID. Please do not use “-“ or “_” characters.
Yes ADMARKETPLACE_PARTNER_SUBID Yes (specified in GUI) sub1=1000
kw Keyword or query term. Yes ADMARKETPLACE_SEARCH_KEYWORD or keywords Yes (specified in GUI)
If not specified, standard Mocean ad request API parameter, keywords, is used.
kw=car+insurance
ip Requesting user IP address Yes ip Yes Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.
ip=66.117.59.146
ua User's agent Yes ua Yes Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
ua=Mozilla/5.0%20%28iPhone;%20CPU%20iPhone%20OS%20
6_0%20like%20Mac%20OS%20X%29%20AppleWebKit/536.26
%20%28KHTML,%20like%20Gecko%29%20Mobile/10A5376e
ptype Corresponds to advertisement placement.
• ptype=pc (desktop)
• ptype=mapp (mobile native app)
• ptype=mweb (mobile web)
Yes Yes If the type of the site determined by the requested zone corresponds to mobile web site, ptype will be set to “mweb”. Otherwise, ptype is set to “mapp”. ptype=mweb
puburl Corresponds to the URL of the page where the ad is shown. Yes
(No for mobile app)
ADMARKETPLACE_REFERRING_URL or url Yes Specified in GUI. If not specified, standard Mocean ad request API parameter, url, is used.
NOTE: If it is specified neither in GUI nor in the ad request, URL of the site associated with the requested zone will be used.
puburl=http%3A%2F%2Fwww.ampkeywords.com%2Fsearch.php
%3Fkeyword%3Dcar
m-idfa Specific to Apple iOS 6+ Mobile Devices
IDFA advertisingIdentifier in string format. This value is not hashed. Pre-iOS6 USID’s can be passed through this parameter as well. See Apple iOS Developer Guide as to how to obtain advertisingIdentifier.
No idfa No Default value is used. m-idfa=AEBE52E7-03EE-455A-B3C4-E5783966239
m-iostrack Specific to Apple iOS 6+ Mobile Devices
Corresponds to the advertisingTrackingEnabled parameter which indicates whether the user has limited ad tracking.
Do not alter this value before sending. See Apple iOS Developer Guide as to how to obtain advertisingTrackingEnabled.
• iostrack=Y (if advertisingTrackingEnabled is set to ‘True’ on device)
• iostrack=N (if advertisingTrackingEnabled is set to ‘False’ on device)
No idte No Standard Mocean ad request API parameter.
It is sent if “idfa” is defined.
m-iostrack=Y
m-anid-sha1 Specific to Android Mobile Devices.
Corresponds to the SHA1 hash of the ANDROID_ID. See Android Developer guide on how to obtain ANDROID_ID.
No androidid No Standard Mocean ad request API parameter.m-anid-sha1=cf23df2207d99a74fbe169e3eba035e633b65d94
g-latlong Corresponds to user’s geographic location in terms of their latitude and longitude coordinates. No lat, lon No Standard Mocean ad request API parameters separated by comma.
NOTE: If not specified by user, the system will try to send g-cc and g-pc.
g-latlong=40.8504%2C-83.9356
g-cc Corresponds to user’s geographic location in terms of the two letter ISO country code of user request origin.
NOTE: Pass this value only if country of origin is definitively known. Do not pass when g-latlong is defined.
No country No Standard Mocean ad request API parameter.
NOTE: Passed only if “lat”, “long” parameters are undefined.
g-cc=US
g-pc Corresponds to user’s geographic location in terms of the postal code of the user request origin.
NOTE: Do not pass when g-latlong is defined.
No zip No Standard Mocean ad request API parameter.
NOTE: Passed only if “lat”, “long” parameters are undefined, and “country” is specified.
g-pc=02141
v** Corresponds to API version. Yes 2 Yes Default value is used. v=2
results** Defines the number of ads to be returned. No 1 No Default value is used.results=1


Headers
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
x-forwarded-forIP address of a clientYes request headers and ip IP's obtained from the HTTP header and ad request parameter separated by commas and spaces. x-forwarded-for=129.78.138.66, 129.78.64.103
HTTP headers sent by the user's device No (request headers received) HTTP headers.
NOTE: All forbidden headers except for "x-forwarded-for" (which is processed manually) won't be sent.


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
openudid m-opudid
udidpubuid
carrier m-operator

AdMarvel *

Logo


Documentation at https://wiki.operamediaworks.com/display/AMS/AdMarvel+Ad+Request+Construction+Example, https://wiki.operamediaworks.com/display/AMS/AdMarvel+API, https://wiki.operamediaworks.com/display/AMS/AdMarvel+XML+API
Base URL

http://ads.admarvel.com/fam/postGetAd.php

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
partner_id The unique ID provided by AdMarvel to represent the partner. Yes ADMARVEL_PARTNER_ID Yes (specified in GUI) partner_id=abbc123
site_id The unique ID provided by AdMarvel to represent the site (or location on a site) where an ad will be displayed. Yes ADMARVEL_SITEID Yes (specified in GUI) site_id=132545sd
version The version of the AdMarvel API being used to request the ad. Yes "1.5.1" Yes Default value is used. version=1.5.1
timeout No "1000" No Default value is used.
NOTE: The parameter value is specified in milliseconds.
timeout=1000
format The parameter should be specified in order to obtain response in a xml_with_html format. No ua Yes Detected by WURFL on the basis of device user agent form “ua” parameter received (or detected from the request headers if no “ua” passed in). Possible values are:
  • "iphone";
  • "android".
format=iphone
testing Test Mode No test No Standard Mocean ad request API parameter or zone settings are used to define this parameter. Use "1" for unit tests. testing=0
phone_headers A specially formatted string that contains all the relevant phone headers that is required for accurate ad targeting. Yes (request headers received) Yes HTTP headers received in the request are parsed and passed to AdMarvel along with the parameters REMOTE_ADDR, REMOTE_HOST, REQUEST_URI, SERVER_NAME, SERVER_PORT and HTTP_USER_AGENT.
NOTE: Forbidden headers won't be sent.
phone_headers=REMOTE_ADDR=>12.23.23.56llREMOTE_HOST=>
12.23.23.56llREQUEST_URI=>http%3A%2F%2Fmydomain.com%2Fsample_page%2F%20llSERVER_NAME=>hiddenllSERVER_PORT=>80ll
HTTP_ACCEPT_LANGUAGE=>en-US%2Cen%3Bq%3D0.5ll
HTTP_VIA=>HTTP%2F1.1+ECD+%28ewr%2F15A3%29%2C
+HTTP%2F1.1+ECD+%28iad%2F1836%29llHTTP_X_EC_TAG=>
waf-productionllHTTP_X_HOST=>ads.mocean.mobill
HTTP_X_GATEWAY_LIST=>iad1llHTTP_USER_AGENT=>Mozilla%2F5.0
+%28iPhone%3B+CPU+iPhone+OS+8_1+like+Mac+OS+
X%29+AppleWebKit%2F600.1.4+%28KHTML%2C+like+
Gecko%29+Version%2F8.0+Mobile%2F12B411+ Safari%2F600.1.4
REMOTE_ADDR No ip Yes Standard Mocean ad request API parameter.
NOTE: If no 'ip' parameter passed, client IP address will be detected from request headers.
REMOTE_ADDR=>12.23.23.56
REMOTE_HOST No ip Yes Standard Mocean ad request API parameter.
NOTE: If no 'ip' parameter passed, client IP address will be detected from request headers.
REMOTE_HOST=>12.23.23.56
REQUEST_URI No url Yes Standard Mocean ad request API parameter. REQUEST_URI=>http%3A%2F%2Fmydomain.com%2Fsample_page%2F%20
SERVER_NAME No "hidden" Yes Default value is used. SERVER_NAME=>hidden
SERVER_PORT No "80" Yes Default value is used. SERVER_PORT=>80
HTTP_USER_AGENT No ua Yes Standard Mocean ad request API parameter.
NOTE: If no 'ua' parameter passed, user agent will be detected from request headers.
HTTP_USER_AGENT=>Mozilla%2F5.0+%28iPhone%3B+
CPU+iPhone+OS+8_1+like+Mac+OS+X%29+
AppleWebKit%2F600.1.4+%28KHTML%2C+like+Gecko%29+
Version%2F8.0+Mobile%2F12B411+ Safari%2F600.1.4
target_params A specially formatted string that contains all the optional targeting parameters that were supplied. No No A set of optional parameters used for targeting ads.
NOTE: "target_params" includes parameters with capitalized names listed below and the parameters that can be defined at the translation layer.
target_params=MSISDN=>919845070000llUNIQUE_ID=>a123ll
KEYWORDS=>newsllAGE=>24
ANDROID_ADVERTISING_ID Unique, user-specific ad ID for Android devices used for serving ads and performing analytics. No androidaid No Standard Mocean ad request API parameter. ANDROID_ADVERTISING_ID=>719ece9e-5404-4883-a0ba-6e7ac689291e
ANDROID_ID Unique Android device ID provided by the manufacturer. No androidid No Standard Mocean ad request API parameter. ANDROID_ID=>9774d56d682e549c
IDFA ID For Advertisers, relevant for iOS 6.0 and above. No idfa No Standard Mocean ad request API parameter. IDFA=>E70E82A6-B20D-4F60-9B5E-16DB925336D7
ANDROID_ADVERTISING_ID_OPT_OUT An Android ad ID that enables a user to opt-out for all ad networks that offer interest-based advertising. Acceptable value is 0 or 1. No idte No Standard Mocean ad request API parameter.

NOTE: "idte" and "ANDROID_ADVERTISING_ID_OPT_OUT" have opposite values. idte=1 corresponds to ANDROID_ADVERTISING_ID_OPT_OUT => 0 and vice versa.

ANDROID_ADVERTISING_ID_OPT_OUT=>1
GEOLOCATION Latitude and longitude (ex: 32.9014,-117.2079). No lat, long No Standard Mocean ad request API parameters "lat" and "long" (comma-separated). GEOLOCATION=>32.9014,-117.2079
JAVASCRIPT If you support Javascript ads (yes/no). No type No Standard Mocean ad request API parameter.
NOTE: If “type” contains “4” (rich media ad), “JAVASCRIPT” will be set to “yes”
JAVASCRIPT=>yes
WIDTH Desired width of ad. No No The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings
WIDTH=>200
HEIGHT Desired height of ad. No No The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings
HEIGHT=>100
AD_TRACKING_ENABLED Indicator whether the device/user has tracking enabled or not: “YES” or “NO" – though an optional parameter, it may be required if IDFA is being sent or to be used. Yes* idte No Standard Mocean ad request API parameter. AD_TRACKING_ENABLED=>YES
UNIQUE_ID Unique ID to describe the user for which ad request is being made. Alphanumeric. No device identifier configurable at the network level, udid No "udid" is used if no device identifier was specified at the network level UNIQUE_ID=>a123
RESPONSE_TYPE** An additional targeting parameter to enable the XML format. No "xml_with_xhtml" Yes Default value is used. RESPONSE_TYPE=>xml_with_xhtml
TYPE Desired type of ad (banner may get filled by text) "mixed" (default), "banner", "text". No type No Standard Mocean ad request API parameter is used to define the parameter. NOTE: If “type” contains “3”, “TYPE” is set to “mixed”, else if “type” contains “2”, “TYPE” is set to “banner”. Otherwise, if “type” contains “1”, “TYPE” is set to “text”. If “type” does not contain either of these values, the “TYPE” parameter won't be sent. TYPE=>text
MARKUP Your site markup: "xhtml" (default), "wml", or "chtml". No "xhtml" Yes Default value is used. MARKUP=>xhtml


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
ageAGE
birthday DOB
genderGENDER
m M
f F
ethnicityETHNICITY
black 0
white 3
eastindian 4
middleeastern 4
asian 1
latino 2
pacificislander 4
nativeamerican 4
mixed 4
other 4
keywords KEYWORDS
area AREA_CODE
dma DMA
zip POSTAL_CODE
carrier CARRIER
Alltel 7
AT&T 3
Cellular One Dobson 41
Cellular South 126
Cincinnati Bell 125
Cricket 146
Dobson 41
Metro PCS 24
Nextel 6
Ntelos 45
Qwest Wireless 32
Sprint 5
T-mobile 2
US Cellular 36
Verizon Wireless 4

Admoda Banner

Logo


Base URL

http://www.admoda.com/ads/fetch.php

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
z Admoda zone ID. Yes ADMODA_ZONE (specified in GUI) z=15457
a User device IP. Yes ip Standard Mocean ad request API parameter. NOTE: If no “ip” parameter passed, client IP address will be detected automatically. a=122.166.7.84
ua The client user agent. Yes ua Standard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100

Admoda Text

Logo


Base URL

http://www.admoda.com/ads/textfetch.php

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
z Admoda zone ID. Yes ADMODA_ZONE (specified in GUI) z=15457
a User device IP. Yes ip Standard Mocean ad request API parameter.NOTE: If no “ip” parameter passed, client IP address will be detected automatically. a=122.166.7.84
ua The client user agent. Yes ua Standard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100

AdMoove *

Logo


Base URL

http://local.admoove.com/ws/getad.php

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
output Output Mode of server. Three possible values:
- xml,
- json,
- xhtml (default value)
Yes xhtml Default value is used. output=xhtml
puid Publisher id – Given by Admoove support team. Yes ADMOOVE_PUBLISHER_ID (specified in UI) puid=893H03H1
userlat User latitude. Yes lat Standard Mocean ad request API parameter. Note: If no “lat” and “long” parameters are passed, user geolocation will be detected automatically. userlat=40.71731
userlngUser longitude.Yes long Standard Mocean ad request API parameter. Note: If no “lat” and “long” parameters are passed, user geolocation will be detected automatically. userlng=-73.99947
useraccAccuracy of lat/lon measurement (in meters). 0 if unknown value (default).Yes0Default value is used.useracc=0
zipOnly for integration with publishers using zipcode information as geolocation information.Yes* zipStandard Mocean ad request API parameter. ISO-3166 country code is passed even if the API example shows the entire name. Note: If no “zip” parameter is passed, user geolocation will be detected automatically.zip=75008
countryOnly for integration with publishers using zipcode information as geolocation information. Yes*countryStandard Mocean ad request API parameter. At first, a country is determined by IP address of the request. Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”. country=France
deviceuaDevice user agent. Read from http request but for the case of server to server integration, this parameter must be set by the external partner server.Yes*uaStandard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected automatically.
deviceua=Mozilla/5.0%20%28BB10;%20Touch%29%20
AppleWebKit/537.3+%20%28KHTML,%20like%20Gecko%29
%20Version/10.0.9.443%20Mobile%20Safari/537.3+
useridID defining a user (usually generated id one per application installation). This id is needed specially because of stats and also capping feature that will be soon implemented. YesudidStandard Mocean ad request API parameter. Configurable at the network level, or "udid" parameter is used by default. NOTE: If no parameter is specified in the request, unique user ID will be generated automatically. userid=25f9e794323b453885f5181f1b624d0b
serialidUDID or any serial id or user device.Noudid Standard Mocean ad request API parameter. Configurable at the network level, or "udid" parameter is used by default. NOTE: If no parameter is specified in the request, unique user ID will be generated automatically. serialid=cd7cs8vdg7s8dfds
deviceipDevice IP adress. Read from http request but for the case of ad server forward, this parameter must be set by the external partner server.Yes*ipStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
deviceip=66.117.59.146
apposOS of device. No(determined by WURFL) Determined automatically on the basis of the "device_os" and the "device_os_version" capabilities for the device. apppos=Android 1.5
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
language locale
English en_US
French fr_FR
Spanish es_ES
Portuguese pt_PT
Italian it_IT
Russian ru
German de_DE
Greek el
Vietnamese vi
Chinese Traditional zh_TW
Chinese Simplified zh_CN
Czech cs
Araic ar
Polish pl
Dutch nl
Lithuanian lt
Turkish tr
Serbian sr
Romanian ro
Chinese zh
Filipino tl
Belarusian be
Croatian hr
Hungarian hu
Danish da
Ukranian uk
Parisian French fr
Albanian sq
Bulgarian bg
Zulu zu
countryisoCountryCode
mccMobileCountryCode
mncMobileNetworkCode
carriercarrierName

Adshandy Banner

Logo


Base URL

http://www.adshandy.com/cgi-bin/pm/getad.cgi?

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
s Adshandy Partner ID. Yes ADSHANDY_PARTNER_ID (specified in GUI) s=45d5f
i User device IP. Yes ip Standard Mocean ad request API parameter. NOTE: If no “ip” parameter passed, client IP address will be detected automatically. a=122.166.7.84
b The client user agent. Yes ua Standard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100
l Desired language of the ad is returned. Yes ADSHANDY_LANGUAGE (specified in GUI) l=en
m Mode: live/test Yes live Default value is used. m=live

Adshandy Text

Logo


Base URL

http://www.adshandy.com/cgi-bin/pm/getad.cgi?

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
s Adshandy Partner ID. Yes ADSHANDY_PARTNER_ID (specified in GUI) s=45d5f
i User device IP. Yes ip Standard Mocean ad request API parameter. NOTE: If no “ip” parameter passed, client IP address will be detected automatically. a=122.166.7.84
b The client user agent. Yes ua Standard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100
l Desired language of the ad returned Yes ADSHANDY_LANGUAGE (specified in GUI) l=en
m Mode: live/test Yes live Default value is used. m=live

ADTECH *

Logo


Base URL

http://adserver.adtechus.com/<TAG_TYPE>/<TAG_VERSION>/<NETWORK_ID>/0/0/-1/ADTECH;loc=100

Base URL parts and scopes
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
TAG_TYPE** Ad response format. Yes “adxml” Default value is used. adxml
TAG_VERSION API version Yes “2.0” Default value is used. 2.0
NETWORK_ID Network ID assigned by ADTECH Yes ADTECH_NETWORK_ID (specified in GUI)
If not specified, default value - “5071.3” - is used
5071.3


Request Parameters
Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
rettype Ad type to be returned. Yes type Yes Standard Mocean Ad request API.
NOTE: If type contains 2 (image is requested), rettype will be set to “serv”. Otherwise, rettype will be set to “js” that correspond to the richmedia ad.
rettype=js
alias User alias for Adtech. Yes ADTECH_ALIAS Yes (specified in GUI) alias=mocean-defaults-5
random Random 20 character token here Yes Yes Randomly generated alphanumeric value of 20 chars. random=l9Xhsa4V0MXUJwS26zBx
guid A custom user identifier that overwrites the standard JEB2 cookie that is used to normally identify a unique user. No udid No Standard Mocean ad request API parameter.
NOTE: If no “udid” parameter passed, unique user ID will be generated automatically as a hash of ip and ua.
guid=9945cd892290c310372c490ef8db68b6d7ddedfa
header Specifies if it is needed to receive "Content-Length". Yes “yes” Yes Default value is used. header=yes
cookie Enable (“yes”) or disable (“no”) JEB2 user ID cookie. No should be used to get a feed directly without a redirection No “no” No Default value is used. cookie=no


Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
user-agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
user-agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
X-Forwarded-For IP Address of the end user. YesipStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
X-Forwarded-For=234.221.2.122


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age kvage
gender kvgender
m male
f female

Advertising.com *

Logo


Base URL

http://mocean.mads.advertising.com/adcalls2s

Testing URL

http://test.mads.advertising.com/adcalls2s


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
mpid Unique agnostic mobile placement ID provided by Ad.com Yes ADDOTCOM_MPID Yes (specified in GUI) mpid=1-FA01-12FF-0001
rettype** Return format specifier:
• “js” (for returning a script tag)
• “rawdata” (for returning an html fragment)
Yes “js” Yes Default value is used. rettype=js
random Random number up to 40 characters generated for each ad call, used to avoid caching issues. Could be in decimal or hex format and may include dashes as separators Yes sid Yes Mocean Show ID is used (32 hexadecimal digits separated by hyphens in the form 8-4-4-4-12) random=04f099ec-690f-4cb4-a46e-b4edd0e7203d
width Requested ad width in pixels. Yes size_x Yes Standard Mocean ad request API parameter.
NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available width for the given device.
width=320
height Requested ad height in pixels. Yes size_yYes Standard Mocean ad request API parameter.
NOTE: If no “size_y” parameter passed in, the height of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available height for the given device.
height=50
appguid Unique device identifier; used for frequency-capping, conversion-matching, and user-targeting. Noidfa, androidaidNo Standard Mocean ad request API parameters are used.
NOTE: If “idfa” is not passed, system will try to pass “androidaid”. If neither “idfa” nor “androidaid” passed, no value for “appguid” will be sent.
appguid=1A2B3C4D-00FF-00FF-00FF-1234567890AB
limitadtracking (for ios 6.0+ only) Flag indicating whether the user has set limit ad tracking in their preferences (“1” - true; “0” - false) No idte No Standard Mocean ad request API parameter.
NOTE: “idte" and “limitadtracking” have opposite values. “idte=1” corresponds to “limitadtracking=0” and vice versa.
limitadtracking=1
kvag Exact user age prefixed with the letters “ua”. No age No Standard Mocean ad request API parameter. “kvag” is formed by adding value of the “age” parameter to the “ua” letters.
NOTE: If “age” <18, nothing will be sent. If “age” >99, “kvag” will be sent as “ua99”.
kvag=ua21


Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
X-Forwarded-For IP Address of the end user. YesipStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.
X-Forwarded-For=234.221.2.122


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
lat lat
longlong
gender kvug
m 1
f 2

Ajillion *


Base URL

http://ad.AjillionMAX.com/ad/<placement_id>/4


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
placement_id** Unique identifier for the placement obtained from AjillionMAX. Yes AJILLION_PLACEMENT_ID Yes (specified in GUI)
NOTE: The "placement_id" parameter is sent as a part of Base URL.
http://ad.AjillionMAX.com/ad/156/4?clientip=91.221.60.18&
clientua=Mozilla%2F5.0+%28X11%3B+Ubuntu%3B+Linux
+x86_64%3B+rv%3A31.0%29+Gecko%2F20100101+Firefox
 %2F31.0&pubid=1&MediaType=MobileWeb&uid=ef78416d
2e6fe139d9fd7671fb4c46e0e72198c0&size=800x600&age=
30&keyword=dance%2Cwall&gender=f&format=json&count=1
clientip Client IP address to enable correct geo targeting. Yes ip Yes Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.
clientip=91.221.60.18
clientua User agent of the client to enable identification of the device. Yes ua Yes Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
clientua=Mozilla%2F5.0+%28X11%3B+Ubuntu%3B+Linux+x86_64
%3B+rv%3A31.0%29+Gecko%2F20100101+Firefox%2F31.0
pubid Unique identifier of the publisher. Yes AJILLION_PUBLISHER_ID Yes (specified in GUI) pubid=1
uid Unique device identifier. Yes Device identifier configurable at the network level, udid Yes The "udid" parameter is used if no device identifier was specified at the network level. uid=ef78416d2e6fe139d9fd7671fb4c46e0e72198c0
size Desired size of the ad. When sending the size you can either use width= and height= or use size=300x50 (digit x digit, no spaces). Note that this only applies when on Ajillion a dynamic placement has been set. Otherwise each placement ID has a fixed size. No Yes The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings
  4. WURFL (on the basis of max available width and height for the given device)

NOTE: Either "size" or the pair of "height" and "width" must be specified in the request to Ajillion.

size=800x600
MediaType Corresponds to advertisement placement (Web, MobileWeb or App). No No If the type of the site determined by the requested zone corresponds to mobile web site, MediaType will be set to “MobileWeb”. Otherwise, MediaType is set to “App”. MediaType=MobileWeb
channel The IAB channel list of channels, separated by ",". No AJILLION_CHANNEL No (specified in GUI) channel=IAB1-1,IAB5-3,IAB9-27
format** Format must be json, in order to obtain a json response. No "json" Yes Default value is used format=json
count** The number of ads to be returned. If count is more than 1, the returned json will be an array of ads. No "1" Yes Default value is used count=1
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
keywordskeyword
gender gender
ageage


Amobee *

Logo




Base URL

http://rrmprod.amobee.com/upsteed/wap/adrequest


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
as A unique identifier – usually a number - that identifies the ad space. Yes AMOBEE_PID (specified in GUI) as=15454
uid A unique user identifier. Mandatory for MarketPlace requests. Yes (for M/P only) udid Standard Mocean ad request API parameter. NOTE: If no “udid” parameter passed, unique user ID will be generated automatically. uid=3c696792bfda2f760a5ab689011aa302bab5423d
ua The user agent that identifies the calling device or browser. Mandatory for MarketPlace requests. Yes (for M/P only) ua Standard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. ua=Mozilla%2F5.0+%28Windows+NT+6.1%3B+WOW64%29
+AppleWebKit%2F537.36+%28KHTML%2C+like+Gecko%29
+Chrome%2F27.0.1453.94+Safari%2F537.36
mu** The chosen markup language. If not specified the system will try to estimate the value from the request’s user agent. Yes xhtml Default value is used. mu=xhtml
pl Identifies the position of the ad space on a page when multiple ads are defined. NoAMOBEE_POSITION(Specified in UI) pl=1
rtDefines the desired ad dimensions. By using format and resource type the web page can request and ad of a specific format and with specific dimensions. If not specified, ads of any available resource type will be retrieved.NoAMOBEE_RESOURCE_TYPE(specified in UI) rt=MMA_4_1
tp Sets the type of the ad request:

3 - client-to-server and should be used for interstitials; 4 - server-to-server integration and should be used for banners. If not specified, the API will respond as if a value of 4 had been passed.

Yes 4 Default value is used. tp=4
i The IP address that identifies the device. This value is required by some ad networks. Yes ip Standard Mocean ad request API parameter. NOTE: If no “ip” parameter passed, client IP address will be detected automatically. i=122.166.7.84
co Identifiers of user’s country. 2 chars ISO country code (e.g. US, CA). Yes ip

or mcc (if passed) or country (if passed)

At first, a country is determined by IP address of the request. Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”. co=US
acc Account id of the publisher. If not specified a default account will be used. No AMOBEE_ACCOUNT (specified in GUI) acc=4546545
f Desired ad format. If not specified, any ads available for the specified ad space will be retrieved. No AMOBEE_FORMAT (specified in GUI) f=MobileBanner
kw Keywords for targeting (delimited by "|") No keywords Standard Mocean ad request API parameter. kw=sports | football
ts Test requests are not logged as impressions and are meant to be used for monitoring and testing purposes. 0 – production; 1 – test. Default – 0. No 0 Default value is used. ts=0
prtCompany / partner name NoAMOBEE_PARTNER_NAME(specified in UI) prt=Amobee
nkNegative keywords for the exclusion of certain ads from flights.NoAMOBEE_NEGATIVE_KEYWORDS(specified in UI) nk=food|animals|alcohol
stState code (in US only)NoregionStandard Mocean API parameter.st=NY
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
birthday dob
yyyy-MM-dd ddMMyyyy
gender ge
lat lat
long long
dma dma
zip zip

Appia *

Logo


Documentation at

https://appiainc.atlassian.net/wiki/display/APDS/XML+Ad+Request+API+-+Version+2

Base URL

http://ads.appia.com/v2/getAds


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
idAuthentication attribute provided by Appia.YesAPPIA_ID Yes ID parameters specified in GUIid = 463
passwordAuthentication attribute provided by Appia.YesAPPIA_PASSWORDYes ID parameters specified in GUIpassword = YSHZCUU8MSGTM3UVY39XKIUEGF
siteId Value provided by Appia to identify the publisher.YesAPPIA_SITEIDYes Specified in GUIsiteId = 3681
userAgentHeaderThe user agent of the device for which the ad is requested. Required to ensure device-application compatibility.YesuaYes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

userAgentHeader = Mozilla/5.0%20%28iPhone;%20CPU%20iPhone%20OS%20
6_0%20like%20Mac%20OS%20X%29%20AppleWebKit/536.26
%20%28KHTML,%20like%20Gecko%29%20Mobile/10A5376e
sessionIdsessionId of the end user device the request is generating Ads for. This parameter is required so ads provided in the XML response will be rotated, end users will not see duplicates on subsequent requests.Yes udidYes Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically as a hash of ip and ua.

sessionId = -235ec0724fe254aee40ba7d9170629c8f93ca745
ipAddressRequired for end user geo-targeting.YesipYes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

ipAddress = 66.117.59.146
categoryIdThe predefined category/subcategory available to filter the results on. Category IDs can be comma separated to filter for multiple categories. See the table at the end of the document for a list of IDs and their category names.NoAPPIA_CATEGORYIDNo Specified in GUIcategoryId = 55,56
adTypeIdThe size of creative returned in the ad response. 1 is the default.

1 = 72x72 Icon

4 = 300x50 Banner

5 = 320x50 Banner

6 = 300x250 Interstitial

7 = 320x480 Interstitial

8 = 480x300 Interstitial

9 = 768x1024 Interstitial

10 = 1024x768 Interstitial

No size_x, size_y No Standard Mocean ad request API parameters.

NOTE: If no “size_x” and “size_y” parameters passed in, the width and the height of the ad returned will be determined by zone default ad sizes (if set) or by WURFL (on the basis of max available width and height for the given device).

adTypeId = 5
udidThe UDID from the requesting device.NoudidNo Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically as a hash of ip and ua.

udid = 123456987
totalCampaignsRequestedAllows publishers to request multiple ads simultaneously. 1 is the default. Note: If value =1, impression tracking is automatic.No No totalCampaignsRequested = 1
cv3n No The "subid" is used. cv3n = subid
cv3v No The <zone_id> value is used. cv3v = 179492


AppLift *

Logo


Documentation at

https://applift.atlassian.net/wiki/display/WA2/Ad+Serving+API+v2

Base URL

http://api.applift.com/api/partner/v2/promotions/<AD_FORMAT>

Base URL parts and scopes:

URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
AD_FORMATAd format, “native” or “image”. YesAPPLIFT_AD_FORMAT or applift_ad_format(specified in GUI)
If not specified in UI, the "applift_ad_format" ad request parameter is checked.
If it is specified neither in UI nor in the ad request, "image" is used as default.
image

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
app_tokenThis is internal ID provided by AppLift to users when they sign up with the AppLift network and create an app.
App_token is a secure token which you can find in AppLift's dashboard.
YesAPPLIFT_APP_TOKENYes(specified in UI)app_token=4fbf43efff7589540204e14cbb2378d195935374ecf
5d0ea2216b83f05715fb1
bundle_idThe Bundle ID of the requesting app.YesBUNDLE_IDYes(specified in UI)bundle_id=com.my.app
user_agent The user agent of the device making the request.YesuaYesStandard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. user_agent=Mozilla%2F5.0+%28iPhone%3B+CPU+iPhone+
OS+6_0+like+Mac+OS+X%29+AppleWebKit%2F536.26+%28
KHTML%2C+like+Gecko%29+Version%2F6.0+Mobile%2F
Safari%2F8536.25
osThe operating system of requesting device.
Possible values are “android” or “ios”.
Yes(Determined by WURFL)YesDetermined by WURFL on the basis of the "device_os" capability for the device.
NOTE: If the “os” parameter is changed via translation layer, please make sure the “os_version” parameter is changed correspondingly.
os=ios
os_versionThe operating system version of the requesting device.Yes (Determined by WURFL)YesDetermined by WURFL on the basis of the "device_os_version" capability for the device.os_version=6.0
device_modelThe model of the requesting device.YesuaYesThe corresponding phone model name from WURFL obtained on the base of user agent. device_model=iPhone
ipThe IP address of the device received from the device request.NoipNoStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected detected automatically.
ip=127.0.0.1
partnerThe partner company name No “mocean” NoDefault value is used. partner=mocean
banner_sizeThe size of icon ad being requested. Values will be either in the format widthxheight, or the text “fullscreen”.
Possible values:
native: “1200x627” (default), “640x334”
image: “fullscreen”, “300x50”, “320x50”, “300x250”, “320x480”, “480x320”, "1024x768”, "768x1024”
NoAPPLIFT_BANNER_SIZE or
size_x and size_y
No(specified in UI)
If APPLIFT_BANNER_SIZE is not specified, standard Mocean ad request API parameters (“size_x” and “size_y”) will be used to determine appropriate value for ad sizes.
NOTE: If “size_x” and “size_y” parameters are not passed in, the width and height of the ad returned will be determined automatically by zone default ad sizes (if set).
banner_size=320x50
device_resolutionThe requesting device resolution. Values will be in the format widthxheightYes* (For fullscreen image format) Yes* (If banner_size=fullscreen)Can be defined at the translation layer. device_resolution=640x1136
device_typeThe type of the device. Can be tablet for iOS or Android tablets or phone. For iPods, please use phone.
Possible values: “phone”, “tablet”
Yes* (For fullscreen image format) Yes* (If banner_size=fullscreen)Can be defined at the translation layer.device_type=phone
mac_addressThe MAC address of the phone's wifi adapter.No macaddressNoStandard Mocean ad request API parameter. mac_address=001422012345
apple_idfaApple ID for Advertising.Noidfa NoStandard Mocean ad request API parameter.apple_idfa=236A005B-700F-4889-B9CE-999EAB2B605D
android_idThe Android Id.Noandroidid No Standard Mocean ad request API parameter.android_id=3ee0149b4ccef71b
android_advertiser_idThe Android Advertiser Id (Android 4.4+)Noandroidaid NoStandard Mocean ad request API parameter.android_advertiser_id=38400000-8cf0-11bd-b23e-10b96e40000d
user_unique_idAny unique identifier representing the user.
Use only in case no other device identifier can be provided.
Noudid NoStandard Mocean ad request API parameter.
NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.
NOTE: It is sent only if macaddress, idfa, androidid, androidaid are not specified.
user_unique_id=c2638260b8ad3c8d34090d7a0bbaea91e3e77a61
ad_count**Number of ads to be returned. No “1”NoDefault value is used. ad_count=1


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
country country
language locale
English en
French fr
Spanish es
Portuguese pt
Italian it
Russian ru
German de
Greek el
Vietnamese vi
Chinese Traditional zh
Chinese Simplified zh
Czech cs
Arabic ar
Polish pl
Dutch nl
Lithuanian lt
Turkish tr
Serbian sr
Romanian ro
Chinese zh
Filipino tl
Belarusian be
Croatian hr
Hungarian hu
Danish da
Ukrainian uk
Parisian French fr
Albanian sq
Bulgarian bg
Zulu zu
lat lat
long long
gender gender
m male
f female
age age
keywords keywords


Brightroll

Logo


Base URL

http://mobile.btrll.com/ad

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
siteID Static parameter per a publisher. Yes BRIGHTROLL_SITE_ID (specified in GUI) siteID=3844778
ipAddress Device IP Address Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ipAdress=122.166.7.84
integration Static parameter Yes mocean Default value is used integration=mocean
version Static parameter. Yes BRIGHTROLL_VERSION Specified in GUI. NOTE: If not specified the default value 20120222 is used. version=20120222
platform A type of platform, e.g. android, mobileWeb, ios Yes BIRGHTROLL_PLATFORM (specified in GUI) platform=android
unit Unit. Default value is mobileWeb Yes mobileWeb Default value is used. unit=mobileWeb
osVersion A user device OS; is passed for Android platform only Yes* (if platform is Android) ua Detected automatically on the basis of device user agent from “ua” parameter received (or determined by request headers if no “ua” passed in). osVersion=3.2

BuzzCityServer *

Logo



Documentation at http://docs.buzzcity.net/wiki/Standard_Server_Side_API

Base URL

http://cd1.buzzcity.net/showads.php


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
partnerid Partner ID registered with BuzzCity. Yes BUZZCITY_PARTNER_ID Yes (specified in GUI) partnerid=4251
ip Caller's IP address. If no ip is specified, the calling program’s IP address will be used. Yes ip Yes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=64.72.33.44
ua Caller's user agent. If no ua is specified, the calling program’s User Agent will be used. M Yes ua Yes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=SAMSUNG-GT-S5620/1.0
getAn ad type. The following values are possible:
“get=rich” - Rich Media Ad Banner. If not present, return Mobile Graphical / Tablet Ad (Recommended).
“get=image” - Indicate a graphical or tablet ad is expected. Old code that uses “mweb” will be treated as the same behavior as "image".
“get=text” - Indicate a text ad is expected.
Yestype Yes Standard Mocean ad request API parameter.
NOTE: If “type” contains “4”, “get” is set to “rich”, else if “type” contains “2”, “get=image”. Otherwise, if “type” contains “1”, “get” is set to “text”.
get=rich
fmt**Output returned in JSON format.NojsonNoDefault value is used.fmt=json
limit If this parameter is specified and has a value greater than “1”, the number of campaigns returned will be either the number specified by the limit” parameter, or the maximum number of campaigns available, whichever is lesser (Recommended). No 1 No Default value is used. limit=1
vIndicate the Server Side API version you want to involve. Set as "3" - For Server Side API Version 3 Yes3 Yes Default value is used.v=3
udid Encrypted version of the phone UDID (Recommended). No udid No Standard Mocean ad request API parameter. udid=efefaf3e870b27fd4f6c49cb3e3134ea67cb23c5bb
browser Browser Type. Specify the type of browser used by your visitor (if matches):
• "app_blackberry" - For BlackBerry Apps;
• “OPERAMINI” – For Opera Mini browser;
• “BOLT” – For Bolt browser;
• "UCWEB" - for UC Browser;
• "OVI" for Ovi Browser.
No (from the request header) No Platform of the mobile site determined by the requested zone, ua or HTTP headers is used. browser=OPERAMINI
bbmnc Mobile Country Code (MCC). No ip or mcc (if passed) or country (if passed) NoAt first, a country is determined by IP address of the request.
Then, if “mcc” parameter is passed in, it overrides country determined by “ip”.
Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.
bbmnc=510

NOTE: For this feed the parameters for translation can be set via the Ad Feed configuration settings in UI.

Centro

Logo


Base URL

http://t.brand-server.com/mocean


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
ipThe end user’s IP. Yesip No Standard Mocean ad request API parameter. NOTE: If no 'ip' parameter passed, client IP address will be detected automatically. ip=67.195.137.147
sAn identifier of publisher’s section (will be provided by Centro for each site/app).YesCENTRO_ID No (specified in UI)s=2324
clickurlA click url to which a request should be made if the user clicks on the ad. CLICKURL_MACRO is default.YesCLICKURL_MACRO No Default value is used.
szThe size of the ad unit.Yessize_x, size_y Yes Standard Mocean API parameter. NOTE: If no “size_x” and "size_y" parameters passed in, the width and height of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available width and height for the given device. The largest support size within the requested size is returned (320*50 or 300*50). If 320*50 or 300*50 size ads are too large, no request to Centro will be sent.size=300*50
urlFor mobile web, the URL of the web page. For mobile apps, an identifier for the web application.Nourl No Standard Mocean ad request API parameter. url=http://domain.com
gpsGeo coordinates of user device.Nolat, long No Standard Mocean ad request API parameters, separated by comma. Note: If no “gps” parameter passed, user geolocation will be detected automatically. gps=41.878114,-87.629798
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0

Chitika *

Logo
Documentation at

https://chitika.atlassian.net/wiki/display/ARIG/Web+API+Integration

Base URL

http://ads.adrtr.net/m/ad


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
vVersion of the AdReactor API. Default value is 5.Yes5 Default value is used.v=5
clientAdReactor client name.YesCHITIKA_CLIENT(specified in UI) client=mocean
idAdReactor tracking id.YesCHITIKA_TRACKING_ID(specified in UI) id=64047f90-4d01-0130-520d-12313d07f9a1
d_ipIP address closest to device (typically a carrier IP).YesipStandard Mocean ad request API parameter. NOTE: If no 'ip' parameter passed, client IP address will be detected automatically. d_ip=75.14.14.28
d_pidPlatform-specific ID (e.g., Android ID or UDID for iOS5/IFA for IOS6).Yesudid It is a sha1 hashed platform-specific ID (e.g., Android ID or UDID for iOS5/IFA for IOS6).NOTE: If no “udid” parameter passed, it will not be sent.d_pid=32b1c496b84ea549191cdc65d32ade0c8d74c91b
d_uaDevice user agent string.YesuaStandard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

d_ua=Mozilla%2F5.0+%28iPhone%3B+U%3B+CPU+iPhone+
OS+4+like+Mac+OS+X%3B+en%29+AppleWebKit%2F420+
+%28KHTML%2C+like+Gecko%29+Version%2F3.0+Mobile
%2F1A543+Safari%2F419.3
a_idApp Store ID. (Google Play or Apple AppStore).YesCHITIKA_APP_STORE_ID(specified in UI)a_id=490505997
a_nameApplication Name.YesCHITIKA_APP_NAME(specified in UI)a_name=Evernote Skitch
a_catArray of categories of the application.YesCHITIKA_CATEGORIES(specified in UI)a_cat=productivity
l_locLatitude, Longitude.Yeslat, longStandard Mocean API parameters lat and long separated with ','. Note: If no “l_loc” parameter passed, user geolocation will be detected automatically.l_loc=26.204118,-98.230287
wWidth in pixels.Yessize_xStandard Mocean API parameter. Note: If no “size_x” parameter passed in, the size of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available width for the given device.w=320
hHeight in pixels.Yessize_yStandard Mocean API parameter. Note: If no “size_y” parameter passed in, the size of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available height for the given device.h=50
s_pageURL of the current page.YesurlStandard Mocean ad request API parameter “url” is used. NOTE: If no “url” passed, app url (site domain) obtained on the base of the standard Mocean ad request API parameter “zone” will be sent.s_page=www.google.com
l_cityCity.Yescity Standard Mocean ad request API parameter. NOTE: The value of standard parameter consists of two parts separated with ", ". The first part will be sent as city value.
Note: If no “l_city” parameter passed, user geolocation will be detected automatically.
l_city=Mcallen
l_stateState; using ISO-3166-2 (for US only).YesregionStandard Mocean API parameter. Note: If no “l_state” parameter passed, user geolocation will be detected automatically.l_state=TX
l_countryCountry; using ISO-3166-1 Alpha-3.Yesip or mcc (if passed) or country (if passed) At first, a country is determined by IP address of the request.
Then, if “mcc” parameter is passed in, it overrides country determined by “ip”.
Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.
The determined country value is Alpha-3 converted.
l_country=USA
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
birthday u_yob
yyyy-MM-dd yyyy
gender u_gender
m M
f F
keywords u_keywords
area l_areacode
dma l_dma
zip l_postcode
carrier d_carrier

CitySearch

Logo


Base URL

http://api.citygridmedia.com/ads/custom/v2/latlon


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
publisher The publisher code that identifies you. This parameter is required so that we know who to credit. Yes CITYSEARCH_PUBLISHER (specified in GUI) publisher=acme
lat Latitude of the center of a circle for a geographic search. A decimal between -90 and 90. Yes lat Standard Mocean ad request API parameter.

Note: If no “lat” parameter passed, user geolocation latitude will be detected automatically.

lat=37.65056
lon Longitude of the center of a circle for a geographic search. A decimal between -180 and 180. Yes long Standard Mocean ad request API parameter.

Note: If no “long” parameter passed, user geolocation longitude will be detected automatically.

lon=-119.03639
radius Radius of a circle search, in miles. Defaults to 5. If radius is larger than 25, it will be clamped to 25. An integer between 1 and 25, inclusive. Yes CITYSEARCH_RADIUS Citysearch radius specified in GUI. If not passed, the default value (25) will be passed instead. radius=25
placement An optional property for storing additional information you would like CityGrid Media to log for this view. No CITYSEARCH_PLACEMENT (specified in GUI) placement=google yahoo searchresults
client_ip The IP address of your client. IPv4 or Ipv6. No ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

client_ip=17.148.221.102
user_agent The version of browser or device the ad is served on. No ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

user_agent=Mozilla%2F5.0+%28BlackBerry
%3B+U%3B+BlackBerry+9800%3Ben-US%29+AppleWebKit%2F534.1%2B%28KHTML%2C+
likeGecko%29+Version%2F6.0.0.246Mobile+Safari%2F
534.1%2B
what What a user is searching for. For multi-word searches, simply put a space between the words. Yes CITYSEARCH_KEYWORDS and keywords Citysearch keywords parameters specified in GUI and a standard Mocean ad request parameter 'keywords'. what=pizza sporting goods plumbers
max The maximum number of results to return. The default value is 10. Values over 10 will be clamped to 10. Integers in the range 1 through 10. No 1 Default value is used. max=1

CitySearch Mobile

Logo


Base URL

http://api.citygridmedia.com/ads/mobile/v2/banner


Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
publisher The publisher code that identifies you. This parameter is required so that we know who to credit. Yes CITYSEARCH_PUBLISHER (specified in GUI) publisher=acme
collection_id Used for rotation or targeting. A publisher can have multiple collections and is required to pass one collection id per request. Yes CITYSEARCH_COLLECTION_ID (specified in GUI) collection_id=mobile-001-320x50
lat Latitude of the center of a circle for a geographic search. A decimal between -90 and 90. Yes lat Standard Mocean ad request API parameter.

Note: If no “lat” parameter passed, user geolocation latitude will be detected automatically.

lat=37.65056
lon Longitude of the center of a circle for a geographic search. A decimal between -180 and 180. Yes long Standard Mocean ad request API parameter.

Note: If no “long” parameter passed, user geolocation longitude will be detected automatically.

lon=-119.03639
radius Radius of a circle search, in miles. Defaults to 5. If radius is larger than 25, it will be clamped to 25. An integer between 1 and 25, inclusive. Yes CITYSEARCH_RADIUS Citysearch radius specified in GUI. If not passed, the default value (25) will be passed instead. radius=25
placement An optional property for storing additional information you would like CityGrid Media to log for this view. No CITYSEARCH_PLACEMENT (specified in GUI) placement=google%20yahoo%20searchresults
client_ip The IP address of your client. IPv4 or Ipv6. No ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

client_ip=17.148.221.102
user_agent The version of browser or device the ad is served on. No ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

user_agent=Mozilla%2F5.0+%28BlackBerry
%20%3B+U%3B+BlackBerry+9800%3B%20en-US%29+AppleWebKit%2F534.1%2B%28%20
KHTML%2C+like%20Gecko%29+Version%2F
6.0.0.246Mobile+Safari%2F534.1%2B
what What a user is searching for. For multi-word searches, simply put a space between the words. Yes CITYSEARCH_KEYWORDS and keywords Citysearch keywords parameters specified in GUI and a standard Mocean ad request parameter 'keywords'. what=pizza%20sporting%20goods%20plumbers
max The maximum number of results to return. The default value is 10. Values over 10 will be clamped to 10. Integers in the range 1 through 10. No 1 Default value is used. max=1
format The desired format for the results: xml/json). The default format is xml. No xml Default value is used. format=xml

DealNet

Logo



Base URL

http://dealnet.mobi/api/get_ads.php?params=

NOTE: A GET parameter called "params" holds request parameters in JSON format.

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
ad_client The username as supplied by DealNet. Yes DEALNET_AD_CLIENT (specified in GUI) "ad_client":"sub_test"
ad_slot The ad id as supplied by DealNet. Yes DEALNET_AD_SLOT (specified in GUI) "ad_slot":"1"
lat The latitude of the device. Yes lat Standard Mocean ad request API parameter.

Note: If no “lat” parameter passed, user geolocation latitude will be detected automatically.

"lat":"37.778820"
lon The longitude of the device. Yes long Standard Mocean ad request API parameter.

Note: If no “long” parameter passed, user geolocation longitude will be detected automatically.

"lon":"-122.475586”
uid The device's id. No udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

"uid":"4iij4e45lk049"
user-agent The details of the user's browser and operation system. No ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

"user-agent":"Mozilla/5.0 (SymbianOS/9.1; U; [en-us]) AppleWebKit/413 (KHTML, like Gecko) Safari/413"

Decktrade

Logo




Base URL

http://ads.decktrade.com/getAd.php5?

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
asid Unique Identifier of the user. Yes DECKTRADE_PARTNER_ID (specified in GUI) asid=4fr35
ua User Agent String of the Device’s Browser. Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100
uip Public IP Address of the Device. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

uip=17.148.221.102
mode The usage mode: test/live. No live Default value is used. mode=live

Doubleclick

Logo



Base URL

http://ad.mo.doubleclick.net/DARTProxy/mobile.handler?

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
k Key. Any valid targeting string. Yes DOUBLECLICK_KEY (specified in GUI) k=site1/zone1
ip Device IP address. Required with server-side requests only. Do not include with client-side requests. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=17.148.221.102
ua URL-encoded device user agent. Required with server-side requests only. Do not include with client-side requests. Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100
r Response format for the ad. No DOUBLECLICK_R (specified in GUI) r=x
c Determines which portion of a combination ad (image and text) is clickable. Also can be used to serve ads without a click-through, which is useful when branding pages. No DOUBLECLICK_C (specified in GUI) c=i
sp Size profile override. The publisher can specify the profile to be returned instead of relying on DoubleClick’s device-to-size-profile mapping. No DOUBLECLICK_SP (specified in GUI) sp=l
matchheight Used to override the profile matching behavior, which matches based on width of the device. If matchheight=1 is passed in the ad request, the width and height of the device is used by the profile matching logic. No DOUBLECLICK_MATCHHEIGHT (specified in GUI) matchheight=1
t Requested Mobile display ad: i=image ad; t=text ad; it= image or text ad. No type Standard Mocean ad request API parameter. t=i

Drawbridge *

Logo


Documentation at http://doc.drawbrid.ge/#65-
Base URL

http://ads.adsymptotic.com/a/r

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
_pid Partner id - an integer id assigned to every data partner with Drawbridge. Yes DRAWBRIDGE_PARTNER_ID (specified in GUI) _pid=18967
_psign Partner Signature - a unique signature to validate the data request originating from a partner. Yes DRAWBRIDGE_PARTNER_SIGNATURE (specified in GUI) _psign=751fc61e59209cdda243639a73cc9511
_clip Client ip. In case of a mobile device, this is the ip closest to the device – carrier ip or wifi. Yes ip Standard Mocean ad request API parameter. NOTE: If no “ip” parameter passed, client IP address will be detected automatically. _clip=64.72.33.44
_did Hashed Unique Device id (if request is from an iPhone/Android application). No udid Standard Mocean ad request API parameter. The unique user ID is sha1 hashed. _did=d89a39a71b17896c26bc8786fce1547d
_aid Appstore ApplicationId for App Request. Yes zone Zone ID obtained from the standard Mocean ad request API parameter “zone”. _aid=113916
_pu Page url - the main page (parent) url hosting the iframe for the ad request. This is only applicable if the ad request is from a mobile web browser. No url Standard Mocean ad request API parameter “url” is used.NOTE: If no “url” passed, app url (site domain) obtained on the base of the standard Mocean ad request API parameter “zone” will be sent. _pu=http%3A%2F%2Fsometravel.com
_puuid Partner detected Unique User id (if available) - this is some unique identifier as detected by the partner via cookies or any other mechanism for users visiting the web page. Yes udid Standard Mocean ad request API parameter. NOTE: If no “udid” parameter passed, unique user ID will be generated automatically. _puuid=d89a39a71b17896c26bc8786fce1547d
_ua Browser user agent if available for mobile or desktop. For the mobile native app, if this not available see the _dev* parameters listed below. Yes ua Standard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. _ua=Mozilla/5.0%20%28BB10;%20Touch%29%20
AppleWebKit/537.3+%20%28KHTML,%20like%20
Gecko29%20Version/10.0.9.443%20Mobile%20
Safari/537.3+&
_geo Geo location co-ordinates - a comma separated list of latitude, longitude and altitude if available. No lat, long Standard Mocean ad request API parameters lat and long (comma-separated).NOTE: If no “lat” and “long” parameters passed,"_geo" won't be sent. _geo=43.716589,-79.340686
_dcoCountry of the user.Nocountry Standard Mocean ad request API parameter. If no "country" parameter passed, "_dco" is not sent. If 'UK' is passed, it is translated into 'GB'._dco=US
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
birthday _dyob
yyyy-MM-dd yyyy
gender _dgen
size_x _adw
size_y _adh
zip _dzip

Google

Logo


Base URL

http://pagead2.googlesyndication.com/pagead/ads?

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
client The client parameter specifies your unique client ID and is used to attribute revenue, impressions, and clicks to your account. Yes GOOGLE_CLIENT (specified in GUI) client=ca-mb-example
ad_type Specifies the type of ads that partners will receive in ad results Yes GOOGLE_AD_TYPE (specified in GUI) ad_type=text
output Specifies the type of markup used to generate the ad. For high-end devices, the only valid value is html. Yes html Default value is used. output=html
format This parameter specifies the style of the user interface used to display ads in HTML format. Yes 320x50_mb Default value is used format=320x50_mb
channel This parameter identifies the reporting and/or targeting channel with which an ad request should be associated. No GOOGLE_CHANNEL (specified in GUI) channel: 'sports fitness'
markup html Default value is used.
dt
js afmc-v1.2 Default value is used. js=afmc-v1.2

Google High-End Devices

Logo


Base URL

http://pagead2.googlesyndication.com/pagead/show_afmc_ads.js

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
client The client parameter specifies your unique client ID and is used to attribute revenue, impressions, and clicks to your account. Yes GOOGLE_CLIENT (specified in GUI) client: 'ca-mb-example'
format This parameter specifies the style of the user interface used to display ads in HTML format. Yes GOOGLE_FORMAT or "320x50_mb" (specified in GUI)
If not specified, default value is used.
format: '320x50_mb'
output Specifies the type of markup used to generate the ad. For high-end devices, the only valid value is html. Yes html Default value is used. output: 'html'
slotname Yes GOOGLE_SLOTNAME (specified in GUI) slotname: '1235489'
channel This parameter identifies the reporting and/or targeting channel with which an ad request should be associated. No GOOGLE_CHANNEL (specified in GUI) channel: 'sports fitness'
ad_type Specifies the type of ads that partners will receive in ad results Yes GOOGLE_AD_TYPE or "text_image" (specified in GUI)
If not specified, default value is used.
ad_type: 'text'

Greystripe MobileWeb *

Logo
Base URL

http://adsx.greystripe.com/openx/www/delivery/mw2.php

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
site_id A unique identifier provided by Greystripe. Yes GREYSTRIPE_SITE_ID Yes(specified in GUI) site_id = 10641
sizesAd size. Specify one or more sizes. Greystripe may return an ad of any one of the specified sizes: "300x250, 320x50". These are encoded and delimited by commas as 300x250, 320x50.YesGREYSTRIPE_SIZES Yes (specified in GUI)
NOTE: If sizes are not specified in GUI, it is checked whether the default value (320x50) corresponds with ad sizes determined by standard Mocean ad request parameters - “size_x” and “size_y”, or by zone default ad sizes (if set) or by WURFL. If so, the default value will be sent. Otherwise, the empty response will be returned.
sizes = 320x50
format** Ad response format Yes "html" Yes Default value is used. format = html
pubClickTracker** A URL that is fired when the ad is clicked. No Yes (is generated automatically) pubClickTracker = http://ads.mocean.mobi/1/redir/b0b75480-799c-11e2-837b-005056967d1f/0/188489?redir=
pubImpTracker** A URL that is fired when the ad is displayed. Fired only when the ad is visible. No Yes (is generated automatically)pubImpTracker = http://ads.mocean.mobi/redir/1effb750-3c79
fcuidA user id string which is provided for the purpose of "no cookie" mode. This together with the site_id is used to determine what is a unique user for when doing "no cookie" frequency capping.Noudid YesStandard Mocean ad request API parameter.
NOTE: If no 'udid' parameter passed, unique user ID will be generated automatically as a hash of ip and ua.
fcuid = 7e610f062fd01935cf4594121dee65869afff474
nc**Engages "no cookie" mode. See also the "fcuid" parameter, which is required for "no cookie" mode to actually work. Default value=1 is used.No "1" YesDefault value is used. nc = 1
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
X-Forwarded-For Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, ip address will be detected from request headers.

X-Forwarded-For=129.78.138.66


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gender gender
m M
f F

InMobi *

Logo


Base URL

http://api.w.inmobi.com/showad/v2

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
id InMobi Site ID. Unique identifier for registered property (32 digit in size). Yes INMOBI_SITEID Yes (specified in GUI) id=727265157cda4218b73814b0d44534d8
ip Remote IP address of the end user device. Yes ip Yes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=17.148.221.102
ua UA of the end user device. Yes ua Yes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100
adsize This should contain one of the supported creative ad sizes of the device requested by the publisher. If not present, the ad size is derived from the user-agent (that is, the capability of the device that is represented by the user-agent).
Please refer to the Supported Parameters and InMobi's Ad Size table for more details.
No INMOBI_AD_SLOT No (specified in GUI) adsize=1
sid User session ID. No udid No Standard Mocean ad request API parameter.
NOTE: If no “udid” parameter passed, unique user ID will be generated automatically as a hash of “ip” and “ua”.
sid=a8285a31d9c8c6ab0122c435035563016dcb7309
ida Identifier for advertiser without hashing. iOS 6 and above only. No idfa No Standard Mocean ad request API parameter. ida=68753A44-4D6F-1226-9C60-0050E4C00067
idv Identifier for vendor without hashing. iOS 6 and above only. No idfv No Standard Mocean ad request API parameter. idv=599F9C00-92DC-4B5C-9464-7971F01F8370
so1 Standard ODIN1 format. Generated from the raw byte-array representation of the MAC address, hashed with SHA1 (SHA1 of Byte MAC address). Applicable for devices below iOS 7. No odin1 No Standard Mocean ad request API parameter. so1=dasasdasc8eydwdbdaev9w6ecwv9ye9adafs
gpid Google Play advertising identifier, without hashing. Available for Android (2.3 and above) devices that have Google Play services with JAR above 4.0 on their phone.  No androidaid No Standard Mocean ad request API parameter. gpid=34fw9cwe9tcev9w6ecwv9ye9wdfweyc
o1 InMobi Standard Alternate ODIN1 format. Generated from the uppercase colon-separated string representation of the MAC address, hashed with SHA1 (SHA1 of String MAC address).
Applicable for devices below iOS 7 and Android.
No androidid_sha1, androidid No Standard Mocean ad request API parameter.
NOTE: If 'androidid_sha1' is not passed, SHA1 hash of 'androidid' is used.
o1=dc8eydwdbwfw9cwe9tcev9w6ecwv9ye9wdfw
um5 UDID of the device hashed using MD5 (MD5 checksum of UDID). Applicable for devices below iOS 6 and Android. No androidid_md5, androidid No Standard Mocean ad request API parameter.
NOTE: If 'androidid_md5' is not passed, MD5 hash of 'androidid' is used.
um5=dasasdasc8eydwdbdaev9w6ecwv9ye9a
adt For iOS 6.0+: Flag indicating whether the user has set limit ad tracking in their preferences (“1” - true; “0” - false)
For Android: This parameter indicates whether the user wants to opt out of Interest based Ads (“1” - true; “0” - false)
No idte No Standard Mocean ad request API parameter. adt=1
adtypeThis parameter needs to be populated when a special ad format is to be requested. Currently, InMobi supports interstitial ads and the parameters should have the value “int” to request for them. No INMOBI_ADTYPE No (specified in GUI) adtype=int
posPosition of the requested ad. Possible values are “top”, “bottom”, “middle”, “page”. No INMOBI_POS No (specified in GUI) pos=page
apiAPI frameworks supported for the request. Possible values are:
0 - Richmedia not supported.
1 - VPAID 1.0
2 - VPAID 2.0
3 - MRAID 1.0
4 - MRAID 2.0
5 - ORMMA
No INMOBI_API No (specified in GUI) api=1
reftagValue is a string by which Reporting/Performance Metrics groupings are needed by the publisher. For example, “reftag=login” can be used to group Reporting/Performance metrics based on advertisements served on a login page only No INMOBI_REF_TAG No (specified in GUI) reftag=login
catComma-separated list of Content Categories of the property from which the request is originating from No INMOBI_CAT No (specified in GUI) cat=im1,im4
Headers
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
content-typeThe MIME type of the body of the request Yes application/json Default value is used.content-type=application/json
x-forwarded-for Originating IP address of a clientYes ip and request headers Standard Mocean ad request API parameter and ip's obtained from the HTTP header separated by commas and spaces. x-forwarded-for=129.78.138.66, 129.78.64.103


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
keywords interests
lat lat
long lon
birthday yob
yyyy-MM-dd yyyy
gender gender
m male
f female
ethnicity ethnicity
black africanamerican
white caucasian
eastindian other
middleeastern other
asian asian
latino hispanic
pacificislander other
nativeamerican other
mixed other
other other
language language
English eng
French fra
Spanish spa
Portuguese por
Italian ita
Russian rus
German deu
Greek ell
Vietnamese vie
Chinese Traditional zho
Chinese Simplified zho
Czech ces
Arabic ara
Polish pol
Dutch nld
Lithuanian lit
Turkish tur
Serbian srp
Romanian ron
Chinese zho
Filipino fil
Belarusian bel
Croatian hrv
Hungarian hun
Danish dan
Ukrainian ukr
Parisian French fra
Albanian sqi
Bulgarian bul
Zulu zul

Inneractive *

logo


Base URL

http://m2m1.inner-active.com/simpleM2M/requestEnhancedXmlAd

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
aid Application ID generated through the Inneractive console. Yes INNERACTIVE_AID Yes (specified in GUI) aid=23424
v** This parameter represents the server version. Later versions support additional functionality. Options:

Sm2m-2.0.1 Sm2m-2.1.0 (includes Rich Media support)

Yes “Sm2m-2.1.0” Yes Default value is used. v=Sm2m-2.1.0
ua The user agent of the client device. For client side requests, this value will be taken from the standard HTTP headers. Yes ua Yes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+ Configuration%2FCLDC-1.1+VendorID%2F100
cip Client IP – the IP address of the requesting device. Yes ip Yes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

cip=17.148.221.102
f This parameters specifies the presence and/or type of rich media ads to be returned. Supported values:

20 - HTMLserving Ads,
52 - ORMMA (Rich Media Standard),
84 - MRAID (Rich Media Standard),
116 - both ORMMA & MRAID.

Yes “20” Yes Default value is used. f=20
idfa Apple's IFA (Identified For Advertisers) Yes* idfa Yes* Standard Mocean ad request API parameter.

* NOTE: At least one of idfa, aaid, amd, asha, dmd, dsha, ismd or issha parameters should be sent.

idfa=AEBE52E7-03EE-455A-B3C4-E57283966239
aaid New Google Advertising ID Yes* androidaid Yes* Standard Mocean ad request API parameter.

* NOTE: At least one of idfa, aaid, amd, asha, dmd, dsha, ismd or issha parameters should be sent.

aaid=38400000-8cf0-11bd-b23e-10b96e40000d
amd Android ID Yes* android_md5, androidid Yes* Standard Mocean ad request API parameter.

* NOTE: At least one of idfa, aaid, amd, asha, dmd, dsha, ismd or issha parameters should be sent.

amd=f3bceb686713bc3e436c979e429f6912
asha Android ID Yes* androidid_sha1, androidid Yes* Standard Mocean ad request API parameter.

* NOTE: At least one of idfa, aaid, amd, asha, dmd, dsha, ismd or issha parameters should be sent.

asha=9f1787b337b92aae66b1676dcfbb4fa494eeee13
dmd DeviceUniqueID for Windows Phone Yes* wuid_md5, wuid Yes* Standard Mocean ad request API parameter.

* NOTE: At least one of idfa, aaid, amd, asha, dmd, dsha, ismd or issha parameters should be sent.

dmd=7a79e2cabfabe207015e499b0ae1610a
dsha DeviceUniqueID for Windows Phone Yes* wuid_sha1, wuid Yes* Standard Mocean ad request API parameter.

NOTE: SHA1 hash of "wuid" is used.
* NOTE: At least one of idfa, aaid, amd, asha, dmd, dsha, ismd or issha parameters should be sent.

dsha=d6d53a4e0fab1a62ac8faddbf4c9858c2abfa0cb
ismd IMSI for all devices with a SIM card.
NOTE: MD5-hashed value should be used.
Yes* Yes* The parameter can be defined via translation layer.

* NOTE: At least one of idfa, aaid, amd, asha, dmd, dsha, ismd or issha parameters should be sent.

ismd=68cc5c4c4ff4a04d393d14a09e72afc4
issha IMSI for all devices with a SIM card.
NOTE: SHA1-hashed value should be used.
Yes* Yes* The parameter can be defined via translation layer.

* NOTE: At least one of idfa, aaid, amd, asha, dmd, dsha, ismd or issha parameters should be sent.

issha=9c77f1301e311c9bfae27d8dd9828843679d7b45
rw Rectangle width; is used together with "rh" to request Rectangle Ad Spot No No Supported sizes: 1024x768, 728x90, 320x480, 300x250, 300x50, 216x36, 168x28.

The priority of selecting size values to be sent to 3rd Party Partner will be the following:

  1. Creative sizes
  2. Request parameters
  3. Zone settings

The largest supported size within the requested size is returned.

rw=300
rh Rectangle height; is used together with "rw" to request Rectangle Ad Spot No No Supported sizes: 1024x768, 728x90, 320x480, 300x250, 300x50, 216x36, 168x28.

The priority of selecting size values to be sent to 3rd Party Partner will be the following:

  1. Creative sizes
  2. Request parameters
  3. Zone settings

The largest supported size within the requested size is returned.

rh=250
lg GPS location – ISO code location data. In latitude, longitude format. No lat, long No Standard Mocean ad request API parameters “lat” and “long” (comma-separated).

NOTE: If no “lat” and “long” parameters passed, "lg" will not be sent.

lg=37.771008,-122.41175
l Location string - comma separated list of Country, State/Province, City. No country, region, cityNo Comma-separated standard Mocean ad request API parameters “country”, “region” and “city” are used.

NOTE: If “region” is not sent, the second part of the location string will be obtained from the “city” parameter. The standard "city" parameter consists of city and state values separated by a comma, so the second part of the “city” parameter will be used for the region.

l=US,CA,San Francisco


Headers
Ad Feed Header Name Description Req? Source Mocean Parameter Comments Sending Value Example
HTTP headers sent by the user's device No (request headers received) HTTP headers.
NOTE: The following headers are not passed:
"accept",
"accept-encoding",
"x-forwarded-for",
"x-forwarded-proto",
"true-client-ip",
"x-images-host",
"host",
"keep-alive",
"connection",
"cookie",
"cache-control",
"content-type",
"content-length",
"user-agent"


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age a
gender g
keywords k
mnc mnc
mcc mcc

iVdopia *

Logo
Documentation at

https://vdopia.atlassian.net/wiki/display/RC/Web+Server+Ad+API+-+v1.1

Base URL

http://serve.vdopia.com/adserver/html5/adFetch

Request Parameters:

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
adFormat Ad format. Yes IVDOPIA_AD_FORMAT Yes (specified in GUI) adFormat=banner
ak The unique key (api key) provided by iVdopia to a partner site. Yes IVDOPIA_AK Yes (specified in GUI) ak=b8d0f070718d495478efc28d2a934a1a
type Possible values:
• app,
• web.
Yes IVDOPIA_TYPE *Yes (specified in GUI)
*NOTE: if “type” is not specified in UI, “type” value will be obtain on the base of the pubsite.
type=web
pageURL URL of the page where the impression will be shown. Yes (only for web) IVDOPIA_PAGE_URL *Yes (specified in GUI)
*NOTE: If “type” is web, “pageUrl” value is obtained from IVDOPIA_PAGE_URL. If “type” value is app, this parameter will not be used. If no “type” defined and pubsite is web site, “url” parameter or pubsite domain will be used.
pageURL=http://sampledomain.com/some.html
domain Domain of the site, used for advertiser side blocking. Yes (only for web) IVDOPIA_DOMAIN *Yes (specified in GUI)
*NOTE: If “type” is web, “domain” value is obtained from IVDOPIA_DOMAIN. If “type” value is app, this parameter will not be used. If no “type” defined and pubsite is web site, “url” parameter or pubsite domain will be used.
domain=sample.com
siteName Site name. Yes (only for web) IVDOPIA_SITE_NAME *Yes (specified in GUI)
*NOTE: If “type” is web, “siteName” value is obtained from IVDOPIA_SITE_NAME. If “type” value is app, this parameter will not be used. If no “type” defined and pubsite is web site, pubsite name will be used.
siteName=ehow.com
appBundle Application bundle name (for iOS) or package name (for Android). Yes (only for app) IVDOPIA_APP_BUNDLE Yes (specified in GUI)
Parameter is used only if IVDOPIA_TYPE=app.
appBundle=com.my.app
appName Application name. Yes (only for app) IVDOPIA_APP_NAME Yes (specified in GUI)
Parameter is used only if IVDOPIA_TYPE=app.
appName=samplename
category IAB content categories for the site or app. No IVDOPIA_CATEGORY or “IAB24” Yes (specified in GUI)
NOTE: The “IAB24” value is used by default, if it is not specified in GUI.
category=IAB24
output** Response format - depends on the integration type. Yes “javascript” Yes Default value is used. output=javascript
version API version used: currently 1.1 Yes “1.1” Yes Default value is used. version=1.1
dnt The 'Do Not Track' indicator. Yes idte Yes Corresponds to the standard Mocean ad request API parameters.
NOTE: "idte" and "dnt" have opposite values. idte=1 corresponds to dnt=0 and vice versa. If "idte" is not specified in the ad request, "dnt" flag will be false by default.
dnt=0
di Device ID. If di value is provided, it should represent a true value. On server-to-server connections, frequency-capping, and unique reporting is not possible if this value is not provided. Yes androidaid, androidid, idfa, macaddress, odin1 Yes Standard Mocean ad request API parameters are used. Parameters are checked in the following order: androidaid, androidid, idfa, macaddress, odin1. Once a parameter is not empty, its value is used for "di" and other parameters aren't checked.
NOTE: If no mentioned parameters passed, device ID parameter сonfigurable at the network level. If no defined, unique user ID will be generated automatically.
di=-1f8713de98c9a177ee495b3e05c1755e4905415a
dif Device ID format. Possible values:
• “dpid” - Device Platform ID (only for mobile app).
• “dhid” - Device Hardware iD (only for mobile app). This value is used when “dpid” is not available in the platform.
• “pid” - Partner Device/User Identifier (only for mobile web).
Yes Yes Value is defined on the base of an unique device ID parameter being used.
NOTE: “dpid” value is used if “androidaid”, “androidid” or “idfa” are used for “di” parameter, “dhid” - if “macaddress” or “odin1” are set as value of the “di” parameter, and “pid” for automatically generated unique user ID.
dif=dpid
ipAddress IP of the client Yes (for server-to-server integration) ip Yes Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
ipAddress=17.148.221.102
ua User agent string on the requesting client. Must be URL-encoded. Yes ua Yes Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected automatically.
ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+ Configuration%2FCLDC-1.1+VendorID%2F100
attr Link attribute to bind to Required for inappvideo. Ignored for other formats IVDOPIA_ATTR Yes (for adFormat=inappvideo) (specified in GUI) attr=href
val Value of the link attribute to match Required for inappvideo. Ignored for other formats IVDOPIA_VAL Yes (for adFormat=inappvideo) (specified in GUI) val=One
size Size of the ad. Possible values:
• 320x480
• 300x250
Yes IVDOPIA_SIZE,
size_x, size_y
Yes (specified in GUI)
NOTE: If no parameters are specified in GUI, standard Mocean ad request parameters “size_x” and “size_y” (separated by x) will be used. If no “size_x” and “size_y” parameters passed in, the width and the height of the ad returned will be determined by zone default ad sizes (if set) or by WURFL (on the basis of max available width and height for the given device). If no size is appropriate, request will not be sent.
size=320x480
target_params Demographic / behavioral information to allow a more informed selection of ads No No (a set of parameters that can be defined at the translation layer along with "latlong") target_params=latlong%3D37.29%2F-121.93%7Ckeywords%3Dnews%2Celection
latlong Decimal Latitude & Longitude separated by '/'. No lat, long No This parameter is included in the “target_params” and can be defined at the translation layer. Standard Mocean ad request API parameters “lat” and “long” (separated by '/').
NOTE: If no "lat" and "long" parameters passed, the "LATLONG" parameter will not be sent.
latlong=37.29/-121.93
geoType Indicate the source of geo data. Possible values:
• 1 - GPS/Location Services
• 2 - IP Address
• 3 - User provided
No (required if “latlong” is provided) No This parameter is included in the “target_params” and can be defined at the translation layer.
Value by default:
• 1 - GPS/Location Services
geoType=1
geo Country / State / City. No country, region, city_name No This parameter is included in the “target_params” and can be defined at the translation layer. Consists of two-digit ISO country code, two-digit sub-country code and city-name separated by ':'. geo=US:CA:San Francisco
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
birthday birthday
gender sex
ethnicity ethnicity
black Black
white White
eastindian Other
middleeastern MiddleEastern
asian Asian
latino Latino/Hispanic
pacificislander PacificIslander
nativeamerican NativeAmerican
mixed Mixed
other Other
language language
age age
zip currpostal
dma dmacode
keywords keywords

Jiwire *

Logo


Base URL

http://tags-mobile.jiwire.com/

Request Parameters
Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
netid Your JiWire partner id Yes JIWIRE_NETID Yes (specified in GUI) netid=99
lid The zone name Yes JIWIRE_LID Yes (specified in GUI) lid=banner
mpxy Mobile Proxy. Proxy content to the Ad server for the mobile device. Required. Must be 1 Yes 1 Yes Default value is used. mpxy=1
resp Response mime type. Default is json. Yes json Yes Default value is used. resp=json
uuid Unique Device Identifier for the client Yes udid Yes Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically as a hash of ip and ua.

uuid=563473
mapiver Version of the API. Default 1 Yes 1 Yes Default value is used. mapiver=1
hl Hyperlocal Targeting. Default 0 = disabled. If you are caching ad content you must leave this feature disabled. Yes 1 Yes Default value is used. hl=1
bt Behavioral Targeting. Default 0 = disabled. If you are caching ad content you must leave this feature disabled. Yes 1YesDefault value is used. bt=1
kw=cat:[JiWire Category Code] The category of the app making the request. Yes JIWIRE_CATEGORY Yes (specified in GUI) kw=cat:[nav]
kw=sup:[type]** Capability of request to support rich media or standard banners only. Possible values: rm or st. Yes type Yes Standard Mocean ad request API parameter. The parameter can not be changed by the translation layer. kw=sup:[rm]
dpi DPI resolution of the device. If dpi >= 326, then dpi=326. If dpi < 326, then dpi=160. Pass only these two values. Yes Yes Determined by WURFL on the base of ua or headers. dpi = 326
fmt The ad size. If not specified 300x250 is the default. Yes size_x, size_y Yes It is determined on the base of standard Mocean API parameters. Such sizes as 300x250 and 320x50 are supported. fmt = 320x50
house If the parameter house=0 is passed in the ad call, then JiWire will omit the actual Ad payload portion in the JSON response since it is assumed the caller does not display house ads to client devices and intends to discard the house Ad response when the ad_type:"house" indicates that the payload is a house Ad. 0 is the default. Yes 0 Yes The default value is used. house = 0
lat The latitude of the client device. Yes lat Yes Standard Mocean ad request API parameter lat. Note: If no “lat” parameter passed, user geolocation will be detected by ip.lat = 40.6501
lon The longitude of the client device. Yes long Yes Standard Mocean ad request API parameter long. Note: If no “long” parameter passed, user geolocation will be detected by ip.lon = -73.9496
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
user-agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
user-agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
x-forwarded-for A series of IPs associated with the ad request. Yesx-forwarded-for,
ip
It is formed based on request headers and the Mocean “ip” parameter that are separated by comma. x-forwarded-for=123.221.2.122,123.221.2.100

Jiwire GeoProbe

Logo


Base URL

http://geotag.jiwire.com/

Request Parameters
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
netid Your JiWire partner id Yes JIWIRE_NETID (specified in GUI) netid=99
lid The zone name Yes JIWIRE_LID (specified in GUI) lid=banner
fmt Ad banner format. Yes size_x x size_y Standard Mocean ad request parameters “size_x” and “size_y” are used to determine the size of a Banner ad to be returned.

NOTE: If no “size_x” and “size_y” passed in, the size of the ad returned will be 320 x 50.

fmt=320x50
lat Yes lat Standard Mocean ad request API parameter.

NOTE: If no “lat” parameter passed, user geolocation latitude will be detected automatically.

lat=37.65056
lon Yes long Standard Mocean ad request API parameter.

NOTE: If no “long” parameter passed, user geolocation longitude will be detected automatically.

lon=-119.03639
mpxy Mobile Proxy. Proxy content to the Ad server for the mobile device. Required. Must be 1 Yes 1 Default value is used. mpxy=1
resp Response mime type. Default is html. Yes html Default value is used. resp=html
udid Unique Device Identifier for the client Yes udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

udid=a21feb9840252eeacd9a7
mapiver Version of the API. Default 1 Yes 1 Default value is used. mapiver=1
hl Hyperlocal Targeting. Default 0 = disabled. If you are caching ad content you must leave this feature disabled. Yes 1 Default value is used. hl=1
bt Behavioral Targeting. Default 0 = disabled. If you are caching ad content you must leave this feature disabled. Yes 1 Default value is used. bt=1
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
user-agent Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

x-forwarded-for Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

Jumptap *

Logo


Base URL

http://a.jumptap.com/a/ads?

Request Parameters
Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
pub Publisher alias as assigned by Jumptap. Yes JUMPTAP_PUBLISHER Yes (specified in GUI) pub=mja
spot An ad spot alias assigned by Jumptap Yes JUMPTAP_AD_SPOT Yes (specified in GUI) spot=mja_test_all_top
site A site alias assigned by Jumptap Yes JUMPTAP_SITE Yes (specified in GUI) site=mja_mobile_pro__mob_web
ua The user-agent of the handset making the request Yes ua Yes Standard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected from request headers ua=Mozilla%2F5.0%20(X11%3B%20Linux
%20i686)%20AppleWebKit%2F535.2%20
(KHTML%2C%20like%20Gecko)%20Ubuntu
%2F10.04%20Chromium%2F15.0.874.106%20
Chrome%2F15.0.874.106%20Safari%2F535.2
v Version of the Jumptap tapLink API. Currently 'v30' (Version 3.0) Yes “v30” Yes Default value is used v=v30
l The user’s preferred language. Valid values are the ISO-639-1 2 letter language codes Yes en Yes Default value is used l=en
mt-mraid mt-mraid=1 to request an MRAID version 1 compliant ad
mt-mraid=2 to request an MRAID version 2 compliant ad
mt-mraid=0 if you do NOT want an MRAID ad
This parameter is required in order to receive MRAID rich media
Yes MT_MRAID No (specified in GUI)
If not specified in GUI, default value (“0”) is sent.
v=0
client-ip The IP Address of the device requesting the ad. No ip No Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.
client-ip=4.56.132.21
hid
hid_sha1
idfa
The unique device hardware ID. *Required for applications, not mobile web sites. Yes* udid, idfa, androidid No Standard Mocean ad request API parameters are used. If “udid” is specified in the request, “hid” will be set to the “udid” value. If “udid” is not specified, system will try to get “idfa” parameter and send its value as “idfa”. If neither “udid” nor “idfa” is specified, "androidid" will be tried to send as “hid_sha1”. Otherwise, the “u” parameter will be sent instead. hid=1bef50453858d317a8471087aaf1614a
idflag Corresponds to the advertisingTrackingEnabled parameter available in iOS 6 (or higher); indicates whether the user has limited ad tracking.
*Required when the device ID parameter idfa is used.
Yes* idte No Standard Mocean ad request API parameter. For “idte=1” “idflag” will be set to “y”. “idte=0” will correspond to “idflag=n”.
NOTE: “idflag” will be sent only if “idfa” parameter is sent
idflag=y
u The publishers unique id of the end-user. Used if the publisher has a unique way of identifying the user, such as a login No ip, ua No A unique user ID will be generated automatically as a hash of ip and ua u=002ebf12a1255ddfa73967c3c5d20177
url The URL of the page requesting the ad.
*Required for requests from mobile web sites, but not for requests from applications
Yes* url No Standard Mocean ad request API parameter url=http%3A%2F%2Fwww. website.com
a Indicates whether adult ads are allowed to be returned in response to the ad request No over_18 No Standard Mocean ad request API parameter is used. If “over_18=0” OR “over_18=1”, “a” will be set to “notallowed”. For other cases “a=allowed”.
NOTE: This value can be changed based on site/app settings the ad is requested for.
a=allowed
ll Comma-separated Latitude and Longitude. Latitude/Longitude is preferred to and supersedes the postal code and country parameters. No lat, long No Standard Mocean ad request API parameters “lat” and “long” (comma-separated).

NOTE: If "lat" and "long" parameters are not passed, the "ll" parameter will not be sent. System will send "country" parameter instead.

ll=37.771008,-122.41175
country The two letter ISO country code of the originating user’s request.
*Country should be passed only if the country of the user originating the ad request is definitively known; it should not be set for a static value for all of your requests. The country parameter is required if the postal code (pc) parameter is passed.
No* ip or mcc (if passed) or country (if passed) No At first, a country is determined by IP address of the request.
Then, if “mcc” parameter is passed in, it overrides country determined by “ip”.

Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.

country=US
pc Postal code. If you are passing latitude/longitude, then the “pc” parameter should not be passed. No zip No Standard Mocean ad request API parameter. pc=02141
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
user-agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
user-agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
x-forwarded-for A series of IPs associated with the ad request. Yesx-forwarded-for,
ip
It is formed based on request headers and the Mocean “ip” parameter that are separated by comma. x-forwarded-for=123.221.2.122,123.221.2.100
{*} HTTP headers sent by the user's device. Yes (request headers received) HTTP headers. NOTE: The following headers are not passed:
"x-forwarded-proto",
"x-images-host",
"host",
"keep-alive",
"connection",
"cookie",
"cache-control",
"content-length",
"content-type"
accept-encoding=gzip, deflate
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age mt-age
gendermt_gender

LeadBolt *

Logo


Base URL

http://api.leadbolt.net/api/ad_feed

Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
section_id Identifies an ad feed. Yes LEADBOLT_SECTION_ID Yes (specified in GUI)section_id=958235281
secret_key Identifies a feed user. Yes LEADBOLT_SECRET_KEYYes (specified in GUI) secret_key=003b9f48533a8d71
client_ipThe IP address of the user. Used for geo targeting. Yes ip YesStandard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

client_ip=17.148.221.102
user_agent The User Agent string of the user’s browser. Yes ua Yes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

user_agent=Mozilla%2F5.0+%28BlackBerry%3B
+U%3B+BlackBerry+9800%3Ben-US%29+AppleWebKit
%2F534.1%2B%28KHTML%2C+like +Gecko%29+Version%2F6.0.0.246
+Mobile+Safari%2F534.1%2B
width Identifies the ad size.
Supported sizes depend on the "ad_type" parameter:
  • For Text: 320x50, 468x60;
  • For Image and Html: 120x120, 300x250, 320x50, 320x480, 320x568, 468x60, 480x320, 568x320, 728x90, 768x1024, 1024x768.
Yes size_x YesStandard Mocean ad request API parameter. The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings
  4. WURFL (on the basis of max available width and height for the given device)

The largest supported size within the requested size is returned.

width=120
height Identifies the ad size.
Supported sizes depend on the "ad_type" parameter:
  • For Text: 320x50, 468x60;
  • For Image and Html: 120x120, 300x250, 320x50, 320x480, 320x568, 468x60, 480x320, 568x320, 728x90, 768x1024, 1024x768.
Yes size_y YesStandard Mocean ad request API parameter.

The priority of selecting size values to be sent to 3rd Party Partner will be the following:

  1. Creative sizes
  2. Request parameters
  3. Zone settings
  4. WURFL (on the basis of max available width and height for the given device)

The largest supported size within the requested size is returned.

height=300
dev_id The device ID of the user’s mobile device where applicable. Yes* (for Android)androididYes Standard Mocean ad request API parameter.
* NOTE: One of "dev_id" or "devad_id" is required.
dev_id=9774d56d682e549c
devad_id The Advertising ID (AID/IDFA) of the user’s mobile device where applicable. Yes* (for Androif or iOS)androidaid, idfaYes Standard Mocean ad request API parameter.
* NOTE: One of "dev_id" or "devad_id" is required.
devad_id=eccfe51b-440f-125a-8e2e-10a79a95bba2
scr_w The width of client screen. No (by wurfl) NoDetermined automatically by WURFL on the basis of max available width for the given device. scr_w=600
src_h The height of client screen. No (by wurfl) NoDetermined automatically by WURFL on the basis of max available height for the given device.src_h=600
ad_type Specifies the ad types to receive. Available types are "Text”, “Image” or “Html”. No type NoStandard Mocean ad request API parameter.
NOTE: Several comma separated types may be requested.
ad_type=Text,Image
category Specifies a list of category IDs accepted. This is a comma separated string of category IDs. No LEADBOLT_CATEGORY No (specified in GUI) category=4,5,6,24,37
pf Identifies the platform of the user’s mobile device.

Valid values:

  • 1 – Apple iOs
  • 2 – Android
  • 3 – Symbian OS
  • 4 – BlackBerry
  • 5 – Windows Phone
  • 6 – Windows 8 Tablet
Yes* (for mobile devices) (by wurfl) No Determined by WURFL on the basis of user agent pf=4
demo_age The user’s age range. Valid values:
  • 13-17
  • 18-25
  • 26-35
  • 36-45
  • 46+
No age No Standard Mocean ad request API parameter. demo_age=26-35
format** Specifies the response format. Yes xhtml Yes Default value is used. format=xhtml
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
gender demo_gender
m Male
f Female
language lang
English en_us
French fr_fr
Spanish es_es
Portuguese pt_pt
Italian it_it
Russian ru
German de_de
Greek el
Vietnamese vi
Chinese Traditional zh_tw
Chinese Simplified zh_cn
Czech cs
Araic ar
Polish pl
Dutch nl
Lithuanian lt
Turkish tr
Serbian sr
Romanian ro
Chinese zh
Filipino tl
Belarusian be
Croatian hr
Hungarian hu
Danish da
Ukranian uk
Parisian French fr
Albanian sq
Bulgarian bg
Zulu zu
country demo_country
region demo_region
zip demo_zip
carrier ph_car

Liquid Wireless

Logo


Base URL

http://ads.liquidwireless.com/r.php

Request Parameters
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
u Full user agent of the mobile device viewing the page Yes (from the header received) user=Mozilla%2F5.0+%28BlackBerry%3B+U%3B+BlackBerry+9800%3B en-US%29 AppleWebKit%2F534.1%2B+%28KHT ML%2C+like +Gecko%29+Version%2F6.0.0.246+Mobile+Safari%2F534.1%2B
i IP address of the mobile device Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

i=122.166.7.84
s Unique id assigned by Liquid Wireless to identify the site making the ad request Yes LIQUID_WIRELESS_SITE_ID (specified in GUI) s=mocean
p URL or identifier for placement within the site Yes LIQUID_WIRELESS_PLACEMENT (specified in GUI) p=test_m
zip 5 digit zip code of the user No zip Standard Mocean ad request API parameter. zip=44556

Local Sensor *

Logo


Base URL

http://ads.locsensads.com/ad/


Request Parameters
Ad Feed API Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
tagidUnique id for the zone in Localsensor and its linked campaign(s).YesLOCALSENSOR_TAGIDYes(specified in UI)tagid=ZO2420059e84aa11e2ae29123142ffe976
udid An identifier for an user or device. Needed for rate limiting. YesudidYesStandard Mocean ad request API parameter.
NOTE: If no 'udid' parameter passed, unique user ID will be generated automatically as a hash of ip and ua.
udid=37c5604616ae0ac7433ccd41fa5ce1eeb8c1872d
awidthBase ad width (what it would be with pixelratio 1).Yessize_xYesStandard Mocean ad request API parameter.
NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined by zone default ad sizes (if set) or by device.
awidth=300
aheightBase ad height (what it would be with pixelratio 1).Yessize_yYesStandard Mocean ad request API parameter.
NOTE: If no “size_y” parameter passed in, the height of the ad returned will be determined by zone default ad sizes (if set) or by device.
aheight=50
ipThe ip of the user. Used for additional geolocation resolution. YesipYesStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.
ip=4.28.132.218
uaThe useragent of the request. Used for device detection. YesuaYesStandard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
ua=Mozilla%2F5.0+%28Windows+NT+6.1%3B+WOW64
%3B+rv%3A6.0.2%29+Gecko%2F20100101+Firefox%2F6.0.2
ex_servThe identifier of the calling adserver. Yes“MOSS”YesDefault value is used.ex_serv=MOSS
ex_servingidThe Mocean id of the serving.Yes sid YesMocean Show ID is used (32 hexadecimal digits separated by hyphens in the form 8-4-4-4-12) ex_servingid=76681950-4e2f-11e3-a05e-005056967c35
ex_domainidDomain id of publisher. Yes YesID of the app/site associated with the requested zone. ex_domainid=1234
dbrandDevice brand Yes Yes The corresponding phone brand name from WURFL obtained on the base of user agent. dbrand=Mozilla
dmodelDevice model Yes YesThe corresponding phone model name from WURFL obtained on the base of user agent. dmodel=Firefox
latThe latitude of the user YeslatYesStandard Mocean ad request API parameter.
NOTE: If no “lat” parameter passed, user geolocation latitude will be detected by ip.
loc_latitude=40.6501
lonThe longitude of the user YeslongYesStandard Mocean ad request API parameter.
NOTE: If no “long” parameter passed, user geolocation longitude will be detected by ip.
loc_longitude=-73.9496
cisoIso code of the users country.Yesip or mcc (if passed) or country (if passed)Yes At first, a country is determined by IP address of the request.
Then, if “mcc” parameter is passed in, it overrides country determined by “ip”.
Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.
ciso=US
outformatThe outputformat of the ad Yes“M”Yes Default value is used. outformat=M
cbCachebuster Yes YesRandomly generated value of 15 digits. cb=971692174452811

NOTE: For this feed the parameters for translation can be set via the Ad Feed configuration settings in UI.

LookSmart

Logo


Base URL

http://val.looksmart.com/r_search

Request Parameters
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
ua The URL-encoded user agent of the user making the incoming HTTP request. Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=Mozilla%2F4.0+%28compatible%3B+MSIE+6.0%3B+Windows+NT+5.1%29
ip The IP address of the user making the incoming HTTP request. Used for geo-targeting and fraud filtering. It is important to include in your query the IP address of the end user that will view the ads you receive. Clicks received from unknown IP addresses may be filtered. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=122.166.7.84
isp The partner syndicate code. It uniquely identifies a configuration of a feed for delivery to a partner. The partner syndicate code grants access to the partner-specific configuration features. Both the name and the parameter value are case-sensitive and the value must be a valid syndicate code. Yes LOOKSMART_PARTNER_CODE (specified in GUI) isp=mo_mob
subid A parameter that allows the partner to uniquely identify the source of traffic on their network. Valid subids have a maximum length of 64 characters and contain only letters, numbers, and "_". No udid Standard Mocean ad request API parameter.
NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

NOTE: If subid consists of more than 64 characters, the 1st 64 ones will be sent.

subid=1a2b3c
key The URL-encoded search phrase. Yes LOOKSMART_KEY & keywords key is formed by splicing the standard Mocean ad request API parameter (keywords) and the parameter specified in GUI (LOOKSMART_KEY) separating them by comma. key=news,gaming%20online
rf The URL of the site making the request. It is especially important that this field be URL-encoded prior to submission to the Ad Server. Yes url Standard Mocean ad request API parameter.

NOTE: If no “url” parameter passed, the default value ('unknown') is used.

rf=http%3A%2F%2Fwww.referrer.com
Result Set Elements
Element Description Req? Comments
title The title of the listing. Yes
abstract A short description of the listing. Yes
url The click-through URL for the listing. Yes
displayUrl A version of the destination site's URL that can be displayed to the user.
NOTE: This field must not be used for click-through and is not guaranteed to resolve to a true URL.
Yes
cpc The bid price associated with a sponsored search listing. No If cpc returned with the ad is more or equal to LOOKSMART_MIN_CPC (specified in GUI), then the ad will be shown. Otherwise, the empty response will be returned.
encoding The text encoding for this listing. If this is not specified, UTF-8 is assumed to be the default. No
lang The language and locale (based on the ISO 639 Standard). The format is a 2-character, lowercase language identifier, followed by a hyphen, followed by a 2-letter, uppercase locale identifier. No

MADGIC *

Logo


Base URL

http://s<MADGIC_SITE_ID>.ads.madgic.com/getAds?v=2.0-java

Base URL parts and scopes
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
publisherID Publisher IDYesMADGIC_PUBLISHER_IDYes(specified in GUI)publisherID=13020200
siteIDSite ID YesMADGIC_SITE_ID Yes(specified in UI) siteID=250411
h_Remote-Addr IP addressYes (h_Remote-Addr or ip)ipYesStandard Mocean API parameter.NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.ip=77.102.4.122
h_User-Agent User agent of the device Yes (h_User-Agent or ua)uaYesStandard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected from request headers. ua=Mozilla/5.0%20%28compatible;%20MSIE%2010.0;
%20Windows%20Phone%208.0;%20Trident/6.0;%20
IEMobile/10.0;%20ARM;%20Touch;%20NOKIA;%20
Lumia%20920%29
contentThis parameter describes the content of your page. When you want to display advertising on a page with sensitive content, you must include this parameter in your ad request. Some advertisers and some ad networks don't want their ads displayed on pages with adult content or with content related to gambling, dating, politics or religion. Using this parameter will avoid your site from being banned by them. And it will display ads from advertisers and ad networks that are interested in your traffic and willing to pay for it. Default value is 'Content'. NoMADGIC_CONTENTNoSpecified in UI. If not specified, the default value, “Content”, is sent.content=Content
categoriesBy default MADGIC will not display any adult ads on your site or any sensitive ads. But if you don’t mind, allowing MADGIC to display ads from these sensitive categories can increase your advertising revenue since MADGIC will have a larger choice of ads to choose from. Use “categories=all” if you want to maximize your advertising revenue. Ads not corresponding to sensitive categories are always displayed with no need to ask for it. NoMADGIC_CATEGORIESNo(specified in UI)categories=Gambling
formatUsing this parameter will allow you to request ads of a specific format, such as text links or banner ads. By default, if you donʼt use this parameter, MADGIC will select the most profitable ads regardless of their format. The best way to optimize your advertising revenue is to let MADGIC do this. But you might want to display less intrusive ads in some places, for example only text links on top of pages. Values supported for this parameter are: “text” and “banner” (banner ads will sometimes also include a text link). NotypeNoStandard Mocean API parameter.
NOTE: If “type” contains both 1 and 2, “format” is set to “text,banner”. Otherwise, if “type” contains “1”, “format” is set to “text”, if “type” contains “2”, “format=banner”.
format=text,banner
testMADGIC provides a test mode that you can use when you are integrating the MADGIC API. When using test mode MADGIC will always return the same “MADGIC test” banner or MADGIC test link. NotestNoStandard Mocean API parameter.test=yes
userIDUsing this optional parameter can increase your revenues by allowing MADGIC to display ads selected for a specific user. For example, MADGIC will avoid displaying an ad that this user has already clicked recently because the probability of a click would be lower but most of all because several ad networks will consider this click as a “repeat click” and pay nothing for it. NoudidNoStandard Mocean API parameter.userID=25f9e794323b453885f5181f1b624d0b
h_{*}End-user headers. No(request headers received)No HTTP headers.
NOTE: The following headers are not passed:
"remote-addr"(processed manually), "x-forwarded-for", "x-forwarded-proto", "x-real-ip", "true-client-ip", "x-images-host", "host", "keep-alive", "connection", "cookie", "content-type", "content-length", "user-agent", "path", "windir", "document_root", "systemroot", "server_signature", "script_filename", "comspec", "server_software", "remote_port", "pathext", "server_name", "gateway_interface", "request_method", "script_name", "script_uri", "query_string", "script_url", "server_port", "request_uri", "php_self", "http_cache_control", "http_cookie", "http_pragma", "argc", "argv", "cache-control", "cookie pragma"
h_Accept-Encoding=gzip


Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
Content-Type Content type Yes “application/x-www-form-urlencoded” Default value is used. Content-Type=application/x-www-form-urlencoded
Connection Connection type Yes“Keep-Alive”Default value is used. Connection=Keep-Alive


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gendergender
m M
f F
keywords keywords
lat latitude
long longitude


MadHouse *

Logo



Base URL

http://api.appsrv3.madserving.com/base/<adspaceid>

Base URL parts and scopes
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
adspaceidAdvertising space identification is the exclusive location identification of the SmartMad advertising placement system. In the case of request for more than one advertising space codes, advertising space identifications (no more than 10 in number) shall be separated by “,”.YesMADHOUSE_ADSPACE_IDNo(specified in GUI)adspaceid=90000001,90000002,90000003,90000004
adtypeType of ads. Possible values are: 1 -Text link; 2 - Banner; 3 - Text link or banner; 4 - Full-screenYestype YesStandard Mocean ad request API parameter. Values 1, 2, 3 only can be sent. adtype=1
uidUser’s exclusive identification, UDID sent to the terminal as requested by iOS; IMEI sent to the terminal as requested by Android and other operating systemsYesudidNoStandard Mocean API parameter. NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.uid=-cf533c20e686e7c612b8cc3dd9ac30429d96970
uaUser browser identification, if browser UA is unavailable, it shall be sent in the format defined in the appendix 5.1UAYesuaNoStandard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. ua=Mozilla/5.0%20%28compatible;%20MSIE%2010.0;
%20Windows%20Phone%208.0;%20Trident/6.0;%20
IEMobile/10.0;%20ARM;%20Touch;%20NOKIA;%20
Lumia%20920%29
osType of operating system. 0 - Android; 1 - iOS; 2 - Windows Mobile; 3 - Windows Phone; 4 - J2ME; 5 - Symbian.YesuaYesDetected automatically on the basis of device user agent from “ua” parameter received.os=0
osvVersion of operating system. Possible values: 1.6 - Android-1.6; 3.2 - iOS-3.2; 7.5 - Windows Phone-7.5; 5.2 - Symbian^3 Anna(S60 5.2)/ NOTE: Symbian only transmits S60 version number. If the parameter is left blank, it may cause failure in placement of oriented ads.Nodetermined automaticallyNoDetermined automatically on the basis of the "device_os_version" parameter for the device. osv=1.6
ipUser source IP, e.g. 211.136.28.18 YesipNoStandard Mocean API parameter.NOTE: If no “ip” parameter passed, client IP address will be detected automatically.ip=77.102.4.122
format**Downlink message format. Values: T - Advertising message in the format of TEXT; X - Advertising message in the format of XML; H - Advertising message format in the of HTML.YeshNoDefault value is used.format=h
widthCell phone screen width, cell phone application sends the correct screen width, to realize compatible display of advertising pictures.Yessize_xNoStandard Mocean API parameter. NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined by zone default ad sizes (if set) or automatically on the basis of max available width for the given device.width=320
heightCell phone screen height, cell phone application sends the correct screen height, to realize compatible display of advertising pictures.Yessize_yNoStandard Mocean ad request API parameter. NOTE: If no “size_y” parameter passed in, the height of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available height for the given device.height=50
debugDebug mode. Values: 1 - Debug mode; 0 - Non-debug mode (default value).No0NoDefault value is used.debug=0
tsUNIX time.Yes (date and time)No ts=1348723179
signSignature.Yes NoThe parameter is detected as md5 of secretKey value + uid value + /n + ts value + /n + urlPrefix value.
secretKey (specified in UI) - MADHOUSE_SECRET_KEY
urlPrefix is determined as /base/+ adspaceid value. NOTE: In case the values are redefined via translation layer, the 'sign' should be also redefined as it will not be redetermined automatically after translation.
sign=85ba3a848c91669bd19a9b3f17e1100a
deviceDensity Nodetermined automaticallyNoDetermined automatically on the basis of the "density_class" parameter for the device.
latLatitude of the cell phone location. NolatNoStandard Mocean API parameter. lat=43.716589
lon Longitude of the cell phone location.NolongNoStandard Mocean API parameter. lon=-79.340686

NOTE: For this feed the parameters for translation can be set via the Ad Feed configuration settings in UI.

MdotM

Logo


Base URL

http://ads.mdotm.com/ads/feed.php

Request Prameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
apikey Identifying you as a source of traffic Yes MDOTM_API_KEY (specified in GUI)apikey=f41f6716c892492babc2acc3a76c7b90
appkey Identifying the application source (32 characters). Generally, we recommend that you md5(concat("mdotm", yourappid)) to form this string, if possible. Yes MDOTM_APP_KEY (specified in GUI) appkey=7c44753f736db2771c25b730df8c8fcf
deviceid Identifies the user. This is critical to Cost-Per-Install campaigns. Yes udid, androidid, imei, odin1, openudid Standard Mocean ad request API parameter.

NOTE: The value is determined using 'androidid', 'imei', 'odin1', 'openudid' parameters.

deviceid=6ffc0b0cd9022ff59f023fc2766b33b81109291c
ua User agent, which is parsed by MdotM servers so that ads can be targeted to platform, OS, and device. Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+ Configuration%2FCLDC-1.1+VendorID%2F100
clientip Client device IP. Enables geotargeting. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

clientip=17.148.221.102
email Client's e-mail. Yes MDOTM_EMAIL (specified in GUI) email=you@appco.com
password Client's password Yes MDOTM_PASSWORD (specified in GUI) password=p@ssWord
partnerkey MdotM Partner Identifier Yes MDOTM_PARTNER_KEY (specified in GUI) partnerkey=xyz123
width Identifies the ad width size. Yes MDOTM_WIDTH or size_x Specified in GUI.
NOTE: If no parameter is specified in GUI, standard Mocean ad request parameter “size_x” will be used.
NOTE: If no “size_x” passed in, the width of the ad returned will be determined automatically (on the basis of device user agent) as max available width for the given device).
width=320
hight Identifies the ad hight size. Yes MDOTM_HEIGHT or size_y Specified in GUI.
NOTE: If no parameter is specified in GUI, standard Mocean ad request parameter “size_y” will be used.
NOTE: If no “size_y” passed in, the hight of the ad returned will be determined automatically (on the basis of device user agent) as max available hight for the given device).
hight=50
fmt Format No xhtml Default value is used. fmt=xhtml
secretkey Secret key, used to ensure that requests from you only are responded to. No MDOTM_SECRET_KEY (specified in GUI) secretkey=c2902e41dbd6a71e43c7eee4add18f8b
type A type of deviceid value. Yes udid, androidid, imei, odin1, openudid The constant value is determined from the parameter that is used to define deviceid. type=udid

mGage

Logo


Base URL

http://mojiva-mc.adinfuse.com/agent/getAd?

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
pid Velti mGage Ad Server publisher identifier. Yes MGAGE_PARTNER_ID (specified in GUI) pid=mojiva
cid Content Identifier. Yes MGAGE_SPOT_ID (specified in GUI) cid=1234
ai-output The response format. No html Default value is used. ai-output=html
test Enable test mode (will return sample advertisements for the purpose of testing). No 1 Default value is used. test=1
uid User ID. No udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

uid=40bd3ab4c4d9525d9f75662fe90e39624261c60a
rip Request IP address. No ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

rip=122.166.7.84
ua User agent. No ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=MOT-V3r%2F08.BD.43R%20 MIB%2F2.2.1%20 Profile%2F

MIDP-2.0%20Configuration%2FCLDC-1.1

co 2 letter country code (US, GB, etc). No MGAGE_COUNTRY (specified in GUI) co=us
ln 2 letter language (en, fr, etc) No MGAGE_LANGUAGE (specified in GUI) ln=en
sex User gender (M – male of F – female). No MGAGE_GENDER (specified in GUI) sex=f
age Age or standard range (20 or 18-24). No MGAGE_AGE (specified in GUI) age=16

Millennial *

Logo



Base URL

http://mydas.millennialmedia.com/getAd.php5

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
apid A unique identifier provided by Millennial Media. Yes MILLENIAL_PARTNER_ID (specified in GUI) apid=78y870b
auid The value that is used to uniquely identify a user when requesting an ad. Yes udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

auid=77de94288bebf633d30c9f692ce0bfe83afa7d12
uip Public IP address of the device that is requesting the ad unit. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

uip=122.166.7.84
ua UA string of the device browser. Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=MOT-V3r%2F08.BD.43R%20 MIB%2F2.2.1%20 Profile%2FMIDP-2.0%20Configuration%2FCLDC-1.1
hswd The width of the ad returned. No size_x Standard Mocean ad request API parameter.

NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available width for the given device.

hswd=320
hsht The height of the ad returned. No size_y Standard Mocean ad request API parameter.

NOTE: If no “size_y” parameter passed in, the height of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available height for the given device.

hsht=50
lat The latitude of the device. No lat Standard Mocean ad request API parameter.

NOTE: If no “lat” parameter passed, it will not be sent

lat=37.65056
long The longitude of the device.. No long Standard Mocean ad request API parameter.

NOTE: If no “long” parameter passed, it will not be sent.

long=-119.03639
zip Zip code. No zip Standard Mocean ad request API parameter. zip=38485
aw No awThe parameter is sent as it is specified in the request. aw=1
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gender gender
m male
f female
ethnicity ethnicity
black Black
white White
eastindian EastIndian
middleeastern MiddleEastern
asian Asian
latino Hispanic
pacificislander PacificIslander
nativeamerican NativeAmerican
mixed Mixed
other Other
language lang
English en
French fr
Spanish es
Portuguese pt
Italian it
Russian ru
German de
Greek el
Vietnamese vi
Chinese Traditional zh
Chinese Simplified zh
Czech cs
Araic ar
Polish pl
Dutch nl
Lithuanian lt
Turkish tr
Serbian sr
Romanian ro
Chinese zh
Filipino tl
Belarusian be
Croatian hr
Hungarian hu
Danish da
Ukranian uk
Parisian French fr
Albanian sq
Bulgarian bg
Zulu zu
lat lat
long long
zip zip

Mobfox *

Logo


Base URL

http://my.mobfox.com/request.php


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
s This parameter should be the unique Publisher ID of your mobile application or website. You can find your Publisher ID by navigating to Sites&Apps and clicking on the 'Setup' link next to your mobile app/website in your MobFox Account. Yes MOBFOX_S Yes (specified in UI)s=fe96717d9875b9da4339ea5367eff1ec
u Pass the url-encoded User Agent of the requesting device in this parameter. Yesua Yes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

ua=MOT-V3r%2F08.BD.43R%20 MIB%2F2.2.1%20 Profile%2FMIDP-2.0%20Configuration%2FCLDC-1.1
i IP Address of requesting device. Yes ip Yes Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
i=213.33.9.14
r_type This parameter should contain either “banner” or “video” indicating the requested ad type Yes type Yes Standard Mocean ad request API parameter is used.
If a text, image or rich media ad is requested, r_type will be set to “banner”; else if video ad is requested, it will be set to “video”.
r_type=banner
m If you would like to receive a test-banner, this parameter should be m=test, otherwise use m=live for real ads. Yes*test Yes * Required for banner ads only.
In case “r_type=banner”, the parameter is defined on the base of “test” Mocean parameter. It is not sent in case “r_type=video”
m=live
c_mraid Specify whether your mobile site / app is able to show MRAID ad responses. Possible values: 0 (is able), 1 (is not able) NoMOBFOX_C_MRAID No (specified in UI)
Sent only in case “r_type=banner”
c_mraid=1
adspace_width The Width of your Ad Space. This is also the maximum banner size that our servers will return. Nosize_x No The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings

Sent only in case “r_type=banner”.

adspace_width=320
adspace_height The Height of your Ad Space. This is also the maximum banner size that our servers will return. Nosize_y No The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings

Sent only in case “r_type=banner”.

adspace_hight=50
adspace_strict If this parameter is set to 1 and an adspace_height and adspace_width are provided, the MobFox ad server will only serve ads of these exact dimensions and will not serve any smaller-sized ads. No“0” No Default value is used.
NOTE: It is sent only if adspace_width and adspace_height are provided.
adspace_strict=0
r_resp This parameter should contain 'vast20' indicating a VAST 2.0 response is expected. Yes*“vast20” Yes * Required for video ads only.
Default value is used.
r_resp=vast20
o_andadvid Google Advertising ID. Yes*androidaid Yes Standard Mocean ad request API parameter.
* NOTE: At least one of o_andadvid, o_androidid, o_iosadvid parameters should be sent.
o_andadvid=719ece9e-5404-4883-a0ba-6e7ac689291e
o_androidid Android ID. Yes*androidid Yes Standard Mocean ad request API parameter.
* NOTE: At least one of o_andadvid, o_androidid, o_iosadvid parameters should be sent.
o_androidid=f3bceb686713bc3e436c979e429f6913
o_iosadvid iOS IFA (available in iOS 6.0+) Yes*idfa Yes Standard Mocean ad request API parameter.
* NOTE: At least one of o_andadvid, o_androidid, o_iosadvid parameters should be sent.
'o_iosadvid=AEBE52E7-03EE-455A-B3C4-E57283966239
p On mobile websites, this should be the URL of the page where the ad is being shown. You can leave this parameter blank for mobile apps. No url No Standard Mocean ad request API parameter.
NOTE: If not specified in the ad request, URL of the site associated with the requested zone will be used.
p=http://example.com
rt** Response type (“api”). Yes “api” Yes Default value is used.rt=api
v** Version of the API. Use 3.0 for this API. Yes “3.0” Yes Default value is used.v=3.0


Headers
Ad Feed URL Parameter Description Req? Comments Sending Value Example
h[{.*}] HTTP headers. Yes Headers received in the request are parsed and passed to Mobfox.
NOTE: Forbidden headers won't be sent.
h[accept-language] = ru-RU,ru;q=0.8,en-US;q=0.5,en;q=0.3


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age demo_age
gender demo_gender
url p
keywords demo_keywords
lat latitude
long longitude

MobGold

Logo


Base URL

http://ads.mobgold.com/request.php


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
ua User agent. Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=MOT-V3r%2F08.BD.43R%20 MIB%2F2.2.1%20 Profile%2FMIDP-2.0%20Configuration%2FCLDC-1.1
xwp HTTP_X_WAP_PROFILE value. Yes (from the header received)
pro HTTP_PROFILE value. Yes (from the header received)
xwc HTTP_X_WAP_CLIENTID value. Yes (from the header received)
ipr REMOTE_ADDR value. Yes (from the header received)
ipx HTTP_X_FORWARDED_FOR value. Yes (from the header received)
ipc HTTP_CLIENT_IP value. Yes (from the header received)
ref HTTP_REFERER value. Yes (from the header received)
hos HTTP_HOST value. Yes (from the header received)
uri REQUEST_URI value. Yes (from the header received)
acp HTTP_ACCEPT value. Yes (from the header received)
cha HTTP_ACCEPT_CHARSET value. Yes (from the header received)
lan Language of the Ad content. Possible values are: EN (English), ES (Spanish), ZZ (Chinese), FR (French), DE (German), IT (Italian), PT (Portuguese), RU (Russian), ID (Indonesian), JA (Japanese), AR (Arabic), TH (Thai), OT (Other) Yes isolang Mocean ad request API parameter. NOTE: If the parameter is not passed, it will be detected automatically from the request header (HTTP_ACCEPT_LANGUAGE). lan=EN
pt Protocol of your server (either http or https). Yes http Default value is used. pt=http
sm SiteID assigned during the creation of new site. Yes MOBGOLD_SITE_ID (specified in GUI) sm=57GH48488JJ33
ver Version of the install code used. Yes (empty) Empty value is passed. ver=
test Indicate testing or live mode. Allowable values:

1 – test mode 0 – live mode (default).

Yes 0 Default value is used. test=0
fmt Type of the ad return format. Allowable values:

xhtml – return ad in XHTML format (default); json – return ad in JSON format; xml – return ad in XML format.

No xhtml Default value is used. fmt=xhtml
type Type of the ad type. Allowable values:

0 – Both (default); 1 – Text Link; 2 – Banner Ad.

No type Standard Mocean ad request API parameter. type=1


Mobiclicks *

Logo



Base Live URL

http://ads.mobiclicksdirect.com/impag/ads


Base Test URL

http://test.mobiclicksdirect.com/impag/ads


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
ua Http user agent of the end user's device to the adserver. Yes ua YesStandard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
ua=SAMSUNG-SGH-A167
ip Ip address of the end user's device to the ad server. Yes ip YesStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, ip will be detected from request headers.
ip=196.11.239.0
site-id Site id of the requesting publisher’s site to the ad server. Yes MOBICLICKS_SITE_ID Yes (specified in UI) site-id=0122000b-3280-a701-487f-546d0b00000d
uid Unique user id of the requesting user who will see the ads. No udid No Standard Mocean ad request API parameter.
NOTE: If no “udid” sent, the device identifier configurable at the network level will be used. If no defined, unique user ID will be generated automatically as a hash of “ip” and “ua”.
uid=34f9e794323b453885f5181f1b624d0b
plat Site platform value. 2 is for mobile web sites and 3 is for mobile applications. No “2” or “3” No Defined on the base of the app/site platform associated with the requested zone. plat=2
fmt** The format of the ad response. No “xml” Yes Default value is used. fmt=xml
ver** The api version of the server to server integration. Yes “s2s_1” Yes Default value is used. ver=s2s_1
nads** The number of ads required from the ad server. No “1” Yes Default value is used. nads=1


Headers
Ad Feed Header Name Description Req? Source Mocean Parameter Comments Sending Value Example
HTTP headers. No (request headers received) HTTP headers.
NOTE: The following headers are not passed:
"accept",
"accept-encoding",
"x-forwarded-for",
"x-forwarded-proto",
"true-client-ip",
"x-images-host",
"host",
"keep-alive",
"connection",
"cookie",
"cache-control",
"content-type",
"content-length",
"user-agent",
"pragma"


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
lat lat
longlon


Mobile Commerce *

Logo



Base URL

http://ms-api.us.mcproton.com/search/<companyname>/banner/v1/Service.svc/html/


Base URL Parts and Scopes
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
companyname Name as it is set up by Mobile Commerce. Yes MOBILE_COMMERCE_PARTNER_NAME (specified in UI) companyname=mocean


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
gip Gateway address from which handset request originates. Yes ip YesStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, ip will be detected from request headers.
gip=170.206.246.18
ua Full user agent of handset Yes ua YesStandard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
ua=SAMSUNG-SGH-A167
region Two letter ISO Alpha-2 code country codes Yes ip
or mcc (if passed)
or country (if passed)
Yes At first, a country is determined by IP address of the request.
Then, if “mcc” parameter is passed in, it overrides country determined by “ip”.
Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.
region=US
uid A unique numeric value provided by Mobile Commerce that represents a unique site/app of yours.
* Either MOBILE_COMMERCE_UID or MOBILE_COMMERCE_SITEID must be specified!
Yes* MOBILE_COMMERCE_UID Yes (specified in GUI) uid=290001
siteid A unique reference you allocate to your sites/apps as assigned by Mobile Commerce.
* Either MOBILE_COMMERCE_UID or MOBILE_COMMERCE_SITEID must be specified!
Yes* MOBILE_COMMERCE_SITEID Yes (specified in GUI) siteid=MT290001
adsize Width and height of the ad to be shown separated by “x”.
Available values are: 320x50, 300x50.
No size_x, size_y NoStandard Mocean ad request API parameters (“size_x” and “size_y”) are used to determine appropriate value for ad sizes.
NOTE: If “size_x” and “size_y” parameters are not passed in, the width and the height of the ad returned will be determined by zone default ad sizes (if set) or by device.
NOTE: If the “adsize” parameter is defined via translation layer, it is sent as defined without modifications.
adsize=320x50


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
url referrer

Mocean-based Ad Feeds *

Base URL

http://ads.mocean.mobi/ad

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
zone Zone ID Yes MOCEAN_ZONE_ID Yes (specified in GUI) zone=12345
ip Ip address Yes ip No Standard Mocean ad request API parameter. ip=10.100.100.147
ua User agent Yes ua No Standard Mocean ad request API parameter. ua=BlackBerry8100%2F4.2.0+Profile %2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100
key** Output format (1 - HTML, 3 - XML, 5 - JSON, 6 - JSONP, 8 - Generic JSON, 9 - VAST) No “3” Yes Default value is used. key=3
count** Number of ads to return in response to a request. No “1” Yes Default value is used. count=1
type Type of ads to be returned (1 - text, 2 - image, 4 - richmedia ad, 8 - native ad, 16 - video ad). You can set different combinations of these values. For example, 3 = 1 + 2 (text + image), 7 = 1 + 2 + 4 (text + image + richmedia) and so on. Default value is 7, i.e., any text, image or rich media ad will be returned. No type Yes Standard Mocean ad request API parameter. type=2

NOTE: The ‘key’ and ‘count’ parameters can not be used for the translation in any way!

NOTE: When the ad request is coming from the Mocean-based ad network to Mocean, it is validated the ‘key’ parameter is in keeping with the ‘type’ parameter.

The following parameters are delivered as they are coming in. Note that the parameters are supported for both GET and POST request methods.

adstype udid target keywords over_18 border textborder
paramBG paramBORDER paramLINK lat long country region/iso_region
city area metro ZIP/zip carrier age birthday
gender education ethnicity household video_protocol size_required size_x
size_y min_size_x min_size_y macaddress odin1 secureudid openudid
androidid idfa screen_resolution pubmatic_exfeeds

The following parameters are only supported for the GET request.

native_content img_size_x img_size_y icon_size_x icon_size_y logo_size_x logo_size_y
description_length title_length cta_length

The parameter supported only for the POST request is native.

Mojiva *

Logo



Base URL

http://ads.mojiva.com/ad

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
zone Zone ID Yes MOJIVA_ZONE_ID Yes (specified in GUI) zone = 12345
ip Ip address Yes ip No Standard Mocean ad request API parameter. ip = 10.100.100.147
ua User agent Yes ua No Standard Mocean ad request API parameter. ua = BlackBerry8100%2F4.2.0+Profile %2FMIDP-2.0+Configuration%2FCLDC-1.1+VendorID%2F100

The following parameters are delivered as they are coming in.

adstype udid target keywords over_18 border textborder
paramBG paramBORDER paramLINK lat long country region
city area metro ZIP zip carrier age
gender birthday education size_x size_y min_size_x min_size_y
size_required ethnicity household mcc nxx type macaddress
odin1 secureudid openudid androidid idfa
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
ethnicity ethnicity
black 0
white 3
eastindian 4
middleeastern 4
asian 1
latino 2
pacificislander 4
nativeamerican 4
mixed 4
other 4
lat lat
long long
zip zip

NOTE: The ‘key’ parameter that defines the output format can not be used for the translation in any way!

Moolah *

Logo


Base URL

http://ads.160tracker.com/mobile_ad_api_indirect.php

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
sig Publisher signature (provided by Moolah Media) Yes MOOLAH_SIG No (specified in GUI) sig=be308ce55b9b750faf49e160153342e5
sid Site ID. Unique among all sites for the publisher account.
NOTE: Required for statistics importing.
Yes (when sig is not specified). MOOLAH_SID Yes (if sig is not passed) (specified in GUI) sid=345245
pid Publisher ID Yes (when sig is not specified) MOOLAH_PID Yes (if sig is not passed) (specified in GUI) pid=325465
site_name Name of the site. Yes (when sig is not specified) MOOLAH_SITE_NAME Yes (if sig is not passed) (specified in GUI)
cat Site category. Yes (when sig is not specified) MOOLAH_CAT Yes (if sig is not passed) (specified in GUI) cat=IAB1
type “app” or “web” (mobile web or mobile app client) Yes MOOLAH_TYPE Yes (specified in GUI) type=web
user_id a unique user identifier for the publisher (upto 32 characters) No udid No Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

user_id = -787c01bc349464c89523846288aa146
request_from Always 'indirect'. It's a constant. Yes indirect No Default value is used. request_from=inderect
user_agent user agent (use “android”, “iphone”, “blackberry” if not available) Yes uaNo Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

user_agent=Mozilla%2F5.0+%28BlackBerry%3B+U%3B+BlackBerry+9800%3B en-US%29+AppleWebKit%2F534.1%2B%28KHTML%2C+like +Gecko%29+Version%2F6.0.0.246+Mobile+Safari%2F534.1%2B
user_ip IP address of the client Yes ip No Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

user_ip=122.166.7.84
response_format** “html" or "json" or "xml" (desired response format). Yes html No Default value is used. response_format=html
zip 5-digit zipcode of the user. No zip NoStandard Mocean ad request API parameter. zip=38485
country User country (USA, UK etc.) No ip
or mcc (if passed)
or country (if passed)
No At first, a country is determined by IP address of the request.

Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.

country = RUS
state State or province of the user. No ip or region (if passed) No At first, a country is determined by IP address of the request. Then, if “region” parameter is passed in, it overrides the value determined automatically. state=NY
lat Latitude of the user’s location No lat No Standard Mocean ad request API parameter.

NOTE: If no “lat” parameter passed, it will not be sent.

lat=37.65056
long Longitude of the user’s location No long No Standard Mocean ad request API parameter.

NOTE: If no “long” parameter passed, it will not be sent.

long=-71.0601
w Inventory width (banner width) No size_x No Standard Mocean ad request API parameter.

NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available width for the given device.

w=800
h Inventor hight (banner hight) No size_y No Standard Mocean ad request API parameter.

NOTE: If no “size_y” parameter passed in, the height of the ad returned will be determined automatically by zone default ad sizes (if set) or on the basis of max available height for the given device.

h=600
bcatBlock ad categories No MOOLAH_BCAT No (specified in GUI) bcat=IAB1
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gender gender
m M
f F
zip zip

MoPub

Logo

NOTE: The ad feed has been disabled since 2016-01-26! All the existing MoPub integrations continue to work, but client can not create new or edit existing ones.


Base URL

http://ads.mopub.com/m/ad

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
idAd unit ID.YesMOPUB_UNIT_IDYes(specified in UI)
vVersion number (For the purposes of this type of integration.)Yes1YesDefault value is used.v = 1
ipIP Address.YesipYes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

ip = 204.28.127.10
tpThird party indicator. YesmoceanNo Default value is used.tp = mocean
mobile_webMobile web indicator (e.g. if your ad call is mobile web, set mobile_web=1)No1No Default value is used.mobile_web = 1
body_onlyReduces the payload to only be in the body field. (e.g. body_only=1)No1No Default value is used.body_only = 1
udidSHA-1 hashed identifier. Yesandroidid, secureudid, openudid, idfaYes Standard Mocean Parameters are used. If one of androidid, secureudid, or openudid is passed, SHA-1 uppercased hash of the identifier, and the prefix this hash with the string “sha:” are sent. If idfa is passed, it is sent with "ifa:" identifier together with "dnt" parameter. NOTE: If non of the above parameters is passed, the “udid” parameter will be generated automatically as a hash of ip and ua and sent with the "mocean:" prefix. udid = ifa:68753A44-4D6F-1226-9C60-0050E4C00067
dntThe 'Do Not Track' indicator. dnt = 0 is default. dnt = 1 means the user has opted to not be tracked. No idte NoDetermined on the base of the "idte" Mocean parameter. If it is not passed, the default value is used. dnt = 1
lllat-long coordinatesNolat, longNo Standard Mocean Parameters delineated with comma are used.NOTE: If the parameter is not sent, it will not be passed.ll = 37.775,-122.418333
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
keywords q

Movoxx

Logo



Base URL

http://apilbr.movoxx.com/ad?

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
pid Movoxx partner ID. Yes MOVOXX_PARTNER_ID (specified in GUI) pid=325465
sid Site ID Yes MOVOXX_SID (specified in GUI) sid=345245
uid User device ID. Yes udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

uid=-3a7c5cd54197d934af6fc418166b8e7a0b1596a0
cs Yes 160 Default value is used. cs=160
gen User gender. No MOVOXX_GEN (specified in GUI) gen=f
age User age. No MOVOXX_AGE (specified in GUI) age=25
hhi No MOVOXX_HHI (specified in GUI) hhi=
zip 5-digit zipcode of the user. No MOVOXX_ZIP (specified in GUI) zip=38485
mfr User device manufacturer (brand). No ua Detected automatically on the basis of device user agent. mfr=generic+web+browser&
mdl User device model. No ua Detected automatically on the basis of device user agent. mdl=2.0
lat User geolocation latitude. No lat Standard Mocean ad request API parameter.

NOTE: If no “lat” parameter passed, user geolocation latitude will be detected automatically.

lat=37.65056
lon User geolocation longitude. No long Standard Mocean ad request API parameter.

NOTE: If no “long” parameter passed, user geolocation longitude will be detected automatically.

lon=-119.03639
cid Carrier. No carrier Standard Mocean ad request API parameter. cid=18762285

Nexage *

Logo


Base URL

http://<DOMAIN>/adServe


Default Base URL (If NEXAGE_DOMAIN is not specified in UI)

http://admax.nexage.com/adServe


Base URL parts and scopes:

URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
DOMAIN Nexage network domain.Yes NEXAGE_DOMAIN (specified in GUI)
If not specified default domain (admax.nexage.com) is used.
admax.nexage.com


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
dcn Distribution Channel Number (also known as site ID). Yes NEXAGE_DCN Yes (specified in GUI) dcn=e123456a78900987a6543aa212345678
pos Position value; header, body and footer as standard position values (case sensitive). Yes NEXAGE_POS Yes (specified in GUI) pos=body
ua User-agent header of the device into which the ad will be displayed. Must be URL encoded. Yes ua Yes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+ Configuration%2FCLDC-1.1+VendorID%2F100
ip Source IP address of the device displaying the ad. Yes ip Yes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

ip=17.148.221.102
req(url)Current page URL. Yes* (Required for Mobile Web)urlNoStandard Mocean ad request API parameter.
NOTE: If not passed, but a site domain is specified, the site domain will be used.
req(url)=test.com
p(sitename)Unique name of the siteYes No Site name and ID are sent.
u(id) Publisher-defined or anonymous user identifier. No udid No Standard Mocean ad request API parameter. Configurable at the network level, or "udid" parameter is used by default.
NOTE: If no parameter is specified in the request, unique user ID will be generated automatically.
NOTE: If udid value consists of more than 32 characters, it is re-hashed with MD5.
u(id)=208D24CA0DB4D2AD5BC70B539D8945E8
u(country) Customer’s country (in the standard 3-letter abbreviations). No ip

or mcc (if passed) or country (if passed)

No At first, a country is determined by IP address of the request.

Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.
NOTE: The determined country value is Alpha-3 converted.

country=USA
d(id2) Platform ID (e.g., iOS UDID, Android ID) hashed via SHA1. No (Strongly Recommended) androidid_sha1, android, wuid_sha1, wuid NoStandard Mocean ad request API parameter (SHA1-hashed).
d(id3) Platform ID. MAC Address hashed via SHA1. No (Strongly Recommended) macaddress_sha1, macaddress NoStandard Mocean ad request API parameter (SHA1-hashed)
d(id12) Platform ID (e.g., iOS UDID, Android ID) hashed via MD5. No (Strongly Recommended) androidid_md5, androidid, wuid_md5, wuid No Standard Mocean ad request API parameters (MD5-hashed).
d(id13) Platform ID. MAC Address hashed via MD5 No (Strongly Recommended) macaddress_md5, macaddress No Standard Mocean ad request API parameter (MD5-hashed).
d(id24) Platform ID. iOS Identifier for Advertisers in the clear (iOS 6+ only)No (Strongly Recommended) idfa No Standard Mocean ad request API parameter.
ifatrk “Do not track” flag for advertiser.
"1" for enabled, "0" for disabled. Corresponds to the advertisingTrackingEnabled property in iOS 6 (iOS 6+ only) and any future advertiser identifiers.
No (Strongly Recommended)idte No Corresponds to the standard Mocean ad request API parameters.
NOTE: “idte” and “ifatrk” have opposite values. idte=1 corresponds to ifatrk=0 and vice versa.
req(loc) Location related to the request. No (Strongly Recommended)lat, long No Standard Mocean ad request API parameters “lat” and “long” (comma-separated).

NOTE: If no “lat” and “long” parameters passed, “req(loc)” parameter will not be sent.

req(loc)=37.771008,-122.41175
cnPage category from the following list:

IAB1 Arts & Entertainment
IAB2 Automotive
IAB3 Business
IAB4 Careers
IAB5 Education
IAB6 Family & Parenting
IAB7 Health & Fitness
IAB8 Food & Drink
IAB9 Hobbies & Interests
IAB10 Home & Garden
IAB11 Law Government & Politics
IAB12 News
IAB13 Personal Finance
IAB14 Society
IAB15 Science
IAB16 Pets
IAB17 Sports
IAB18 Style & Fashion
IAB19 Technology & Computing
IAB20 Travel
IAB21 Real Estate
IAB22 Shopping
IAB23 Religion & Spirituality
IAB24 Uncategorized
IAB25 Non-Standard Content
IAB26 Illegal Content

NoNEXAGE_CN No(specified in GUI)cn=IAB26
mode Enables test mode for integration. "mode=test" indicates test mode. Default or other value=LIVE. No test No Based on the Standard Mocean request API parameter; is used only for unit tests. mode = live is used by default. mode=test
grp Impression Group Alpha-numeric (lower-case) ID that matches an existing configured Impression Group. No NEXAGE_GRP No(specified in UI)


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age u(age)
birthday u(dob)
yyyy-MM-dd yyyyMMdd
dma u(dma)
ethnicityu(eth)
black 0
white 3
eastindian 4
middleeastern 4
asian 1
latino 2
pacificislander 4
nativeamerican 4
mixed 4
other 4
gender u(gender)
m M
f F
keywords req(keywords)
zip u(zip)

Plus 1 Wapstart *

Logo



Base URL

http://ro.plus1.wapstart.ru

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
id Unique site identifier at Plus1 network. Unsigned integer. Yes WAPSTART_ID(specified in UI)id=8667
pageIdAd-cast unique identifier, row [0-9a-f] {40} (sha1 like). To show several different banners on one screen you should make requests with the same pageId.Yes The sha1 hash of zone ID and ip values will be used. pageId=7dfd21fd16c373cdcb5fac7601b081bbd53de410
area Yes viewBannerDefault value is used.area=viewBanner
version Yes 2Default value is used.version=2
ipip4 user’s address.YesipStandard Mocean ad request API parameter. NOTE: If no “ip” parameter passed, client IP address will be detected automatically.ip=50.74.197.106
markup**Type of markup (use only with controller viewBanner). 3 is for xhtml and 2 is for wml. 3 by default. No3Default value is used.markup=3
login udidStandard Mocean ad request API parameter. NOTE: If no 'udid' parameter passed, unique user ID will be generated automatically.login=65bf0f039ed11571d25f0689b1d257b69eefdbd6
geoData Geo-information string (e.g. city; state; country separated with “;”)Nocity, countryStandard Mocean ad request API parameters “city” and “country” (separated with semi-colon). NOTE: The value of city standard parameter consists of two parts separated with "; ". The first part will be sent as city value, the second is for state. geoData=NewYork;NY;US


Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
x-plus1-remote-addr YesipStandard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

x-plus1-remote-addr=4.28.132.218
x-plus1-user-agent YesuaStandard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. x-plus1-user-agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
x-plus1- Yes The content of a header must be preceded with x-plus1-. Headers containing accept-, host, referer, via, x- (except 'x-forwarded-proto' and 'x-images-host') are passed in.
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gender sex
m 1
f 2
country countryCode

PubMatic *

Logo


Base URL

http://showads.pubmatic.com/AdServer/AdServerServlet

Base URL for EMEA regions

http://permobads-ams.pubmatic.com/AdServer/AdServerServlet

Test URL

http://showads1065.pubmatic.com/AdServer/AdServerServlet

Test URL for EMEA regions

http://showads1065.pubmatic.com/AdServer/AdServerServlet

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
operId** Identifier (ID) of the operation. Possible values are:

“1” - For HTML response
“3” - For JavaScript response
“102” - For JSON response
“201” - JSON response for mobile ad serving

Yes 201 Yes Default value is used. operid=201
pubId Id of Publisher. This parameter is same as "pubId" in PubMatic AdTag. Yes PUBMATIC_PUBID Yes (specified in GUI) pubId=504
siteId One publisher can have multiple sites. "siteId" is site identifier for a Publisher. This value is picked up from "siteId" parameter in PubMatic AdTag. Yes PUBMATIC_SITEID Yes (specified in GUI) siteId=28848
adId A site can have multiple ad placements or positions which has same or different ad sizes. "adId" is unique identifier for such an ad placement. Yes PUBMATIC_ADID Yes (specified in GUI) adId=25111
kadwidth Dimension of AdSize. This is picked up from “kadwidth” parameter in PubMatic AdTag. Yes PUBMATIC_KADWIDTH Yes (specified in GUI)
NOTE: If the “kadwidth” parameter is passed in the request, it overrides the value of corresponding parameter set in UI.
kadwidth=320
kadheight Dimension of AdSize. This is picked up from “kadheight” parameter in PubMatic AdTag. Yes PUBMATIC_KADHEIGHT Yes (specified in GUI)
NOTE: If the “kadheight” parameter is passed in the request, it overrides the value of corresponding parameter set in UI.
kadheight=60
pageURL URL of the page on which the Ad is shown. Yes url *Yes Standard Mocean ad request API parameter.
*NOTE: If not specified in the ad request, URL of the app/site associated with the requested zone will be used. If there is no URL detected, empty value is sent.
pageURL=http://192.168.1.115/pub-test.html
kltstamp Time stamp (Format YYYY-MM-DD HH:MM:SS) when the ad request is made. Yes (current date and time) Yes Replaced with the current time, in seconds. kltstamp=2013-04-02%2017%3A28%3A5
ranreq Random number between (0 - 1). This is done to avoid URL caching from browser. Yes Yes A double value randomly generated from 0 to 1 ranreq=0.56
timezone Time zone of the User/Browser who is making an Ad Request. Yes “-05.00” Yes Default value is used. timezone=-05.00
screenResolution Screen Resolution in Format (WxH). Yes wurfl Yes Determined by WURFL (on the basis of max available width and height for the given device).
inIframe Weather the Ad is served in iFrame. Yes “0” Yes Default value is used. inIframe=0
adVisibility 0 – Visibility couldn’t be determined.

1 – Above the fold. 2 – Below the fold. 3 – Partially above the fold.

Yes “0” Yes Default value is used. advisibility=0
adPosition -1x-1 if the adPosition cannot be determined. In other cases, Left x Top of the ad container. Yes “-1x-1” Yes Default value is used. adPosition=-1x-1
udid A unique device identifier for the given udidtype.Yes* (for Mobile Applications) Raw, SHA1, MD5 of the following parameters:
idfa, idfv, androidid, openudid, secureudid, macaddress, odin1, androidaid, wuid, waid, adtruth, bkid, drawbridge, udid (raw)
No Standard Mocean ad request API parameters are used. Parameters are checked in the order to the left. At first, raw value of the parameter is checked, then SHA1-hash, and then MD5-hash. If one of mentioned parameters is specified in the request, its value will be used.
If no special device ID parameters passed, the device identifier configurable at the network level, or "udid" is used by default. If no defined, unique device ID will be generated automatically.
NOTE: If the "udid" parameter is changed via translation layer, please, make sure "udidType" and "udidhash" parameters are changed correspondingly.
udid=1A2B3C4D-00FF-00FF-00FF-1234567890AB
udidtype A unique device identifier for the given udidtype. Type of value provided in the udid parameter mentioned above. Possible values are:
0 - Other
1 - identifierForadvertiser (IDFA)
2 - identifierForvendor (IDFV)
3 - Android_ID
4 - UDID
5 - OpenUDID
6 - SecureUDID
7 - MAC Address
8 - ODIN–1
9 - Android Advertising ID
Yes* (for Mobile Applications) 0, 1, 2, 3, 5, 6, 7, 8 or 9 Yes* (if "udid" is sent) Defined on the base of Unique device ID being used. udidtype=3
udidhash Type of algorithm used for hashing the device identifier provided in the udid parameter mentioned above.
Possible values are:
1 - Raw
2 - SHA1
3 - MD5
Yes* (for Mobile Applications)1, 2 or 3 Yes* (if "udid" is sent) Defined on the base of Unique device ID being used. udidhash=2
dntDo not track. NoidteNo Corresponds to the standard Mocean ad request API parameters.
NOTE:"idte" and "dnt" have opposite values. idte=1 corresponds to dnt=0 and vice versa.
dnt=0
oid Original impression id used for tracking a unique pair of request-response. NooidNo Standard Mocean ad request API parameter. oid=3FBC7E41-11EA-40F5-A03C-532FF9272A3D
kadflooreCPM value which the PubMatic system uses as the bid price floor in the RTB auction. NoPUBMATIC_KADFLOORNo Specified in GUI.
The value should be specified in USD. If UI parameter PUBMATIC_KADFLOOR is not specified, min eCPM defined for the requested zone and converted from network currency to USD is used.
kadfloor=0.05
kbgColor Background Color of the page on which the Ad is shown (in RGB format). No paramBG No Standard Mocean ad request API parameter (without '#' sign). kbgColor=ffffff
klinkColor Link Color in (RGB format). This is used for displaying Text Ads. No paramLINK No Standard Mocean ad request API parameter (without '#' sign). klinkColor=0f0f0f
js Indicates whether the user's mobile device supports JavaScript or not. Possible values are:
• 0 - Device does not support JavaScript
• 1 - Device supports JavaScript
No 1 or 0 No Standard Mocean ad request API parameter, “type”, is used. If “type” contains “4”, “js” will be set to “1”. Otherwise, “0” will be sent. js=1
rs**Type of the JSON response to be expected if the operId parameter's value is set to either 102 or 201. Possible values are:
• 1 - Pure JSON response (Default value)
• 2 - JSON response padded with a callback JS function
• 3 - JSON repose padded with JS variable definition
No1Yes Default value is used. rs=1
locParameter for geolocation of the user.Nolat, longNo Standard Mocean ad request API parameters. NOTE: If no "lat" and "long" parameters passed, the "loc" parameter will be detected by IP.
NOTE: If the "loc" parameter is defined via translation layer, please, make sure the "loc_source" parameter is defined correspondingly.
loc=-999.99,-999.99
loc_sourceSource of user's mobile device's location as provided in the "loc" parameter mentioned above. This does not indicate the source for the user's geo-specific parameters such as country, state, city, and so on.< br/> Possible values are:
0 - Unknown
1 - GPS / Location Services
2 - IP Address
3 - User provided (for example, registration data)
Yes* (Required if "loc" is provided) “1”, “2” Yes* "1" is sent if lat/long were specified in the request;
"2" - if loc was detected by IP;
"3" - if lat/long were hardcoded in the Ad Feed UI.
NOTE: This parameter is required only if the "loc" parameter is provided.
loc_source=1
cityCity of the user. NocityNo Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated with ", ". The first part will be sent as city value.
city=New York
stateState of the user. NocityNo Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated with ", ". The second part will be sent as state value.
state=NY
expdir Comma-separated list of the expansion direction IDs. Possible values are:
1 - Left
2 - Right
3 - Up
4 - Down
5 - Fullscreen
No expdir No Ad request API parameter. expdir=1,2,3
battr Comma-separated list of blocked creative attributes’ IDs. Possible values are:
1 - Audio Ad (Auto Play)
2 - Audio Ad (User Initiated)
3 - Expandable (Automatic)
4 - Expandable (User Initiated - Click)
5 - Expandable (User Initiated - Rollover)
6 - in Banner Video Ad (Auto Play)
7 - in Banner Video Ad (User Initiated)
8 - Pop (such as Over, Under, or upon Exit)
9 - Provocative or Suggestive Image Ads
10 - Shaky/Flashing/Flickering Ad, Extreme Animation, or Smileys
11 - Survey Ads (such as Dynamic Logic, Insight Express, Vizu, and so on.)
12 - Text Only Ads
13 - User Interactive (such as embedded games)
14 - Windows Dialog Ad or Alert Style Ad
44 - Auto Refresh Ad
No battr No Ad request API parameter. battr=4,5,6
ifb Comma-separated list of IDs of the allowed iframe buster/rich media-supported technologies. Possible values are:
pr - Pointroll
eb - Eyeblaster
dc - DoubleClick
ew - EyeWonder
mp - Mediaplex
vp - Viewpoint
ui - Unicast
sa - Smart Adserver
km - Klipmart
er - EyeReturn
at - Atlas
ad - Adinterax
ac - Adcentric
ft - Flashtalking
mm - MediaMind
pt - Pictela
No ifb No Ad request API parameter. ifb=pr,mm
adtype Type of ad. Possible values are:
1 - Text only ads
2 - Image only ads
3 - Text and Image ads
4 - Ad made up of link units
5 - HTML ads
6 - Flash ads
7 - Text and Flash ads
8 - Text and Image and Flash ads
9 - Text and Image and Flash and HTML ads
10 - Text and HTML ads
11 - Text and Image and Rich Media ads
12 - Native ads
13 - Video ads
Yes* type Yes* Standard Mocean ad request API parameter.
NOTE: This parameter is required for video ads. In other cases the parameter is not sent.
If request type does not contain any combination of text, image or rich media and contain video, adtype will be set to “13”.
NOTE: In case of video ad it is additionally checked if the response format supports VAST ads only.
NOTE: This ad feed integration does not support native ad types.
NOTE: If the "adtype" parameter is defined via translation layer and equals to “13”, please, make sure the "vmaxl" parameter is defined correspondingly.
NOTE: The ‘adtype’ value must match the requested format.
adtype=13
vtype Type of video. Possible values are:
0 - Any type
1 - Linear
2 - Overlay
NOTE: Default value is ‘0’.
No vtype No Ad request API parameter. vtype=0
vpos Position of the video in the content. Possible options are:
0 - Any position
1 - Pre-roll
2 - In-roll
3 - Post-roll
NOTE: Default value is ‘0’.
No vpos No Ad request API parameter. vpos=0
vminl Minimum duration (in seconds) of the video clip. No vminl No Ad request API parameter. vminl=10
vmaxl Maximum duration (in seconds) of the video clip. Yes* vmaxl Yes* Ad request API parameter.
*NOTE: This parameter is required for video ads (if the "adtype" parameter equals to ‘13’).
vmaxl=10
vcom Indicates whether a companion ad is requested or not. Possible options are:
0 - False
1 - True
NOTE: Default value is ‘0’.
No vcom No Ad request API parameter. vcom=0
vminbtr Minimum bitrate (in kbps) allowed for the video stream. No vminbtr No Ad request API parameter. vminbtr=300
vmaxbtr Maximum bitrate (in kbps) allowed for the video stream. No vmaxbtr No Ad request API parameter. vmaxbtr=600
vfmt Acceptable video streaming formats. It is a combination of the following values separated by +:
0 - All
1 - video/mp4
2 - application/swf
3 - video/wmv
4 - video/h264
5 - video/webm
6 - application/javascript
7 - video/ogg
NOTE: Default value is ‘0’ (All).
No vfmt No Ad request API parameter. vfmt=1+4
vcomw Width (in pixels) of the companion ad.
Note: Default value is ‘300’.
No vcomw No Ad request API parameter. vcomw=300
vcomh Height (in pixels) of the companion ad.
Note: Default value is ‘250’.
No vcomh No Ad request API parameter. vcomh=250
vadFmt Video ad format (VAST version) supported as per the IAB standards in response. Possible options are:
1 - VAST 1.0 (unsupported)
2 - VAST 2.0
3 - VAST 3.0
No vadFmt No Ad request API parameter. vadFmt=3
vapi Video ad API (VPAID) version supported as per the IAB standards in response. Possible options are:
1 - VPAID 1.0
2 - VPAID 2.0
No vapi No Ad request API parameter. vapi=2
vcont Contextual information about the Web page serving the ad. This partner-dependent data can be encoded and has to be passed to the demand side for Brand Safety or used internally for blocking lists. No vcont No Ad request API parameter.
vplay List of allowed playback methods. If blank, assume that all are allowed. Possible values are as follows:
1 - Auto-play sound on
2 - Auto-play sound off
3 - Click-to-play
4 - Mouse-over
No vplay No Ad request API parameter. vplay=1+3
iabcat List of IAB content categories for the overall site/application. If the site/application falls under multiple IAB categories, you can send categories separated by comma, and the string should be URL encoded. No No This parameter is defined based on content categories which are set for the zone. Only Tier 1 IAB categories are sent. iabcat=IAB1%2CIAB5%2CIAB6


Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
RLNClientIpAddr Indicates the IP address of the device which originated the ad request. YesipStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, the IP address will be detected from request headers.
RLNClientIpAddr=115.112.64.6
Accept-Language Indicates the list of languages accepted by the browser. Yes (“accept-language” header) HTTP header - “accept-language” - is used. If the header is not sent, “en-US” is used by default.Accept-Language=en-US
Referer Indicates the Reference URL for the ad request. No (“referer” header) HTTP header - “referer” - is used.Referer=http://example.com
KADUSERCOOKIE PubMatic UserId which identifies each user uniquely. No* (“kadusercookie” header or “KADUSERCOOKIE” cookie) HTTP header - “kadusercookie” - is used. If the header is not sent, the “KADUSERCOOKIE” cookie is used.
* In case of server to server integration, sending PubMatic user ID as KADUSERCOOKIE header parameter is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26


Cookies
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
KADUSERCOOKIE PubMatic UserId which identifies each user uniquely. No* (“kadusercookie” header or “KADUSERCOOKIE” cookie) HTTP header - “kadusercookie” - is used. If the header is not sent, the “KADUSERCOOKIE” cookie is used.
* In case of server to server integration, sending PubMatic user ID as KADUSERCOOKIE cookie is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age yob
yyyy
birthday yob
yyyy-MM-dd yyyy
ethnicityethn
black 1
white 2
eastindian 4
middleeastern 4
asian 3
latino 0
pacificislander 4
nativeamerican 4
mixed 4
other 4
gender gender
m M
f F
dma dma
zip zip
keywords keywords
region state
country country
carrier carrier
pubmatic_exfeeds kadNetwork
pubmatic_excamps defcmpgIDs

PubMatic Desktop *

Logo


Base URL

http://bid.pubmatic.com/AdServer/AdServerServlet

Base URL for EMEA regions

http://bid.pubmatic.com/AdServer/AdServerServlet

Test URL

http://showads1065.pubmatic.com/AdServer/AdServerServlet

Test URL for EMEA regions

http://showads1065.pubmatic.com/AdServer/AdServerServlet

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
operId** Identifier (ID) of the operation. Possible values are:

“1” - For HTML response
“3” - For JavaScript response
“102” - For JSON response
“201” - JSON response for mobile ad serving

Yes “102” Yes Default value is used. operid=102
pubId Id of Publisher. This parameter is same as “pubId” in PubMatic AdTag. Yes PUBMATIC_PUBID Yes (specified in GUI) pubId=504
siteId One publisher can have multiple sites. “siteId” is site identifier for a Publisher. This value is picked up from “siteId” parameter in PubMatic AdTag. Yes PUBMATIC_SITEID Yes (specified in GUI) siteId=28848
adId A site can have multiple ad placements or positions which has same or different ad sizes. “adId” is unique identifier for such an ad placement. Yes PUBMATIC_ADID Yes (specified in GUI) adId=25111
kadwidth Dimension of AdSize. This is picked up from “kadwidth” parameter in PubMatic AdTag. Yes PUBMATIC_KADWIDTH Yes (specified in GUI)
NOTE: If the “kadwidth” parameter is passed in the request, it overrides the value of corresponding parameter set in UI.
kadwidth=320
kadheight Dimension of AdSize. This is picked up from “kadheight” parameter in PubMatic AdTag. Yes PUBMATIC_KADHEIGHT Yes (specified in GUI)
NOTE: If the “kadheight” parameter is passed in the request, it overrides the value of corresponding parameter set in UI.
kadheight=60
pageURL URL of the page on which the Ad is shown. Yes url *Yes Standard Mocean ad request API parameter.
*NOTE: If not specified in the ad request, URL of the app/site associated with the requested zone will be used. If there is no URL detected, empty value is sent.
pageURL=http://192.168.1.115/pub-test.html
kltstamp Time stamp (Format YYYY-MM-DD HH:MM:SS) when the ad request is made. Yes (current date and time) Yes Replaced with the current time, in seconds. kltstamp=2013-04-02%2017%3A28%3A5
ranreq Random number between (0 - 1). This is done to avoid URL caching from browser. Yes Yes A double value randomly generated from 0 to 1 ranreq=0.56
timezone Time zone of the User/Browser who is making an Ad Request. Yes “-05.00” Yes Default value is used. timezone=-05.00
screenResolution Screen Resolution in Format (WxH). Yes wurfl Yes Determined by WURFL (on the basis of max available width and height for the given device). screenResolution=720x490
inIframe Weather the Ad is served in iFrame. Yes “0” Yes Default value is used. inIframe=0
adVisibility 0 – Visibility couldn’t be determined.

1 – Above the fold. 2 - Below the fold. 3 – Partially above the fold.

Yes “0” Yes Default value is used. advisibility=0
adPosition -1x-1 if the adPosition cannot be determined. In other cases, Left x Top of the ad container. Yes “-1x-1” Yes Default value is used. adPosition=-1x-1
udid A unique device identifier for the given udidtype.Yes* (for Mobile Applications) Raw, SHA1, MD5 of the following parameters:
idfa, idfv, androidid, openudid, secureudid, macaddress, odin1, androidaid, wuid, waid, adtruth, bkid, drawbridge, udid (raw)
No Standard Mocean ad request API parameters are used. Parameters are checked in the order to the left. At first, raw value of the parameter is checked, then SHA1-hash, and then MD5-hash. If one of mentioned parameters is specified in the request, its value will be used.
If no special device ID parameters passed, the device identifier configurable at the network level, or “udid” is used by default. If no defined, unique device ID will be generated automatically.
NOTE: If the “udid” parameter is changed via translation layer, please, make sure “udidtype” and “udidhash” parameters are changed correspondingly.
udid=1A2B3C4D-00FF-00FF-00FF-1234567890AB
udidtype A unique device identifier for the given udidtype. Type of value provided in the udid parameter mentioned above. Possible values are:
0 - Other
1 - identifierForadvertiser (IDFA)
2 - identifierForvendor (IDFV)
3 - Android_ID
4 - UDID
5 - OpenUDID
6 - SecureUDID
7 - MAC Address
8 - ODIN–1
9 - Android Advertising ID
Yes* (for Mobile Applications) 0, 1, 2, 3, 5, 6, 7, 8 or 9 Yes* (if “udid” is sent) Defined on the base of Unique device ID being used. udidtype=3
udidhash Type of algorithm used for hashing the device identifier provided in the udid parameter mentioned above.
Possible values are:
1 - Raw
2 - SHA1
3 - MD5
Yes* (for Mobile Applications)1, 2 or 3 Yes* (if “udid” is sent) Defined on the base of Unique device ID being used. udidhash=2
dntDo not track. NoidteNo Corresponds to the standard Mocean ad request API parameters.
NOTE: “idte” and “dnt” have opposite values. idte=1 corresponds to dnt=0 and vice versa.
dnt=0
oid Original impression id used for tracking a unique pair of request-response. NooidNo Standard Mocean ad request API parameter. oid=3FBC7E41-11EA-40F5-A03C-532FF9272A3D
kadflooreCPM value which the PubMatic system uses as the bid price floor in the RTB auction. NoPUBMATIC_KADFLOORNo Specified in GUI.
The value should be specified in USD. If UI parameter PUBMATIC_KADFLOOR is not specified, min eCPM defined for the requested zone and converted from network currency to USD is used.
kadfloor=0.05
kbgColor Background Color of the page on which the Ad is shown (in RGB format). No paramBG No Standard Mocean ad request API parameter (without '#' sign). kbgColor=ffffff
klinkColor Link Color in (RGB format). This is used for displaying Text Ads. No paramLINK No Standard Mocean ad request API parameter (without '#' sign). klinkColor=0f0f0f
js Indicates whether the user's mobile device supports JavaScript or not. Possible values are:
• 0 - Device does not support JavaScript
• 1 - Device supports JavaScript
No 1 or 0 No Standard Mocean ad request API parameter, “type”, is used. If “type” contains “4”, “js” will be set to “1”. Otherwise, “0” will be sent. js=1
rs**Type of the JSON response to be expected if the operId parameter's value is set to either 102 or 201. Possible values are:
• 1 - Pure JSON response (Default value)
• 2 - JSON response padded with a callback JS function
• 3 - JSON repose padded with JS variable definition
No1Yes Default value is used. rs=1
locParameter for geolocation of the user.Nolat, longNo Standard Mocean ad request API parameters. NOTE: If no “lat” and “long” parameters passed, the “loc” parameter will be detected by IP.
NOTE: If the “loc” parameter is defined via translation layer, please, make sure the “loc_source” parameter is defined correspondingly.
loc=-999.99,-999.99
loc_sourceSource of user's mobile device's location as provided in the “loc” parameter mentioned above. This does not indicate the source for the user's geo-specific parameters such as country, state, city, and so on.
Possible values are:
0 - Unknown
1 - GPS / Location Services
2 - IP Address
3 - User provided (for example, registration data)
Yes* (Required if “loc” is provided) “1”, “2” Yes* “1” is sent if lat/long were specified in the request;
“2” - if loc was detected by IP;
“3” - if lat/long were hardcoded in the Ad Feed UI.
NOTE: This parameter is required only if the “loc” parameter is provided.
loc_source=1
cityCity of the user. NocityNo Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated with “, ”. The first part will be sent as city value.
city=New York
stateState of the user. NocityNo Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated with “, ”. The second part will be sent as state value.
state=NY
expdir Comma-separated list of the expansion direction IDs. Possible values are:
1 - Left
2 - Right
3 - Up
4 - Down
5 - Fullscreen
No expdir No Ad request API parameter. expdir=1,2,3
battr Comma-separated list of blocked creative attributes’ IDs. Possible values are:
1 - Audio Ad (Auto Play)
2 - Audio Ad (User Initiated)
3 - Expandable (Automatic)
4 - Expandable (User Initiated - Click)
5 - Expandable (User Initiated - Rollover)
6 - in Banner Video Ad (Auto Play)
7 - in Banner Video Ad (User Initiated)
8 - Pop (such as Over, Under, or upon Exit)
9 - Provocative or Suggestive Image Ads
10 - Shaky/Flashing/Flickering Ad, Extreme Animation, or Smileys
11 - Survey Ads (such as Dynamic Logic, Insight Express, Vizu, and so on.)
12 - Text Only Ads
13 - User Interactive (such as embedded games)
14 - Windows Dialog Ad or Alert Style Ad
44 - Auto Refresh Ad
No battr No Ad request API parameter. battr=4,5,6
ifb Comma-separated list of IDs of the allowed iframe buster/rich media-supported technologies. Possible values are:
pr - Pointroll
eb - Eyeblaster
dc - DoubleClick
ew - EyeWonder
mp - Mediaplex
vp - Viewpoint
ui - Unicast
sa - Smart Adserver
km - Klipmart
er - EyeReturn
at - Atlas
ad - Adinterax
ac - Adcentric
ft - Flashtalking
mm - MediaMind
pt - Pictela
No ifb No Ad request API parameter. ifb=pr,mm
adtype Type of ad. Possible values are:
1 - Text only ads
2 - Image only ads
3 - Text and Image ads
4 - Ad made up of link units
5 - HTML ads
6 - Flash ads
7 - Text and Flash ads
8 - Text and Image and Flash ads
9 - Text and Image and Flash and HTML ads
10 - Text and HTML ads
11 - Text and Image and Rich Media ads
12 - Native ads
13 - Video ads
Yes* type Yes* Standard Mocean ad request API parameter.
* NOTE: This parameter is required for video ads. In other cases the parameter is not sent.
If request type does not contain any combination of text, image or rich media and contain video, adtype will be set to “13”.
NOTE: In case of video ad it is additionally checked if the response format supports VAST ads only.
NOTE: This ad feed integration does not support native ad types.
NOTE: If the "adtype" parameter is defined via translation layer and equals to “13”, please, make sure the "vmaxl" parameter is defined correspondingly.
NOTE: The ‘adtype’ value must match the requested format.
adtype=13
vtype Type of video. Possible values are:
0 - Any type
1 - Linear
2 - Overlay
NOTE: Default value is ‘0’.
No vtype No Ad request API parameter. vtype=0
vpos Position of the video in the content. Possible options are:
0 - Any position
1 - Pre-roll
2 - In-roll
3 - Post-roll
NOTE: Default value is ‘0’.
No vpos No Ad request API parameter. vpos=0
vminl Minimum duration (in seconds) of the video clip. No vminl No Ad request API parameter. vminl=10
vmaxl Maximum duration (in seconds) of the video clip. Yes* vmaxl Yes* Ad request API parameter.
*NOTE: This parameter is required for video ads (if the "adtype" parameter equals to ‘13’).
vmaxl=10
vcom Indicates whether a companion ad is requested or not. Possible options are:
0 - False
1 - True
NOTE: Default value is ‘0’.
No vcom No Ad request API parameter. vcom=0
vminbtr Minimum bitrate (in kbps) allowed for the video stream. No vminbtr No Ad request API parameter. vminbtr=300
vmaxbtr Maximum bitrate (in kbps) allowed for the video stream. No vmaxbtr No Ad request API parameter. vmaxbtr=600
vfmt Acceptable video streaming formats. It is a combination of the following values separated by +:
0 - All
1 - video/mp4
2 - application/swf
3 - video/wmv
4 - video/h264
5 - video/webm
6 - application/javascript
7 - video/ogg
NOTE: Default value is ‘0’ (All).
No vfmt No Ad request API parameter. vfmt=1+4
vcomw Width (in pixels) of the companion ad.
Note: Default value is ‘300’.
No vcomw No Ad request API parameter. vcomw=300
vcomh Height (in pixels) of the companion ad.
Note: Default value is ‘250’.
No vcomh No Ad request API parameter. vcomh=250
vadFmt Video ad format (VAST version) supported as per the IAB standards in response. Possible options are:
1 - VAST 1.0 (unsupported)
2 - VAST 2.0
3 - VAST 3.0
No vadFmt No Ad request API parameter. vadFmt=3
vapi Video ad API (VPAID) version supported as per the IAB standards in response. Possible options are:
1 - VPAID 1.0
2 - VPAID 2.0
No vapi No Ad request API parameter. vapi=2
vcont Contextual information about the Web page serving the ad. This partner-dependent data can be encoded and has to be passed to the demand side for Brand Safety or used internally for blocking lists. No vcont No Ad request API parameter.
vplay List of allowed playback methods. If blank, assume that all are allowed. Possible values are as follows:
1 - Auto-play sound on
2 - Auto-play sound off
3 - Click-to-play
4 - Mouse-over
No vplay No Ad request API parameter. vplay=1+3
iabcat List of IAB content categories for the overall site/application. If the site/application falls under multiple IAB categories, you can send categories separated by comma, and the string should be URL encoded. No No This parameter is defined based on content categories which are set for the zone. Only Tier 1 IAB categories are sent. iabcat=IAB1%2CIAB5%2CIAB6
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
RLNClientIpAddr Indicates the IP address of the device which originated the ad request. YesipStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, the IP address will be detected from request headers.
RLNClientIpAddr=115.112.64.6
Accept-Language Indicates the list of languages accepted by the browser. Yes (“accept-language” header) HTTP header - “accept-language” - is used. If the header is not sent, “en-US” is used by default.Accept-Language=en-US
Referer Indicates the Reference URL for the ad request. No (“referer” header) HTTP header - “referer” - is used.Referer=http://example.com
KADUSERCOOKIE PubMatic UserId which identifies each user uniquely. No* (“kadusercookie” header or “KADUSERCOOKIE” cookie) HTTP header - “kadusercookie” - is used. If the header is not sent, the “KADUSERCOOKIE” cookie is used.
* In case of server to server integration, sending PubMatic user ID as KADUSERCOOKIE header parameter is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26
Cookies
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
KADUSERCOOKIE PubMatic UserId which identifies each user uniquely. No* (“kadusercookie” header or “KADUSERCOOKIE” cookie) HTTP header - “kadusercookie” - is used. If the header is not sent, the “KADUSERCOOKIE” cookie is used.
* In case of server to server integration, sending PubMatic user ID as KADUSERCOOKIE cookie is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age yob
yyyy
birthday yob
yyyy-MM-dd yyyy
ethnicityethn
black 1
white 2
eastindian 4
middleeastern 4
asian 3
latino 0
pacificislander 4
nativeamerican 4
mixed 4
other 4
gender gender
m M
f F
dma dma
zip zip
keywords keywords
region state
country country
carrier carrier
pubmatic_exfeeds kadNetwork
pubmatic_excamps defcmpgIDs

PubMatic Native *

Logo



Base URL

http://showads.pubmatic.com/AdServer/AdServerServlet

Base URL for EMEA regions

http://permobads-ams.pubmatic.com/AdServer/AdServerServlet

Test URL

http://showads1065.pubmatic.com/AdServer/AdServerServlet

Test URL for EMEA regions

http://showads1065.pubmatic.com/AdServer/AdServerServlet

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
pubId ID of the publisher. This value can be obtained from the pubId parameter in the PubMatic ad tag. Yes PUBMATIC_PUB_ID Yes (specified in GUI) pubId=31400
siteId ID of the publisher's Web site. A publisher can have multiple sites. This value can be obtained from the siteId parameter in the PubMatic ad tag. Yes PUBMATIC_SITE_ID Yes (specified in GUI) siteId=32506
adId ID of the ad's placement. A site can have multiple ad placements or positions which have the same or different ad sizes. adId is the unique identifier for such an ad placement and this value can be obtained from the adId parameter in the PubMatic ad tag. Yes PUBMATIC_AD_ID Yes (specified in GUI) adId=76964
pageURL URL of the page for which the ad is requested. Note: This parameter's value should be URL encoded. Since there is no page URL in the case of Mobile Application, an empty string "" can be set in this parameter. Yes url Yes Standard Mocean ad request API parameter.
NOTE: If not specified in the ad request, URL of the app/site associated with the requested zone will be used. In case no URL is detected, empty value is sent.
pageURL=example.com
kltstampTimestamp (in the YYYY-MM-DD HH:MM:SS format) of the user or browser at which the ad request is generated. Yes (current date and time) Yes Replaced with the current time, in seconds. kltstamp=2014-11-25%2017%3A28%3A5
ranreq A unique random number of data type double ranging between 0 to 1. This is required to avoid URL caching from the browser. Yes Yes A double value randomly generated from 0 to 1. ranreq=0.61
timezone Time zone of the User/Browser who is making an Ad Request. Yes “-05.00” Yes Default value is used. timezone=-05.00
screenResolution Resolution of the screen in the WidthxHeight format. Yes Yes Determined by WURFL (on the basis of max available width and height for the given device). screenResolution=720x490
adPosition Position of the ad to be served, that is, the (Top x Left) position of the ad container. Note: If the ad position cannot be determined, the default value as -1x-1 can be set in this parameter.Yes “-1x-1” Yes Default value is used. adPosition=-1x-1
inIframe Indicates whether the ad is served in an iFrame or not (0 - False; 1 - True). Note: If it is unable to determine, the default value as 1 can be set in this parameter. Yes “1” Yes Default value is used. inIframe=1
adVisibility Fold placement of the ad to be served.
0 – Visibility cannot be determined.

1 – Above the fold. 2 - Below the fold. 3 – Partially above the fold.

Yes “0” Yes Default value is used. advisibility=0
udid A unique device identifier for the given udidtype.Yes* (for Mobile Apps) Raw, SHA1, MD5 of the following parameters:
idfa, idfv, androidid, openudid, secureudid, macaddress, odin1, androidaid, wuid, waid, bkid, drawbridge, udid (raw)
No Standard Mocean ad request API parameters are used. Parameters are checked in the order to the left. At first, raw value of the parameter is checked, then SHA1-hash, and then MD5-hash. If one of thee mentioned parameters is specified in the request, its value will be used.
If no special device ID parameters passed, the device identifier configurable at the network level, or "udid" is used by default. If no defined, unique device ID will be generated automatically.
NOTE: If the "udid" parameter is changed via translation layer, please, make sure "udidtype" and "udidhash" parameters are changed correspondingly.
udid=1A2B3C4D-00FF-00FF-00FF-1234567890AB
udidtype A unique device identifier for the given udidtype. Type of value provided in the udid parameter mentioned above. Possible values are:
0 - Other
1 - identifierForadvertiser (IDFA)
2 - identifierForvendor (IDFV)
3 - Android_ID
4 - UDID
5 - OpenUDID
6 - SecureUDID
7 - MAC Address
8 - ODIN–1
9 - Android Advertising ID
Yes* (for Mobile Apps) 0, 1, 2, 3, 5, 6, 7, 8 or 9 Yes* (if "udid" is sent) Defined on the base of Unique device ID being used. udidtype=3
udidhash Type of algorithm used for hashing the device identifier provided in the udid parameter mentioned above.
Possible values are:
1 - Raw
2 - SHA1
3 - MD5
Yes* (for Mobile Apps)1, 2 or 3 Yes* (if "udid" is sent) Defined on the base of Unique device ID being used. udidhash=2
dntDo not track. Indicates whether the user has opted out of the publisher or not, or whether HTTP_DNT is set or not.
0 - Either the user has not opted out of the publisher or HTTP_DNT is not set.
1 - Either the user has opted out of the publisher or HTTP_DNT is set; in this case, PubMatic will not target such users.
NoidteNo Corresponds to the standard Mocean ad request API parameters.
NOTE:"idte" and "dnt" have opposite values. idte=1 corresponds to dnt=0 and vice versa.
dnt=0
oid Original impression id used for tracking a unique pair of request-response. NooidNo Standard Mocean ad request API parameter. oid=3FBC7E41-11EA-40F5-A03C-532FF9272A3D
kadflooreCPM value which the PubMatic system uses as the bid price floor in the RTB auction. NoPUBMATIC_KADFLOORNo Specified in GUI.
The value should be specified in USD. If UI parameter PUBMATIC_KADFLOOR is not specified, min eCPM defined for the requested zone and converted from network currency to USD is used.
kadfloor=0.05
locLocation of the user's mobile device. Its value indicates the latitude and longitude, and should be specified in the Latitude,Longitude format such as 41.906365, -75.327759. Latitude varies from -90 to 90 and longitude varies from -180 to 180. Note that South and West are depicted as negative numbers.Nolat, longNo Standard Mocean ad request API parameters. NOTE: If no "lat" and "long" parameters passed, the "loc" parameter will be detected by IP.
NOTE: If the "loc" parameter is defined via translation layer, please, make sure the "loc_source" parameter is defined correspondingly.
loc=-999.99,-999.99
loc_sourceSource of user's mobile device's location as provided in the "loc" parameter mentioned above. This does not indicate the source for the user's geo-specific parameters such as country, state, city, and so on.
Possible values are:
0 - Unknown
1 - GPS / Location Services
2 - IP Address
3 - User provided (for example, registration data)
Yes* (if "loc" is provided) “1", "2" Yes* (if "loc" is sent) "1" is sent if lat/long were specified in the request;
"2" - if loc was detected by IP;
"3" - if lat/long were hardcoded in the Ad Feed UI.
loc_source=1
cityCity of the user. NocityNo Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated with ", ". The first part will be sent as city value.
city=New York
stateState of the user. NocityNo Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated with ", ". The second part will be sent as state value.
state=NY
operId** For JSON response. Yes "201" Yes Default value is used. operId=201
awt** Indicates whether the tracking URL has been wrapped or not in the creative tag.

0 - Indicates that the tracking URL is sent separately in the response JSON as tracking_url. In this case, the tracking_url field is absent in the JSON response. 1 - Indicates that the tracking_url value is wrapped in an Iframe and appended to the creative_tag. 2 - Indicates that the tracking_url value is wrapped in a JS tag and appended to the creative_tag. Note: If the awt parameter is absent in the bid request URL, then it is same as awt=0 mentioned above.

No "0" Yes Default value is used. awt=0
rs** Type of the JSON response to be expected if the operId parameter's value is set to either 102 or 201.

1 - Pure JSON response (Default value) 2 - JSON response padded with a callback JS function 3 - JSON repose padded with JS variable definition

No "1" Yes Default value is used. rs=1
adtype** This parameter is mandatory for native ad serving. Possible values are:
1 - TextOnly (Text only ads);
2 - ImageOnly (Image only ads);
3 - TextAndImage (Text and Image ads);
4 - LinkUnit (Ad made up of link units);
5 - HTML (HTML ads);
6 - Flash (Flash ads);
7 - TextAndFlash (Text and Flash ads);
8 - TextImageFlash (Text and Image and Flash ads);
9 - TextImageFlashHTML (Text and Image and Flash and HTML ads);
10 - TextHTML (Text and HTML ads);
11 - TextImageRichMedia (Text and Image and RichMedia ads);
12 - Native (Native Ads);
13 - Video (Video ads).
Yes "12" Yes Default value is used. adtype=12
native Native object in JSON format Yes* (For native ads) Yes See the Native Object table below.
expdir Comma-separated list of the expansion direction IDs. Possible values are:
1 - Left
2 - Right
3 - Up
4 - Down
5 - Fullscreen
No expdir No Ad request API parameter. expdir=1,2,3
battr Comma-separated list of blocked creative attributes’ IDs. Possible values are:
1 - Audio Ad (Auto Play)
2 - Audio Ad (User Initiated)
3 - Expandable (Automatic)
4 - Expandable (User Initiated - Click)
5 - Expandable (User Initiated - Rollover)
6 - in Banner Video Ad (Auto Play)
7 - in Banner Video Ad (User Initiated)
8 - Pop (such as Over, Under, or upon Exit)
9 - Provocative or Suggestive Image Ads
10 - Shaky/Flashing/Flickering Ad, Extreme Animation, or Smileys
11 - Survey Ads (such as Dynamic Logic, Insight Express, Vizu, and so on.)
12 - Text Only Ads
13 - User Interactive (such as embedded games)
14 - Windows Dialog Ad or Alert Style Ad
44 - Auto Refresh Ad
No battr No Ad request API parameter. battr=4,5,6
ifb Comma-separated list of IDs of the allowed iframe buster/rich media-supported technologies. Possible values are:
pr - Pointroll
eb - Eyeblaster
dc - DoubleClick
ew - EyeWonder
mp - Mediaplex
vp - Viewpoint
ui - Unicast
sa - Smart Adserver
km - Klipmart
er - EyeReturn
at - Atlas
ad - Adinterax
ac - Adcentric
ft - Flashtalking
mm - MediaMind
pt - Pictela
No ifb No Ad request API parameter. ifb=pr,mm
iabcat List of IAB content categories for the overall site/application. If the site/application falls under multiple IAB categories, you can send categories separated by comma, and the string should be URL encoded. No No This parameter is defined based on content categories which are set for the zone. Only Tier 1 IAB categories are sent. iabcat=IAB1%2CIAB5%2CIAB6
Native Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
verVersion of the Native Markup version in use. Yes "1.0" Default value is used.
adunit The Ad unit ID of the native ad unit. Possible values are:
1 – Paid Search Units;
2 – Recomendation Widgets;
3 – Promoted Listings;
4 – In-Ad (IAB Standatd) with Native Element Units;
5 – Custom/”Can't Be Contained”;
500+ - Reserved for Exchange specific formats.
No PUBMATIC_ADUNIT Specified in GUI.
NOTE:
  • UI parameter is used for GET-requests or for POST-requests without native related parameters.
  • For POST-requests with native related parameters: UI parameter is not used; response to the PubMatic is formed based on native parameter specified in JSON format.
layout The Layout ID of the native ad unit. Possible values are:
1 – Content Wall;
2 – App Wall;
3 – News Feed;
4 – Chat List;
5 – Carousel;
6 - Content Stream;
7 - Grid adjoining the content;
500+ - Reserved for Exchange specific layouts.
No PUBMATIC_NATIVE_AD_TEMPLATE Specified in GUI.
NOTE:
  • UI parameter is used for GET-requests or for POST-requests without native related parameters.
  • For POST-requests with native related parameters: UI parameter is not used; response to the PubMatic is formed based on native parameter specified in JSON format.
assetsAn array of Asset Objects. Any bid must comply with the array of elements expressed by the Exchange. Yes PUBMATIC_ADMSUPPORT, native_content Array of asset objects is formed on the base of “native_content” request parameter (these assets are required) and on the base of limitation parameters specified in the request or in UI (these assets are optional). The ad request is checked first and then Mocean UI.
NOTE:
  • If 'native_content' parameter is not passed, the value of the PUBMATIC_ADMSUPPORT parameter which is generated on the base of UI parameters settings (PUBMATIC_ICON_SIZE, PUBMATIC_MIN_ICON_SIZE, PUBMATIC_IMAGE_SIZE, PUBMATIC_MIN_IMAGE_SIZE, PUBMATIC_TITLE_LENGTH, PUBMATIC_DESC_LENGTH, PUBMATIC_CTA_LENGTH, PUBMATIC_AD_STAR_RATING) will be used.
  • UI parameters are used for GET-requests or for POST-requests without native related parameters.
  • For POST-requests with native related parameters: UI parameters are not used; response to the PubMatic is formed based on native parameter specified in JSON format.
Asset Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
idUnique asset ID, assigned by exchange. Typically a counter for the array. Yes Constant:

“1” – icon; “2” – main image; “3” – title; “4” – description; “5” – CTA; “6” – rating; “7” – logo

reqDefines whether the asset is required ("1") or not ("0"). O is used by default. No PUBMATIC_ADMSUPPORT, native_content Set to “1” if asset is requested based on “PUBMATIC_ADMSUPPORT” or “native_content” (passed with positive value). Otherwise (any asset is requested or the asset is requested based on limitation parameters), “0” is sent.
titleTitle object for title assets. See Title Object definition below. No Formed on the base of PUBMATIC_ADMSUPPORT”/“native_content” and limitation parameters.
imgImage object for image assets. See Image Object definition below. No Formed on the base of “PUBMATIC_ADMSUPPORT”/“native_content” and limitation parameters.
dataData object for ratings, prices etc. See Data Object definition below. No Formed on the base of PUBMATIC_ADMSUPPORT”/“native_content” and limitation parameters.
Title Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
len Maximum length of the text in the title element. Yes title_length, PUBMATIC_TITLE_LENGTH Mocean Ad Request API parameter is used. If not specified, UI value is used. Otherwise, the default value (“25”) will be sent.
Image Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
wWidth of the image in pixels. No img_size_x, PUBMATIC_IMAGE_SIZE;
icon_size_x, PUBMATIC_ICON_SIZE;
logo_size_x
Mocean Ad Request API parameter (or UI parameter) is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
hHeight of the image in pixels. No img_size_y, PUBMATIC_IMAGE_SIZE;
icon_size_y, PUBMATIC_ICON_SIZE;
logo_size_y
Mocean Ad Request API parameter (or UI parameter) is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
wminMinimal width of the image in pixels. No PUBMATIC_MIN_IMAGE_SIZE,
PUBMATIC_MIN_ICON_SIZE
Mocean Ad Request API parameter (or UI parameter) is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
NOTE: “PUBMATIC_MIN_IMAGE_SIZE” and “PUBMATIC_MIN_ICON_SIZE” are used for GET-requests or for POST-requests without native related parameters.
NOTE: For POST-requests with native related parameters: The UI parameters are not used. Response to the PubMatic is formed based on native parameter specified in JSON format.
hminMinimal height of the image in pixels. No PUBMATIC_MIN_IMAGE_SIZE,
PUBMATIC_MIN_ICON_SIZE
Mocean Ad Request API parameter (or UI parameter) is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
NOTE: “PUBMATIC_MIN_IMAGE_SIZE” and “PUBMATIC_MIN_ICON_SIZE” are used for GET-requests or for POST-requests without native related parameters.
NOTE: For POST-requests with native related parameters: The UI parameters are not used. Response to the PubMatic is formed based on native parameter specified in JSON format.
Data Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
typeType ID of the element supported by the publisher. The publisher can display this information in an appropriate format. Yes “2” – for the description asset;
“3” – for the rating asset;
“5” – for the CTA asset
lenMaximum length of the text in the element’s response. No description_length, PUBMATIC_DESC_LENGTH,
cta_length, PUBMATIC_CTA_LENGTH
Passed for the description and CTA text assets. Mocean Ad Request API parameter is used. If not specified, UI value is used.
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
RLNClientIpAddr Indicates the IP address of the device which originated the ad request. YesipStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, the IP address will be detected from request headers.
RLNClientIpAddr=115.112.64.6
Accept-Language Indicates the list of languages accepted by the browser. Yes (“accept-language” header) HTTP header - “accept-language” - is used. If it is empty, "en-US" is used by default.Accept-Language=en-US
Referer Indicates the Reference URL for the ad request. No (“referer” header) HTTP header - “referer” - is used.Referer=http://example.com
KADUSERCOOKIE PubMatic UserId which identifies each user uniquely. No* (“kadusercookie” header or “KADUSERCOOKIE” cookie) HTTP header - “kadusercookie” - is used. If the header is not sent, the “KADUSERCOOKIE” cookie is used.
* In case of server to server integration, sending PubMatic user ID as KADUSERCOOKIE header parameter is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26
Cookies
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
KADUSERCOOKIE PubMatic UserId which identifies each user uniquely. No* (“kadusercookie” header or “KADUSERCOOKIE” cookie) HTTP header - “kadusercookie” - is used. If the header is not sent, the “KADUSERCOOKIE” cookie is used.
* In case of server to server integration, sending PubMatic user ID as KADUSERCOOKIE cookie is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
pubmatic_exfeeds kadNetwork
birthday yob
yyyy-MM-dd yyyy
age yob
yyyy
ethnicityethn
black 1
white 2
eastindian 4
middleeastern 4
asian 3
latino 0
pacificislander 4
nativeamerican 4
mixed 4
other 4
gender gender
m M
f F
dma dma
zip zip
keywords keywords
region state
country country
carrier carrier
pubmatic_excamps defcmpgIDs

PubMatic Native Desktop *

Logo



Base URL

http://bid.pubmatic.com/AdServer/AdServerServlet

Base URL for EMEA regions

http://bid.pubmatic.com/AdServer/AdServerServlet

Test URL

http://showads1065.pubmatic.com/AdServer/AdServerServlet

Test URL for EMEA regions

http://showads1065.pubmatic.com/AdServer/AdServerServlet

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
pubId ID of the publisher. This value can be obtained from the pubId parameter in the PubMatic ad tag. Yes PUBMATIC_PUB_ID Yes (specified in GUI) pubId=31400
siteId ID of the publisher's Web site. A publisher can have multiple sites. This value can be obtained from the siteId parameter in the PubMatic ad tag. Yes PUBMATIC_SITE_ID Yes (specified in GUI) siteId=32506
adId ID of the ad's placement. A site can have multiple ad placements or positions which have the same or different ad sizes. adId is the unique identifier for such an ad placement and this value can be obtained from the adId parameter in the PubMatic ad tag. Yes PUBMATIC_AD_ID Yes (specified in GUI) adId=76964
pageURL URL of the page for which the ad is requested. Note: This parameter's value should be URL encoded. Since there is no page URL in the case of Mobile Application, an empty string “” can be set in this parameter. Yes url Yes Standard Mocean ad request API parameter.
NOTE: If not specified in the ad request, URL of the app/site associated with the requested zone will be used. In case no URL is detected, empty value is sent.
pageURL=example.com
kltstampTimestamp (in the YYYY-MM-DD HH:MM:SS format) of the user or browser at which the ad request is generated. Yes (current date and time) Yes Replaced with the current time, in seconds. kltstamp=2014-11-25%2017%3A28%3A5
ranreq A unique random number of data type double ranging between 0 to 1. This is required to avoid URL caching from the browser. Yes Yes A double value randomly generated from 0 to 1. ranreq=0.61
timezone Time zone of the User/Browser who is making an Ad Request. Yes “-05.00” Yes Default value is used. timezone=-05.00
screenResolution Resolution of the screen in the WidthxHeight format. Yes Yes Determined by WURFL (on the basis of max available width and height for the given device). screenResolution=720x490
adPosition Position of the ad to be served, that is, the (Top x Left) position of the ad container. Note: If the ad position cannot be determined, the default value as -1x-1 can be set in this parameter.Yes “-1x-1” Yes Default value is used. adPosition=-1x-1
inIframe Indicates whether the ad is served in an iFrame or not (0 - False; 1 - True). Note: If it is unable to determine, the default value as 1 can be set in this parameter. Yes “1” Yes Default value is used. inIframe=1
adVisibility Fold placement of the ad to be served.
0 – Visibility cannot be determined.

1 – Above the fold. 2 - Below the fold. 3 – Partially above the fold.

Yes “0” Yes Default value is used. advisibility=0
udid A unique device identifier for the given udidtype.Yes* (for Mobile Apps) Raw, SHA1, MD5 of the following parameters:
idfa, idfv, androidid, openudid, secureudid, macaddress, odin1, androidaid, wuid, waid, bkid, drawbridge, udid (raw)
No Standard Mocean ad request API parameters are used. Parameters are checked in the order to the left. At first, raw value of the parameter is checked, then SHA1-hash, and then MD5-hash. If one of thee mentioned parameters is specified in the request, its value will be used.
If no special device ID parameters passed, the device identifier configurable at the network level, or “udid” is used by default. If no defined, unique device ID will be generated automatically.
NOTE: If the “udid” parameter is changed via translation layer, please, make sure “udidtype” and “udidhash” parameters are changed correspondingly.
udid=1A2B3C4D-00FF-00FF-00FF-1234567890AB
udidtype A unique device identifier for the given udidtype. Type of value provided in the udid parameter mentioned above. Possible values are:
0 - Other
1 - identifierForadvertiser (IDFA)
2 - identifierForvendor (IDFV)
3 - Android_ID
4 - UDID
5 - OpenUDID
6 - SecureUDID
7 - MAC Address
8 - ODIN–1
9 - Android Advertising ID
Yes* (for Mobile Apps) 0, 1, 2, 3, 5, 6, 7, 8 or 9 Yes* (if “udid” is sent) Defined on the base of Unique device ID being used. udidtype=3
udidhash Type of algorithm used for hashing the device identifier provided in the udid parameter mentioned above.
Possible values are:
1 - Raw
2 - SHA1
3 - MD5
Yes* (for Mobile Apps)1, 2 or 3 Yes* (if “udid” is sent) Defined on the base of Unique device ID being used. udidhash=2
dntDo not track. Indicates whether the user has opted out of the publisher or not, or whether HTTP_DNT is set or not.
0 - Either the user has not opted out of the publisher or HTTP_DNT is not set.
1 - Either the user has opted out of the publisher or HTTP_DNT is set; in this case, PubMatic will not target such users.
NoidteNo Corresponds to the standard Mocean ad request API parameters.
NOTE: “idte” and “dnt” have opposite values. idte=1 corresponds to dnt=0 and vice versa.
dnt=0
oid Original impression id used for tracking a unique pair of request-response. NooidNo Standard Mocean ad request API parameter. oid=3FBC7E41-11EA-40F5-A03C-532FF9272A3D
kadflooreCPM value which the PubMatic system uses as the bid price floor in the RTB auction. NoPUBMATIC_KADFLOORNo Specified in GUI.
The value should be specified in USD. If UI parameter PUBMATIC_KADFLOOR is not specified, min eCPM defined for the requested zone and converted from network currency to USD is used.
kadfloor=0.05
locLocation of the user's mobile device. Its value indicates the latitude and longitude, and should be specified in the Latitude, Longitude format such as 41.906365, -75.327759. Latitude varies from -90 to 90 and longitude varies from -180 to 180. Note that South and West are depicted as negative numbers.Nolat, longNo Standard Mocean ad request API parameters. NOTE: If no “lat” and “long” parameters passed, the “loc” parameter will be detected by IP.
NOTE: If the “loc” parameter is defined via translation layer, please, make sure the “loc_source” parameter is defined correspondingly.
loc=-999.99,-999.99
loc_sourceSource of user's mobile device's location as provided in the “loc” parameter mentioned above. This does not indicate the source for the user's geo-specific parameters such as country, state, city, and so on.
Possible values are:
0 - Unknown
1 - GPS / Location Services
2 - IP Address
3 - User provided (for example, registration data)
Yes* (if “loc” is provided) “1”, “2” Yes* (if “loc” is sent) “1” is sent if lat/long were specified in the request;
“2” - if loc was detected by IP;
“3” - if lat/long were hardcoded in the Ad Feed UI.
loc_source=1
cityCity of the user. NocityNo Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated with “, ”. The first part will be sent as city value.
city=New York
stateState of the user. NocityNo Standard Mocean ad request API parameters.
NOTE: The value of standard parameter consists of two parts separated with “, ”. The second part will be sent as state value.
state=NY
operId** For JSON response. Yes “102” Yes Default value is used. operId=102
awt** Indicates whether the tracking URL has been wrapped or not in the creative tag.

0 - Indicates that the tracking URL is sent separately in the response JSON as tracking_url. In this case, the tracking_url field is absent in the JSON response. 1 - Indicates that the tracking_url value is wrapped in an Iframe and appended to the creative_tag. 2 - Indicates that the tracking_url value is wrapped in a JS tag and appended to the creative_tag. Note: If the awt parameter is absent in the bid request URL, then it is same as awt=0 mentioned above.

No “0” Yes Default value is used. awt=0
rs** Type of the JSON response to be expected if the operId parameter's value is set to either 102 or 201.

1 - Pure JSON response (Default value) 2 - JSON response padded with a callback JS function 3 - JSON repose padded with JS variable definition

No “1” Yes Default value is used. rs=1
adtype** This parameter is mandatory for native ad serving. Possible values are:
1 - TextOnly (Text only ads);
2 - ImageOnly (Image only ads);
3 - TextAndImage (Text and Image ads);
4 - LinkUnit (Ad made up of link units);
5 - HTML (HTML ads);
6 - Flash (Flash ads);
7 - TextAndFlash (Text and Flash ads);
8 - TextImageFlash (Text and Image and Flash ads);
9 - TextImageFlashHTML (Text and Image and Flash and HTML ads);
10 - TextHTML (Text and HTML ads);
11 - TextImageRichMedia (Text and Image and RichMedia ads);
12 - Native (Native Ads);
13 - Video (Video ads).
Yes “12” Yes Default value is used. adtype=12
native Native object in JSON format Yes* (For native ads) Yes See the Native Object table below.
expdir Comma-separated list of the expansion direction IDs. Possible values are:
1 - Left
2 - Right
3 - Up
4 - Down
5 - Fullscreen
No expdir No Ad request API parameter. expdir=1,2,3
battr Comma-separated list of blocked creative attributes’ IDs. Possible values are:
1 - Audio Ad (Auto Play)
2 - Audio Ad (User Initiated)
3 - Expandable (Automatic)
4 - Expandable (User Initiated - Click)
5 - Expandable (User Initiated - Rollover)
6 - in Banner Video Ad (Auto Play)
7 - in Banner Video Ad (User Initiated)
8 - Pop (such as Over, Under, or upon Exit)
9 - Provocative or Suggestive Image Ads
10 - Shaky/Flashing/Flickering Ad, Extreme Animation, or Smileys
11 - Survey Ads (such as Dynamic Logic, Insight Express, Vizu, and so on.)
12 - Text Only Ads
13 - User Interactive (such as embedded games)
14 - Windows Dialog Ad or Alert Style Ad
44 - Auto Refresh Ad
No battr No Ad request API parameter. battr=4,5,6
ifb Comma-separated list of IDs of the allowed iframe buster/rich media-supported technologies. Possible values are:
pr - Pointroll
eb - Eyeblaster
dc - DoubleClick
ew - EyeWonder
mp - Mediaplex
vp - Viewpoint
ui - Unicast
sa - Smart Adserver
km - Klipmart
er - EyeReturn
at - Atlas
ad - Adinterax
ac - Adcentric
ft - Flashtalking
mm - MediaMind
pt - Pictela
No ifb No Ad request API parameter. ifb=pr,mm
iabcat List of IAB content categories for the overall site/application. If the site/application falls under multiple IAB categories, you can send categories separated by comma, and the string should be URL encoded. No No This parameter is defined based on content categories which are set for the zone. Only Tier 1 IAB categories are sent. iabcat=IAB1%2CIAB5%2CIAB6
Native Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
verVersion of the Native Markup version in use. Yes “1.0” Default value is used.
adunit The Ad unit ID of the native ad unit. Possible values are:
1 – Paid Search Units;
2 – Recomendation Widgets;
3 – Promoted Listings;
4 – In-Ad (IAB Standatd) with Native Element Units;
5 – Custom/”Can't Be Contained”;
500+ - Reserved for Exchange specific formats.
No PUBMATIC_ADUNIT Specified in GUI.
NOTE:
  • UI parameter is used for GET-requests or for POST-requests without native related parameters.
  • For POST-requests with native related parameters: UI parameter is not used; response to the PubMatic is formed based on native parameter specified in JSON format.
layout The Layout ID of the native ad unit. Possible values are:
1 – Content Wall;
2 – App Wall;
3 – News Feed;
4 – Chat List;
5 – Carousel;
6 - Content Stream;
7 - Grid adjoining the content;
500+ - Reserved for Exchange specific layouts.
No PUBMATIC_NATIVE_AD_TEMPLATE Specified in GUI.
NOTE:
  • UI parameter is used for GET-requests or for POST-requests without native related parameters.
  • For POST-requests with native related parameters: UI parameter is not used; response to the PubMatic is formed based on native parameter specified in JSON format.
assetsAn array of Asset Objects. Any bid must comply with the array of elements expressed by the Exchange. Yes PUBMATIC_ADMSUPPORT, native_content Array of asset objects is formed on the base of “native_content” request parameter (these assets are required) and on the base of limitation parameters specified in the request or in UI (these assets are optional). The ad request is checked first and then Mocean UI.
NOTE:
  • If 'native_content' parameter is not passed, the value of the PUBMATIC_ADMSUPPORT parameter which is generated on the base of UI parameters settings (PUBMATIC_ICON_SIZE, PUBMATIC_MIN_ICON_SIZE, PUBMATIC_IMAGE_SIZE, PUBMATIC_MIN_IMAGE_SIZE, PUBMATIC_TITLE_LENGTH, PUBMATIC_DESC_LENGTH, PUBMATIC_CTA_LENGTH, PUBMATIC_AD_STAR_RATING) will be used.
  • UI parameters are used for GET-requests or for POST-requests without native related parameters.
  • For POST-requests with native related parameters: UI parameters are not used; response to the PubMatic is formed based on native parameter specified in JSON format.
Asset Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
idUnique asset ID, assigned by exchange. Typically a counter for the array. Yes Constant:

“1” – icon; “2” – main image; “3” – title; “4” – description; “5” – CTA; “6” – rating; “7” – logo

reqDefines whether the asset is required (“1”) or not (“0”). O is used by default. No PUBMATIC_ADMSUPPORT, native_content Set to “1” if asset is requested based on “PUBMATIC_ADMSUPPORT” or “native_content” (passed with positive value). Otherwise (any asset is requested or the asset is requested based on limitation parameters), “0” is sent.
titleTitle object for title assets. See Title Object definition below. No Formed on the base of PUBMATIC_ADMSUPPORT”/“native_content” and limitation parameters.
imgImage object for image assets. See Image Object definition below. No Formed on the base of “PUBMATIC_ADMSUPPORT”/“native_content” and limitation parameters.
dataData object for ratings, prices etc. See Data Object definition below. No Formed on the base of PUBMATIC_ADMSUPPORT”/“native_content” and limitation parameters.
Title Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
len Maximum length of the text in the title element. Yes title_length, PUBMATIC_TITLE_LENGTH Mocean Ad Request API parameter is used. If not specified, UI value is used. Otherwise, the default value (“25”) will be sent.
Image Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
wWidth of the image in pixels. No img_size_x, PUBMATIC_IMAGE_SIZE;
icon_size_x, PUBMATIC_ICON_SIZE;
logo_size_x
Mocean Ad Request API parameter (or UI parameter) is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
hHeight of the image in pixels. No img_size_y, PUBMATIC_IMAGE_SIZE;
icon_size_y, PUBMATIC_ICON_SIZE;
logo_size_y
Mocean Ad Request API parameter (or UI parameter) is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
wminMinimal width of the image in pixels. No PUBMATIC_MIN_IMAGE_SIZE,
PUBMATIC_MIN_ICON_SIZE
Mocean Ad Request API parameter (or UI parameter) is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
NOTE: “PUBMATIC_MIN_IMAGE_SIZE” and “PUBMATIC_MIN_ICON_SIZE” are used for GET-requests or for POST-requests without native related parameters.
NOTE: For POST-requests with native related parameters: The UI parameters are not used; response to the PubMatic is formed based on native parameter specified in JSON format.
hminMinimal height of the image in pixels. No PUBMATIC_MIN_IMAGE_SIZE,
PUBMATIC_MIN_ICON_SIZE
Mocean Ad Request API parameter (or UI parameter) is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
NOTE: “PUBMATIC_MIN_IMAGE_SIZE” and “PUBMATIC_MIN_ICON_SIZE” are used for GET-requests or for POST-requests without native related parameters.
NOTE: For POST-requests with native related parameters: The UI parameters are not used; response to the PubMatic is formed based on native parameter specified in JSON format.
Data Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
typeType ID of the element supported by the publisher. The publisher can display this information in an appropriate format. Yes “2” – for the description asset;
“3” – for the rating asset;
“5” – for the CTA asset
lenMaximum length of the text in the element’s response. No description_length, PUBMATIC_DESC_LENGTH,
cta_length, PUBMATIC_CTA_LENGTH
Passed for the description and CTA text assets. Mocean Ad Request API parameter is used. If not specified, UI value is used.
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent User agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
RLNClientIpAddr Indicates the IP address of the device which originated the ad request. YesipStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, the IP address will be detected from request headers.
RLNClientIpAddr=115.112.64.6
Accept-Language Indicates the list of languages accepted by the browser. Yes (“accept-language” header) HTTP header - “accept-language” - is used. If it is empty, "en-US" is used by default.Accept-Language=en-US
Referer Indicates the Reference URL for the ad request. No (“referer” header) HTTP header - “referer” - is used.Referer=http://example.com
KADUSERCOOKIE PubMatic UserId which identifies each user uniquely. No* (“kadusercookie” header or “KADUSERCOOKIE” cookie) HTTP header - “kadusercookie” - is used. If the header is not sent, the “KADUSERCOOKIE” cookie is used.
* In case of server to server integration, sending PubMatic user ID as KADUSERCOOKIE header parameter is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26
Cookies
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
KADUSERCOOKIE PubMatic UserId which identifies each user uniquely. No* (“kadusercookie” header or “KADUSERCOOKIE” cookie) HTTP header - “kadusercookie” - is used. If the header is not sent, the “KADUSERCOOKIE” cookie is used.
* In case of server to server integration, sending PubMatic user ID as KADUSERCOOKIE cookie is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
pubmatic_exfeeds kadNetwork
birthday yob
yyyy-MM-dd yyyy
age yob
yyyy
ethnicityethn
black 1
white 2
eastindian 4
middleeastern 4
asian 3
latino 0
pacificislander 4
nativeamerican 4
mixed 4
other 4
gender gender
m M
f F
dma dma
zip zip
keywords keywords
region state
country country
carrier carrier
pubmatic_excamps defcmpgIDs

PubMatic Phoenix (BETA)

NOTE: The ad feed is available to customers participating in Phoenix Beta program.

Base URL

http://ae.pubmatic.com/ad

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
au AdUnit codes list. Yes PHOENIX_AD_UNIT_ID Yes (specified in GUI)
The parameter contains only the AdUnit code
au=48000018
iid Impression ID. Yes “DIV1” Yes As an AdUnit can be used in many AdSlots on same page, every adSlot will be identified with unique impression ID. Impression ID of different slots are separated by pipe iid=DIV1
res_format** Response type.
Possible values are:
1 – for VAST response;
2 – for JSON response;
3 – for native response
Yes “2” Yes The “2” value is used by default. res_format=2
req_type Request type. Possible values:
1. Flash
2. Image
4. Native
8. Text
16. ThirdParty
32. Video
64. RichMedia
Yes Yes The request type is defined using Mocean request type. The flash ("1"), thirdparty ("16") and richmedia ("64") are requested for richmedia ads.req_type=32
rndn Random number.
This is done to avoid URL caching from browser.
No No Randomly generated value. rndn=0.56
tz Time zone of the User/Browser who is making an Ad Request No “-05.00” No Default value is used. tz=-05.00
aszWidth and height of the slot to be shown separated by “x”. Yes* (For banner and richmedia ads) size_x, size_y Yes* Standard Mocean ad request API parameters.
The priority of selecting size values to be sent to Phoenix will be the following:
1. Creative sizes
2. Request parameters
3. Zone settings
4. WURFL (on the basis of max available width and height for the given device).
asz=320x50
scrn Screen resolution in format (WxH). No wurfl No Determined by WURFL (on the basis of max available width and height for the given device). scrn=320x50
purl URL of the page on which the Ad is shown. No url Yes* Standard Mocean ad request API parameter.
*NOTE: If pubsite is web site, “url” parameter or pubsite domain is used.
purl=example.com
lat A user's device latitude. No lat No Standard Mocean ad request API parameters. lat=-999.99
lon A user's device longitude. No long NoStandard Mocean ad request API parameter. lon=43.72
lsrc Source of latlong. Possible values are:
1 - GPS,
2 - IP derived,
3 - User registration data.
No “1” or “2” No If “lat”/“lon” parameters are specified in the request, “lscr” is set to “1”; else if “lat”/“lon” parameters are detected by IP, “lscr” is set to “2”.
NOTE: If the “lat”/“lon” parameters are changed via translation layer, please, make sure “lsrc” parameter is changed correspondingly.
lsrc=1
iifr** Indicates whether the ad is served in an iFrame or not. Possible values are:
0 - False (by default),
1 - True
No “0” No Default value is used. iifr=0
ntI Native input. Yes* (For native ads) Yes*IAB standard native request JSON. It is used for both GET and POST requests.
NOTE: “ntI” parameter is filled only if text, banner or richmedia are not requested.
NOTE: For POST-requests POST Specific Parameters are used.
For GET-requests see the NtI Object table below.
udid A unique device identifier for the given udidtype.Yes* (for Mobile Applications) Raw, SHA1, MD5 of the following parameters:
idfa, idfv, androidid, macaddress, odin1, androidaid, wuid, waid, adtruth, bkid, drawbridge, udid (raw)
No Standard Mocean ad request API parameters are used. Parameters are checked in the order to the left. At first, raw value of the parameter is checked, then SHA1-hash, and then MD5-hash. If one of mentioned parameters is specified in the request, its value will be used.
If no special device ID parameters passed, the device identifier configurable at the network level, or "udid" is used by default. If no defined, unique device ID will be generated automatically.
NOTE: If the "udid" parameter is changed via translation layer, please, make sure "udidtype" and "udidhash" parameters are changed correspondingly.
udid=1A2B3C4D-00FF-00FF-00FF-1234567890AB
udidtype A unique device identifier for the given udidtype. Type of value provided in the udid parameter mentioned above. Possible values are:
0 - Other
1 - identifierForadvertiser (IDFA)
2 - identifierForvendor (IDFV)
3 - Android_ID
4 - UDID
5 - OpenUDID
6 - SecureUDID
7 - MAC Address
8 - ODIN–1
9 - Android Advertising ID
Yes* (for Mobile Applications and if "udid" is sent) 0, 1, 2, 3, 5, 6, 7, 8 or 9 Yes* (if "udid" is sent) Defined on the base of Unique device ID being used. udidtype=3
udidhash Type of algorithm used for hashing the device identifier provided in the udid parameter mentioned above.
Possible values are:
1 - Raw
2 - SHA1
3 - MD5
Yes* (for Mobile Applications and if "udid" is sent)1, 2 or 3 Yes* (if "udid" is sent) Defined on the base of Unique device ID being used. udidhash=2
NtI Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
verVersion of the Native Markup version in use. Yes "1.0" Default value is used.
adunit The Ad unit ID of the native ad unit. Possible values are:
1 – Paid Search Units;
2 – Recomendation Widgets;
3 – Promoted Listings;
4 – In-Ad (IAB Standatd) with Native Element Units;
5 – Custom/”Can't Be Contained”;
500+ - Reserved for Exchange specific formats.
No NOTE: For POST-requests request to the PubMatic is formed based on native parameter specified in JSON format.
layout The Layout ID of the native ad unit. Possible values are:
1 – Content Wall;
2 – App Wall;
3 – News Feed;
4 – Chat List;
5 – Carousel;
6 – Content Stream;
7 – Grid adjoining the content;
500+ - Reserved for Exchange specific layouts.
No NOTE: For POST-requests request to the PubMatic is formed based on native parameter specified in JSON format.
assetsAn array of Asset Objects. Any bid must comply with the array of elements expressed by the Exchange. Yes NOTE: For GET-requests GET Specific Parameters are used.


Asset Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
idUnique asset ID, assigned by exchange. Typically a counter for the array. Yes Constants, used for GET-requests:

“1” – icon; “2” – main image; “3” – title; “4” – description; “5” – CTA; “6” – rating; “7” – logo

requiredDefines whether the asset is required ("1") or not ("0"). "0" is used by default. Yes* “native_content” Set to “1”, if asset is requested based on “native_content”. Otherwise (any asset is requested or the asset is requested based on limitation parameters), “0” is sent.
titleTitle object for title assets. See Title Object definition below. No Formed on the base of limitation parameters.
imgImage object for image assets. See Image Object definition below. No Formed on the base of limitation parameters.
dataData object for ratings, prices etc. See Data Object definition below. No Formed on the base of limitation parameters.
Title Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
len Maximum length of the text in the title element. Yes title_length Mocean Ad Request API parameter is used. Default value (“25”) is used.
Image Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
typeType ID of the element supported by the publisher. The publisher can display this information in an appropriate format. No “1”, “2” or “3” “1” – for an icon image;
“2” – for a logo image;
“3” – for a main image
wWidth of the image in pixels. No img_size_x,
icon_size_x,
logo_size_x
Mocean Ad Request API parameter is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
hHeight of the image in pixels. No img_size_y,
icon_size_y,
logo_size_y
Mocean Ad Request API parameter is used. Which parameter(s) is used depends on the asset being requested: icon, logo or main image.
Data Object
Ad Feed Object Element Description Req? Source Mocean Parameter Comments
typeType ID of the element supported by the publisher. The publisher can display this information in an appropriate format. Yes “2” – for the description asset;
“3” – for the rating asset;
“5” – for the CTA asset
lenMaximum length of the text in the element’s response. No description_length,
cta_length
Passed for the description and CTA text assets. Mocean Ad Request API parameter is used.
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
RLNClientIpAddr Indicates the IP address of the device which originated the ad request. Yes ip Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.
RLNClientIpAddr=129.78.138.66
User-Agent Indicates the name of the browser. Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
Accept-Language Indicates the list of languages accepted by the browser. Yes (“accept-language” header) HTTP header - “accept-language” - is used. If the header is not sent, “en-US” is used by default. Accept-Language=en-US
Referer Indicates the Reference URL for the ad request. No (“referer" header) HTTP header - “referer” - is used. Referer=www.example.com
Cookies
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
KADUSERCOOKIE For sending user ID No* “KADUSERCOOKIE” (cookie) The “KADUSERCOOKIE” cookie is used.
In case of server to server integration, sending Phoenix user ID as KADUSERCOOKIE cookie is mandatory.
KADUSERCOOKIE=F6FC89B0-54AE-46E1-A5FF-10336B7A8E26
pmoo PubMatic Opt Out Flag No The pmoo equals “true” if optout is true in Mocean system. pmoo=true
fpc First Party Cookie Enabled Flag No “fpc” fpc=true
tpc Third party Cookie Enabled Flag No “tpc” tpc=true
dnt Do Not Track Flag No “dnt” dnt=true
coppa Coppa Compliance Flag No “coppa” coppa=true


PuddingMedia

Logo


Base URL

http://wap.puddingmedia.com/wapFrontend/get_ad?


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
pub_id Publisher ID. A unique identifier for the publisher account. Yes PUDDINGMEDIA_PUB_ID (specified in GUI) pub_id=O334Sddgfhdg56gAA
aff_id Affiliate ID. Yes PUDDINGMEDIA_AFF_ID (specified in GUI) aff_id=default
ad_slot_id Pudding Media slot ID. Yes PUDDINGMEDIA_SLOT_ID (specified in GUI) ad_slot_id=wap
url Url of the page the request come from. Yes url Standard Mocean ad request API parameter. url=http%3A%2F%2Fwww.website.com
devip Device IP address. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

devip=17.148.221.102


Reporo *

Logo


Base URL

http://<activation_code>.reporo.net/api


Base URL parts and scopes
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
activation_codeActivation code provided by Reporo.YesREPORO_CODEYes(specified in GUI)1234-5678-9a01-2abc


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
ip The client ip address (proxies/gateways should be accounted for) Yes ip Yes Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.
ip=80.175.187.1
ua User Agent Yes ua Yes Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
ua=SonyEricssonW600i%2fR7CA+Java%2fSEMC-Java%2f2.0+Profile%2fMIDP-2.0+Configuration%2fCLDC-1.1+UNTRUSTED%2f1.0+UP.Link%2f6.3.0.0.0
z ZoneId assigned by Reporo.
It should be a single zone.
Yes REPORO_Z Yes (specified in GUI)
NOTE: If multiple values are specified, the request won't be sent to Reporo.
z=321

NOTE: For this feed the parameters for translation can be set via the Ad Feed configuration settings in UI.

Rhythm

Logo



Base URL

http://ads.rnmd.net/getAds

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
channelType of ad. "Banner" is used by default. Yes bannerDefault value is used.channel=banner
userA unique user identifier. Yes udidStandard Mocean ad request API parameter.
NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.
user=65bf0f039ed11571d25f0689b1d257b69eefdbd6
appId Application ID. YesRHYTHM_APPID(specified in GUI)appId=66
deliveryType of the ad format returned. Default value = xml Yes xml Default value is used. delivery=xml
Headers
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
user-agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected automatically.
user-agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:15.0) Gecko/20100101 Firefox/15.0.1
x-forwarded-for Yes ipStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
x-forwarded-for=4.28.132.218
X-rnmd-dua Yes RHYTHM_CLIENTNAME
RHYTHM_RNMAPPID
RHYTHM_CLIENTVERSION
Specified in GUI. The header consists of RHYTHM_CLIENTNAME, RHYTHM_RNMAPPID and RHYTHM_CLIENTVERSION separated with dashes.

Rubicon *

Logo


Base Live URL

http://optimized-by.rubiconproject.com/a/api/server.<format>

Base Test URL

http://staged-by.rubiconproject.com/a/api/server.<format>


Base URL parts and scopes
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
format** The type of response, and can be one of:

js - JSON containing a Javascript response (recommended).
html - JSON containing an HTML response, e.g., with tags to wrap Javascript.
jsonp - JSONP response.

Yes “js” Default value is used.js


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
account_idRubicon identifier of the publisher account of the ad to be populated Yes RUBICON_ACCOUNT_IDYes(specified in GUI)account_id=1234
site_idRubicon identifier of the site of the ad to be populated Yes RUBICON_SITE_IDYes(specified in GUI)site_id=23456
zone_idRubicon identifier of the zone of the ad to be populated Yes RUBICON_ZONE_IDYes(specified in GUI)zone_id=123456
size_idRubicon identifier of the size of the ad to be populated Yes RUBICON_SIZE_IDYes(specified in GUI)size_id=43
ipIP address for this call;
note, used to validate the request (and to determine carrier and, optionally, geographic location)
Yes ipYesStandard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.
ip=123.123.4.56
uaUser agent for this call;
note, used to validate the request
Yes* (Required for web) uaYesStandard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected automatically from request headers.
ua=Mozilla%2F4.0+%28compatible%3B+MSIE+6.0
%3B+Symbian+OS%3B+Series+60%2F4.0736.3.2.1
%3B+9712%29+Opera+8.65+%5Ben%5D
device.dpidDevice identifier (not encoded) Yes* (Required for app) idfa, openudid, androidid No Standard Mocean ad request API parameters are used. If one of mentioned parameters is specified in the request, its value will be used.
NOTE: If the "device.dpid" parameter is changed via translation layer, please, make sure the "device.dpid_type" parameter is changed correspondingly.
device.dpid=1A2B3C4D-00FF-00FF-00FF-1234567890AB
device.dpid_typeType of device identifier. One of:
• 1 (IDFA),
• 2 (OpenUDID),
• 4 (Android device ID)
Yes* (Required for app) 1, 2 or 4 No Standard Mocean ad request parameters are used.
'1' will be sent if 'idfa' is used as value of "device.dpid",
'2' - in case of 'openudid',
'4' - in case of 'androidid'.
device.dpid_type=4
rfReference URL for the ad request. No referer No Obtained from the HTTP referer header.rf=www.rubiconproject.com
app.bundleApplication bundle or package name, intended to be a unique ID across multiple exchanges Yes* (Required for app) RUBICON_APP_BUNDLE No (specified in GUI)app.bundle=com.rubiconproject.myapp
app.domain Publisher's highest-level domain No RUBICON_APP_DOMAIN No (specified in GUI) app.domain=rubiconproject.com
app.ver Application version No RUBICON_APP_VER No (specified in GUI) app.ver=5
app.ext.appstoreidAccounts for passing numeric Apple appstore ID for iOS and passing bundle name/Google Play store ID for Android. No RUBICON_APP_STORE_ID No (specified in GUI)app.ext.appstoreid=25927
storeurlAppstore URL for an installed app. No RUBICON_APP_STORE_URL No (specified in GUI)
NOTE: If not specified in the ad request, URL of the app associated with the requested zone will be used.
storeurl=itunes.com/birds
site.domain The site's highest-level domain No RUBICON_SITE_DOMAIN No (specified in GUI)
NOTE: If not specified, URL of the site associated with the requested zone will be used.
NOTE: "site.domain" will be sent only if app parameters ("app.bundle", "app.domain", "app.ver", "app.ext.appstoreid", and "storeurl") are not specified.
site.domain=rubiconproject.com
site.name Site name No RUBICON_SITE_NAME No (specified in GUI)
NOTE: If not specified, name of the site associated with the requested zone will be used.
NOTE: "site.name" will be sent only if app parameters ("app.bundle", "app.domain", "app.ver", "app.ext.appstoreid", and "storeurl") are not specified.
site.name=Rubiconproject
device.os Name of the operating system manufacturer No (Determined by WURFL) No Determined by WURFL on the basis of the "device_os" capability for the device. device.os=Android%201.5
geo.latitude Latitude location of device No lat No Standard Mocean ad request API parameter.
Note: If no “lat” parameter passed, user geolocation latitude will be detected by ip.
NOTE: If the "device.latitude" parameter is changed via translation layer, please make sure the "geo.type" parameter is changed correspondingly.
geo.latitude=37.781493
geo.longitude Longitude location of device No long No Standard Mocean ad request API parameter.
Note: If no “long” parameter passed, user geolocation longitude will be detected by ip.
NOTE: If the "device.longitude" parameter is changed via translation layer, please make sure the "geo.type" parameter is changed correspondingly.
geo.longitude=-122.395362
geo.type Type of location No No If user geolocation (latitude and longitude) is specified in the request, geo.type is set to “1”. Otherwise, geolocation is detected by ip and geo.type is set to “2”. geo.type=1


Headers
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-AgentUser agent Yes ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
user-agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:15.0) Gecko/20100101 Firefox/15.0.1
Authorization The user:password sequence (base-64 encoded strings that are sent on the request in the Authorization header) Yes “Basic RUBICON_USERNAME:RUBICON_PASSWORD”(specified in GUI)
NOTE: Obtained RUBICON_USERNAME:RUBICON_PASSWORD string is base-64 encoded.

NOTE: For this feed the parameters for translation can be set via the Ad Feed configuration settings in UI.

SeventyNine *

Logo



Base URL

http://r.platform.seventynine.mobi/www/delivery/79spcjs.php?

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
idPublisher ID provided by Seventynine.YesSEVENTYNINE_PUBLISHER_ID(specified in UI)id=285
category The category sent will be used for targeting.YesSEVENTYNINE_CATEGORY(specified in UI)category=networks
secretkeySecret API Key provided by Seventynine upon integration.YesSEVENTYNINE_SECRET_KEY(specified in UI)secretkey=f457c545a9ded88f18ecee47145a72c0
sourceTypeParameter which can have any of the following values (www, mobile, bb, apk, java, sis, wp7). uaDetected automatically on the base of device user agent form “ua” parameter received. NOTE: If no “ua” parameter passed, it will be detected from the 'device_os'.sourceType=java
ipThis should hold end-user's IP address. ipStandard Mocean ad request API parameter. NOTE: If no “ip” parameter passed, client IP address will be detected automatically.ip=76.116.128.151
zoneid If available, output will be shown for this zone only.NoSEVENTYNINE_ZONE_ID(specified in UI) zoneid=792
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
User-Agent Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

User-Agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
X-Forwarded-For No
X-OperaMini-Phone-UA No
x-apn-id No
x-ggsnip No
x-sgsnip No
x-up-calling-line-id No
x-nokia-bearer No
x-nokia-imsi No
x-imsi No
x-nokia-msisdn No
x-msisdn No
x-nokia-prepaidind No
x-original-user-agent No
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gendergender
m male
f female
size_x screenWidth
size_y screenHeight

Smaato *

Logo


Base URL

http://soma.smaato.net/oapi/reqAd.jsp?

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
apiver**The version of the API.Yes"415"YesDefault value is used.apiver = 415
adspace AdSpaceId (assigned by Smaato). ID “0” can be used for unattended testing purpose. Yes SMAATO_AD_SPACE Yes (specified in GUI) adspace=123456789
pub PublisherId (assigned by Smaato). ID “0” can be used for unattended testing purpose. Yes SMAATO_PARTNER_ID Yes (specified in GUI) pub=4711
devip The IP address of the requesting mobile device (this may differ from the request IP e.g. if a publisher’s web server is between the mobile device and SOMA). Yes* (‘no’ if the device requesting directly) ip No Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

devip=17.148.221.102
device The user agent of the device’s default browser. Yes ua No Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

device=Mozilla%2F5.0%20(Linux%3B%20U
%3B%20Android%202.2.1%3B%20en-us%3B
%20Nexus%20One%20Build%2FFRG83)%20
AppleWebKit%2F533.1%20(KHTML%2C%20
like%20Gecko)%20Version%2F4.0%20Mobile
%20Safari%2F5331
response** Desired format of the response. “XML” or “HTML” (must be XML for Video). Yes "xml" Yes Default value is used. response=xml
format The format of the ad to be returned:
  • all: Image, text or rich media (strongly recommended!!)
  • img: Any image format
  • txt: Text
  • richmedia: Rich media;
  • video: A video clip (Note: “response” must be “XML”).
Yes SMAATO_FORMAT, type YesThe parameter is specified in UI. If not specified, the standard Mocean ad request API parameter type is used. format=txt
formatstrict When the format parameter is handled as “strict” only the desired format will be delivered. If it’s not strict, an alternative format might be delivered, if the desired format is not available. No"true" No The default value (TRUE) is used. formatstrict=true
mraidverMRAID version:
  • 0 - None
  • 1 - MRAID 1.x
  • 2 - MRAID 2.x
"0"NoDefault value is used mraidver=0
coppa “0” will indicate that your content should not be treated as child-directed for purposes of COPPA.
“1” will indicate that your content should be treated as child-directed for purposes of COPPA.
Yes* (traffic from the US) SMAATO_COPPANo (specified in GUI) coppa=0
iosadid Apple’s Advertising Identifier. Yes* (for iOS applications) idfaNoStandard Mocean ad request API parameter.iosadid=68753A44-4D6F-1226-9C60-0050E4C00067
iosadtracking Apple’s advertisingTrackingEnabled Property (false = user has decided against tracking – this is the opposite way around as on Android) Yes* (for iOS applications) idteNoStandard Mocean ad request API parameter.
NOTE: The parameter will be sent only if "idfa" is specified.
iosadtracking=true
googleadid Google Android Advertising ID. Yes* (for Android Applications) androidaidNoStandard Mocean ad request API parameter. googleadid=719ece9e-5404-4883-a0ba-6e7ac689291e
googlednt Android limit ad tracking preference (true = user has decided against tracking – this is the opposite way around as on iOS) Yes* (for Android Applications) idteNoStandard Mocean ad request API parameter.
NOTE: The parameter will be sent only if "androidaid" is specified.
NOTE: "idte" and "googlednt" have opposite values. idte=true corresponds to googlednt => false and vice versa.
googlednt=false
androidid The Android device’s Android ID (Settings.Secure.ANDROID_ID) Yes* (for Android Applications)androididNoStandard Mocean ad request API parameter.androidid=9774d56d682e549c
cityThe city the user is located in.NocityNoStandard Mocean ad request API parameter.
NOTE: The value of standard parameter consists of two parts separated with ", ". The first part will be sent as city value.
city=London
width Width of the ad space. Recommended for applications. On mobile sites the screen width can be used instead. No size_x NoThe priority of defining size values to be sent to the 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters (“size_x”, “size_y”)
  3. Zone settings
width=320
height Height of the ad space. Recommended for in-application advertising. On mobile sites the screen height can be used instead. No size_y NoThe priority of defining size values to be sent to the 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters (“size_x”, “size_y”)
  3. Zone settings
height=50
gps GPS coordinates of the user’s location. Latitude and longitude in decimal degrees format, comma separated. No lat, long No Standard Mocean ad request API parameters “lat” and “long” (comma-separated).gps=37.771008,-122.41175
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
x-mh-{*}HTTP headers.Yes (request headers received) HTTP headers.
NOTE: Forbidden headers won't be sent.


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
qs qs
carrier carrier
keywords kws
age age
birthday dateofbirth
gender gender
region region
zip zip
ethnicity ethnicity
black black
white white
eastindian other
middleeastern middleeastern
asian oriental
latino latino
pacificislander other
nativeamerican other
mixed other
other other

SoMo Audience *

Logo


Base Live URL

http://m.mobilepassback.com/md.request.php

Base Test URL

http://p.mobilepassback.com/md.request.php

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
s This is the Placement / Zone ID Provided by SoMo Audience.YesSOMOAUDIENCE_PLACEMENT_IDYes(specified in GUI)s=f1f6b8c24f19ef1745978cb03b5aba52
u User Agent (URL-encoded) Yes ua YesStandard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected automatically.
u=Mozilla/5.0%20(Macintosh;%20Intel%20Mac%20OS%20X%
2010_8_4)%20AppleWebKit/536.30.1%20(KHTML,%20like%20Gecko)
%20Version/6.0.5%20Safari/536.30.1
p Page Referrer. The URL the end user is on when the ad request occurs. (URL-encoded) Yes url NoStandard Mocean ad request API parameter.
NOTE: If not specified in the ad request, URL of the site associated with the requested zone will be used.
p=http://www.yoursite.com/page1.html
i The IP address the user’s request is coming from. Only valid with rt values of “xml” and “html”. No ip No Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
i=8.8.4.4
rt** The type of return value being requested. Yes “html” YesDefault value is used. rt=html
random A random number generated with each request to ensure at least part of the URL is unique Yes YesRandom number from 0 to 1. random=0.02287234249524772


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
lat latitude
long longitude
dma dma
country geo_country
region geo_region
zip geo_postal_code
openudid o_openudid
idfa o_iosadvid
age age
gender gender
m male
f female
ethnicity ethnicity
black african-american
white white
eastindian other
middleeastern other
asian asian
latino hispanic
pacificislander other
nativeamerican other
mixed other
other other


StartApp *

Logo


Base URL

http://s2s.startappnetwork.com/s2s/1.3/ads

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
partner StartApp Partner ID, as provided by StartApp. Yes STARTAPP_PARTNER Yes (specified in GUI) partner=987654321
token Security token as provided by StartApp. Yes STARTAPP_TOKEN Yes (specified in GUI) token=12hgt78564
segId segId is the appId created in the StartApp publishers' portal. It represent a line of products that can be used for segments analytics and reporting on the StartApp portal. Yes STARTAPP_SEGID Yes (specified in GUI) segId=12365479
ua The user-agent identifies the user device or browser. Yes ua Yes Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
ua=Mozilla/5.0 (Linux; U; Android 4.0.3; de-ch; HTC Sensation Build/IML74K) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30
adType** Requested ad format.
Possible values:
0 – Banner;
2 – Rich text (Title, Desc, Rating, Image) + 1200x628 img;
3 – Full Page Interstitial.
Yes 2 Yes Default value is used. adType=2
dipThe device IP. Yes ip Yes Standard Mocean ad request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
dip=82.25.55.73
adw The available width in pixels for the ad.
Supported width and height (adh):
1200x628;
340x340;
150x150;
100x100;
72x72.
Yes size_x Yes Standard Mocean ad request API parameter.
The priority of selecting width values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings
  4. WURFL (on the basis of max available width for the given device)

The largest supported width within the requested width is returned.

adw=1200
adh The available height in pixels for the ad.
Supported width (adw) and height:
1200x628;
340x340;
150x150;
100x100;
72x72.
Yes size_y Yes Standard Mocean ad request API parameter.
The priority of selecting height values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings
  4. WURFL (on the basis of max available height for the given device)

The largest supported height within the requested height is returned.

adh=628
prod Product identifier. Android package name or iOS bundle name or site domain name. Yes STARTAPP_PRODYes (Specified in GUI) prod=com.foobar.app
partnerDId Device Id as represented in your system. Yes udid Yes Standard Mocean ad request API parameter. NOTE: The device identifier configurable at the network level, or "udid" is used by default. If no defined, unique device ID will be generated automatically as a hash of "ip" and "ua". partnerDId=12987ab6
advId Unique advertising identifier:
Android: Google Advertising Id;
iOS: IDFA.
No idfa, androidaid No Standard Mocean ad request API parameter. advId=17e3ce3518af76e4
dId Android ID. No androidid No Standard Mocean ad request API parameter. dId=17e3ce3518af76e4
test Indicates whether the request is part of a test or not. Impressions and click are not logged and are to be used for monitoring and testing purposes. Default value is “false”.No “true” or “false” No Standard Mocean ad request API parameter. NOTE: If the test mode setting is enabled for the requested zone, “true” will be sent irrespective of the ‘test’ ad request parameter value. test=false
locGPS location – latitude, longitude format. Nolat, longNo Standard Mocean ad request API parameters.
NOTE: If no “lat” and “long” parameters passed, "loc" will not be sent.
loc=-999.99,-999.99
adsNum** Number af ads in response (max). Requests up to 20 ads are allowed. If more than 20 ads are requested, only 20 will be retrieved. Default value = 1. No “1” No Default value is used. adsNum=1
sizeFlag Append sizeFlag=“true” to receive 1200x628 image. No “true” No Default value is used. NOTE: sizeFlag is sent if "adw" equals to 1200 and "adh" equals to 680 sizeFlag=true
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
gender gen
m 0
f 1
age age

Strikead

Logo


Base URL

http://rtb.strikead.com/mojiva_bid

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
sid Site/app unique id Yes STRIKEAD_SITE_ID (specified in GUI) If not specified, id of site is sent. sid=32990
pid Publisher unique id Yes STRIKEAD_PUBLISHER_ID (specified in GUI) If not specified, user id is sent. pid=p123
did Device unique ID, can be SHA1 hashed Yes udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

did=7878137ed8787289
ua Full browser user agent string; for apps, the following OS parameters are needed: 1) Device OS 2) OS Version 3) Manufacturer 4) Model * Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

ua=BlackBerry8100%2F4.2.0+Profile%2FMIDP-2.0+ Configuration%2FCLDC-1.1+VendorID%2F100
ip User/device IP address Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=17.148.221.102
width Ad space width in pixels Yes size_x Standard Mocean ad request API parameter.

NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.

width=350
height Ad space height in pixels Yes size_y Standard Mocean ad request API parameter.

NOTE: If no “size_y” parameter passed in, the height of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.

height=50
min_bid Min bid price No STRIKEAD_MIN_BID (specified in GUI) min_bid=0.5
keywords Any keywords relevant for app / site context. No keywords Standard Mocean ad request API parameter. keywords=news,election
country User/device country. No ip

or mcc (if passed) or country (if passed)

At first, a country is determined by IP address of the request.

Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.

country = US
loc Lat and long – for GPS enabled apps – not needed if derived from geo IP DB/ No lat, long Standard Mocean ad request API parameters “lat” and “long” (comma-separated).

NOTE: If no “lat” and “long” parameters passed, user geolocation will be detected automatically.

loc=37.771008,-122.41175

Tapad Basic

Logo


Base URL

http://bidders.rtb.tapad.com/mocean/bid

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
adSize The size of the creative on the format WIDTHxHEIGHT, e.g “320x50”. Yes 320x53 Default value is used.

NOTE: if the default value is more than max available width and height for the given device, nothing will be returned.

adSize=320x53
contextType The display context type, “site” or “app”. Yes TAPAD_CONTEXT_TYPE (specified in GUI) contextType=app
contextId Value identifying the context that the impression is going to be displayed in. This is typically a site or application ID and must be unique to the 3rd party. In case of a website, this value may be the top level domain name of the site, e.g “huffingtonpost.com”. YesTAPAD_CONTEXT_ID (specified in GUI) contextId=huffingtonpost.com
ip The ip address of the client requesting the ad. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=17.148.221.102
userAgent The user agent header of the client requesting the ad, e.g “Mozilla 5.0. Yes ua Standard Mocean ad request API parameter. NOTE: If no “ua” parameter passed, user agent will be detected automatically. userAgent=Mozilla%2F5.0+%28Windows +NT+6.1%3B+WOW64%3B+rv%3A2.0.1%29 +Gecko%2F20100101+Firefox%2F4.0.1
cpm The CPM price of this impression, e.g “0.50”. Yes TAPAD_CPM (specified in GUI) Cpm=0.50
min_price Min bid price. No TAPAD_MIN_PRICE (specified in GUI) min_price=0.10
jsSupport If the display context supports Javascript, this value should be “true”. No type If the standard Mocean ad request API parameter “type” is passed requesting a rich-media ad (“4”), jsSupport will be sent as true. Otherwise the parameter won't be sent. jsSupport=true
uid Value identifying the user that the impression is going to be served to. No udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

u-id=5C5892AE-F73D-4363-B03254C
zip The zip code of the user’s home address. No zip Standard Mocean ad request API parameter. zip=38485
country The international country code of user’s home address. No ip

or mcc (if passed) or country (if passed)

At first, a country is determined by IP address of the request.

Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.

co=US
latLon The current latitude and longitude of the client device. No lat, long Standard Mocean ad request API parameters “lat” and “long” (comma-separated).

NOTE: If no “lat” and “long” parameters passed, user geolocation will be detected automatically.

latLon=37.771008,-122.41175

TapIt *

Logo


The API Integration document is at http://support.tapit.com/entries/21429148-web-development-ad-requests-api

Base URL

http://r.tapit.com/adrequest.php

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
zoneThe id of the zone of publisher site. YesTAPIT_ZONE (specified in GUI)zone=124966
ipThe IP address of the carrier gateway which the device is connecting over. Being passed directly, it redefines the IP address the request has been received from.YesipStandard Mocean request API parameter.
NOTE: If no “ip” parameter passed, client IP address will be detected automatically.
ip=173.3.77.115
uaThe browser user agent of the device making the request. Being passed directly, it redefines the value retrieved from ’User-Agent’ header field.YesuaStandard Mocean request API parameter.
NOTE: If no “ua” parameter passed, it will be detected automatically.
ua=SCH-R211 UP.Browser/6.2.3.8 (GUI)MMP/2.0
udid MD5-hashed unique device id. UDID is used for installation and conversion tracking.Yes (Required for applications)udidStandard Mocean request API parameter.udid=476fea48797b7336dabce7b979e8047a
modeUsed to retrieve test ads.NotestStandard Mocean request API parameter; is used only for unit tests. mode=test
wRequired width of ad creative. It’s used together with ’h’ parameter.Nosize_xStandard Mocean ad request API parameter.
NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.
w=320
hRequired height of ad creative. It’s used together with ’w’ parameter.Nosize_yStandard Mocean ad request API parameter.
NOTE: If no “size_y” parameter passed in, the height of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.
h=50
latUser location latitude value (given in degrees). It’s used together with ’long’ parameter.NolatStandard Mocean ad request API parameters “lat”.

NOTE: If no “lat” parameter passed, "lat" will not be sent.

lat=40.71435
longUser location longitude value (given in degrees). It’s used together with ’lat’ parameter.NolongStandard Mocean ad request API parameters “long”.

NOTE: If no “long” parameter passed, "long" will not be sent.

long=-74.00597
format**The format of the ad response. The ad server will default to the format required for our SDK.
*if a non-SDK integration is done, then publishers should specify format=html to ensure the desired response.
Yes*htmlDefault value is used.format=html
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
size_x w
size_y h

Tapjoy

Logo


Base URL

https://ws.tapjoyads.com/display_ad/webview

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
app_id The Application ID Yes TAPJOY_APP_ID (specified in GUI) app_id=bfc9c8ab-9a47-48ea-984e-7057ba52f2fb
udid The UDID/IMEI of the device Yes udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

udid=-75714225b0d12c60cde8df7d66c4b0da768151b4
timestamp Current time (number of seconds since January 1st, 1970) Yes (current date and time) Replaced with the current time, in seconds. timestamp=1310672254
verifier SHA256 hash computed by taking the appID, UDID, timestamp, and app secret key separated by colons - (app_id + ":" + udid + ":" + timestamp + ":" + secret_key) Yes :(udid):(current time):(TAPJOY_SECRET_KEY) Appid and secret key parameters specified in Ui, 'udid' standard Mocean ad request API parameter and current time value given in seconds separated by ':' . verifier=af5590e8016a5e6812aa1f48c2b3ee168fd784f90a60819d54b88941a9b7c25d
publisher_user_id By default, this is the UDID/IMEI if using Tapjoy Managed Currency. This is otherwise set by the publisher. Yes TAPJOY_PUBLISHER_USER_ID Standard Mocean ad request API parameter.
size The size of the banner ad to be returned. Can be one of the following: '320x50', '640x100', '768x90' Yes size_x x size_y Standard Mocean ad request parameters “size_x” and “size_y” are used .

NOTE: If no size parameters passed in, the size of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.

size=320x50

TeleNav

Logo



Base URL

http://api.telenav.com/tnapi/services/ads/searchImageAds

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
apiKey Developer key issued by TeleNav. Yes TELENAV_API_KEY (specified in GUI) apiKey=AQAAATL0b8gYf
visitorID Globally unique identifier for each visitor in the publisher system. Yes udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically by zone default ad sizes (if set) or by device.

visitorID=968654675476456456546544665
query Search term OR category name Yes keywords Standard Mocean ad request API parameter. query=pizza
searchLocation Search location. Format – Lat:Long Yes lat, long Standard Mocean ad request API parameters “lat” and “long” (separated by “:”).

NOTE: If no “lat” and “long” parameters passed, user geolocation will be detected automatically.

searchLocation=37.77
imageSize Yes size_x x size_y Standard Mocean ad request parameters “size_x” and “size_y” are used .

NOTE: If no size parameters passed in, the size of the ad returned will be determined automatically.

imageSize=300x50
imageFormat Yes jpg Default value is used. imageFormat=jpg
responseDataFormat XML or JSON (default = XML). No xml Default value is used. responseDataFormat=xml

Todacell *

Logo


Base URL

http://ads.todacell.com/adserver/getad

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
pubid Publisher identifier provided by Todacell: 0 is default value for testing to be replaced by production value later. Yes TODACELL_PUBID (specified in GUI) pubid=0
ua URL encoded User Agent of the user’s device. Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

ua=Mozilla/5.0 (Linux; U; Android 2.3; en-us; SGH-T989D Build/GINGERBREAD) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1
uaddr IP address of the user’s device. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

uaddr=17.148.221.102
mode Specifies whether the request is being made in live (“l”) or test (“t”) mode. Yes test Standard Mocean ad request API parameter.

NOTE: If not passed in, the live mode ('l') is used be default

mode=l
version The version of the format of the ad request Yes 2.0 Default value is used. version=2.0
adspaces Comma‐separated list of ad positions: top, middle, bottom, preroll, postroll, interstitial Yes TODACELL_ADSPACES (specified in GUI) adspaces=top
siteid Site identifier provided by Todacell. Can be used if publisher has multiple sites or applications. No TODACELL_SITEID (specified in GUI) siteid=312
adformat The comma‐separated list of the formats of the ads to be returned :“img” – image, “txt” – text, “combo” – combo ad,”html” – any valid html Yes type Standard Mocean ad request API parameter.

If “type=-1”, “html” will be passed. If “type=1”, adformat will be set to “txt”; If “type=2”, adformat will be set to “img”; If “type=1+2” or “type=1+2+4”, adformat will be set to “combo”.

adformat=html,txt,img,combo
uid The unique identifier of the user within the publisher’s site or application No udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

uid=2625fded0cc5dc4ba7feeaa88fac49470ca38ca4
markup** Specifies the format of the response returned by ad server. If no passed, html is used. No xml Default value is used. markup=xml
resaddr The URL of the publisher’s web page. No url Standard Mocean ad request API parameter. resaddr=http%3A%2F%2Fmobi.todacell.com%2F
long Longitude of user device No long Standard Mocean ad request API parameter. long=-71.0602
lat Latitude of user device No lat Standard Mocean ad request API parameter. lat=37.65057
-h-{.*} You should pass Todacell ad server all the HTTP headers that your web/application server receives from the user’s mobile device except for custom headers and the User‐Agent header. Headers are passed as extra parameters of the ad request. The name of the headers must have the ‐h‐ prefix. No header The content of the headers must be encoded with URL encoding. ‐h‐x‐forwarded‐for=212.183.134.65
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gender gender
adcategory adcategory

Verve Wireless

Logo



Base URL

http://adcel.vrvm.com/banner

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
ac A single consolidated code can be created to represent all of the above 3 values with 1 request parameter. Varying optional parameters can also be represented with this consolidated code. Requests can either be made with 'p', 'b', and 'c' OR 'ac'. 'ac' is preferred over using the other 3 parameters. Yes VERVE_AC Yes (specified in GUI)The parameter may be not specified, but in this case 'p', 'b' or 'c' are required. ac=
p Portal keyword. This is a Verve-assigned value identifying the distribution portal on which the advertisement is being displayed. Yes VERVE_P Yes (specified in GUI) p=def
b Partner (publisher) keyword. This is a Verve-assigned value identifying the publisher of the mobile content.Yes VERVE_B Yes (specified in GUI) b=dailyplanet
c Content category ID. This is an integer which identifies the type of content available on the page for which an ad is requested. Yes VERVE_C Yes (specified in GUI) c=87
ip Device’s IP address. This should be the IP address of the device on which the advertisement is to be displayed. Yes ip Yes Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

ip=17.148.221.102
ui A unique user identifier. If the requester has a reliable identifier for the mobile user, it may include the value with this parameter. No idfa, idfv, androidid, androidaid No Standard Mocean ad request API parameters are used. ui=asdfgasdew4234545
uis Code indicating the source or type of ID passed in the "ui" parameter. (Ignored when the "ui" parameter is not present.) By default and in the absence of this parameter, the user identifier is assumed to be a randomly-generated ID. No idfa, idfv, androidid, androidaid, idte No Standard Mocean ad request API parameters are used. The following parameter values can be sent:
"a" if idfa is specified (or "ar" if determined by idte), "av" if idfv is specified, "dc" if androidid is specified, "g" if androidaid is specified (or "gr" if determined by idte)
uis=454rgsadgsgsfgsdfg
adunit Ad Unit. Used to retrieve an ad specifically crafted for the target medium. No VERVE_ADUNIT *Yes (specified in GUI)The parameters are sent together. If one of the parameters is not specified, the system will try to determine the size values automatically.
•If "adunit" is set as 'mma', "size" can be determined from UI, from the request or by zone default settings.
•If "adunit" is not 'mma', "size" can be determined from UI, from the request, by zone default settings or by WURFL.
•If "adunit" and "size" are not specified in UI but "size" can be determined from the ad request or by default size zone settings, "adunit" is set to 'mma'. The most appropriate mma size option will be used as ad size.
*NOTE: The request is determined as invalid:
•if "size" is specified in UI but "adunit" is not;
•if "adunit" is not 'mma' and "size" is not determined. '
adunit=mma
size Specifies the size of the ad you want returned. Required for non-MMA banners or where an explicit mma size is required. The following options are:
•for mma - 320*50, 300*50, 216*36;
•for banner - 728x90, 300x250;
•for inter - 320x416, 300x250;
•for sponsor - 728x90, 320x50, 300x250, 300x50.
No VERVE_SIZE *Yes size=728x90
pos Position in which ad is to appear on page. Acceptable values are "top","inline", and "bottom" No VERVE_POS No (specified in GUI) pos=top
dguid Device guid. A Verve-assigned identifier assigned to the device type making the request. It is used to override the “User-Agent” HTTP request header. If blank, omitted, or an unknown value, the “User-Agent” HTTP request header is used to identify the device type. No VERVE_DGUIDE No (specified in GUI)
pm Partner module ID. A partner module is a content container associated with one or more feeds. No VERVE_PM No (specified in GUI) pm=126
db Display block ID. The display block distinguishes where in a mobile site the ad is being displayed. This identifier is a Verve-assigned integer. No VERVE_DB No (specified in GUI) db=484
ll Latitude and longitude of the user, encoded. The location of the user at the time of the advertising request. No lat, long No Standard Mocean ad request API parameters “lat” and “long” (separated by “,”).

NOTE: If no “lat” and “long” parameters passed, "ll" will not be sent.

ll=37.771008,-122.41175
ou (“Origin URL”) The full (encoded) URL (including any request parameters) of the page on whichthe advertisement is to be displayed. No url No Standard Mocean ad request API parameter. ou=http%3A%2F%2Fm.dailyplanet.com %2Fdailyplanet%2Fdb_484%2F contentdetail.htm%3Fcontentguid%3DskH0uZOG%26 detilindex%3D0%26pn%3D0%26ps%3D2
Headers
Ad Feed API Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
user-agent User agent No ua Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
user-agent=Mozilla/5.0 (Windows NT 6.1; WOW64; rv:20.0) Gecko/20100101 Firefox/20.0
accept-language No HTTP header.
msisdn No HTTP header.
referer No HTTP header.
x-up-subno No HTTP header.
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gender gender
zip zip

Voodoovox *

Base URL

http://mocean.incallads.com/xml/start.jsp

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
key The source key. Yes VOODOO_KEY (specified in GUI) key=V0FCOD5FEV
version The major version of the API, currently 4. Yes 4 Default value is used. version=4
language The language of the caller. Possible values: english, spanish, mandarin. No isolang Mocean ad request API parameter. language=english
phonetype The phone type of the caller. Possible values: landline, cell (default), payphone. If no parameter passed in, it will be detected from the callerID. No cell Default value is used. phonetype=cell
carrier The carrier of the caller if phone type is cell. No carrier Standard Mocean ad request API parameter. NOTE: If no parameter passed in, it will be detected automatically.carrier=other
ipIP address of User/CallerNoip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=4.28.132.218
country A country of the caller. No ip or mcc (if passed) or country(if passed)At first, a country is determined by IP address of the request.
Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.
country=US
areacode The 3-digit area code of the caller. If not provided, the parameter value is detected from callerID.Noarea Standard Mocean ad request API parameter. areacode=212
bannerHeight Ad banner height. No size_yStandard Mocean ad request API parameter.

NOTE: If no “size_y” parameter passed in, the width of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.

bannerHeight=600
bannerWidhtAd banner wight.Nosize_xStandard Mocean ad request API parameter.

NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.

bannerWight=800
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
gender gender

Vserv *

Logo



Base URL

http://rq.vserv.mobi/getad.php

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
adspot Alphanumeric zone key from Vserv account. Yes VSERV_ZONEIDYes (specified in GUI) adspot=dgss139
ua Requesting device (Client) User-Agent Yes uaYes Standard Mocean ad request API parameter.
NOTE: If no ‘ua’ parameter passed, user agent will be detected automatically.
ua=Mozilla/5.0%20%28iPhone;%20CPU%20iPhone%20
OS%206_0%20like%20Mac%20OS%20X%29%20
AppleWebKit/536.26%20%28KHTML,%20like%20Gecko%29
%20Mobile/10A5376e
sourceThe site/app identification. For e.g. HTTP header HOST (for sites) / Packagename / Bundle identifier / Product ID (for apps) Yes urlYes Standard Mocean ad request API parameter.
NOTE: If not specified in the ad request, URL of the app/site associated with the requested zone will be used. If URL is not detected, the ‘source’ parameter will be sent as the app/site name followed by its ID.
source=example.com
ip Client originating IP address Yes ipYes Standard Mocean ad request API parameter.
NOTE: If no ‘ip’ parameter passed, client IP address will be detected from request headers.
ip=212.58.251.195
ff Client Request HTTP header X-FORWARDED-FOR HTTP Yes request header, ipNo User IPs obtained from the ‘x-forwarded-for’ header and the Mocean ad request parameter (‘ip’) separated by a comma and a space. ff=4.28.132.218, 68.232.37.232
hv Client Request HTTP header VIA Yes request headerNo The ‘via’ header is used. hv=1.0_fred
tmIndicates Test mode [For test mode on this should be set to “1”].NotestNo Standard Mocean ad request API parameter.
NOTE: If the test mode setting is enabled for the requested zone, “1” will be sent irrespective of the ‘test’ ad request parameter value.
tm=1
advidiOS/Android Advertiser Id. No androidaid, idfa No Standard Mocean ad request API parameter.advid=3D1E2DFA89-496A-47FD-9941-DF1FC4E6484A
wid Device Unique Id (Applicable for Windows Phone)No wuidNo Standard Mocean ad request API parameter.wid=002ebf12a125-5ddfa73967c3c5d20177
sw Indicates screen width No (determined by WURFL)No Determined by WURFL on the basis of the ‘max_image_width’ and ‘resolution_width’ device capabilities.sw=320
sh Indicates screen height No (determined by WURFL)No Determined by WURFL on the basis of the ‘max_image_height’ and ‘resolution_height’ device capabilities.sh=50
sbdIndicates ‘strict banner dimension’. If this parameter is present, Vserv will only returned the specified ad size OR would send back no-fill.
Supported sizes:
1024x600;
800x480;
728x90;
600x1024;
480x800;
480x320;
320x480;
320x188;
320x50;
300x250;
300x50;
240x340;
240x240;
216x36;
168x28;
128x115;
120x20
No size_x, size_yNo Standard Mocean ad request API parameters (‘size_x’ and ‘size_y’) are used to determine appropriate value for ad sizes. The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings

The largest supported size within the requested size is returned.

sbd=320x50


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
url ru
lat lat
long lon
mcc cc
mnc nc
area lac
languagelc
Englishen
Frenchfr
Spanishes
Portuguesept
Italianit
Russianru
Germande
Greekel
Vietnamesevi
Chinese Traditionalzh
Chinese Simplifiedzh
Czechcs
Arabicar
Polishpl
Dutchnl
Lithuanianlt
Turkishtr
Serbiansr
Romanianro
Chinesezh
Filipinotl
Belarusianbe
Croatianhr
Hungarianhu
Danishda
Ukrainianuk
Parisian Frenchfr
Albaniansq
Bulgarianbg
Zuluzu
ageag
birthday dob
gender gn
m M
f F

Webmoblink

Logo


Base URL

http://www.webmoblink-api.mobi/API2/MobileAPI.aspx

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
pid Publisher ID assigned by Webmoblink. You can get your pid from the Webmoblink publisher site. Yes WEBMOBLINK_PID No (specified in GUI) pid=10023
mo Operating mode.

Possible values: TEST, LIVE LIVE is used by default.

Yes WEBMOBLINK_MO No (specified in GUI) mo=LIVE
ua The user agent of the device’s default browser. Yes ua NoStandard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

ua=SAMSUNG-GT-S5603/S5603DDIG1+SHP/VPP/R5+Jasmine/0.8+Qtv5.3+SMM-MMS/1.2.0+profile/MIDP-2.1+configuration/CLDC-1.1
ip The IP address of the requesting mobile device. Yes ip No Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=17.148.221.102
cc Two-character for the country code of the requesting mobile device. No ip

or mcc (if passed) or country (if passed)

No At first, a country is determined by IP address of the request.

Then, if “mcc” parameter is passed in, it overrides country determined by “ip”. Then, if “country” parameter is passed in, it overrides the value determined by “ip” or “mcc”.

cc=US
result Desired format of the response. Possible values: XML, HTML, WML, XHTML. Yes html No Default value is used. result=html
format The formats of the ads to be returned. Possible values:

IMG: Any image format with text
TXT: Only text
ANY: Image with text or only text

Yes type Yes Standard Mocean ad request API parameter.

If “type=1”, format will be set to “TXT”; If “type=2”, format will be set to “IMG”; If “type=-1”,“type=1+2” or “type=1+2+7”, format will be set to “ANY”.

format=IMG
channels Ad type according to the channel. You must specify values for the channels separated by commas.

1 - Arts, Movie, TV and Entertainment 3 - News, Weather, Business, Travel, Sports and World Affairs 10 - Games and Video 11 - Health and Fitness 14 - Ringtones, Portals, Music and Photos 16 - Personals 20 - Communications and Technology 23 - Women and Home

No WEBMOBLINK_CHANNELS No(specified in GUI) channels=1,3,11

WHERE *

Logo


Base URL

http://ad.where.com/jin/spotlight/ads?

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
pubid The publisher id assigned by WHERE. Yes WHERE_PARTNER_ID (specified in GUI) pubid=test
platformid A platform number. Platforms are device groups, ex: unknown, android, BlackBerry, palm, WP7. Yes WHERE_PLATFORMID Platform value specified in UI.

NOTE: If not specified, the platform is detected automatically.

platformid=53
profileid A unique id of the user or the mobile device. Yes (recommended) udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

profileid=4A1F5BB9B461C695B3F6D648BA416A06
profiletype 0 Default value is used. profiletype=0
lat The latitude of the current user location. No lat Standard Mocean ad request API parameter.

NOTE: If no “lat” parameter passed, "lat" will not be sent.

lat=37.65056
lng The longitude of the current user location. No long Standard Mocean ad request API parameter.

NOTE: If no “long” parameter passed, "lng" will not be sent.

lng=-71.0601
width The screen width of the mobile device or the web page width. This value is used to determine the best fitting size of the banner images. No size_x Standard Mocean ad request API parameter.

NOTE: If no “size_x” parameter passed in, the width of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.

width=320
height The screen height of the mobile device. This value is used to determine the best fitting size of the banner images. No size_y Standard Mocean ad request API parameter.

NOTE: If no “size_y” parameter passed in, the height of the ad returned will be determined automatically by zone default ad sizes (if set) or by device.

height=480
placement An indication of where on the page the ad is positioned. This value is for optimization and reporting purpose. No WHERE_PLACEMENT (specified in GUI) placement=bottom
zip The zip code of the current user location. No zip Standard Mocean ad request API parameter. zip=002114
city The city of the current user location. No city Standard Mocean ad request API parameter.

NOTE: The value of standard parameter consists of two parts separated with ", ". The first part will be sent as city value.

city=Boston
state The state of the current user location (2-letter abbreviation or state name) No city Standard Mocean ad request API parameter.

NOTE: The value of standard parameter consists of two parts separated with ", ". The second part will be sent as state value.

state=MA
Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
birthday age
yyyy-MM-dd yyyy
gender gender

xAD *

Logo



The API Integration document is at http://cdn.xad.com/developers/rest/local_display/

Base Live URL

http://display.xad.com/rest/banner

Base Test URL

http://test.xad.com:8085/rest/banner


Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
v** Version of xAD API to be used. Yes “1.2.7” Yes Default value is used. v=1.2.7
k Provided by xAD to uniquely identify the publisher and grant access to the system. Yes XAD_K Yes (specified in GUI) k=_qBSopIE_U1qkxgiCr-z2iL9VfYwB7CFo6p6i-Vn3p9aQ7RAEgCkMYUQnMlPu9sv
devid Identification of the end users browser. It is the user agent of the browser. Yes ua Yes Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected from request headers.

devid=Mozilla%2F4.0+%28compatible%3B+MSIE+6.0
%3B+Symbian+OS%3B+Series+60%2F4.0736.3.2.1
%3B+9712%29+Opera+8.65+%5Ben%5D
ip IP address of the client where listings are displayed.Yes ip YesStandard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

ip=127.0.0.1
cat The categories that best represents the publisher application or mobile site. Only IAB (Tier1 & Tier2), iTunes & Google Play category taxonomies are accepted. Please apply url encoding where necessary.Yes XAD_CATEGORY Yes(specified in GUI)
NOTE: Please do not pass multiple categories. Only one category is supported in Mocean.
cat=IAB1
pt Define the publisher type. Options: “app” or “web”.Yes “app” or “web” Yes Defined on the base of the app/site platform associated with the requested zone. pt=web
pname Publisher name as registered in the xAd network.Yes XAD_PUBLISHER_NAME Yes (specified in GUI) pname=Mocean
appid This is used to differentiate traffic source of a publisher. No XAD_APPID No(specified in GUI) appid=89753
domain Top level domain of the publisher. Do not include http:// or www. just the top level domain. Yes XAD_DOMAIN or url Yes Specified in GUI. If not specified, standard Mocean ad request API parameter, url, is used.
NOTE: If it is specified neither in GUI nor in the ad request, URL of the site associated with the requested zone will be used.
NOTE: While processing the url "http://", "https://", "www." involved in it and any characters after and including "/" are removed from the url.
domain=sample.com
uid iOS: Raw IDFA for iOS, Provide a generated UUID that persists for at least a full day for older versions which do not have IDFA. Can be stored in KeyChain.
Android: Raw Google Advertiser Identifier. If available, otherwise use SHA1 Android_Id.
Mobile Web: Generated UUID that persists in a cookie for at least a full day.
Other cases: We recommend using one of the ids above but if for some reason you can not pass the above ids, please provide a generated UUID that persists in a storage of your choice at least for a day.
Yes idfa, androidaid, androidid_sha1, androidid, udid Yes Standard Mocean ad request API parameters are used.
Parameters are checked in the following order; idfa, androidaid, androidid_sha1, androidid. Once a parameter is not empty, its value is used for "uid" and other parameters aren't checked. If androidid is chosen for "uid", its value will be SHA1-hashed.

NOTE: If no mentioned parameters passed, device ID parameter configurable at the network level, or "udid" is used by default. If no defined, unique user ID will be generated automatically.

uid=2792c5ca-b8fa-11e2-99a7-14109fd63bf9
uid_type Identifies the type of uid passed in along with the hash Algorithm separated by a pipe (|).
User Identifier Options: IDFA, GIDFA, Android_Id, UUID
Hash Algorithm Options: RAW, SHA1, MD5
Expectation: IDFA should be RAW, Android_Id should be SHA1.
Yes “IDFA|RAW”, “GIDFA|RAW”, “Android_Id|SHA1”, “UUID|MD5” or “UUID|SHA1” Yes If "idfa" is used for "uid", "uid_type" is set to "IDFA|RAW".
uid_type=GIDFA|RAW for "androidaid".
uid_type=Android_Id|SHA1 for "android_sha1"/SHA1("androidid").
If udid (specified in the ad request or automatically generated) is used for "uid", "UUID|MD5" or "UUID|SHA1" will be used for "uid_type".
NOTE: If the "uid" parameter is changed via translation layer, please, make sure the "udid_type" parameter is changed correspondingly.
uid_type=IDFA|RAW
uid_tr Currently available on the iOS platform only. Allows you to pass Apple's tracking enabled flag.
NOTE: If platform is not iOS please set value to 1 or omit this parameter.
No idte No Standard Mocean ad request API parameter.uid_tr=1
size Size parameter specifies the banner size required in the response. Represents [width]x[height] e.g 320x50.
Supported sizes: 300x50, 320x50, 300x250, 728x90.
Yes Yes The priority of defining size values to be sent to the 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters (“size_x”, “size_y”)
  3. Zone settings
  4. WURFL (on the basis of max available width and height for the given device)

The largest supported size within the requested size is returned.

size=300x50
appname Application name. Yes* (For Mobile Apps)XAD_APP_NAME Yes* (For Mobile Apps)(specified in GUI) appname=testapp
appver Application version. Yes* (For Mobile Apps)XAD_APP_VERSION Yes* (For Mobile Apps)(specified in GUI) appver=1
bundle Application bundle or package name. Yes* (For Mobile Apps)XAD_BUNDLE Yes* (For Mobile Apps)(specified in GUI) bundle=com.xad.mygame
paid "1" if the application is a paid version; else "0" (i.e., free). Yes* (For Mobile Apps)XAD_PAID Yes* (For Mobile Apps)(specified in GUI) paid=0
appurl Application url (URL encoded). For mobile web sites it will be the URL where the site resides. For native apps it will be the URL to the app store. YesXAD_APP_URL or url Yes(specified in GUI)
If not specified in GUI, standard Mocean ad request API parameter, "url", is used.
NOTE: If it is specified neither in UI nor in the ad request, URL of the site/app associated with the requested zone will be used.
appurl=https%3A%2F%2Fitunes.apple.com%2Fus%2Fapp%2Ffind-my-iphone%2Fid376101648
o_fmt** Specifies the type of banner returned in the response. No“html5” YesDefault value is used. o_fmt=html5
instl** Specifies the type of banner returned in the response:
• 0: Request for an inline banner.
• 1: Request for an interstitial.
No “0” YesDefault value is used. instl=0


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
age age
carrier carrier
city loc'
country co'
gender gender
m M
f F
language lang
English en-us
French fr
Spanish es
Portuguese pt
Italian it
Russian ru
German de
Greek el
Vietnamese vi
Chinese Traditional zh
Chinese Simplified zh
Czech cs
Arabic ar
Polish pl
Dutch nl
Lithuanian lt
Turkish tr
Serbian sr
Romanian ro
Chinese zh
Filipino tl
Belarusian be
Croatian hr
Hungarian hu
Danish da
Ukrainian uk
Parisian French fr
Albanian sq
Bulgarian bg
Zulu zu
lat lat
long long
url ref
zip zip


Xtopoly *

Logo


Base URL

http://api.xtconnect.com/adPlacement/v1

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Validation Applied Comments Sending Value Example
clientId String used to authenticate usage of the API. Contact your account manager at Xtopoly for details. Yes XTOPOLY_CLIENT_ID Yes (specified in UI) clientId=50002
placementId The Ad Placement ID. Contact your account manager at Xtopoly to provision the placements to beused for your deployment. Yes XTOPOLY_PLACEMENT_ID Yes (specified in GUI) placementId=1001
ip Remote IP address of the end user device.Yes ip YesStandard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected from request headers.

ip=98.129.229.72
ua User Agent (UA) of the end user device. Yes ua Yes Standard Mocean ad request API parameter.
NOTE: If no “ua” parameter passed, user agent will be detected from request headers.
ua=Mozilla%2F4.0+%28compatible%3B+MSIE+6.0
%3B+Symbian+OS%3B+Series+60%2F4.0736.3.2.1
%3B+9712%29+Opera+8.65+%5Ben%5D
size Ad Size provided in format 320x50. Supported sizes: 320x50; 320x250; 300x50; 300x250; 120x20; 168x28; 216x36 Yes size_x, size_y YesStandard Mocean ad request API parameters (“size_x” and “size_y”) are used to determine appropriate value for ad sizes. The priority of selecting size values to be sent to 3rd Party Partner will be the following:
  1. Creative sizes
  2. Request parameters
  3. Zone settings
  4. WURFL (on the basis of max available width and height for the given device)

The largest supported size within the requested size is returned.

size=320x50
ida Identifier for advertiser without hashing. iOS 6 and above only. No idfa No Standard Mocean ad request API parameter. ida=68753A44-4D6F-1226-9C60-0050E4C00067
gpid Google Play advertising identifier, without hashing. Available for Android (2.3 and above) devices that have Google Play services with JAR above 4.0 on their phone. No androidaid No Standard Mocean ad request API parameter. gpid=68753A44-4D6F-1226-9C60-0050E4C00067


Parameters Translation
Incoming Parameter Ad Feed Parameter
Name Value Name Value
birthday yob
yyyy-MM-dd yyyy
gender gender
language language
English eng
French fre
Spanish spa
Portuguese por
Italian ita
Russian rus
German ger
Greek grk
Vietnamese vie
Chinese Traditional zhx
Chinese Simplified zho
Czech ces
Arabic ara
Polish pol
Dutch dum
Lithuanian lit
Turkish ota
Serbian srp
Romanian ron
Chinese zho
Filipino fil
Belarusian bel
Croatian hrv
Hungarian hun
Danish dan
Ukrainian ukr
Parisian French fre
Albanian sqi
Bulgarian bul
Zulu zul
lat lat
long lon


Ybrant

Logo



Base URL

http://adserver.admaxim.com/adserver/adapi?

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
aType Required to get ads. Enter your ad Type e.g. value 5 for textlink ad, 6 for image banner ad. Yes type Standard Mocean ad request API parameter. aType=6
siteId Ybrant site ID Yes YBRANT_SITEID (specified in GUI) siteId=1234
numads Number of Ads to be returned Yes 1 Default value is used. numads=1
fmt Format. Possible Values are: html/xml (NOTE: default format is xml). Yes html Default value is used. fmt=html
keywords A comma delimited list of keywords. No keywords Standard Mocean ad request API parameter. keywords=news,election
city City code of the request. No city=Boston
state State code of the request. No state=MA
zip Zip /postal code of the request. No zip Standard Mocean ad request API parameter. zip=002114
country 2-character country code. No country=US
ua User Agent String passed by full or mobile micro browser. No ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically'.

ua=Mozilla/5.0 (SymbianOS/9.2; U; Series60/3.1 NokiaN95/11.0.026;Profile MIDP-2.0 Configuration/CLDC-1.1)AppleWebKit/413 (KHTML, like Gecko)Safari/413
remoteIP IP Address No ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

remoteIP=17.148.221.102

Yellowpages

Logo



Base URL

http://api.yp.com/display/v1/ad

Request Parameters
Ad Feed URL Parameter Description Req? Source Mocean Parameter Comments Sending Value Example
apikey Alphanumeric API access key provided by AT&T Interactive. Yes YELLOWPAGES_APIKEY (specified in GUI) apikey=attisupport
ip IP address of the requesting device. Yes ip Standard Mocean ad request API parameter.

NOTE: If no “ip” parameter passed, client IP address will be detected automatically.

ip=17.148.221.102
useragent The full handset user agent string, which must be URL encoded. Yes ua Standard Mocean ad request API parameter.

NOTE: If no “ua” parameter passed, user agent will be detected automatically.

useragent=MOT-V3r%2F08.BD.43R%20MIB%2F2.2.1%20Profile%2FMIDP-2.0%20Configuration%2FCLDC-1.1
keywords Optional keyword or category list describing the content. Multiple keywords may be provided in priority order and must be separated by pipe-delimiter. No keywords Standard Mocean ad request API parameter. keywords=floristlflowers
zone A unique identifier for the publisher content, i.e. a specific area of a publisher’s site that contains the ad-unit or a specific page or a group of pages. No YELLOWPAGES_ZONE (specified in GUI) zone=5477
homezip The user’s 5 digit postal code. No zip Standard Mocean ad request API parameter. homezip=12345
loc This parameter is intended for use when knowledge of the user’s geolocation is available. Location value can be zipcode,latitude/longitude or city,state, but ONLY one value can be used. Must be URL encoded. No zip

or city state or lat:long

Standard Mocean ad request API parameter called 'zip' is used.

If no 'zip' parameter specified in the request, ' standard Mocean ad request API parameters 'city' and 'state' are used (space-delimited). If no 'city' and 'state' parameters passed, standard Mocean ad request API parameters “lat” and “long” (separated by colon) . NOTE: If no “lat” and “long” parameters passed, user geolocation will be detected automatically.

loc=91203

OR loc=glendale+CA OR loc=37.7752%3A-122.4192

clkpxl Optional parameter for Publishers to use for click pixel tracking. Must be URL encoded. No MACRO_CLKPXL When processing the response, the passed values are replaced with Mocean Macros %LINK%. clkpxl=MACRO_CLKPXL
impxl Optional parameter for Publishers to use for impression pixel tracking.Must be URL encoded. No MACRO_IMPXL When processing the response, the passed values are replaced with Mocean Macros %TRACKURL%. impxl=MACRO_IMPXL
test For testing purposes, this parameter may be used to retrieve test ads. Use value “1” to request test ads. No 0 Default value is used. test=0
site Optional parameter to represent a specific publisher site. No YELLOWPAGES_SITE (specified in GUI) site=1235
ptag Optional additional parameter to represent a specific publisher site in addition to ‘site’ parameter. No YELLOWPAGES_PTAG (specified in GUI) ptag=abc
udid Optional parameter indicating unique device identification number of mobile device. No udid Standard Mocean ad request API parameter.

NOTE: If no “udid” parameter passed, unique user ID will be generated automatically.

udid=76d6c950-63e7-4f1e-b935-e6b33a88daa
carrier Optional parameter indicating carrier/provider. Use the Mobile Country Code (MCC) and Mobile Network Code (MNC), separated by ‘-‘ as the value, <MCC>-<MNC>. No Mcc and mnc Standard Mocean ad request API parameter 'mcc' and 'mnc' carrier=310-410



Personal tools