Api (1)

Integration Tools
Documentation
Tools / Native Ads API / Native Ads API
Version 28072015 | Appnext © 2015 Tools / Native Ads API / Native Ads API 1Version 28072015 | Appnext © 2015 Tools / Native Ads API / Native Ads API 1

Appnext Account & ID
Register for an Appnext Account
You must first create an account with Appnext to be able to use this ad unit features. If you do not
have an Appnext account, copy the following URL to the browser: https://www.appnext.com and sign
up.
Unique ID
A unique ID called a “Placement ID” is required for all inbound requests. A Placement ID is a 32-
character string generated by Appnext for every registered app/website.
Get a Unique ID
To get started – add a new App via the Appnext Self-service Platform, then copy the Placement ID,
which can be found in your account at: Apps -> Settings Icon-> Settings & Placements -> Placement
ID (make sure to copy the Placement ID for both Android and iOS apps).
Version 28072015 | Appnext © 2015 Tools / Native Ads API / Native Ads API 2Version 28072015 | Appnext © 2015 Tools / Native Ads API / Native Ads API 2Version 28072015 | Appnext © 2015 Tools / Native Ads API / Native Ads API 2Version 28072015 | Appnext © 2015 Tools / Native Ads API / Native Ads API 2

Change log
01/09/2015
Added an optional parameter to the API call:
"&vs=1" (provides a video creative in the API response)
23/08/2015
Change to the base URL format
10/08/2015
Added 2 new parameters to the API response:
storeRating
appSize
26/07/2015
Added 5 new parameters to the API response:
supportedDevices
bannerId
campaignId
campaignType
supportedVersion

Getting started with Appnext
API
Data returned in Appnext API response
Appnext API returns raw-data of Android or iOS apps, promoted through campaigns by advertisers in
the Appnext platform, which specifically target your app placement. Data includes advertiser’s app
creative content, current bid, tracking link, ad-serving weight, etc.
Requesting app data
A “Placement ID”, which is a unique key generated by the Appnext platform, must be added to the
API call in order to receive apps data.
Requesting the API with an Android Placement ID will return Android targeted campaigns and
requesting it with an iOS Placement ID will return iOS targeted campaigns. Only one OS can be
called in a single API call.
Campaign inventory
Each API request will return up to 200 app records for a targeted GEO. By default, the targeted GEO
will be determined as the client-side GEO. For example: when requesting the API form a server
located in the US, the API will return campaigns that are targeting US users.
Campaigns Status
App campaigns constantly change during the day by advertisers. Campaigns are being paused,
activated, creative change and bid increase or decrease to compete on your placements via the
platform.
Every campaign running has a daily cap (budget). Once a campaign has depleted its daily cap it will
be paused until the following day. Campaign that was paused, might not redirect to the store, and will
not be eligible for payment.
Server-side requests: Campaign status is updated every 20 minutes, therefore, in case API is
requested via server-side, it is highly important to refresh the API data every 20 minutes. Campaigns
that are live will be returned in the API response and campaigns that are offline will not appear in the
response anymore.
In case of Capping /Geo Targeting/end of banner inventory:
Important note:
1. Make sure you only serve updated apps. It is important to call the API for updated
campaigns every 30 minutes and avoid displaying ads which were not returned in
the last API call.
2. Each offer includes a Campaign ID and a Banner ID. If an app is promoted by
Sample JSON:
{
"empty":""
}

several advertisers, Appnext API will only return the campaign with the highest
bid, for the asked GEO.The Campaign ID may also change in case the advertiser
choose to A/B test several creative. If the Campaign ID and/or the Banner ID has
changed from one API call to the next, make sure to replace all returned
parameters (including image and tracking links) and serve the most recent banner.

