/creatives

GET
A GET request can always be filtered by the get parameters defined in the introduction section of this documentation.
Example get request:
1
GET https://api.adnuntius.com/api/v1/creatives?context=winning&orderByDirection=ASCENDING
Copied!
Example response:
1
{
2
    "results": [
3
        {
4
            "id": "7007clfzcm78jkjg",
5
            "createUser": {
6
                "id": "380a19a3-96e9-4eb8-ba74-f93da35cd153",
7
                "name": "Adnuntius",
8
                "url": "/api/v1/users/380a19a3-96e9-4eb8-ba74-f93da35cd153"
9
            },
10
            "createTime": "2017-10-24T11:07:41.041Z",
11
            "updateUser": {
12
                "id": "380a19a3-96e9-4eb8-ba74-f93da35cd153",
13
                "name": "Adnuntius",
14
                "url": "/api/v1/users/380a19a3-96e9-4eb8-ba74-f93da35cd153"
15
            },
16
            "updateTime": "2017-10-24T11:07:59.837Z",
17
            "objectState": "ACTIVE",
18
            "validationWarnings": [],
19
            "network": {
20
                "id": "winning",
21
                "name": "Micke",
22
                "url": "/api/v1/networks/winning"
23
            },
24
            "name": "Creative for Testing burn rate",
25
            "lineItem": {
26
                "id": "tpfbtsbmkxj8ghz7",
27
                "name": "Testing burn rate",
28
                "url": "/api/v1/lineitems/tpfbtsbmkxj8ghz7"
29
            },
30
            "layout": {
31
                "id": "winning_image_layout_1",
32
                "name": "Image",
33
                "url": "/api/v1/layouts/winning_image_layout_1"
34
            },
35
            "width": 980,
36
            "height": 240,
37
            "userState": "APPROVED",
38
            "constraintsToAssets": {
39
                "Image": {
40
                    "id": "72wgy8mhhsxdnqs7",
41
                    "url": "/api/v1/assets/7007clfzcm78jkjg/72wgy8mhhsxdnqs7"
42
                }
43
            },
44
            "constraintsToText": {},
45
            "constraintsToUrls": {
46
                "destination": "http://www.google.com"
47
            },
48
            "targeting": {
49
                "deviceTargets": [],
50
                "adUnitTarget": {
51
                    "adUnits": []
52
                },
53
                "userSegmentTargets": [],
54
                "dateTarget": {
55
                    "dateRanges": [],
56
                    "timeZoneSetting": "SYSTEM"
57
                },
58
                "geospatialTargets": [],
59
                "keyValueTargets": [],
60
                "siteTarget": {
61
                    "sites": []
62
                },
63
                "adUnitMatchingLabelTargets": [],
64
                "categoryTargets": [],
65
                "namedLocationTarget": {
66
                    "locations": []
67
                },
68
                "dayPartingTargets": [],
69
                "retargetingTargets": [],
70
                "keywordTargets": [],
71
                "ipAddressTarget": {
72
                    "addresses": []
73
                }
74
            },
75
            "impressionTrackingUrls": [],
76
            "thirdPartyContent": {},
77
            "renderedHtml": "<a rel=\"nofollow\" target=\"_top\" href=\"\"><img src=\"//assets.adnuntius.com/aO59MDnCKaLBQNA0G0DUCc7nj8wJA0e149OPTkQCww8.jpg\" width=\"980\" height=\"240\" alt=\"\"/></a>",
78
            "type": "INTERNAL",
79
            "url": "/api/v1/creatives/7007clfzcm78jkjg"
80
        }
81
    ],
82
    "totalCount": 1
83
}
Copied!
POST
Post object contains the following keys:
Name
Type
Description
id
String
Identification of the object.
createUser
Object
Reference to the user that created the object.
createTime
String
Date string referencing the creation of the object.
constraintsToAssets
Object
Object that defines the assets linked to the creative.
constraintsToText
Object
Object that defines the text items linked to the creative.
constraintsToUrl
Object
Object holding the various click trackers for Adnuntius.
description
String
The description for the creative
height
Int
The height of the creative
Creative ID can be set to whatever string value the user would like as long as it is unique within the network.
Example POST request: {id} will be required when posting to the API.
1
POST https://api.adnuntius.com/api/v1/creatives/{id}
Copied!
Example post body:
1
{
2
  "constraintsToAssets": {
3
    "image1": "asset_1",
4
    "image2": {
5
      "id": "asset_2"
6
    },
7
    "image3": null
8
  },
9
  "constraintsToText": {
10
    "headline": "Man bites Dog!",
11
    "content": "Click here..."
12
  },
13
  "constraintsToUrls": {
14
    "destinationUrl": "www.example.com"
15
  },
16
  "description": "The description for the creative",
17
  "height": 300,
18
  "impressionTrackingUrls": [ "http://imp.tradedoubler.com/imp?type(inv)g(20367306)a(2095715)" ],
19
  "layout": "layout_1",
20
  "lineItem": "lineitem_1",
21
  "name": "My First Creative",
22
  "userState": "REQUIRES_REVIEW",
23
  "width": 200,
24
  "type": "INTERNAL"
25
}
Copied!
example POST response
1
{
2
  "lineItem": {
3
    "id": "lineitem_1",
4
    "url": "/api/v1/lineitems/lineitem_1",
5
    "name": "My Line Item"
6
  },
7
  "constraintsToAssets": {
8
    "image1": {
9
      "id": "asset_1",
10
      "url": "/api/v1/assets/creative_1/asset_1"
11
    },
12
    "image2": {
13
      "id": "asset_2",
14
      "url": "/api/v1/assets/creative_1/asset_2"
15
    },
16
    "image3": null
17
  },
18
  "constraintsToText": {
19
    "headline": "Man bites Dog!",
20
    "content": "Click here..."
21
  },
22
  "constraintsToUrls": {
23
    "destinationUrl": "www.example.com"
24
  },
25
  "thirdPartyContent": {},
26
  "createTime": "2016-01-01T10:20:30Z",
27
  "createUser": {
28
    "id": "create_user",
29
    "url": "/api/v1/users/create_user",
30
    "name": "Alice"
31
  },
32
  "description": "The description for the creative",
33
  "height": 300,
34
  "id": "creative_1",
35
  "impressionTrackingUrls": [ "http://imp.tradedoubler.com/imp?type(inv)g(20367306)a(2095715)" ],
36
  "layout": {
37
    "id": "layout_1",
38
    "url": "/api/v1/layouts/layout_1",
39
    "name": "My Layout"
40
  },
41
  "name": "My First Creative",
42
  "network": {
43
    "id": "network_1",
44
    "url": "/api/v1/networks/network_1"
45
  },
46
  "objectState": "ACTIVE",
47
  "targeting": {
48
    "adUnitMatchingLabelTargets": [],
49
    "adUnitTarget": {
50
      "adUnits": []
51
    },
52
    "categoryTargets": [],
53
    "dateTarget": {
54
      "dateRanges": [],
55
      "timeZoneSetting": "SYSTEM"
56
    },
57
    "deviceTargets": [],
58
    "geospatialTargets": [],
59
    "keyValueTargets": [],
60
    "keywordTargets": [],
61
    "namedLocationTarget": {
62
      "locations": []
63
    },
64
    "retargetingTargets": [],
65
    "siteTarget":{
66
      "sites": []
67
    },
68
    "userSegmentTargets": [],
69
    "dayPartingTargets": [],
70
    "ipAddressTarget": {
71
      "addresses":[]
72
    }
73
  },
74
  "updateTime": "2016-01-11T10:20:30Z",
75
  "updateUser": {
76
    "id": "update_user",
77
    "url": "/api/v1/users/update_user",
78
    "name": "Bob"
79
  },
80
  "userState": "REQUIRES_REVIEW",
81
  "url": "/api/v1/creatives/creative_1",
82
  "validationWarnings": [],
83
  "width": 200,
84
  "type": "INTERNAL"
85
}
Copied!
/coupons
/customeventtypes
Last modified 6mo ago
Copy link
Contents
GET
POST