These are objects representing the ads that can be used for promoting an Offer. A list of available codes for the provided Offer and Ad inventory is returned.
Specifications
-
Path:
/api/v1/codes
-
HTTP verb:
GET
Parameters
-
limit
A limit on the number of objects to be returned. Accepts integers between 1 and 50. If not specified the default value is 10. -
offset
An offset for use in pagination. It offsets the starting point of the returned objects by the provided integer. For instance, if you request a list of the first ten objects, your subsequent call can include offset=10 in order to fetch the next ten Offers. -
offerSid – required
The Offer for which the codes are returned. -
adInventorySid – required
The Ad inventory for which the codes are returned.
Example response
[
{
"id" : "573",
"name" : "Summer sale 2016",
"type" : "banner",
"isDefault" : true,
"targetedCountries" : [
"FR",
"DE",
"NO",
"PL"
],
"clickUrl" : "https://c.trackmytarget.com/28ig76",
"bannerDetails" : {
"impressionUrl": "https://i.trackmytarget.com/q67cb8",
"height" : 297,
"width" : 297,
"fileSize" : 48988,
"fileType" : "image/jpeg"
}
}, {
"id" : "609",
"name" : "Summer sale 2016",
"type" : "text link",
"isDefault" : true,
"targetedCountries" : [
"FR",
"DE",
"NO",
"PL"
],
"clickUrl" : "https://c.trackmytarget.com/238g36",
"bannerDetails" : null
}
]
Response codes
-
200 Accepted
-
401 Unauthorized – No valid account token
-
408 Request timeout – Request Time Out