Measurement and reporting
Impressions count
Counting impressions accurately is important for performance calculations.
All app images, received through the API ("urlImg''), have been added with a pixel in order to record
an impression upon display.
If choosing not to display/load the app image ("urlImg''), please replace the pimg=1 parameter in the
API request URL: https://admin.appnext.com/offerWallApi.aspx?pimg=1 with pimp=1.
Adding &pimp=1 to the API string will provide an additional field to the returned banners JSON/XML:
"pixelImp'' that provides an impression reporting URL for the provided banner. It is mandatory to call
the "pixelImp'' URL each time the banner is displayed to the end-users. 1 call = 1 impression logged.
Example the "pixelImp'' parameter:
Counting Clicks and installs
Appnext counts a click whenever the download link (urlApp), provided by the API for each app, is
clicked. It is highly important to use the provided download link in order to direct the user to the
market, as this is the only way to track app installs.
Important note: do not preload / pre-fetch the urlApp links, as this will generate
additional costs to our Advertisers who are using 3rd party tracking solutions for
conversion tracking.
Postbacks
A Postback (also known as a callback) is a server-to-server call made by Appnext’s server to a
publisher’s server with the purpose of notifying him of a conversion (install) made through his app /
website.
You may choose to receive up to 3 parameters in each Postback call:
1. Postback parameter – any custom parameter
2. Revenue – the CPI revenue generated for the install
3. Package – the app package
Passing a Postback parameter
You can pass a different Postback value for each offer returned by the API. Once a successful install
is made, Appnext will call your Postback URL, with the Postback value passed.
In order to pass a Postback value, make sure to add it to the “&q=” parameter in the download link
(urlApp), provided by the API for each offer.
For example:
"pixelImp":"https://admin.appnext.com/pView.aspx?b=40444&z=66005&c=30361"
"urlApp":"https://admin.appnext.com/appLink.aspx?b=1183&e=6780&q=your_postback_value

When passing several values/parameters in the “&q=”, make sure to encode the string. For example:
&q=param1=value1&param2=value2 should be: &q=
param1%3Dvalue1%26param2%3Dvalue2%20%20%20
Appnext will send Postbacks from this IP address: 54.204.84.86 make sure to white-list this address.
Receiving Postbacks
In order to receive Postbacks, you should provide Appnext with a Postback URL. The Postback URL
is the endpoint at your server or third-party tracking service, to which we will be sending the
Postback.
If you are interested in receiving a Postback, please make sure to send your Postback URL to:
support@appnext.com
SubID Reporting
Media Partners (such as: ad networks, content networks etc.) are required to pass their publisher’s
Subid on every click.
Every app retuned by Appnext’s API includes a tracking URL (“urlApp”) for directing the user to the
app’s listing in the store, for example:
In order to pass the SubID, add a “&subid={value}” to the tracking link of each app:
"urlApp":"https://admin.appnext.com/appLink.aspx?b=18443&e=25526&q="
"urlApp":"https://admin.appnext.com/appLink.aspx?b=18443&e=25526&q=&subid=12345"

Requesting raw ad data for
Android and iOS
Request API base URL:
API request Parameters:
Parameter Description Example Notes
Placement ID a 32-character string generated
by Appnext for every registered
app/mobile-web app that is
required for all inbound requests
id=0fa643ba-a3e5-4f01-bf49-89354fbd0562 Must
cnt The number of apps received in
the API response
&cnt=200 Optional
– up to
200
apps
per call
cat Sort the apps in the API
response by app
category/genre (see full
category list at the end of this
document)
&cat=Arcade,Board,Card,Arcade&Action Optional
ip Enter an IP address of the
targeted users GEO. When US
IP is used, API will return apps
for US users.
&ip=76.72.171.54 Optional
–
default
will
return
apps for
client-
side
GEO
useragent_ios when calling the API for iOS
apps, you can choose the
relevant user agent: iPhone,
iPad and/or iPod
&useragent_ios=iPhone,iPad Optional
–
default
will
return
apps for
all user
agent
https://admin.appnext.com/offerWallApi.aspx?pimg=1&tid=API&vid=API_150823&id= PlacementID

Parameter Description Example Notes
type API response format: JSON or
XML
&type=json Optional
–
default
will
return
JSON
format
pbk postback parameters &pbk=YOUR_CUSTOM_PARAMETERS Optional
subid Required for media partners.
Enter the publisher id in where
the user clicked on the app
advertisement.
&subid=44332 Must for
media
partners
pimg=1 Count an impression whenever
an offer’s “urlImg” link is loaded.
&pimg=1 Do not
call the
API with
“pimp=1”
when
calling it
with
“pimg=1”
pimp=1 Count an impression whenever
an offer’s “pixel_imp” link is
loaded.
&pimp=1 Do not
call the
API with
“pimg=1”
when
calling it
with
“pimp=1”
vs=1 Adds a video link, to each app,
in the API's response
&vs=1 Optional.
Currently
available
only for
Android
Example (Android placement ID and US IP address):
https://admin.appnext.com/offerWallApi.aspx?id=0fa643ba-a3e5-4f01-bf49-89354fbd0562&cnt
=10&cat=Action,Brain%20&%20Puzzle&type=xml&ip=76.72.171.54&pbk=mypostback

Important notes:
1. Each parameter added to the API string should be added with the “&” symbol.
This symbol is used in order to differentiate one parameter from another.
2. When using multiple categories, make sure to use the following format:
app_category,app_category,app_category Categories with 2 words, for example:
Arcade & Action must be encoded in the following format:
Arcade%20%26%20Action

Response of raw ad data
Sample JSON – Android:
Sample JSON – iOS:
{
"apps":
[
{
"title":"Ringo: International Call",
"desc":"Ringo lets you make low cost international calls without using the Internet (WiFi or 3G)",
"urlImg":"https://appnext-a.akamaihd.net/banner/hRfj5Tku24P0s4w_default.png",
"urlApp":"https://admin.appnext.com/appLink.aspx?b=38762&e=81307&q=",
"androidPackage":"co.ringo",
"revenueType":"cpi",
"revenueRate":"0.70",
"categories":"Communications",
"idx":"928",
"urlVideo":"https://appnext.hs.llnwd.net/banner/video/pqzbzezftho.webm?ver=5",
"bannerId":"38762",
"campaignId":"29028",
"country":"US",
"campaignType":"network",
"supportedVersion":"4.0.3 and up",
"storeRating":"4.1",
"storeDownloads":"100000+",
"appSize":"13M"
}
]
}
{
"apps":
[
{
"title":"Wishbone",
"desc":"Wishbone is your home for comparing social content.",

"urlImg":"https://appnext-a.akamaihd.net//banner/ESmSQLtmsOcTwAJ_uploaded.jpeg",
"urlApp":"https://admin.appnext.com/appLink.aspx?b=39656&e=66005&q=",
"revenueType":"cpi",
"revenueRate":"3.90",
"categories":"Social Networking",
"idx":"651",
"iosPackage":"836071680",
"supportedDevices":"iphone,ipad,ipod",
"bannerId":"39656",
"campaignId":"29708",
"country":"US",
"campaignType":"network",
"supportedVersion":"Requires iOS 7.0 or later. ",
"storeRating":"4.5",
"appSize":"23.8 MB"
}
]
}

API response Parameters:
Parameter Description Explanation
title title of the promoted app
desc description of the promoted app
urlimg image of the promoted app
urlApp Link to the promoted app listing
in the market
The urlApp will direct to the App store / Play Store and
will record a click in Appnext platform
androidPackage Android Play Store unique
package
When calling for Android app data
iosPackage iOS App store unique package When calling for iOS app data
revenueType CPC/CPM/CPI
revenueRate The revenue for the installation
of the app
categories Promoted app categories Provided categories are the same as market categories
idx Index score An index score which is calculated based on parameters
such as: overall relevancy, conversion and payout. The
higher the idx score is, it is more likely that the banner
will perform better. idx will be visible only to placements
with more than a 1000 impressions.
urlVideo Video of the promoted app Can be used in order to create video ad units.
supportedDevices the supported device type –
iphone, ipad or ipod
iOS only
bannerId Banner ID on the Appnext
Platform.
Each campaign can consist with several banners, only
the highest converting banner will be served per-geo.
campaignId Campaign ID on the Appnext
Platform.
country Targeted Country. The country targeted in the campaign.

Parameter Description Explanation
campaignType Campaign type: Network / Direct A “Network” campaign is targeting the entire Appnext
network, while a “Direct” campaign is only targeting a
specific publisher. When receiving a “Direct” campaign in
the API response, it means that your app was targeted by
the advertiser.
supportedVersion The supported version of the
promoted app.
Only users who meet the supported version requirements
will be able to successfuly install this app.
storeDownloads The minimum number of
downloads, provided by the
store
Only for Android
storeRating The App’s average rating on
the Appstore / PlayStore
Rating range is 0-5
appSize The physical size of the App in
KB/MB
As provided by the Appstore / PlayStore

App Categories:
Make sure to encode (%20) categories with more than 1 word, example: Travel%20%26%20Local
Android:
1. Action
2. Adventure
3. Arcade
4. Arcade & Action
5. Board
6. Books & Reference
7. Brain & Puzzle
8. Business
9. Card
10. Cards & Casino
11. Casino
12. Casual
13. Comics
14. Communications
15. Education
16. Educational
17. Entertainment
18. Family
19. Finance
20. Health & Fitness
21. Libraries & Demo
22. Lifestyle
23. Live Wallpaper
24. Media & Video
25. Medical
26. Music
27. Music & Audio
28. News & Magazines
29. Personalization
30. Photography
31. Productivity
32. Puzzle
33. Racing
35. Shopping
36. Simulation
37. Social
38. Sports
39. Sports Games
40. Strategy
41. Tools
42. Travel & Local
43. Trivia
44. Weather
45. Word
iOS:
1. Action
2. Adventure
3. Arcade
4. Board
5. Books
6. Business
7. Card
8. Casino
9. Catalogs
10. Dice
11. Education
12. Educational
13. Entertainment
14. Family
15. Finance
16. Food & Drink
17. Graphics & Design
18. Health & Fitness
19. Kids
20. Lifestyle
21. Medical
22. Music
23. Navigation
24. News
25. Photo & Video
26. Productivity
27. Puzzle
28. Racing
29. Reference
30. Role Playing
31. Simulation
32. Social Networking
33. Sports
34. Strategy
35. Travel
36. Trivia
37. Utilities
38. Weather

Api (1)

Recommandé

Recommandé

Contenu connexe

Similaire à Api (1)

Similaire à Api (1) (20)

Dernier

Dernier (20)

Api (1)