Mojiva API Documentation
Follow the below API to integrate ads into your applications, WAP portals or SMS!
Mojiva ad request API
Common Parameters |
||||||
| Parameter | Name | Description | Required? | Provided By | Example | Notes |
|---|---|---|---|---|---|---|
| site | Site id. | The id of the publisher site. | Yes | Publisher | site=60 | |
| ip | Ip address. | The ip address of the carrier gateway over which the device is connecting. | No | Mobile device | ip=127.0.0.1 | |
| ua | User agent. | The browser user agent of the device making the request. | No | Mobile device | ua=BlackBerry8100/4.2.0 Profile/MIDP-2.0 Configuration/CLDC-1.1 VendorID/100 | |
| url | Url | Url of site for which it is necessary to receive advertising. | Yes | Mobile device | ||
| keywords | Keywords | keywords to search ad delimited by commas. | No | Publisher | keywords=music | |
| whitelabel | Whitelabel flag | filter by whitelabel(0 - all, 1 - only whitelabel, 2 - only non-whitelabel | No | Publisher | whitelabel=0 | Can be used only by whitelabel publishers |
| premium | Premium flag | filter by premium (0 - non-premium, 1 - premium only, 2 - both | No | Publisher | premium=0 | Can be used only by premium publishers |
| zone | Zone id. | The id of the zone of publisher site. | Yes | Publisher | ||
| key | Output format | Output format. Normal format uses key = 1. Parameter key should be set to 3 in order to use XML output. | No | Publisher | key=1 (normal) key=3 (XML) |
|
| test | Mode. | Default setting is test mode where, if the ad code is properly installed, the ad response is "Test MODE". | No | Publisher | test=1 | |
| count | Quantity of ads | Quantity of ads, returned by a server. | No | Publisher | count=3 | |
| country | Country | Country of visitor. See codes here. | No | Publisher | country=US | Will override country detected by ip |
| region | Region | Region of visitor. See codes for US and Canada here, others - here. | No | Publisher | region=NY | Will override region detected by ip |
| adstype | Ad type | Type of advertisement. 1 - text only, 2 - image only, 3 - image and text, 4 - SMS ad | No | Publisher | adstype=4 | SMS will be returned in XML |
Rendering Parameters |
||||||
| Parameter | Name | Description | Required? | Provided By | Example | Notes |
| paramBORDER | Color of a border of ad. | Color of a border of ad. | No | Publisher | paramBORDER=#000000 | |
| paramHEADER | Color of a header of ad. | Color of a header of ad. | No | Publisher | paramHEADER=#ffffff | |
| paramBG | Color of a background of ad. | Color of a background of ad. | No | Publisher | paramBG=#ffffff | |
| paramTEXT | Color of a text of ad. | Color of a text of ad. | No | Publisher | paramTEXT=#000000 | |
| paramLINK | Color of a link of ad. | Color of a link of ad. | No | Publisher | paramLINK=#0000ff | |
| size_required | Set size for images | img tags will contain width and height attributes where possible. | No | Publisher | size_required=1 | |