GET /request
You can display banners using the ad
field in the received data from the response. Since the banner is returned in HTML format, you can directly render it in web projects. In other platforms, you can utilize a WebView.
Parameters:
Name | Type | Mandatory | Description |
---|---|---|---|
unit | STRING | YES | Ad unit ID |
uid | STRING | Strongly Recommended | Provide a value to uniquely identify the user. |
pf | STRING | Recommended | |
lcl | STRING | Recommended |
Platform
Use lowercase letters.
android | Platform value for Android |
ios | Platform value for Apple |
web | Platform value for Web |
Locale
To specify a locale, use an underscore character to combine a language ID with a region designator. For example, the locale ID for English-language speakers in the United Kingdom is en_GB
, while the locale for English-speaking residents of the United States is en_US
.
[language designator]_[region designator] | en_GB zh_HK |
Language designator: A code that represents a language. Use the two-letter ISO 639-1 standard.
Regional designator: A code that represents a country. Use the ISO 3166-1 standard, a two-letter, capitalized code.
Response:
Name | Type | Mandatory | Description |
---|---|---|---|
code | INT | YES | |
msg | STRING | YES | Adrop Error Code Message |
result | JSON | YES |
Response Code & Message
Please refer to the Adrop Error Code page. A successful response is indicated by:
Ad Data
Name | Type | Mandatory | Description |
---|---|---|---|
format | STRING | YES | |
unit | STRING | YES | Ad unit ID |
ad | STRING | YES | |
w | INT | YES | Width |
h | INT | YES | Height |
advertiser | STRING | NO | Advertiser Name (only for NativeAd) |
icon | URL | NO | Advertiser Icon (only for NativeAd) |
cover | URL | NO | Advertiser Cover (only for NativeAd) |
advertiserURL | URL | NO | Advertiser URL (only for NativeAd) |
headline | STRING | NO | Headline text (only for NativeAd) |
body | STRING | NO | Body text (only for NativeAd) |
callToAction | STRING | NO | Action button text (only for NativeAd) |
destinationURL | URL | NO | Destination URL (only for NativeAd) |
accountTag | JSON | NO | Account tag data added by publisher (only for NativeAd) |
creativeTag | JSON | NO | Creative tag data added by publisher (only for NativeAd) |
Ad Format
banner | Ad format value for banner |
nativeAd | Ad format value for NativeAd |
Ad Creative
banner | HTML format response |
nativeAd | HTML format response |
video | VAST format response (coming soon) |
Last updated