Downloadable document

Table of Contents

Ad result sets can be filtered based on the parameters outlined below.  All values sent must be URL encoded to accommodate any special characters.

Request Parameters

Other request parameters:

Sample Request

Generic:

http://ads.appia.com/v2/getAds?id=[ID]&password=[PASSWORD]&sessionId=[SESSIONID]&siteId=[SITEID]&userAgentHeader=[USERAGENTHEADER]&ipAddress=[IPADDRESS]&placementId=[PLACEMENTID]&androidId=[ANDROIDID]&aIdSHA1=[AIDSHA1]&aIdMD5=[AIDMD5]&macAddress=[MACADDRESS]&idfa=[IDFA]&aaid=[ANDROIDADVERTISINGID]&subSite=[SubSiteId]

Actual:

http://ads.appia.com/v2/getAds?id=123&password=digitalturbinePassword&sessionId=somerandomvalue001&siteId=1234&userAgentHeader=Mozilla/5.0 (Linux; U; Android 4.1; en-us; Full Android on Crespo Build/GINGERBREAD) AppleWebKit/533.1 (KHTML, like Gecko) Version/4.0 Mobile Safari/533.1&siteId=1234&ipAddress=173.226.92.34&placementId=320x50&androidId=01930&aIdSHA1=&AiDMD5=&macAddress=0123456789ab&idfa=1234&aaid=1234&subSite=1234567890

Response Parameters

Response provides all the data available in XML/XHTML format, which can be used to construct or readily display the Ad. 

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ads xmlns="http://www.appia.com/AS/get/ads/2013-01">
    <adListId>dee6f238-e5cd-4c5b-93a1-808769166cb6</adListId>
    <ad>
        <apks>
            <apk>
                <fileName>com.ibotta.android~c358be779552584db2b8b711cb275788.apk</fileName>
                <fileSize>56430138</fileSize>
                <md5>c358be779552584db2b8b711cb275788</md5>
                <networkType>both</networkType>
                <packageName>com.ibotta.android</packageName>
                <permissions>
                    <permission>android.permission.ACCESS_COARSE_LOCATION</permission>
                    <permission>android.permission.ACCESS_FINE_LOCATION</permission>
                    <permission>android.permission.ACCESS_NETWORK_STATE</permission>
                    <permission>android.permission.ACCESS_WIFI_STATE</permission>
                    <permission>android.permission.AUTHENTICATE_ACCOUNTS</permission>
                    <permission>android.permission.BLUETOOTH</permission>
                </permissions>
                <sha2>78e706f9fad37011bd8fc7a8c93abe5c085e143a9b57cbed7597da6ed55877b0</sha2>
                <title>Ibotta</title>
                <url>https://s3.amazonaws.com/appia-dev-apks/com.ibotta.android~c358be779552584db2b8b711cb275788.apk</url>
                <version>4.11.2</version>
                <versionCode>2096</versionCode>
            </apk>
        </apks>
        <appId>com.zavyn.app.01</appId>
        <averageRatingImageURL>https://assets.gopda.com/hua/cdn/adpub/default/rated-5-5.png</averageRatingImageURL>
        <bidRate>2.100</bidRate>
        <billingTypeId>1</billingTypeId>
        <callToAction>Install Now</callToAction>
        <campaignDisplayOrder>1</campaignDisplayOrder>
        <campaignId>12424</campaignId>
        <campaignTypeId>2</campaignTypeId>
        <categoryName>Books &amp; Reference</categoryName>
        <clickProxyURL>https://balalaika-central-2022-alpha.dev.appia.com/v2/delivers/clickAd.jsp?siteId=41488&amp;deviceId=4520&amp;spotId=&amp;sessionId=getAdsDebug&amp;campaignId=12424&amp;creativeId=&amp;packageName=com.zavyn.app.01&amp;fulfillmentTypeId=1&amp;placementId=&amp;campaignDisplayOrder=1&amp;enc=true&amp;ts=17da484dedf&amp;algorithmId=166&amp;partner=1411&amp;homeScreen=false&amp;houseApp=false&amp;installDelay=0&amp;enableAutoLaunch=true&amp;countryCode=US&amp;bidId=BID215201059225089188757028065641167901481&amp;adListId=dee6f238-e5cd-4c5b-93a1-808769166cb6</clickProxyURL>
        <creativeId>0</creativeId>
        <externalMetadata xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:nil="true"/>
        <homeScreen>false</homeScreen>
        <impressionTrackingURL>https://balalaika-central-2022-alpha.dev.appia.com/v2/impressionAd.jsp?siteId=41488&amp;campaignId=12424&amp;creativeId=&amp;campaignDisplayOrder=1&amp;ts=17da484dedf&amp;sessionId=getAdsDebug&amp;packageName=com.zavyn.app.01&amp;enc=true&amp;eventGroupId=EVTGID1639142708845248814692352&amp;algorithmId=166&amp;partner=1411&amp;countryCode=US&amp;bidId=BID215201059225089188757028065641167901481&amp;impressionId=IMP166976276725647341184525072781505505140&amp;adListId=dee6f238-e5cd-4c5b-93a1-808769166cb6</impressionTrackingURL>
        <isRandomPick>false</isRandomPick>
        <numberOfRatings>1,000-10,000</numberOfRatings>
        <productId>17063</productId>
        <productName>Zavyn App 01</productName>
        <rating>5.0</rating>
        <numberOfDownloads>1,000-10,000</numberOfDownloads>
        <tstiEligible>false</tstiEligible>
        <stiEnabled>false</stiEnabled>
        <postInstallActions/>
        <useInstallerBroadcast>false</useInstallerBroadcast>
        <installDelay>0</installDelay>
        <reclickAttribution>false</reclickAttribution>
        <enableAutoLaunch>true</enableAutoLaunch>
        <s2s>false</s2s>
        <metadata>
            <bidId>BID215201059225089188757028065641167901481</bidId>
            <impressionId>IMP166976276725647341184525072781505505140</impressionId>
        </metadata>
    </ad>
    <responseTime>2.163 seconds</responseTime>
    <totalCampaignsRequested>7</totalCampaignsRequested>
    <version>v2</version>
</ads>

Error Response

If access has not been enabled, an error message will be returned:

<ads>
    <errorMessage>{errorMessage}</errorMessage>
    <serverId>{server}</serverId>
    <version>{version}</version>
</ads>

Campaign Categories

Flow Diagram