MAST for Publishers Request Ad API

Follow this API documentation to form your ad request within your mobile application, WAP portal or SMS.

You can also specify another host header in your request to override default (ads.mocean.mobi host). But it can be done only after our approval and DNS change.

Parameter	Description	Code Example
adstype	Type of advertisement (1 - text only, 2 - image only, 3 - image and text, 4 - SMS ad). SMS will be returned in XML.	adstype=4
carrier	Carrier name.	carrier=Aktel
city	City. For US only.	city=New York, NY
count	Quantity of ads returned by a server. Maximum value is 5.	count=3
country	Country of visitor. Will override country detected by IP.	country=US
imgSize	Override size detection for banners (1 - the smallest, 4 - the largest).	imgSize=2
ip	The IP address of the carrier gateway over which the device is connecting.	ip=127.0.0.1
key	Output format. Normal format uses key = 1. Parameter key should be set to 3 in order to use XML output and to 5 in order to use JSON output.	key=1 (normal) key=3 (XML) key=5 (JSON)
keywords	Keywords to search ad delimited by commas.	music
lat	Latitude.	lat=0.5
long	Longitude.	long=0.5
metro	Metro code.	metro=753
over_18	Filter by ad over 18 content (0 or 1 - deny over 18 content , 2 - only over 18 content, 3 - allow all ads including over 18 content).	over_18=2
paramBG	Background color in borders.	paramBG=#ffffff
paramBORDER	Border color.	paramBORDER=#000000
pixel	Return redirect to image for ad (or tracking pixel 1x1) directly (instead of html response).	pixel=1
region	Region of visitor.	region=NY
site (required)	The id of the publisher site.	site=60
target	Target attribute for <a href= />(_blank - open the linked document in a new window, _self - open the linked document in the same frame, _parent - open the linked document in the parent frameset, _top - open the linked document in the full body of the window)	target=_blank
test	Default setting is test mode where, if the ad code is properly installed, the ad response is "Test MODE".	test=1
textborder	Show borders around text ads (0 - non-borders, 1 - show borders).	textborder=0
ua	The browser user agent of the device making the request.	ua=BlackBerry8100/4.2.0 Profile/MIDP
url (required)	URL of site for which it is necessary to receive advertising.	url=http%3A%2F%2Fwww.moceanmobile.net
ZIP	Zip code.	ZIP=55416
zone (required)	The id of the zone of publisher site.	zone=123

Parameter

Description

Code Example

adstype

Type of advertisement (1 - text only, 2 - image only, 3 - image and text, 4 - SMS ad). SMS will be returned in XML.

adstype=4

carrier

Carrier name.

carrier=Aktel

city

City. For US only.

city=New York, NY

count

Quantity of ads returned by a server. Maximum value is 5.

count=3

country

Country of visitor. Will override country detected by IP.

country=US

imgSize

Override size detection for banners (1 - the smallest, 4 - the largest).

imgSize=2

The IP address of the carrier gateway over which the device is connecting.

ip=127.0.0.1

key

Output format. Normal format uses key = 1. Parameter key should be set to 3 in order to use XML output and to 5 in order to use JSON output.

key=1 (normal)
key=3 (XML)
key=5 (JSON)

keywords

Keywords to search ad delimited by commas.

music

lat

Latitude.

lat=0.5

long

Longitude.

long=0.5

metro

Metro code.

metro=753

over_18

Filter by ad over 18 content (0 or 1 - deny over 18 content , 2 - only over 18 content, 3 - allow all ads including over 18 content).

over_18=2

paramBG

Background color in borders.

paramBG=#ffffff

paramBORDER

Border color.

paramBORDER=#000000

pixel

Return redirect to image for ad (or tracking pixel 1x1) directly (instead of html response).

pixel=1

region

Region of visitor.

region=NY

site (required)

The id of the publisher site.

site=60

target

Target attribute for <a href= />(_blank - open the linked document in a new window, _self - open the linked document in the same frame, _parent - open the linked document in the parent frameset, _top - open the linked document in the full body of the window)

target=_blank

test

Default setting is test mode where, if the ad code is properly installed, the ad response is "Test MODE".

test=1

textborder

Show borders around text ads (0 - non-borders, 1 - show borders).

textborder=0

The browser user agent of the device making the request.

ua=BlackBerry8100/4.2.0 Profile/MIDP

url (required)

URL of site for which it is necessary to receive advertising.

url=http%3A%2F%2Fwww.moceanmobile.net

ZIP

Zip code.

ZIP=55416

zone (required)

The id of the zone of publisher site.

zone=123