Response - mobvistateam/Offline-API GitHub Wiki

Two returned text format: json and xml, developers can obtain the appropriate format based on the needs of their own programs, developers need to pass parameters restype, json is default format returned.

Note:

The returned ad list contains ad validity.
The click url is only valid in a day, that is to say, clicks after the day you request will not be received.
The returned number of ads may change, because there may be some ads between two requests is manually stopped.

Returned content includes following parameters:

Field	Description	Example
status	Status code	100
describe	The description of the status	success
img	Image url for src attribute	http://d11kdtiohse1a9.cloudfront.net/common/201404/201404011111296192_320X50.gif
impression_url	notify this URL when impression happens	http://agentapi.rayjump.com/agent_impression.php?campagin_id=1&....
trackurl	Ad click link, notice that this url is within an hour of effective	http://agentapi.rayjump.com/agentapi/click?cid=112&aid=33921
campaign_id	Campaign ID	127
trace_app_id	App ID	trace_app_id=com.tap4fun.spartanwar
preview_url	Preview link	preview_url=https://play.google.com/store/apps/details?id=com.zplay.android.mm
payout	Campaign payout	$0.30
begintime	Beginning time stamp of ad validity period	1389628800
endtime	Ending time stamp of ad validity period	1389628800
icon_url	Url of ad icon	http://d11kdtiohse1a9.cloudfront.net/common/201403/399739_128X128.png
allow_country	Allowed countries of campaigns	AF,AX,AL,AS,AD \| ALL: means all country
allow_device	Allowed devices of campaigns	android, ios
cap	Total cap of the campaign	1000000
video_urls	Video of campaigns	http://cdn-adn.rayjump.com/cdn-adn/16/08/31/18/42/57c6b49fed962.mp4
ads_details	Image and text of campaigns	http://d11kdtiohse1a9.cloudfront.net/common/201403/201403281430377774_400X300.png
title	App name	Wechat
appdesc	App description	Free texting, voice messages, and video calls in your pocket
appsize	App size	8.2
startrate	App scores in Google Play	4.5
category	App category	Application
appinstall	Number of app installation in Google Play	500,000,000 – 1,000,000,000
link_type	the link type of app	googleplay/apk/other

Important: Add device Information in the trackurl:

When user click the trackurl, you need add {android device id} & {imei} & {google advertising id} with the real value of the user device, sub_id(sub channel id), and jump to the url.
Example: http://agentapi.rayjump.com/agentapi/click?cid=112&aid=33921&did=24c939215bb67c43&im=354786062859323&gaid=38400000-8cf0-11bd-b23e-10b96e40000d&sub_id=1057&idfa=77B8659E-BF7C-44DC-9559-D425AAD23391

Note:

What is Google Advertising ID?
The conversion figure can not be matched if the androidId ,imei or idfa is wrong.

JSON Response Example

{"status":1000,"describe":"success","campaigns":{"campaign_133":{"campaign_id":"133","trace_app_id":"com.tap4fun.spartanwar","preview_url":"https:\/\/play.google.com\/store\/apps\/details?id=com.tap4fun.spartanwar","trackurl":"http:\/\/net.mobvista.com\/click?p=eyJja......lmIn0%3D","payout":".6","begintime":"1396022400","endtime":"1427644799","icon_url":"http:\/\/d11kdtiohse1a9.cloudfront.net\/common\/201403\/201403291044087458_128X128.png","title":"FarmVille-US","appdesc":"More addictive than Clash of Clans, Join now!","appsize":"48","startrate":"4.3","category":"Game","appinstall":"1000-2000","allow_country":"GB","allow_device":"android","cap":"1000000","video_urls":{"video_2004":"http://cdn-adn.rayjump.com/cdn-adn/16/08/31/18/42/57c6b49fed962.mp4","video_2007": "http://cdn-adn.rayjump.com/cdn-adn/16/08/31/57c6a41b4921d.mp4"},"ads_details":{"image_0":"http:\/\/d11kdtiohse1a9.cloudfront.net\/common\/201403\/201403291044459009_320X50.jpg"}}}}

XML Response Example

<response>    
<status>1000</status>    
<describe>success</describe>    
<campaigns>    
<campaign_150>    
<campaign_id>150</campaign_id>   
<trace_app_id>com.boyaa.androidmarkettaiyu</trace_app_id>    
<preview_url>    
https://play.google.com/store/apps/details?id=com.boyaa.androidmarkettaiyu    
</preview_url>    
<trackurl>    
http://agentapi.rayjump.com/agentapi/click?cid=112&aid=33921    
</trackurl>    
<payout>.8</payout>    
<begintime>1390233600</begintime>    
<endtime>1422719999</endtime>    
<icon_url>    
http://d11kdtiohse1a9.cloudfront.net/common/201401/201401211548317728_128X128.jpg    
</icon_url>    
<title>Texas Poker Th</title>    
<appdesc>app describtion</appdesc>    
<appsize>12</appsize>    
<startrate>4.1</startrate>    
<category>Game</category>    
<appinstall>1</appinstall>    
<allow_country>TH</allow_country>    
<allow_device>android</allow_device>    
<cap>1000000</cap>
<video_urls>    
<video_2004>http://cdn-adn.rayjump.com/cdn-adn/16/08/31/18/42/57c6b49fed962.mp4</video_2004>    
<video_2007>http://cdn-adn.rayjump.com/cdn-adn/16/08/31/57c6a41b4921d.mp4</video_2007>
</video_urls>  
<ads_details>    
<image_49>http://d11kdtiohse1a9.cloudfront.net/04021156272247_320X50.jpg</image_49>    
<image_50>http://d11kdtiohse1a9.cloudfront.net/04021156561312_320X480.jpg</image_50>    
<image_51>http://d11kdtiohse1a9.cloudfront.net/04021158468154_480X320.png</image_51>    
<image_52>http://d11kdtiohse1a9.cloudfront.net/04021200067834_400X300.png</image_52>    
</ads_details>     
</campaign_150>    
</campaigns>    
</response>

Response - mobvistateam/Offline-API GitHub Wiki

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️