Downloadable document
| lref-gdriveview-file | |||||
|---|---|---|---|---|---|
| |||||
| Lref gdrive file | |||||
|
Table of Contents
...
| Table of Contents | ||||
|---|---|---|---|---|
|
...
Field | Required | Description |
id | Yes | Authentication attribute provided by Digital Turbine |
password | Yes | Authentication attribute provided by Digital Turbine |
| siteId | Yes | Value provided by Digital Turbine to identify the publisher |
userAgentHeader | Yes | The user agent of the device for which the ad is requested. Required to ensure device-application compatibility |
sessionId | Yes | sessionId of the end user device the request is generating Ads for. This parameter is required so ads provided in the XML response will be rotated, end users will not see duplicates on subsequent requests. However, you don’t need to maintain any session and this can be any randomly generated number, for example, timestamp. |
| placementId | No | Placement of site id in VIA |
ipAddress | No | Required for end user geo-targeting |
| ipAddressList | No | Required for end user geo-targeting |
| countryCode | No | Country code to filter ads by. Example: US |
| countrySource | No | Integer. Example: 1 |
| imageHeight | No | Allows partners to request various icon sizes. Digital Turbine will return the best match from the sizes we have available. The default value is 72 and the max 200. |
| iconHeight | No | Used along with adTypeId, this allows partners to request various icon sizes in addition to a Banner or Interstitial. The default value is 72 and the max 200. |
| acceptLanguageHeader | No | Two letter ISO language code. Allows partners to request a specific language. Digital Turbine will return ads in the request language if available. |
totalCampaignsRequested | No | Allows publishers to request multiple ads simultaneously |
adTypeId | No | The size of creative returned in the ad response. 1 is the default. 1 – 72x72 Icon 4 – 300x50 Banner 5 – 320x50 Banner 6 – 300x250 Interstitial 7 – 320x480 Interstitial 8 – 480x320 Interstitial 9 – 768x1024 Interstitial 10 – 1024x768 Interstitial 11 - 390x200 interstitial 12 - 240x350 Interstitial 13 - 750x560 Interstitial 14 - 560x750 Interstitial 15 – 728x90 Banner 16 - 1200x627 Interstitial 28 - 600x600 Interstitial 42 - 1280x720 Interstitial |
categoryId | No | The predefined category/subcategory available to filter the results on. Category IDs can be comma separated to filter for multiple categories. See the table at the end of the document for a list of IDs and their category names. |
androidId | No | Raw Android ID for optimization and conversion tracking. |
aIdSHA1 | No | Android ID SHA-1 hashed for optimization and conversion tracking when available. |
| aIdMD5 | No | Android ID MD5 hashed for optimization and conversion tracking when available. |
idfa | No | Raw iOS IDFA for optimization and conversion tracking when available. |
macAddress | No | Raw MAC Address not case sensitive, including : separator for optimization and conversion tracking when available. |
| aaid | No | Android Advertising ID for optimization and conversion tracking. |
| campaignId | No | The Digital Turbine campaign ID. Passing this param will return details for the passed campaign ID only. If the campaign is not available the result will be empty. |
carrierName | No | Carrier Name: Verizon, ATT, Tmobile, etc. |
lat | No | Latitude |
long | No | Longitude |
gender | No | male/female |
minAge | No | Age or minimum age if an age range is known |
| maxAge | No | Maximum age if an age range is known |
| childAge | No | Comma separated list of a child age ranges (0-3,4-7) |
minIncome | No | Income or minimum income of an income range is known |
| maxIncome | No | Maximum income of an income range is known |
| vendor | No | Vendor |
| subPartner | No | Sub partner |
| deviceSpec | No | Returns campaigns with apps that has apks uploaded |
| screenshotSize | No | Example: 100x100 |
Other request parameters:
...
| Parameter | Description |
|---|---|
| language | Used in impression tracking url |
| adUnitId | Used in impression tracking url |
| creativeId | Used in click proxy url + impression tracking url |
| templateId | Used in click proxy url + impression tracking url |
| bidRequestId | Used in click proxy url + impression tracking url |
| bidResponseId | Used in click proxy url + impression tracking url |
| exchange | Used in click proxy url + impression tracking url |
| bidClearPrice | Used in click proxy url + impression tracking url |
| retargeted | Used in click proxy url + impression tracking url |
| homeScreen | Used in click proxy url + impression tracking url |
| aaidSHA1 | Used in click proxy url + impression tracking url |
| aaidMD5 | Used in click proxy url + impression tracking url |
| handsetId | Used in click proxy url + impression tracking url |
| udid | Used in click proxy url + impression tracking url |
| odin | Used in click proxy url + impression tracking url |
| limitAdTracking | Used in click proxy url + impression tracking url. Values: true/false. |
| flows | Used in click proxy url |
| clicklessSupported | Used in click proxy url |
| rdnsCarrierSafe | Used in click proxy url |
| dvURL | Used in click proxy url |
| stiFlow | Used in click proxy url |
| deviceId | Used in click proxy url |
| algorithmId | Used in click proxy url |
| provider | Used in click proxy url |
| mccmnc | Used in click proxy url |
| deviceManufacturer | Used in click proxy url |
| deviceModel | Used in click proxy url |
| density | Values: ldpi/mdpi/tvdpi/hdpi/xhdpi/xxhdpi/xxxhdpi |
| deviceState | Configured in Via Site Optimization/Priority. Values: outOfBox/inLife |
| randomization | Determine if the ads for a specific request should be randomized. Values: true/false |
| clickProxy | if deeplink is sent then clickProxyUrl will have delivers URL |
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]
...
Field | Description | Value |
| adListId | Unique uuid for each request. Part of clickProxyUrl and impressionUrl. | String |
| apks | List of apk configuration from the Via App/Manage Apk page. | List of Objects |
appId | The app's unique identifier in the app store, Google Play or iTunes | String |
averageRatingImageURL | An image representing the star rating of the application. | String |
| bidId | Unique id for each campaign. Part of metadata object, clickProxyUrl and impressionUrl. Example: BID214330009156094520454149095213969486968 | String |
bidRate | Amount paid to a publisher for an install | Float |
| billingTypeId | Billing type of campaign. Can be: CPI (1), CPP (2), CPC (3), CPM (4) | Integer |
| callToAction | Static localized parameter that returns "Install now" text. Supports following languages codes: en, zh, sv, da, no, fi, de, es, fr, nl, it, tr, ro, pt, pt-br | String |
campaignDisplayOrder | Recommended display order for the ad based on Digital Turbine’s campaign performance algorithm | Integer |
campaignId | The campaign's ID within the Digital Turbine system. | Integer |
campaignTypeId | A tracking parameter used by Digital Turbine. Typically unused by publishers. | Integer |
categoryName | The category of the application from Google Play or iTunes | String |
clickProxyURL | A link that will record a click in Digital Turbine's system and redirect the end user to the appropriate app store, Google Play or iTunes. | String |
creativeId | The ID of the creative returned. Typically unused by publishers. | Integer |
| enableAutoLaunch | If false, user will be presented with the app details modal containing the call to action: "tap here to open". | Boolean |
| homeScreen | Shows if campaign may appear on the home screen. Configured in Via site optimization page. | Boolean |
impressionTrackingURL | pixel tracker that must be placed when an ad is shown to the end-user | String |
| impressionId | Unique id for each campaign. Part of metadata object and impressionUrl. Example: IMP181121631983274148732716928498071899713 | String |
| installDelay | Delay in seconds between download complete and install for an app delivery | Integer |
isRandomPick | All ads are returned in order of their performance, with a few randomly returned out of order. This indicates if the specific ad was returned in performance order or was a random placement. | String |
| metadata | Contains such metadata as bidId and impressionId. | Object |
maxOSVersion | The maximum OS version supported. Must be used to filter out unsupported devices. | String |
minOSVersion | The minimum OS version supported. Must be used to filter out unsupported devices. | String |
| numberOfDownloads | How much downloads have happened for a specific app. | String |
numberOfRatings | The number of ratings. | String |
productDescription | The ad copy for the ad. Typically a short description of the product. | String |
productId | Digital Turbine system ID for the application linked to a campaign. Typically unused by publishers. | Integer |
| postInstallActions | Discovery notifications post install actions. | Object |
productName | The headline for the ad. Typically the title of the product | String |
productThumbnail | URL for the image icon | String |
responseTime | Digital Turbine AdServer response time for the current ad request. Typically unused by publishers. | String |
| reclickAttribution | Determines whether or not to re-click the attribution click upon auto-launch if an app is already installed. | Boolean |
rating | The application rating | Float |
| s2s | Server to server parameter. | Boolean |
| segments | Specific for applist site. Configured under Site Optimization/Applist in Via. Each segment has list of campaigns. | List of Objects |
totalCampaignsRequested | Indicates the number of campaigns requested. The results may be less than the number requested if the targeting criteria filters out available ads. | Integer |
| useInstallerBroadcast | Broadcast message to the installed app. | Boolean |
version | Current version of the ad server. Typically unused by publishers. | String |
...