epom 0.9.9 → 0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/epom/banner.rb +0 -5
- data/lib/epom/epom_element.rb +15 -1
- data/lib/epom/placement.rb +10 -0
- data/lib/epom/site.rb +0 -7
- data/lib/epom/version.rb +1 -1
- data/lib/parser/doc/advertiser.html +3627 -0
- data/lib/parser/doc/advertiser_files/collapse.gif +0 -0
- data/lib/parser/doc/advertiser_files/default_037.css +71 -0
- data/lib/parser/doc/advertiser_files/expand.gif +0 -0
- data/lib/parser/doc/advertiser_files/header.gif +0 -0
- data/lib/parser/doc/advertiser_files/searchbtn.png +0 -0
- data/lib/parser/jquery-1.11.0.min.js +4 -0
- data/lib/parser/parser.html +10 -0
- data/lib/parser/parser.js +12 -0
- data/test/epom/placement_test.rb +15 -0
- data/test/epom/site_test.rb +0 -15
- data/test/epom/zone_test.rb +1 -1
- metadata +11 -8
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b4c396bb9de8ec04b2572fd46c76ce69f2ca4c75
|
|
4
|
+
data.tar.gz: 3f2f59811305247d84c8767e8a0e60085dbadc3d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 067dc225a6ba0bf2f76dc518dde729036c77ea8938e015d5df5384205572345b63e6d4c0509afcde668797f3b80460b047b24d1e7d956810d186c3eeac788397
|
|
7
|
+
data.tar.gz: e75e598ad49c41f8d198c51487482844dd7f00fa3e17c753da835985570453a08a949fc8e2d0b7cc554be906d3d645e2bb0d33a3b36b3c7ea8995261a153eb9d
|
data/lib/epom/banner.rb
CHANGED
|
@@ -474,11 +474,6 @@ module Epom
|
|
|
474
474
|
:body_parameters => [:bannerIds, :advertisingCategories, :hash, :timestamp, :username],
|
|
475
475
|
:method => :get
|
|
476
476
|
},
|
|
477
|
-
:get_publishing_categories => {
|
|
478
|
-
:url => '/rest-api/categories/publishing.do',
|
|
479
|
-
:body_parameters => [:hash, :timestamp, :username],
|
|
480
|
-
:method => :get
|
|
481
|
-
},
|
|
482
477
|
:update_banner => {
|
|
483
478
|
:url => '/rest-api/banner/BANNER_ID/update.do',
|
|
484
479
|
:url_parameters => [:bannerId],
|
data/lib/epom/epom_element.rb
CHANGED
|
@@ -77,7 +77,21 @@ module Epom
|
|
|
77
77
|
|
|
78
78
|
def self.method_missing(name, *args)
|
|
79
79
|
if self.extended_methods.keys.include?(name.to_sym)
|
|
80
|
-
|
|
80
|
+
if args.count == 1 and args[0].is_a?(Hash)
|
|
81
|
+
signature = extended_methods[name]
|
|
82
|
+
url_params_signature = signature[:url_parameters]
|
|
83
|
+
body_params_signature = signature[:body_parameters]
|
|
84
|
+
|
|
85
|
+
args[0].symbolize_keys!
|
|
86
|
+
url_params = args[0].select{|key, value| url_params_signature.include? key}
|
|
87
|
+
body_params = args[0].select{|key, value| body_params_signature.include? key}
|
|
88
|
+
|
|
89
|
+
self.generic_method(name, url_params, body_params)
|
|
90
|
+
elsif args.count == 2
|
|
91
|
+
self.generic_method(name, args[0], args[1])
|
|
92
|
+
else
|
|
93
|
+
super
|
|
94
|
+
end
|
|
81
95
|
else
|
|
82
96
|
super
|
|
83
97
|
end
|
data/lib/epom/placement.rb
CHANGED
|
@@ -13,6 +13,13 @@ module Epom
|
|
|
13
13
|
:body_parameters => [:hash, :timestamp, :username],
|
|
14
14
|
:method => :post
|
|
15
15
|
},
|
|
16
|
+
:set_placement_pricing => {
|
|
17
|
+
:url => '/rest-api/placements/PLACEMENT_ID/pricing.do?username=USERNAME×tamp=TIMESTAMP&hash=HASH',
|
|
18
|
+
:url_parameters => [:placementId, :hash, :timestamp, :username],
|
|
19
|
+
:body_parameters => [],
|
|
20
|
+
:method => :post,
|
|
21
|
+
:headers => {'Content-type' => 'application/json'}
|
|
22
|
+
},
|
|
16
23
|
:get_placement_summary => {
|
|
17
24
|
:url => '/rest-api/placements/summary.do',
|
|
18
25
|
:body_parameters => [:placementIds, :publishingCategories, :hash, :timestamp, :username],
|
|
@@ -57,6 +64,9 @@ module Epom
|
|
|
57
64
|
end
|
|
58
65
|
|
|
59
66
|
def self.replace_params_in_url(url, url_params)
|
|
67
|
+
url.gsub!('USERNAME', url_params[:username].to_s) if url.include?('USERNAME')
|
|
68
|
+
url.gsub!('TIMESTAMP', url_params[:timestamp].to_s) if url.include?('TIMESTAMP')
|
|
69
|
+
url.gsub!('HASH', url_params[:hash].to_s) if url.include?('HASH')
|
|
60
70
|
url.gsub!('PLACEMENT_ID', url_params[:placementId].to_s) if url.include?('PLACEMENT_ID')
|
|
61
71
|
url
|
|
62
72
|
end
|
data/lib/epom/site.rb
CHANGED
|
@@ -57,13 +57,6 @@ module Epom
|
|
|
57
57
|
:method => :post,
|
|
58
58
|
:headers => {'Content-type' => 'application/json'}
|
|
59
59
|
},
|
|
60
|
-
:set_placement_pricing => {
|
|
61
|
-
:url => '/rest-api/placements/PLACEMENT_ID/pricing.do?username=USERNAME×tamp=TIMESTAMP&hash=HASH',
|
|
62
|
-
:url_parameters => [:placementId, :hash, :timestamp, :username],
|
|
63
|
-
:body_parameters => [],
|
|
64
|
-
:method => :post,
|
|
65
|
-
:headers => {'Content-type' => 'application/json'}
|
|
66
|
-
},
|
|
67
60
|
:update_country_pricing => {
|
|
68
61
|
:url => '/rest-api/sites/SITE_ID/pricing/COUNTRY_CODE.do',
|
|
69
62
|
:url_parameters => [:siteId, :countryCode],
|
data/lib/epom/version.rb
CHANGED
|
@@ -0,0 +1,3627 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html xmlns:og="http://opengraphprotocol.org/schema/" lang="en-US"><head>
|
|
3
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
4
|
+
|
|
5
|
+
<meta charset="UTF-8">
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
<link rel="shortcut icon" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/favicon.ico">
|
|
9
|
+
<link rel="profile" href="http://gmpg.org/xfn/11">
|
|
10
|
+
|
|
11
|
+
<link rel="pingback" href="http://epom.com/support/xmlrpc.php">
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
<meta name="robots" content="index, follow">
|
|
15
|
+
|
|
16
|
+
<!-- This site is optimized with the Yoast WordPress SEO plugin v1.2.5 - http://yoast.com/wordpress/seo/ -->
|
|
17
|
+
<title>Advertiser API | Epom Help Center</title>
|
|
18
|
+
<link rel="canonical" href="http://epom.com/support/advertiser-api-2/">
|
|
19
|
+
<meta property="og:locale" content="en_us">
|
|
20
|
+
<meta property="og:title" content="Advertiser API | Epom Help Center">
|
|
21
|
+
<meta property="og:url" content="http://epom.com/support/advertiser-api-2/">
|
|
22
|
+
<meta property="og:site_name" content="Epom Help Center">
|
|
23
|
+
<meta property="og:type" content="article">
|
|
24
|
+
<!-- / Yoast WordPress SEO plugin. -->
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
<link rel="EditURI" type="application/rsd+xml" title="RSD" href="http://epom.com/support/xmlrpc.php?rsd">
|
|
30
|
+
<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="http://epom.com/support/wp-includes/wlwmanifest.xml">
|
|
31
|
+
<meta name="generator" content="WordPress 3.7.1">
|
|
32
|
+
<link rel="shortlink" href="http://epom.com/support/?p=5854">
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<link rel="stylesheet" type="text/css" href="advertiser_files/default_037.css" media="all">
|
|
40
|
+
</head>
|
|
41
|
+
<body>
|
|
42
|
+
|
|
43
|
+
<div class="container">
|
|
44
|
+
<div id="MrScrollUp" style="display: none;">
|
|
45
|
+
<div class="MrScrollUp1"></div>
|
|
46
|
+
<div class="MrScrollUp2"></div>
|
|
47
|
+
</div>
|
|
48
|
+
|
|
49
|
+
<div class="header">
|
|
50
|
+
<a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default.html" class="logo1"> </a>
|
|
51
|
+
<a href="http://epom.com/support" class="logo2"> </a>
|
|
52
|
+
<img src="advertiser_files/header.gif" alt="epom blog">
|
|
53
|
+
|
|
54
|
+
</div>
|
|
55
|
+
|
|
56
|
+
<div class="page">
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
<div class="right">
|
|
65
|
+
<div class="breadcrumb"><a href="http://epom.com/support">Home</a> » <a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_066.html" title="View all posts in Network Account">Network Account</a>, <a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_036.html" title="View all posts in API Reference" rel="category tag">API Reference</a> » Advertiser API</div>
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
<div class="post">
|
|
69
|
+
<h1><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_037.html">Advertiser API</a></h1>
|
|
70
|
+
|
|
71
|
+
<div class="postcontent">
|
|
72
|
+
<h3 id="contents">Table of Contents</h3>
|
|
73
|
+
<ul>
|
|
74
|
+
<li><a href="#advman">Advertiser Management API</a></li>
|
|
75
|
+
<li><a href="#camman">Campaign Management API</a>
|
|
76
|
+
<ul>
|
|
77
|
+
<li><a href="#camcap">Campaign Capping API</a></li>
|
|
78
|
+
<li><a href="#camlim">Campaign Limits API</a></li>
|
|
79
|
+
<li><a href="#camtar">Campaign Targeting API</a></li>
|
|
80
|
+
<li><a href="#camadc">Campaign Adjusted CPM API</a></li>
|
|
81
|
+
<li><a href="#camppric">Campaign Pricing API</a></li>
|
|
82
|
+
</ul>
|
|
83
|
+
</li>
|
|
84
|
+
<li><a href="#banman">Banner Management API</a>
|
|
85
|
+
<ul>
|
|
86
|
+
<li><a href="#bancap">Banner Capping API</a></li>
|
|
87
|
+
<li><a href="#banlim">Banner Limits API</a></li>
|
|
88
|
+
<li><a href="#bantar">Banner Targeting API</a></li>
|
|
89
|
+
<li><a href="#banlin">Banner Placement Linking API</a></li>
|
|
90
|
+
<li><a href="#banpric">Banner Pricing API</a></li>
|
|
91
|
+
</ul>
|
|
92
|
+
</li>
|
|
93
|
+
<li>
|
|
94
|
+
<ul>
|
|
95
|
+
<a href="#actman">Action Management API</a>
|
|
96
|
+
</ul>
|
|
97
|
+
</li>
|
|
98
|
+
<li>
|
|
99
|
+
<ul>
|
|
100
|
+
<a href="#tempact">Templates Management API</a>
|
|
101
|
+
</ul>
|
|
102
|
+
</li>
|
|
103
|
+
</ul>
|
|
104
|
+
<h3 id="advman" align="center">Advertiser Management</h3>
|
|
105
|
+
<p><!-- NEXT TITLE --></p>
|
|
106
|
+
<h4>Delete Advertiser</h4>
|
|
107
|
+
<p style="white-space: pre-wrap;">Deletes advertiser by given id.</p>
|
|
108
|
+
<p><strong>URL:</strong> /rest-api/advertisers/{advertiserId}/delete.do<br>
|
|
109
|
+
<strong>Method:</strong> DELETE<br>
|
|
110
|
+
<strong>Response format:</strong> application/json</p>
|
|
111
|
+
<p><strong>Error codes:</strong></p>
|
|
112
|
+
<p>401 Unauthorized – authentication error</p>
|
|
113
|
+
<p><strong>Response sample:</strong><br>
|
|
114
|
+
200 OK<br>
|
|
115
|
+
{“success”:true} – success<br>
|
|
116
|
+
{“permission_denied”:,”success”:false} – failure due to insufficient privileges</p>
|
|
117
|
+
<p><strong>Parameters:</strong></p>
|
|
118
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
119
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
120
|
+
username – the given username</p>
|
|
121
|
+
<p><!-- NEXT TITLE --><br>
|
|
122
|
+
<!-- NEXT TITLE --></p>
|
|
123
|
+
<h4>Get Advertiser Permissions For User</h4>
|
|
124
|
+
<p style="white-space: pre-wrap;">Get all advertiser shares for user with Access Level info: Can Edit/Can View/Is Owner.</p>
|
|
125
|
+
<p><strong>URL:</strong> /advertiserShares.do<br>
|
|
126
|
+
<strong>Method:</strong> GET<br>
|
|
127
|
+
<strong>Response format:</strong> application/json</p>
|
|
128
|
+
<p><strong>Error codes:</strong></p>
|
|
129
|
+
<p>401 Unauthorized – authentication error</p>
|
|
130
|
+
<p><strong>Response sample:</strong><br>
|
|
131
|
+
200 OK<br>
|
|
132
|
+
[{"id":1, "name":"campaign1"}, ...]</p>
|
|
133
|
+
<p><strong>Parameters:</strong></p>
|
|
134
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
135
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
136
|
+
username – the given username<br>
|
|
137
|
+
<!-- NEXT TITLE --><br>
|
|
138
|
+
<!-- NEXT TITLE --></p>
|
|
139
|
+
<h4>Get Campaigns For Advertiser</h4>
|
|
140
|
+
<p style="white-space: pre-wrap;">Get the list of all campaigns for a given advertiser.</p>
|
|
141
|
+
<p><strong>URL:</strong> /advertiser/{advertiserId}/campaigns.do<br>
|
|
142
|
+
<strong>Method:</strong> GET<br>
|
|
143
|
+
<strong>Response format:</strong> application/json</p>
|
|
144
|
+
<p><strong>Error codes:</strong></p>
|
|
145
|
+
<p>401 Unauthorized – authentication error</p>
|
|
146
|
+
<p><strong>Response sample:</strong><br>
|
|
147
|
+
200 OK<br>
|
|
148
|
+
[{"id":1, "name":"campaign1"}, ...]</p>
|
|
149
|
+
<p><strong>Parameters:</strong></p>
|
|
150
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
151
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
152
|
+
username – the given username<br>
|
|
153
|
+
<!-- NEXT TITLE --><br>
|
|
154
|
+
<!-- NEXT TITLE --></p>
|
|
155
|
+
<h4>Update Advertiser</h4>
|
|
156
|
+
<p style="white-space: pre-wrap;">Creates or updates advertiser info based on whether or not id was provided.</p>
|
|
157
|
+
<p><strong>URL:</strong> /rest-api/advertisers/update.do<br>
|
|
158
|
+
<strong>Method:</strong> PUT<br>
|
|
159
|
+
<strong>Response format:</strong> application/json</p>
|
|
160
|
+
<p><strong>Error codes:</strong></p>
|
|
161
|
+
<p>401 Unauthorized – authentication error</p>
|
|
162
|
+
<p><strong>Response sample:</strong><br>
|
|
163
|
+
200 OK<br>
|
|
164
|
+
{“success”:true, id:} – success, returns id of affected advertiser record<br>
|
|
165
|
+
{“success”:false} – error {“success”:false, “error”:”permission_denied”} – error due to insufficient privileges</p>
|
|
166
|
+
<p><strong>Parameters:</strong></p>
|
|
167
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
168
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
169
|
+
username – the given username<br>
|
|
170
|
+
id – advertiser identifier (mandatory)<br>
|
|
171
|
+
name – advertiser name (optional)<br>
|
|
172
|
+
contactName – advertiser contact name (optional)<br>
|
|
173
|
+
contactEmail – advertiser contact e-mail (optional)<br>
|
|
174
|
+
description – advertiser description (optional)<br>
|
|
175
|
+
categoryId – advertiser category (optional)<br>
|
|
176
|
+
<!-- NEXT TITLE --></p>
|
|
177
|
+
<h3 id="camman" align="center">Campaign Management</h3>
|
|
178
|
+
<p><!-- NEXT TITLE --></p>
|
|
179
|
+
<h4>Create Campaign</h4>
|
|
180
|
+
<p style="white-space: pre-wrap;">Creates campaign.</p>
|
|
181
|
+
<p><strong>URL:</strong> /rest-api/campaign/create.do<br>
|
|
182
|
+
<strong>Method:</strong> POST<br>
|
|
183
|
+
<strong>Response format:</strong> application/json</p>
|
|
184
|
+
<p><strong>Error codes:</strong></p>
|
|
185
|
+
<p>400 Bad Request – wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
186
|
+
401 Unauthorized – authentication error<br>
|
|
187
|
+
403 Forbidden – not enough permissions<br>
|
|
188
|
+
404 Not Found – advertiser with given id not found</p>
|
|
189
|
+
<p><strong>Request Parameters:</strong></p>
|
|
190
|
+
<p>name – name of campaign as a String<br>
|
|
191
|
+
advertiserId – id of the advertiser<br>
|
|
192
|
+
description – description of campaign as a String<br>
|
|
193
|
+
active – active status of campaign as a boolean<br>
|
|
194
|
+
ctrOptimization – switch for CTR optimization setting of campaign as a boolean<br>
|
|
195
|
+
weight – weight of campaign as a integer<br>
|
|
196
|
+
allowNewPlacementsAutolinking – permission for campaign to allow link it’s banners to new placements automatically as boolean.<br>
|
|
197
|
+
autolinkCategories – ID’s of publishing categories for autolinking.</p>
|
|
198
|
+
<p><strong>Response sample:</strong><br>
|
|
199
|
+
200 OK<br>
|
|
200
|
+
{“success”:true} – success<br>
|
|
201
|
+
{“error”:”permission_denied”,”success”:false} – failure due to insufficient privileges</p>
|
|
202
|
+
<p><strong>Parameters:</strong></p>
|
|
203
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
204
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
205
|
+
username – the given username<br>
|
|
206
|
+
<!-- NEXT TITLE --><br>
|
|
207
|
+
<!-- NEXT TITLE --></p>
|
|
208
|
+
<h4>Copy|Move the campaign</h4>
|
|
209
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/{operation}/{advertiserId}.do.<br>
|
|
210
|
+
<strong>Method:</strong> POST.<br>
|
|
211
|
+
<strong>Response format:</strong> application/json.<br>
|
|
212
|
+
<strong>Error codes:</strong></p>
|
|
213
|
+
<ul>
|
|
214
|
+
<li>400 Bad Request – wrong request format. E.g. wrong types for parameters or no campaign|advertiser with such id exists.</li>
|
|
215
|
+
<li>401 Unauthorized – authentication error.</li>
|
|
216
|
+
<li>403 Forbidden – not enough permissions.</li>
|
|
217
|
+
</ul>
|
|
218
|
+
<p><strong>Response sample:</strong><br>
|
|
219
|
+
200 OK.<br>
|
|
220
|
+
<strong>Parameters:</strong></p>
|
|
221
|
+
<ul>
|
|
222
|
+
<li>hash – a MD5 digest of concatenated username’s md5 password and the given timestamp;</li>
|
|
223
|
+
<li>timestamp – UNIX timestamp used in hash generation;</li>
|
|
224
|
+
<li>username – the given username;</li>
|
|
225
|
+
<li>advertiserId – the given banner id;</li>
|
|
226
|
+
<li>campaignId id – of campaign where to move/copy banner to;</li>
|
|
227
|
+
<li>operation – operation to perform (literal, either COPY or MOVE);</li>
|
|
228
|
+
<li>copyCount – numbers of copies, not required, defaults to 1;</li>
|
|
229
|
+
<li>keepBannersLinked – boolean, whether or not preserve banners linkage, defaults to false.</li>
|
|
230
|
+
</ul>
|
|
231
|
+
<p><!-- NEXT TITLE --><br>
|
|
232
|
+
<!-- NEXT TITLE --></p>
|
|
233
|
+
<h4>Delete Campaign</h4>
|
|
234
|
+
<p style="white-space: pre-wrap;">Deletes campaign by given id.</p>
|
|
235
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/delete.do<br>
|
|
236
|
+
<strong>Method:</strong> POST<br>
|
|
237
|
+
<strong>Response format:</strong> application/json</p>
|
|
238
|
+
<p><strong>Error codes:</strong></p>
|
|
239
|
+
<p>401 Unauthorized – authentication error</p>
|
|
240
|
+
<p><strong>Response sample:</strong><br>
|
|
241
|
+
200 OK<br>
|
|
242
|
+
{“success”:true} – success<br>
|
|
243
|
+
{“error”:”permission_denied”,”success”:false} – failure due to insufficient privileges</p>
|
|
244
|
+
<p><strong>Parameters:</strong></p>
|
|
245
|
+
<p>hash – an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
246
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
247
|
+
username – the given username<br>
|
|
248
|
+
campaignId – the given campaign id<br>
|
|
249
|
+
<!-- NEXT TITLE --><br>
|
|
250
|
+
<!-- NEXT TITLE --></p>
|
|
251
|
+
<h4>Get Banners For Campaign</h4>
|
|
252
|
+
<p style="white-space: pre-wrap;">Get the list of all banners for given campaign.</p>
|
|
253
|
+
<p><strong>URL:</strong> /campaign/{campaignId}/banners.do<br>
|
|
254
|
+
<strong>Method:</strong> GET<br>
|
|
255
|
+
<strong>Response format:</strong> application/json</p>
|
|
256
|
+
<p><strong>Error codes:</strong></p>
|
|
257
|
+
<p>401 Unauthorized – authentication error</p>
|
|
258
|
+
<p><strong>Response sample:</strong><br>
|
|
259
|
+
200 OK<br>
|
|
260
|
+
[{"id":1, "name":"banner1"}, ...]</p>
|
|
261
|
+
<p><strong>Parameters:</strong></p>
|
|
262
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
263
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
264
|
+
username – the given username<br>
|
|
265
|
+
<!-- NEXT TITLE --><br>
|
|
266
|
+
<!-- NEXT TITLE --></p>
|
|
267
|
+
<h4>Get Campaign</h4>
|
|
268
|
+
<p style="white-space: pre-wrap;">Get the campaign by id.</p>
|
|
269
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}.do<br>
|
|
270
|
+
<strong>Method:</strong> GET<br>
|
|
271
|
+
<strong>Response format:</strong> application/json</p>
|
|
272
|
+
<p><strong>Error codes:</strong></p>
|
|
273
|
+
<p>401 Unauthorized – authentication error<br>
|
|
274
|
+
403 Forbidden – not enough permissions<br>
|
|
275
|
+
404 Not Found – no campaign for such id found</p>
|
|
276
|
+
<p><strong>Response sample:</strong><br>
|
|
277
|
+
200 OK</p>
|
|
278
|
+
<p><strong>Parameters:</strong></p>
|
|
279
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
280
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
281
|
+
username – the given username<br>
|
|
282
|
+
campaignId – the given campaign id<br>
|
|
283
|
+
<!-- NEXT TITLE --><br>
|
|
284
|
+
<!-- NEXT TITLE --></p>
|
|
285
|
+
<h4>Get Campaigns</h4>
|
|
286
|
+
<p style="white-space: pre-wrap;">Get the list of all campaigns for the given user.</p>
|
|
287
|
+
<p><strong>URL:</strong> /rest-api/campaigns.do<br>
|
|
288
|
+
<strong>Method:</strong> GET<br>
|
|
289
|
+
<strong>Response format:</strong> application/json</p>
|
|
290
|
+
<p><strong>Error codes:</strong></p>
|
|
291
|
+
<p>401 Unauthorized – authentication error</p>
|
|
292
|
+
<p><strong>Response sample:</strong><br>
|
|
293
|
+
200 OK</p>
|
|
294
|
+
<p><strong>Parameters:</strong></p>
|
|
295
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
296
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
297
|
+
username – the given username<br>
|
|
298
|
+
<!-- NEXT TITLE --><br>
|
|
299
|
+
<!-- NEXT TITLE --></p>
|
|
300
|
+
<h4>Update Campaign</h4>
|
|
301
|
+
<p style="white-space: pre-wrap;">Updates campaign with given id.</p>
|
|
302
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/update.do<br>
|
|
303
|
+
<strong>Method:</strong> POST<br>
|
|
304
|
+
<strong>Response format:</strong> application/json</p>
|
|
305
|
+
<p><strong>Error codes:</strong></p>
|
|
306
|
+
<p>401 Unauthorized – authentication error<br>
|
|
307
|
+
403 Forbidden – not enough permissions<br>
|
|
308
|
+
404 Not Found – campaign with given id not found</p>
|
|
309
|
+
<p><strong>Request Parameters:</strong></p>
|
|
310
|
+
<p>name – name of campaign as a String<br>
|
|
311
|
+
description – description of campaign as a String<br>
|
|
312
|
+
active – active status of campaign as a boolean<br>
|
|
313
|
+
ctrOptimization – switch for CTR optimization setting of campaign as a boolean<br>
|
|
314
|
+
weight – weight of campaign as a integer<br>
|
|
315
|
+
allowNewPlacementsAutolinking – permission for campaign to allow link it’s banners to new placements automatically as boolean.<br>
|
|
316
|
+
autolinkCategories – ID’s of publishing categories for autolinking.</p>
|
|
317
|
+
<p><strong>Response sample:</strong><br>
|
|
318
|
+
200 OK<br>
|
|
319
|
+
{“success”:true} – success<br>
|
|
320
|
+
{“error”:”permission_denied”,”success”:false} – failure due to insufficient privileges</p>
|
|
321
|
+
<p><strong>Parameters:</strong></p>
|
|
322
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
323
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
324
|
+
username – the given username<br>
|
|
325
|
+
campaignId – the given campaign id<br>
|
|
326
|
+
<!-- NEXT TITLE --></p>
|
|
327
|
+
<h4 id="camcap" align="center"><span style="text-decoration: underline;">Campaign Capping API</span></h4>
|
|
328
|
+
<p><!-- NEXT TITLE --></p>
|
|
329
|
+
<h4>Get Action Capping</h4>
|
|
330
|
+
<p style="white-space: pre-wrap;">Get the campaign action capping information by campaign id.</p>
|
|
331
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/actionCapping.do<br>
|
|
332
|
+
<strong>Method:</strong> GET<br>
|
|
333
|
+
<strong>Response format:</strong> application/json</p>
|
|
334
|
+
<p><strong>Error codes:</strong></p>
|
|
335
|
+
<p>401 Unauthorized – authentication error<br>
|
|
336
|
+
403 Forbidden – not enough permissions<br>
|
|
337
|
+
404 Not Found – campaign with given id not found</p>
|
|
338
|
+
<p><strong>Response sample:</strong><br>
|
|
339
|
+
200 OK</p>
|
|
340
|
+
<p><strong>Parameters:</strong></p>
|
|
341
|
+
<p>hash – an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
342
|
+
timestamp – UNIX timestamp used in hash generation.<br>
|
|
343
|
+
username – the given username.<br>
|
|
344
|
+
campaignId – the given campaign id.<br>
|
|
345
|
+
<!-- NEXT TITLE --><br>
|
|
346
|
+
<!-- NEXT TITLE --></p>
|
|
347
|
+
<h4>Get Click Capping</h4>
|
|
348
|
+
<p style="white-space: pre-wrap;">Get the campaign click capping information by campaign id.</p>
|
|
349
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/clickCapping.do<br>
|
|
350
|
+
<strong>Method:</strong> GET<br>
|
|
351
|
+
<strong>Response format:</strong> application/json</p>
|
|
352
|
+
<p><strong>Error codes:</strong></p>
|
|
353
|
+
<p>401 Unauthorized – authentication error<br>
|
|
354
|
+
403 Forbidden – not enough permissions<br>
|
|
355
|
+
404 Not Found – campaign with given id not found</p>
|
|
356
|
+
<p><strong>Response sample:</strong><br>
|
|
357
|
+
200 OK<br>
|
|
358
|
+
{id: 1, paymentModel: “CPM”, price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }</p>
|
|
359
|
+
<p><strong>Parameters:</strong></p>
|
|
360
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
361
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
362
|
+
username - the given username<br>
|
|
363
|
+
campaignId - the given campaign id<br>
|
|
364
|
+
<!-- NEXT TITLE --><br>
|
|
365
|
+
<!-- NEXT TITLE --></p>
|
|
366
|
+
<h4>Get Frequency Capping</h4>
|
|
367
|
+
<p style="white-space: pre-wrap;">Get the campaign frequency capping information by campaign id.</p>
|
|
368
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/frequencyCapping.do<br>
|
|
369
|
+
<strong>Method:</strong> GET<br>
|
|
370
|
+
<strong>Response format:</strong> application/json</p>
|
|
371
|
+
<p><strong>Error codes:</strong></p>
|
|
372
|
+
<p>401 Unauthorized - authentication error<br>
|
|
373
|
+
403 Forbidden - not enough permissions<br>
|
|
374
|
+
404 Not Found - campaign with given id not found</p>
|
|
375
|
+
<p><strong>Response sample:</strong><br>
|
|
376
|
+
200 OK<br>
|
|
377
|
+
{id: 1, paymentModel: "CPM", price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }</p>
|
|
378
|
+
<p><strong>Parameters:</strong></p>
|
|
379
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
380
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
381
|
+
username - the given username<br>
|
|
382
|
+
campaignId - the given campaign id<br>
|
|
383
|
+
<!-- NEXT TITLE --><br>
|
|
384
|
+
<!-- NEXT TITLE --></p>
|
|
385
|
+
<h4>Remove Action Capping</h4>
|
|
386
|
+
<p style="white-space: pre-wrap;">Removes the campaign action capping by campaign id.</p>
|
|
387
|
+
<p><strong>URL:</strong> rest-api/campaign/{campaignId}/actionCapping.do<br>
|
|
388
|
+
<strong>Method:</strong> DELETE<br>
|
|
389
|
+
<strong>Response format:</strong> application/json</p>
|
|
390
|
+
<p><strong>Error codes:</strong></p>
|
|
391
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
392
|
+
401 Unauthorized - authentication error<br>
|
|
393
|
+
403 Forbidden - not enough permissions</p>
|
|
394
|
+
<p><strong>Response sample:</strong><br>
|
|
395
|
+
200 OK</p>
|
|
396
|
+
<p><strong>Parameters:</strong></p>
|
|
397
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
398
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
399
|
+
username - the given username<br>
|
|
400
|
+
campaignId - the given campaign id<br>
|
|
401
|
+
<!-- NEXT TITLE --><br>
|
|
402
|
+
<!-- NEXT TITLE --></p>
|
|
403
|
+
<h4>Remove Click Capping</h4>
|
|
404
|
+
<p style="white-space: pre-wrap;">Removes the campaign click capping by campaign id.</p>
|
|
405
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/clickCapping.do<br>
|
|
406
|
+
<strong>Method:</strong> DELETE<br>
|
|
407
|
+
<strong>Response format:</strong> application/json</p>
|
|
408
|
+
<p><strong>Error codes:</strong></p>
|
|
409
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
410
|
+
401 Unauthorized - authentication error<br>
|
|
411
|
+
403 Forbidden - not enough permissions</p>
|
|
412
|
+
<p><strong>Response sample:</strong><br>
|
|
413
|
+
200 OK</p>
|
|
414
|
+
<p><strong>Parameters:</strong></p>
|
|
415
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
416
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
417
|
+
username - the given username<br>
|
|
418
|
+
campaignId - the given campaign id<br>
|
|
419
|
+
<!-- NEXT TITLE --><br>
|
|
420
|
+
<!-- NEXT TITLE --></p>
|
|
421
|
+
<h4>Remove Frequency Capping</h4>
|
|
422
|
+
<p style="white-space: pre-wrap;">Removes the campaign frequency capping by campaign id.</p>
|
|
423
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/frequencyCapping.do<br>
|
|
424
|
+
<strong>Method:</strong> DELETE<br>
|
|
425
|
+
<strong>Response format:</strong> application/json</p>
|
|
426
|
+
<p><strong>Error codes:</strong></p>
|
|
427
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
428
|
+
401 Unauthorized - authentication error<br>
|
|
429
|
+
403 Forbidden - not enough permissions</p>
|
|
430
|
+
<p><strong>Response sample:</strong><br>
|
|
431
|
+
200 OK</p>
|
|
432
|
+
<p><strong>Parameters:</strong></p>
|
|
433
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
434
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
435
|
+
username - the given username<br>
|
|
436
|
+
campaignId - the given campaign id<br>
|
|
437
|
+
<!-- NEXT TITLE --><br>
|
|
438
|
+
<!-- NEXT TITLE --></p>
|
|
439
|
+
<h4>Set Action Capping</h4>
|
|
440
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign action capping values by campaign id.</p>
|
|
441
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/actionCapping/set.do<br>
|
|
442
|
+
<strong>Method:</strong> POST<br>
|
|
443
|
+
<strong>Response format:</strong> application/json</p>
|
|
444
|
+
<p><strong>Error codes:</strong></p>
|
|
445
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
446
|
+
401 Unauthorized - authentication error<br>
|
|
447
|
+
403 Forbidden - not enough permissions<br>
|
|
448
|
+
404 Not Found - campaign not found</p>
|
|
449
|
+
<p><strong>Response sample:</strong><br>
|
|
450
|
+
200 OK</p>
|
|
451
|
+
<p><strong>Parameters:</strong></p>
|
|
452
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
453
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
454
|
+
username - the given username<br>
|
|
455
|
+
campaignId - the given campaign id<br>
|
|
456
|
+
amount - amount of capping<br>
|
|
457
|
+
period - period for capping<br>
|
|
458
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
459
|
+
evenDistribution - - value for even distribution (true/false)<br>
|
|
460
|
+
<!-- NEXT TITLE --><br>
|
|
461
|
+
<!-- NEXT TITLE --></p>
|
|
462
|
+
<h4>Set Click Capping</h4>
|
|
463
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign click capping values by campaign id.</p>
|
|
464
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/clickCapping/set.do<br>
|
|
465
|
+
<strong>Method:</strong> POST<br>
|
|
466
|
+
<strong>Response format:</strong> application/json</p>
|
|
467
|
+
<p><strong>Error codes:</strong></p>
|
|
468
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
469
|
+
401 Unauthorized - authentication error<br>
|
|
470
|
+
403 Forbidden - not enough permissions<br>
|
|
471
|
+
404 Not Found - campaign not found</p>
|
|
472
|
+
<p><strong>Response sample:</strong><br>
|
|
473
|
+
200 OK</p>
|
|
474
|
+
<p><strong>Parameters:</strong></p>
|
|
475
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
476
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
477
|
+
username - the given username<br>
|
|
478
|
+
campaignId - the given campaign id<br>
|
|
479
|
+
amount - amount of capping<br>
|
|
480
|
+
period - period for capping<br>
|
|
481
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
482
|
+
evenDistribution - value for even distribution (true/false)<br>
|
|
483
|
+
<!-- NEXT TITLE --><br>
|
|
484
|
+
<!-- NEXT TITLE --></p>
|
|
485
|
+
<h4>Sets (and enables if was disabled) the campaign click capping values by campaign id</h4>
|
|
486
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/clickCapping/update.do.<br>
|
|
487
|
+
<strong>Method:</strong> POST.<br>
|
|
488
|
+
<strong>Response format:</strong> application/json.<br>
|
|
489
|
+
<strong>Error codes:</strong></p>
|
|
490
|
+
<ul>
|
|
491
|
+
<li>400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.</li>
|
|
492
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
493
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
494
|
+
<li>404 Not Found - no click capping enabled or campaign not found.</li>
|
|
495
|
+
</ul>
|
|
496
|
+
<p><strong>Response sample:</strong><br>
|
|
497
|
+
200 OK.<br>
|
|
498
|
+
<strong>Parameters:</strong></p>
|
|
499
|
+
<ul>
|
|
500
|
+
<li>hash - a MD5 digest of concatenated username's md5 password and the given timestamp;</li>
|
|
501
|
+
<li>timestamp - UNIX timestamp used in hash generation;</li>
|
|
502
|
+
<li>username - the given username;</li>
|
|
503
|
+
<li>id - id of capping record to update;</li>
|
|
504
|
+
<li>campaignId - the given campaign id;</li>
|
|
505
|
+
<li>amount - amount of capping;</li>
|
|
506
|
+
<li>period - period for capping;</li>
|
|
507
|
+
<li>periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR;</li>
|
|
508
|
+
<li>evenDistribution - value for even distribution (true/false).</li>
|
|
509
|
+
</ul>
|
|
510
|
+
<p><!-- NEXT TITLE --><br>
|
|
511
|
+
<!-- NEXT TITLE --></p>
|
|
512
|
+
<h4>Set Frequency Capping</h4>
|
|
513
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign frequency capping values by campaign id.</p>
|
|
514
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/frequencyCapping/set.do<br>
|
|
515
|
+
<strong>Method:</strong> POST<br>
|
|
516
|
+
<strong>Response format:</strong> application/json</p>
|
|
517
|
+
<p><strong>Error codes:</strong></p>
|
|
518
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
519
|
+
401 Unauthorized - authentication error<br>
|
|
520
|
+
403 Forbidden - not enough permissions<br>
|
|
521
|
+
404 Not Found - campaign not found</p>
|
|
522
|
+
<p><strong>Response sample:</strong><br>
|
|
523
|
+
200 OK</p>
|
|
524
|
+
<p><strong>Parameters:</strong></p>
|
|
525
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
526
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
527
|
+
username - the given username<br>
|
|
528
|
+
campaignId - the given campaign id<br>
|
|
529
|
+
amount - amount of capping<br>
|
|
530
|
+
period - period for capping<br>
|
|
531
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
532
|
+
evenDistribution - value for even distribution (true/false)<br>
|
|
533
|
+
<!-- NEXT TITLE --><br>
|
|
534
|
+
<!-- NEXT TITLE --></p>
|
|
535
|
+
<h4>Update Action Capping</h4>
|
|
536
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign action capping values by campaign id.</p>
|
|
537
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/actionCapping/update.do<br>
|
|
538
|
+
<strong>Method:</strong> POST<br>
|
|
539
|
+
<strong>Response format:</strong> application/json</p>
|
|
540
|
+
<p><strong>Error codes:</strong></p>
|
|
541
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
542
|
+
401 Unauthorized - authentication error<br>
|
|
543
|
+
403 Forbidden - not enough permissions<br>
|
|
544
|
+
404 Not Found - campaign not found</p>
|
|
545
|
+
<p><strong>Response sample:</strong><br>
|
|
546
|
+
200 OK</p>
|
|
547
|
+
<p><strong>Parameters:</strong></p>
|
|
548
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
549
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
550
|
+
username - the given username<br>
|
|
551
|
+
campaignId - the given campaign id<br>
|
|
552
|
+
amount - amount of capping<br>
|
|
553
|
+
period - period for capping<br>
|
|
554
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
555
|
+
evenDistribution - value for even distribution (true/false)<br>
|
|
556
|
+
<!-- NEXT TITLE --><br>
|
|
557
|
+
<!-- NEXT TITLE --></p>
|
|
558
|
+
<h4>Update Click Capping</h4>
|
|
559
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign click capping values by campaign id.</p>
|
|
560
|
+
<p><strong>URL:</strong> //rest-api/campaign/{campaignId}/clickCapping/update.do<br>
|
|
561
|
+
<strong>Method:</strong> POST<br>
|
|
562
|
+
<strong>Response format:</strong> application/json</p>
|
|
563
|
+
<p><strong>Error codes:</strong></p>
|
|
564
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
565
|
+
401 Unauthorized - authentication error<br>
|
|
566
|
+
403 Forbidden - not enough permissions<br>
|
|
567
|
+
404 Not Found - campaign not found</p>
|
|
568
|
+
<p><strong>Response sample:</strong><br>
|
|
569
|
+
200 OK</p>
|
|
570
|
+
<p><strong>Parameters:</strong></p>
|
|
571
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
572
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
573
|
+
username - the given username<br>
|
|
574
|
+
campaignId - the given campaign id<br>
|
|
575
|
+
amount - amount of capping<br>
|
|
576
|
+
period - period for capping<br>
|
|
577
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
578
|
+
evenDistribution - value for even distribution (true/false)<br>
|
|
579
|
+
<!-- NEXT TITLE --><br>
|
|
580
|
+
<!-- NEXT TITLE --></p>
|
|
581
|
+
<h4>Update Frequency Capping</h4>
|
|
582
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign frequency capping values by campaign id.</p>
|
|
583
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/frequencyCapping/update.do<br>
|
|
584
|
+
<strong>Method:</strong> POST<br>
|
|
585
|
+
<strong>Response format:</strong> application/json</p>
|
|
586
|
+
<p><strong>Error codes:</strong></p>
|
|
587
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
588
|
+
401 Unauthorized - authentication error<br>
|
|
589
|
+
403 Forbidden - not enough permissions<br>
|
|
590
|
+
404 Not Found - campaign not found</p>
|
|
591
|
+
<p><strong>Response sample:</strong><br>
|
|
592
|
+
200 OK</p>
|
|
593
|
+
<p><strong>Parameters:</strong></p>
|
|
594
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
595
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
596
|
+
username - the given username<br>
|
|
597
|
+
campaignId - the given campaign id<br>
|
|
598
|
+
amount - amount of capping<br>
|
|
599
|
+
period - period for capping<br>
|
|
600
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
601
|
+
evenDistribution - value for even distribution (true/false)<br>
|
|
602
|
+
<!-- NEXT TITLE --></p>
|
|
603
|
+
<h4 id="camlim" align="center"><span style="text-decoration: underline;">Campaign Limits API</span></h4>
|
|
604
|
+
<p><!-- NEXT TITLE --></p>
|
|
605
|
+
<h4>Disable Limits</h4>
|
|
606
|
+
<p style="white-space: pre-wrap;">Disables campaign limits.</p>
|
|
607
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/limits.do<br>
|
|
608
|
+
<strong>Method:</strong> DELETE<br>
|
|
609
|
+
<strong>Response format:</strong> application/json</p>
|
|
610
|
+
<p><strong>Error codes:</strong></p>
|
|
611
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
612
|
+
401 Unauthorized - authentication error<br>
|
|
613
|
+
403 Forbidden - not enough permissions</p>
|
|
614
|
+
<p><strong>Response sample:</strong><br>
|
|
615
|
+
200 OK</p>
|
|
616
|
+
<p><strong>Parameters:</strong></p>
|
|
617
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
618
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
619
|
+
username - the given username<br>
|
|
620
|
+
campaignId - the given campaign id<br>
|
|
621
|
+
<!-- NEXT TITLE --><br>
|
|
622
|
+
<!-- NEXT TITLE --></p>
|
|
623
|
+
<h4>Get Limits</h4>
|
|
624
|
+
<p style="white-space: pre-wrap;">Get the campaign limits information by campaign id.</p>
|
|
625
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/limits.do<br>
|
|
626
|
+
<strong>Method:</strong> GET<br>
|
|
627
|
+
<strong>Response format:</strong> application/json</p>
|
|
628
|
+
<p><strong>Error codes:</strong></p>
|
|
629
|
+
<p>401 Unauthorized - authentication error<br>
|
|
630
|
+
403 Forbidden - not enough permissions<br>
|
|
631
|
+
404 Not Found - no limits set for such campaign.</p>
|
|
632
|
+
<p><strong>Response sample:</strong><br>
|
|
633
|
+
200 OK</p>
|
|
634
|
+
<p><strong>Parameters:</strong></p>
|
|
635
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
636
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
637
|
+
username - the given username<br>
|
|
638
|
+
campaignId - the given campaign id<br>
|
|
639
|
+
<!-- NEXT TITLE --><br>
|
|
640
|
+
<!-- NEXT TITLE --></p>
|
|
641
|
+
<h4>Reset Limits</h4>
|
|
642
|
+
<p style="white-space: pre-wrap;">Resets the campaign limits counter values by campaign id and counter type.</p>
|
|
643
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/limits/reset.do<br>
|
|
644
|
+
<strong>Method:</strong> DELETE<br>
|
|
645
|
+
<strong>Response format:</strong> application/json</p>
|
|
646
|
+
<p><strong>Error codes:</strong></p>
|
|
647
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
648
|
+
401 Unauthorized - authentication error<br>
|
|
649
|
+
403 Forbidden - not enough permissions<br>
|
|
650
|
+
404 Not Found - no limit enabled for the campaign</p>
|
|
651
|
+
<p><strong>Response sample:</strong><br>
|
|
652
|
+
200 OK</p>
|
|
653
|
+
<p><strong>Parameters:</strong></p>
|
|
654
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
655
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
656
|
+
username - the given username<br>
|
|
657
|
+
campaignId - the given campaign id<br>
|
|
658
|
+
limitCounters - list of counters to reset, available values:
|
|
659
|
+
TOTAL_IMPRESSIONS, TOTAL_CLICKS, TOTAL_REVENUE, DAILY_IMPRESSIONS,
|
|
660
|
+
DAILY_CLICKS, DAILY_REVENUE<br>
|
|
661
|
+
<!-- NEXT TITLE --><br>
|
|
662
|
+
<!-- NEXT TITLE --></p>
|
|
663
|
+
<h4>Set Limits</h4>
|
|
664
|
+
<p style="white-space: pre-wrap;">Set the campaign limits information by campaign id.</p>
|
|
665
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/limits/set.do<br>
|
|
666
|
+
<strong>Method:</strong> POST<br>
|
|
667
|
+
<strong>Response format:</strong> application/json</p>
|
|
668
|
+
<p><strong>Error codes:</strong></p>
|
|
669
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
670
|
+
401 Unauthorized - authentication error<br>
|
|
671
|
+
403 Forbidden - not enough permissions</p>
|
|
672
|
+
<p><strong>Request Parameters:</strong></p>
|
|
673
|
+
<p>Long totalImpressionsLimit; Long totalClicksLimit; Double
|
|
674
|
+
totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit;
|
|
675
|
+
Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double
|
|
676
|
+
totalBudget; Long dailyImpressions; Long dailyClicks; Double
|
|
677
|
+
dailyBudget;<br>
|
|
678
|
+
startDate - limit start, "yyyy-MM-dd-HH-mm"<br>
|
|
679
|
+
endDate - limit end, "yyyy-MM-dd-HH-mm"<br>
|
|
680
|
+
totalImpressionsLimit - limit for impressions<br>
|
|
681
|
+
totalClicksLimit - limit for clicks<br>
|
|
682
|
+
totalBudgetLimit - limit for budget<br>
|
|
683
|
+
dailyImpressionsLimit - daily limit for impressions<br>
|
|
684
|
+
dailyClicksLimit - daily limit for clicks<br>
|
|
685
|
+
dailyBudgetLimit - daily limit for budget<br>
|
|
686
|
+
totalImpressions - current value for impressions<br>
|
|
687
|
+
totalClicks - current value for clicks<br>
|
|
688
|
+
totalBudget - current value for budget<br>
|
|
689
|
+
dailyImpressions - value for impressions for current day<br>
|
|
690
|
+
dailyClicks - value for clicks for current day<br>
|
|
691
|
+
dailyBudget - value for budget for current day</p>
|
|
692
|
+
<p><strong>Response sample:</strong><br>
|
|
693
|
+
200 OK</p>
|
|
694
|
+
<p><strong>Parameters:</strong></p>
|
|
695
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
696
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
697
|
+
username - the given username<br>
|
|
698
|
+
campaignId - the given campaign id<br>
|
|
699
|
+
<!-- NEXT TITLE --><br>
|
|
700
|
+
<!-- NEXT TITLE --></p>
|
|
701
|
+
<h4>Update Limits</h4>
|
|
702
|
+
<p style="white-space: pre-wrap;">Updates the campaign limits information by campaign id.</p>
|
|
703
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/limits/update.do<br>
|
|
704
|
+
<strong>Method:</strong> POST<br>
|
|
705
|
+
<strong>Response format:</strong> application/json</p>
|
|
706
|
+
<p><strong>Error codes:</strong></p>
|
|
707
|
+
<p>400 Bad Request - wrong request format. No campaign or campaign pricing is not enabled for the given campaign.<br>
|
|
708
|
+
401 Unauthorized - authentication error<br>
|
|
709
|
+
403 Forbidden - not enough permissions<br>
|
|
710
|
+
404 Not Found - no limits enabled or campaign not found</p>
|
|
711
|
+
<p><strong>Request Parameters:</strong></p>
|
|
712
|
+
<p>Long totalImpressionsLimit; Long totalClicksLimit; Double
|
|
713
|
+
totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit;
|
|
714
|
+
Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double
|
|
715
|
+
totalBudget; Long dailyImpressions; Long dailyClicks; Double
|
|
716
|
+
dailyBudget;<br>
|
|
717
|
+
startDate - limit start, milliseconds<br>
|
|
718
|
+
endDate - limit end, milliseconds<br>
|
|
719
|
+
totalImpressionsLimit - limit for impressions<br>
|
|
720
|
+
totalClicksLimit - limit for clicks<br>
|
|
721
|
+
totalBudgetLimit - limit for budget<br>
|
|
722
|
+
dailyImpressionsLimit - daily limit for impressions<br>
|
|
723
|
+
dailyClicksLimit - daily limit for clicks<br>
|
|
724
|
+
dailyBudgetLimit - daily limit for budget<br>
|
|
725
|
+
totalImpressions - current value for impressions<br>
|
|
726
|
+
totalClicks - current value for clicks<br>
|
|
727
|
+
totalBudget - current value for budget<br>
|
|
728
|
+
dailyImpressions - value for impressions for current day<br>
|
|
729
|
+
dailyClicks - value for clicks for current day<br>
|
|
730
|
+
dailyBudget - value for budget for current day</p>
|
|
731
|
+
<p><strong>Response sample:</strong><br>
|
|
732
|
+
200 OK</p>
|
|
733
|
+
<p><strong>Parameters:</strong></p>
|
|
734
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
735
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
736
|
+
username - the given username<br>
|
|
737
|
+
campaignId - the given campaign id<br>
|
|
738
|
+
<!-- NEXT TITLE --></p>
|
|
739
|
+
<h4 id="camtar" align="center"><span style="text-decoration: underline;">Campaign Targeting API</span></h4>
|
|
740
|
+
<p><!-- NEXT TITLE --></p>
|
|
741
|
+
<h4>Get Targeting</h4>
|
|
742
|
+
<p style="white-space: pre-wrap;">Get the campaign targeting by id and by campaign id.</p>
|
|
743
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/{targetId}.do<br>
|
|
744
|
+
<strong>Method:</strong> GET<br>
|
|
745
|
+
<strong>Response format:</strong> application/json</p>
|
|
746
|
+
<p><strong>Error codes:</strong><br>
|
|
747
|
+
401 Unauthorized - authentication error<br>
|
|
748
|
+
403 Forbidden - not enough permissions<br>
|
|
749
|
+
404 Not Found - no targeting with given id found for given campaign<br>
|
|
750
|
+
<strong>Response sample:</strong><br>
|
|
751
|
+
200 OK</p>
|
|
752
|
+
<p><strong>Parameters:</strong><br>
|
|
753
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
754
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
755
|
+
username - the given username<br>
|
|
756
|
+
campaignId - the given campaign id<br>
|
|
757
|
+
<!-- NEXT TITLE --><br>
|
|
758
|
+
<!-- NEXT TITLE --></p>
|
|
759
|
+
<h4>Get Targetings</h4>
|
|
760
|
+
<p style="white-space: pre-wrap;">Get the campaign targetings by campaign id.</p>
|
|
761
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targetings.do<br>
|
|
762
|
+
<strong>Method:</strong> GET<br>
|
|
763
|
+
<strong>Response format:</strong> application/json</p>
|
|
764
|
+
<p><strong>Error codes:</strong><br>
|
|
765
|
+
401 Unauthorized - authentication error<br>
|
|
766
|
+
403 Forbidden - not enough permissions<br>
|
|
767
|
+
<strong>Response sample:</strong><br>
|
|
768
|
+
200 OK</p>
|
|
769
|
+
<p><strong>Parameters:</strong><br>
|
|
770
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
771
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
772
|
+
username - the given username<br>
|
|
773
|
+
campaignId - the given campaign id<br>
|
|
774
|
+
<!-- NEXT TITLE --><br>
|
|
775
|
+
<!-- NEXT TITLE --></p>
|
|
776
|
+
<h4>Get Targeting Types</h4>
|
|
777
|
+
<p style="white-space: pre-wrap;">Get the campaign targeting types by campaign id.</p>
|
|
778
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/types.do<br>
|
|
779
|
+
<strong>Method:</strong> GET<br>
|
|
780
|
+
<strong>Response format:</strong> application/json</p>
|
|
781
|
+
<p><strong>Error codes:</strong><br>
|
|
782
|
+
401 Unauthorized - authentication error<br>
|
|
783
|
+
403 Forbidden - not enough permissions<br>
|
|
784
|
+
404 Not Found - no targeting with given id found for given campaign<br>
|
|
785
|
+
<strong>Response sample:</strong><br>
|
|
786
|
+
200 OK</p>
|
|
787
|
+
<p><strong>Parameters:</strong><br>
|
|
788
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
789
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
790
|
+
username - the given username<br>
|
|
791
|
+
campaignId - the given campaign id<br>
|
|
792
|
+
<!-- NEXT TITLE --><br>
|
|
793
|
+
<!-- NEXT TITLE --></p>
|
|
794
|
+
<h4>Remove Targeting</h4>
|
|
795
|
+
<p style="white-space: pre-wrap;">Removes targeting by targeting id and campaign id.</p>
|
|
796
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/{targetId}/delete.do<br>
|
|
797
|
+
<strong>Method:</strong> DELETE<br>
|
|
798
|
+
<strong>Response format:</strong> application/json</p>
|
|
799
|
+
<p><strong>Error codes:</strong><br>
|
|
800
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
801
|
+
401 Unauthorized - authentication error<br>
|
|
802
|
+
403 Forbidden - not enough permissions<br>
|
|
803
|
+
404 Not Found - no targeting with given id found for given campaign<br>
|
|
804
|
+
<strong>Response sample:</strong><br>
|
|
805
|
+
200 OK</p>
|
|
806
|
+
<p><strong>Parameters:</strong><br>
|
|
807
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
808
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
809
|
+
username - the given username<br>
|
|
810
|
+
campaignId - the given campaign id<br>
|
|
811
|
+
targetId - the given target id<br>
|
|
812
|
+
<!-- NEXT TITLE --><br>
|
|
813
|
+
<!-- NEXT TITLE --></p>
|
|
814
|
+
<h4>Get available operating systems values for operating system targeting type</h4>
|
|
815
|
+
<p><strong>URL:</strong> /rest-api/targeting/os/values.do.</p>
|
|
816
|
+
<p><strong>Method:</strong> GET.</p>
|
|
817
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
818
|
+
<p><strong>Error codes:</strong></p>
|
|
819
|
+
<ul>
|
|
820
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
821
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
822
|
+
<li>404 Not Found - no banner found.</li>
|
|
823
|
+
</ul>
|
|
824
|
+
<p><strong>Response sample:</strong><br>
|
|
825
|
+
200 OK.</p>
|
|
826
|
+
<p><strong>Parameters:</strong></p>
|
|
827
|
+
<ul>
|
|
828
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
829
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
830
|
+
<li>username — a given username.</li>
|
|
831
|
+
</ul>
|
|
832
|
+
<p><!-- NEXT TITLE --><br>
|
|
833
|
+
<!-- NEXT TITLE --></p>
|
|
834
|
+
<h4>Get available values of version of operating systems for operating system targeting type</h4>
|
|
835
|
+
<p><strong>URL:</strong> /rest-api/targeting/os/{osName}/versions.do.</p>
|
|
836
|
+
<p><strong>Method:</strong> GET.</p>
|
|
837
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
838
|
+
<p><strong>Error codes:</strong></p>
|
|
839
|
+
<ul>
|
|
840
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
841
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
842
|
+
<li>404 Not Found - no banner found.</li>
|
|
843
|
+
</ul>
|
|
844
|
+
<p><strong>Response sample:</strong><br>
|
|
845
|
+
200 OK.</p>
|
|
846
|
+
<p><strong>Parameters:</strong></p>
|
|
847
|
+
<ul>
|
|
848
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
849
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
850
|
+
<li>username — a given username;</li>
|
|
851
|
+
<li>osName - the name of Operation System from list of available OS values.</li>
|
|
852
|
+
</ul>
|
|
853
|
+
<p><!-- NEXT TITLE --><br>
|
|
854
|
+
<!-- NEXT TITLE --></p>
|
|
855
|
+
<h4>Create Browser Target</h4>
|
|
856
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the browser targeting by campaign id.</p>
|
|
857
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/browser/create.do<br>
|
|
858
|
+
<strong>Method:</strong> POST<br>
|
|
859
|
+
<strong>Response format:</strong> application/json</p>
|
|
860
|
+
<p><strong>Error codes:</strong><br>
|
|
861
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
862
|
+
401 Unauthorized - authentication error<br>
|
|
863
|
+
403 Forbidden - not enough permissions<br>
|
|
864
|
+
<strong>Response sample:</strong><br>
|
|
865
|
+
200 OK</p>
|
|
866
|
+
<p><strong>Parameters:</strong><br>
|
|
867
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
868
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
869
|
+
username - the given username<br>
|
|
870
|
+
campaignId - the given campaign id<br>
|
|
871
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
872
|
+
browser -<br>
|
|
873
|
+
relation - - values are LOWER,GREATER,LOWER_EQUAL,GREATER_EQUAL,EQUAL<br>
|
|
874
|
+
browserVersion -<br>
|
|
875
|
+
<!-- NEXT TITLE --><br>
|
|
876
|
+
<!-- NEXT TITLE --></p>
|
|
877
|
+
<h4>Create Channel Target</h4>
|
|
878
|
+
<p style="white-space: pre-wrap;">Sets the campaign channel targeting by campaign id.</p>
|
|
879
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/channel/create.do<br>
|
|
880
|
+
<strong>Method:</strong> POST<br>
|
|
881
|
+
<strong>Response format:</strong> application/json</p>
|
|
882
|
+
<p><strong>Error codes:</strong><br>
|
|
883
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
884
|
+
401 Unauthorized - authentication error<br>
|
|
885
|
+
403 Forbidden - not enough permissions<br>
|
|
886
|
+
<strong>Response sample:</strong><br>
|
|
887
|
+
200 OK</p>
|
|
888
|
+
<p><strong>Parameters:</strong><br>
|
|
889
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
890
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
891
|
+
username - the given username<br>
|
|
892
|
+
campaignId - the given campaign id<br>
|
|
893
|
+
channel -<br>
|
|
894
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
895
|
+
<p><!-- NEXT TITLE --><br>
|
|
896
|
+
<!-- NEXT TITLE --></p>
|
|
897
|
+
<h4>Create Coookie Value Target</h4>
|
|
898
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign cookie value targeting by campaign id.</p>
|
|
899
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/cookie/create.do<br>
|
|
900
|
+
<strong>Method:</strong> POST<br>
|
|
901
|
+
<strong>Response format:</strong> application/json</p>
|
|
902
|
+
<p><strong>Error codes:</strong><br>
|
|
903
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
904
|
+
401 Unauthorized - authentication error<br>
|
|
905
|
+
403 Forbidden - not enough permissions<br>
|
|
906
|
+
<strong>Response sample:</strong><br>
|
|
907
|
+
200 OK</p>
|
|
908
|
+
<p><strong>Parameters:</strong><br>
|
|
909
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
910
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
911
|
+
username - the given username<br>
|
|
912
|
+
campaignId - the given campaign id<br>
|
|
913
|
+
cookieName -<br>
|
|
914
|
+
cookieValue -<br>
|
|
915
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
916
|
+
<!-- NEXT TITLE --><br>
|
|
917
|
+
<!-- NEXT TITLE --></p>
|
|
918
|
+
<h4>Create Country Target</h4>
|
|
919
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign country targeting by campaign id.</p>
|
|
920
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/country/create.do<br>
|
|
921
|
+
<strong>Method:</strong> POST<br>
|
|
922
|
+
<strong>Response format:</strong> application/json</p>
|
|
923
|
+
<p><strong>Error codes:</strong><br>
|
|
924
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
925
|
+
401 Unauthorized - authentication error<br>
|
|
926
|
+
403 Forbidden - not enough permissions<br>
|
|
927
|
+
<strong>Response sample:</strong><br>
|
|
928
|
+
200 OK</p>
|
|
929
|
+
<p><strong>Parameters:</strong><br>
|
|
930
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
931
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
932
|
+
username - the given username<br>
|
|
933
|
+
campaignId - the given campaign id<br>
|
|
934
|
+
countryCode - - ISO country code<br>
|
|
935
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
936
|
+
<!-- NEXT TITLE --><br>
|
|
937
|
+
<!-- NEXT TITLE --></p>
|
|
938
|
+
<h4>Create Custom Parameter Target</h4>
|
|
939
|
+
<p style="white-space: pre-wrap;">Sets custom parameter targeting by campaign id.</p>
|
|
940
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/custom/create.do<br>
|
|
941
|
+
<strong>Method:</strong> POST<br>
|
|
942
|
+
<strong>Response format:</strong> application/json</p>
|
|
943
|
+
<p><strong>Error codes:</strong><br>
|
|
944
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
945
|
+
401 Unauthorized - authentication error<br>
|
|
946
|
+
403 Forbidden - not enough permissions<br>
|
|
947
|
+
<strong>Response sample:</strong><br>
|
|
948
|
+
200 OK</p>
|
|
949
|
+
<p><strong>Parameters:</strong><br>
|
|
950
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
951
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
952
|
+
username - the given username<br>
|
|
953
|
+
campaignId - the given campaign id<br>
|
|
954
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
955
|
+
expression - - valid expression (Sample: ($p1==1 || $p1=='a') && ($p2>=12 && $p2<=22) )<br>
|
|
956
|
+
<!-- NEXT TITLE --><br>
|
|
957
|
+
<!-- NEXT TITLE --></p>
|
|
958
|
+
<h4>Create Day Of Week Target</h4>
|
|
959
|
+
<p style="white-space: pre-wrap;">Sets day of week targeting by campaign id.</p>
|
|
960
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/dayofweek/create.do<br>
|
|
961
|
+
<strong>Method:</strong> POST<br>
|
|
962
|
+
<strong>Response format:</strong> application/json</p>
|
|
963
|
+
<p><strong>Error codes:</strong><br>
|
|
964
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
965
|
+
401 Unauthorized - authentication error<br>
|
|
966
|
+
403 Forbidden - not enough permissions<br>
|
|
967
|
+
<strong>Response sample:</strong><br>
|
|
968
|
+
200 OK</p>
|
|
969
|
+
<p><strong>Parameters:</strong><br>
|
|
970
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
971
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
972
|
+
username - the given username<br>
|
|
973
|
+
campaignId - the given campaign id<br>
|
|
974
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
975
|
+
dayOfWeek - available values are MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY<br>
|
|
976
|
+
<!-- NEXT TITLE --><br>
|
|
977
|
+
<!-- NEXT TITLE --></p>
|
|
978
|
+
<h4>Create Device Format Target</h4>
|
|
979
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign device targeting by campaign id.</p>
|
|
980
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/deviceformat/create.do<br>
|
|
981
|
+
<strong>Method:</strong> POST<br>
|
|
982
|
+
<strong>Response format:</strong> application/json</p>
|
|
983
|
+
<p><strong>Error codes:</strong><br>
|
|
984
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
985
|
+
401 Unauthorized - authentication error<br>
|
|
986
|
+
403 Forbidden - not enough permissions<br>
|
|
987
|
+
<strong>Response sample:</strong><br>
|
|
988
|
+
200 OK</p>
|
|
989
|
+
<p><strong>Parameters:</strong><br>
|
|
990
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
991
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
992
|
+
username - the given username<br>
|
|
993
|
+
campaignId - the given campaign id<br>
|
|
994
|
+
deviceFormat -<br>
|
|
995
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
996
|
+
<p><!-- NEXT TITLE --><br>
|
|
997
|
+
<!-- NEXT TITLE --></p>
|
|
998
|
+
<h4>Create Device Target</h4>
|
|
999
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign device targeting by campaign id.</p>
|
|
1000
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/device/create.do<br>
|
|
1001
|
+
<strong>Method:</strong> POST<br>
|
|
1002
|
+
<strong>Response format:</strong> application/json</p>
|
|
1003
|
+
<p><strong>Error codes:</strong><br>
|
|
1004
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1005
|
+
401 Unauthorized - authentication error<br>
|
|
1006
|
+
403 Forbidden - not enough permissions<br>
|
|
1007
|
+
<strong>Response sample:</strong><br>
|
|
1008
|
+
200 OK</p>
|
|
1009
|
+
<p><strong>Parameters:</strong><br>
|
|
1010
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1011
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1012
|
+
username - the given username<br>
|
|
1013
|
+
campaignId - the given campaign id<br>
|
|
1014
|
+
device -<br>
|
|
1015
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1016
|
+
<p><!-- NEXT TITLE --><br>
|
|
1017
|
+
<!-- NEXT TITLE --></p>
|
|
1018
|
+
<h4>Create Device Vendor Target</h4>
|
|
1019
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign device vendor targeting by campaign id.</p>
|
|
1020
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/devicevendor/create.do<br>
|
|
1021
|
+
<strong>Method:</strong> POST<br>
|
|
1022
|
+
<strong>Response format:</strong> application/json</p>
|
|
1023
|
+
<p><strong>Error codes:</strong><br>
|
|
1024
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1025
|
+
401 Unauthorized - authentication error<br>
|
|
1026
|
+
403 Forbidden - not enough permissions<br>
|
|
1027
|
+
<strong>Response sample:</strong><br>
|
|
1028
|
+
200 OK</p>
|
|
1029
|
+
<p><strong>Parameters:</strong><br>
|
|
1030
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1031
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1032
|
+
username - the given username<br>
|
|
1033
|
+
campaignId - the given campaign id<br>
|
|
1034
|
+
deviceVendor -<br>
|
|
1035
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1036
|
+
<p><!-- NEXT TITLE --><br>
|
|
1037
|
+
<!-- NEXT TITLE --></p>
|
|
1038
|
+
<h4>Create Domain Target</h4>
|
|
1039
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign referrer domain targeting by campaign id.</p>
|
|
1040
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/domain/create.do<br>
|
|
1041
|
+
<strong>Method:</strong> POST<br>
|
|
1042
|
+
<strong>Response format:</strong> application/json</p>
|
|
1043
|
+
<p><strong>Error codes:</strong><br>
|
|
1044
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1045
|
+
401 Unauthorized - authentication error<br>
|
|
1046
|
+
403 Forbidden - not enough permissions<br>
|
|
1047
|
+
<strong>Response sample:</strong><br>
|
|
1048
|
+
200 OK</p>
|
|
1049
|
+
<p><strong>Parameters:</strong><br>
|
|
1050
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1051
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1052
|
+
username - the given username<br>
|
|
1053
|
+
campaignId - the given campaign id<br>
|
|
1054
|
+
domain -<br>
|
|
1055
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1056
|
+
<p><!-- NEXT TITLE --><br>
|
|
1057
|
+
<!-- NEXT TITLE --></p>
|
|
1058
|
+
<h4>Create Ip Range Target</h4>
|
|
1059
|
+
<p style="white-space: pre-wrap;">Sets ip range targeting by campaign id.<br>
|
|
1060
|
+
Params - Valid IP range (Sample: from 194.222.012.001 to 194.223.07.01)</p>
|
|
1061
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/iprange/create.do<br>
|
|
1062
|
+
<strong>Method:</strong> POST<br>
|
|
1063
|
+
<strong>Response format:</strong> application/json</p>
|
|
1064
|
+
<p><strong>Error codes:</strong><br>
|
|
1065
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1066
|
+
401 Unauthorized - authentication error<br>
|
|
1067
|
+
403 Forbidden - not enough permissions<br>
|
|
1068
|
+
<strong>Response sample:</strong><br>
|
|
1069
|
+
200 OK</p>
|
|
1070
|
+
<p><strong>Parameters:</strong><br>
|
|
1071
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1072
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1073
|
+
username - the given username<br>
|
|
1074
|
+
campaignId - the given campaign id<br>
|
|
1075
|
+
ipFrom - valid ip from for range<br>
|
|
1076
|
+
ipTo - valid ip to for range<br>
|
|
1077
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1078
|
+
<p><!-- NEXT TITLE --><br>
|
|
1079
|
+
<!-- NEXT TITLE --></p>
|
|
1080
|
+
<h4>Create Language Target</h4>
|
|
1081
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the campaign language targeting by campaign id.</p>
|
|
1082
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/language/create.do<br>
|
|
1083
|
+
<strong>Method:</strong> POST<br>
|
|
1084
|
+
<strong>Response format:</strong> application/json</p>
|
|
1085
|
+
<p><strong>Error codes:</strong><br>
|
|
1086
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1087
|
+
401 Unauthorized - authentication error<br>
|
|
1088
|
+
403 Forbidden - not enough permissions<br>
|
|
1089
|
+
<strong>Response sample:</strong><br>
|
|
1090
|
+
200 OK</p>
|
|
1091
|
+
<p><strong>Parameters:</strong><br>
|
|
1092
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1093
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1094
|
+
username - the given username<br>
|
|
1095
|
+
campaignId - the given campaign id<br>
|
|
1096
|
+
languageCode - - language code<br>
|
|
1097
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1098
|
+
<p><!-- NEXT TITLE --><br>
|
|
1099
|
+
<!-- NEXT TITLE --></p>
|
|
1100
|
+
<h4>Create Location Target</h4>
|
|
1101
|
+
<p style="white-space: pre-wrap;">Sets location targeting by campaign id.</p>
|
|
1102
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/location/create.do<br>
|
|
1103
|
+
<strong>Method:</strong> POST<br>
|
|
1104
|
+
<strong>Response format:</strong> application/json</p>
|
|
1105
|
+
<p><strong>Error codes:</strong><br>
|
|
1106
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1107
|
+
401 Unauthorized - authentication error<br>
|
|
1108
|
+
403 Forbidden - not enough permissions<br>
|
|
1109
|
+
<strong>Response sample:</strong><br>
|
|
1110
|
+
200 OK</p>
|
|
1111
|
+
<p><strong>Parameters:</strong><br>
|
|
1112
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1113
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1114
|
+
username - the given username<br>
|
|
1115
|
+
campaignId - the given campaign id<br>
|
|
1116
|
+
countryCode -<br>
|
|
1117
|
+
regionName -<br>
|
|
1118
|
+
cityName -<br>
|
|
1119
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1120
|
+
<p><!-- NEXT TITLE --><br>
|
|
1121
|
+
<!-- NEXT TITLE --></p>
|
|
1122
|
+
<h4>Create Mobile Carrier Target</h4>
|
|
1123
|
+
<p style="white-space: pre-wrap;">Sets the campaign mobile carrier targeting by campaign id.</p>
|
|
1124
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/mobilecarrier/create.do<br>
|
|
1125
|
+
<strong>Method:</strong> POST<br>
|
|
1126
|
+
<strong>Response format:</strong> application/json</p>
|
|
1127
|
+
<p><strong>Error codes:</strong><br>
|
|
1128
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1129
|
+
401 Unauthorized - authentication error<br>
|
|
1130
|
+
403 Forbidden - not enough permissions<br>
|
|
1131
|
+
<strong>Response sample:</strong><br>
|
|
1132
|
+
200 OK</p>
|
|
1133
|
+
<p><strong>Parameters:</strong><br>
|
|
1134
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1135
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1136
|
+
username - the given username<br>
|
|
1137
|
+
campaignId - the given campaign id<br>
|
|
1138
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
1139
|
+
mobileCarriers - - array of mobile carrier names</p>
|
|
1140
|
+
<p><!-- NEXT TITLE --><br>
|
|
1141
|
+
<!-- NEXT TITLE --></p>
|
|
1142
|
+
<h4>Create OS Target</h4>
|
|
1143
|
+
<p style="white-space: pre-wrap;">Sets operating system targeting by campaign id.</p>
|
|
1144
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/os/create.do<br>
|
|
1145
|
+
<strong>Method:</strong> POST<br>
|
|
1146
|
+
<strong>Response format:</strong> application/json</p>
|
|
1147
|
+
<p><strong>Error codes:</strong><br>
|
|
1148
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1149
|
+
401 Unauthorized - authentication error<br>
|
|
1150
|
+
403 Forbidden - not enough permissions<br>
|
|
1151
|
+
<strong>Response sample:</strong><br>
|
|
1152
|
+
200 OK</p>
|
|
1153
|
+
<p><strong>Parameters:</strong><br>
|
|
1154
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1155
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1156
|
+
username - the given username<br>
|
|
1157
|
+
campaignId - the given campaign id<br>
|
|
1158
|
+
operatingSystem - -<br>
|
|
1159
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1160
|
+
<p><!-- NEXT TITLE --><br>
|
|
1161
|
+
<!-- NEXT TITLE --></p>
|
|
1162
|
+
<h4>Create Screen Resolution Target</h4>
|
|
1163
|
+
<p style="white-space: pre-wrap;">Sets the campaign screen resolution targeting by campaign id.</p>
|
|
1164
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/resolution/create.do<br>
|
|
1165
|
+
<strong>Method:</strong> POST<br>
|
|
1166
|
+
<strong>Response format:</strong> application/json</p>
|
|
1167
|
+
<p><strong>Error codes:</strong><br>
|
|
1168
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1169
|
+
401 Unauthorized - authentication error<br>
|
|
1170
|
+
403 Forbidden - not enough permissions<br>
|
|
1171
|
+
<strong>Response sample:</strong><br>
|
|
1172
|
+
200 OK</p>
|
|
1173
|
+
<p><strong>Parameters:</strong><br>
|
|
1174
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1175
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1176
|
+
username - the given username<br>
|
|
1177
|
+
campaignId - the given campaign id<br>
|
|
1178
|
+
relation - - available values LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL<br>
|
|
1179
|
+
screenWidth -<br>
|
|
1180
|
+
screenHeight -<br>
|
|
1181
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1182
|
+
<p><!-- NEXT TITLE --><br>
|
|
1183
|
+
<!-- NEXT TITLE --></p>
|
|
1184
|
+
<h4>Create Time Range Target</h4>
|
|
1185
|
+
<p style="white-space: pre-wrap;">Sets time range targeting by campaign id.</p>
|
|
1186
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/timerange/create.do<br>
|
|
1187
|
+
<strong>Method:</strong> POST<br>
|
|
1188
|
+
<strong>Response format:</strong> application/json</p>
|
|
1189
|
+
<p><strong>Error codes:</strong><br>
|
|
1190
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1191
|
+
401 Unauthorized - authentication error<br>
|
|
1192
|
+
403 Forbidden - not enough permissions<br>
|
|
1193
|
+
<strong>Response sample:</strong><br>
|
|
1194
|
+
200 OK</p>
|
|
1195
|
+
<p><strong>Parameters:</strong><br>
|
|
1196
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1197
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1198
|
+
username - the given username<br>
|
|
1199
|
+
campaignId - the given campaign id<br>
|
|
1200
|
+
timeFrom - String in format 24h format hh:MM , where hh - hours, MM - minutes<br>
|
|
1201
|
+
timeTo - String in format 24h format hh:MM , where hh - hours, MM - minutes<br>
|
|
1202
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1203
|
+
<p><!-- NEXT TITLE --><br>
|
|
1204
|
+
<!-- NEXT TITLE --></p>
|
|
1205
|
+
<h4>Create Wifi Traffic Target</h4>
|
|
1206
|
+
<p style="white-space: pre-wrap;">Sets the campaign wifi traffic targeting by campaign id.</p>
|
|
1207
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/wifi/create.do<br>
|
|
1208
|
+
<strong>Method:</strong> POST<br>
|
|
1209
|
+
<strong>Response format:</strong> application/json</p>
|
|
1210
|
+
<p><strong>Error codes:</strong><br>
|
|
1211
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1212
|
+
401 Unauthorized - authentication error<br>
|
|
1213
|
+
403 Forbidden - not enough permissions<br>
|
|
1214
|
+
<strong>Response sample:</strong><br>
|
|
1215
|
+
200 OK</p>
|
|
1216
|
+
<p><strong>Parameters:</strong><br>
|
|
1217
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1218
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1219
|
+
username - the given username<br>
|
|
1220
|
+
campaignId - the given campaign id<br>
|
|
1221
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
1222
|
+
<p><!-- NEXT TITLE --><br>
|
|
1223
|
+
<!-- NEXT TITLE --></p>
|
|
1224
|
+
<h4>Disable Targeting</h4>
|
|
1225
|
+
<p style="white-space: pre-wrap;">Disables targeting for given campaign.</p>
|
|
1226
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/disable.do<br>
|
|
1227
|
+
<strong>Method:</strong> POST<br>
|
|
1228
|
+
<strong>Response format:</strong> application/json</p>
|
|
1229
|
+
<p><strong>Error codes:</strong><br>
|
|
1230
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1231
|
+
401 Unauthorized - authentication error<br>
|
|
1232
|
+
403 Forbidden - not enough permissions<br>
|
|
1233
|
+
404 Not Found - no targeting with given id found for given campaign<br>
|
|
1234
|
+
<strong>Response sample:</strong><br>
|
|
1235
|
+
200 OK</p>
|
|
1236
|
+
<p><strong>Parameters:</strong><br>
|
|
1237
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1238
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1239
|
+
username - the given username<br>
|
|
1240
|
+
campaignId - the given campaign id</p>
|
|
1241
|
+
<p><!-- NEXT TITLE --><br>
|
|
1242
|
+
<!-- NEXT TITLE --></p>
|
|
1243
|
+
<h4>Enable Targeting</h4>
|
|
1244
|
+
<p style="white-space: pre-wrap;">Enables targeting for given campaign.</p>
|
|
1245
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/targeting/enable.do<br>
|
|
1246
|
+
<strong>Method:</strong> POST<br>
|
|
1247
|
+
<strong>Response format:</strong> application/json</p>
|
|
1248
|
+
<p><strong>Error codes:</strong><br>
|
|
1249
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1250
|
+
401 Unauthorized - authentication error<br>
|
|
1251
|
+
403 Forbidden - not enough permissions<br>
|
|
1252
|
+
404 Not Found - no targeting with given id found for given campaign<br>
|
|
1253
|
+
<strong>Response sample:</strong><br>
|
|
1254
|
+
200 OK</p>
|
|
1255
|
+
<p><strong>Parameters:</strong><br>
|
|
1256
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1257
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1258
|
+
username - the given username<br>
|
|
1259
|
+
campaignId - the given campaign id</p>
|
|
1260
|
+
<p><!-- NEXT TITLE --></p>
|
|
1261
|
+
<p><!-- NEXT TITLE --></p>
|
|
1262
|
+
<h4 id="camadc" align="center"><span style="text-decoration: underline;">Campaign Adjusted CPM API</span></h4>
|
|
1263
|
+
<p><!-- NEXT TITLE --></p>
|
|
1264
|
+
<h4>Add Fixed Cpm Country Pricing</h4>
|
|
1265
|
+
<p style="white-space: pre-wrap;">Create or update Adjusted CPM value.</p>
|
|
1266
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/adjustedCpm/value.do<br>
|
|
1267
|
+
<strong>Method:</strong> PUT<br>
|
|
1268
|
+
<strong>Response format:</strong> application/json</p>
|
|
1269
|
+
<p><strong>Error codes:</strong><br>
|
|
1270
|
+
400 Bad Request - no campaign with such id exists<br>
|
|
1271
|
+
401 Unauthorized - authentication error<br>
|
|
1272
|
+
403 Forbidden - not enough permissions<br>
|
|
1273
|
+
<strong>Response sample:</strong><br>
|
|
1274
|
+
200 OK</p>
|
|
1275
|
+
<p><strong>Parameters:</strong><br>
|
|
1276
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1277
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1278
|
+
username - the given username<br>
|
|
1279
|
+
campaignId - the given campaign id<br>
|
|
1280
|
+
value - the value of adjustment<br>
|
|
1281
|
+
countryCode - the 2 symbol country code corresponding to ISO 3166<br>
|
|
1282
|
+
date - the date of adjustment application</p>
|
|
1283
|
+
<p><!-- NEXT TITLE --><br>
|
|
1284
|
+
<!-- NEXT TITLE --></p>
|
|
1285
|
+
<h4>Adjusted Cpm Country Trigger</h4>
|
|
1286
|
+
<p style="white-space: pre-wrap;">Enabe or disable Adjusted CPM value.</p>
|
|
1287
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/adjustedCpm.do<br>
|
|
1288
|
+
<strong>Method:</strong> POST<br>
|
|
1289
|
+
<strong>Response format:</strong> application/json</p>
|
|
1290
|
+
<p><strong>Error codes:</strong><br>
|
|
1291
|
+
400 Bad Request - no campaign with such id exists<br>
|
|
1292
|
+
401 Unauthorized - authentication error<br>
|
|
1293
|
+
403 Forbidden - not enough permissions<br>
|
|
1294
|
+
<strong>Response sample:</strong><br>
|
|
1295
|
+
200 OK</p>
|
|
1296
|
+
<p><strong>Parameters:</strong><br>
|
|
1297
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1298
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1299
|
+
username - the given username<br>
|
|
1300
|
+
campaignId - the given campaign id<br>
|
|
1301
|
+
enable - true if CPM Adjustment should be enabled and false otherwise</p>
|
|
1302
|
+
<p><!-- NEXT TITLE --><br>
|
|
1303
|
+
<!-- NEXT TITLE --></p>
|
|
1304
|
+
<h4>Adjusted Cpm List</h4>
|
|
1305
|
+
<p style="white-space: pre-wrap;">List of Adjusted CPM values.</p>
|
|
1306
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/adjustedCpm/values.do<br>
|
|
1307
|
+
<strong>Method:</strong> GET<br>
|
|
1308
|
+
<strong>Response format:</strong> application/json</p>
|
|
1309
|
+
<p><strong>Error codes:</strong><br>
|
|
1310
|
+
400 Bad Request - no campaign with such id exists<br>
|
|
1311
|
+
401 Unauthorized - authentication error<br>
|
|
1312
|
+
403 Forbidden - not enough permissions<br>
|
|
1313
|
+
<strong>Response sample:</strong><br>
|
|
1314
|
+
200 OK</p>
|
|
1315
|
+
<p><strong>Parameters:</strong><br>
|
|
1316
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1317
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1318
|
+
username - the given username<br>
|
|
1319
|
+
campaignId - the given campaign id<br>
|
|
1320
|
+
<!-- NEXT TITLE --></p>
|
|
1321
|
+
<h3 id="camppric" align="center">Campaign Pricing API</h3>
|
|
1322
|
+
<p><!-- NEXT TITLE --></p>
|
|
1323
|
+
<h4>Get Campaign Pricing</h4>
|
|
1324
|
+
<p style="white-space: pre-wrap;">Get the campaign pricing information by campaign id.</p>
|
|
1325
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/pricing.do<br>
|
|
1326
|
+
<strong>Method:</strong> GET<br>
|
|
1327
|
+
<strong>Response format:</strong> application/json</p>
|
|
1328
|
+
<p><strong>Error codes:</strong></p>
|
|
1329
|
+
<p>401 Unauthorized - authentication error<br>
|
|
1330
|
+
403 Forbidden - not enough permissions<br>
|
|
1331
|
+
404 Not Found - no campaign pricing for such campaign</p>
|
|
1332
|
+
<p><strong>Response sample:</strong><br>
|
|
1333
|
+
200 OK</p>
|
|
1334
|
+
<p><strong>Parameters:</strong></p>
|
|
1335
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1336
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1337
|
+
username - the given username<br>
|
|
1338
|
+
campaignId - the given campaign id</p>
|
|
1339
|
+
<p><!-- NEXT TITLE --><br>
|
|
1340
|
+
<!-- NEXT TITLE --></p>
|
|
1341
|
+
<h4>Update Campaign Country Pricing</h4>
|
|
1342
|
+
<p style="white-space: pre-wrap;">Update the country campaign pricing information by campaign id.</p>
|
|
1343
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/pricing/{countryCode}.do<br>
|
|
1344
|
+
<strong>Method:</strong> POST<br>
|
|
1345
|
+
<strong>Response format:</strong> application/json</p>
|
|
1346
|
+
<p><strong>Error codes:</strong></p>
|
|
1347
|
+
<p>400 Bad Request - wrong request format. E.g. wrong types for parameters, no campaign or country with such code exists, or campaign pric<br>
|
|
1348
|
+
401 Unauthorized - authentication error<br>
|
|
1349
|
+
403 Forbidden - not enough permissions</p>
|
|
1350
|
+
<p><strong>Request Parameters:</strong></p>
|
|
1351
|
+
<p>price - campaign price as a double</p>
|
|
1352
|
+
<p><strong>Response sample:</strong><br>
|
|
1353
|
+
200 OK</p>
|
|
1354
|
+
<p><strong>Parameters:</strong></p>
|
|
1355
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1356
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1357
|
+
username - the given username<br>
|
|
1358
|
+
campaignId - the given campaign id<br>
|
|
1359
|
+
countryCode - 2 symbol country code corresponding to ISO 3166</p>
|
|
1360
|
+
<p><!-- NEXT TITLE --><br>
|
|
1361
|
+
<!-- NEXT TITLE --></p>
|
|
1362
|
+
<h4>Update the campaign pricing information by campaign id</h4>
|
|
1363
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/campaignPricing/actionPricing.do.</p>
|
|
1364
|
+
<p><strong>Method:</strong> POST.</p>
|
|
1365
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
1366
|
+
<p><strong>Error codes:</strong></p>
|
|
1367
|
+
<ul>
|
|
1368
|
+
<li>400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.</li>
|
|
1369
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
1370
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
1371
|
+
</ul>
|
|
1372
|
+
<p><strong>Response sample:</strong><br>
|
|
1373
|
+
200 OK.</p>
|
|
1374
|
+
<p>Request parameters:<br></p>
|
|
1375
|
+
<ul>
|
|
1376
|
+
<li>price - campaign price as a double;</li>
|
|
1377
|
+
<li>actionName - actionName is a string corresponding to name of existing action in specified campaign;</li>
|
|
1378
|
+
<li>actionKey - actionKey is a string corresponding to key of existing action in specified campaign.</li>
|
|
1379
|
+
</ul>
|
|
1380
|
+
<p><strong>Parameters:</strong></p>
|
|
1381
|
+
<ul>
|
|
1382
|
+
<li>hash - a MD5 digest of concatenated username's md5 password and the given timestamp;</li>
|
|
1383
|
+
<li>timestamp - UNIX timestamp used in hash generation;</li>
|
|
1384
|
+
<li>username - the given username;</li>
|
|
1385
|
+
<li>campaignId - the given campaign id.</li>
|
|
1386
|
+
</ul>
|
|
1387
|
+
<p><!-- NEXT TITLE --><br>
|
|
1388
|
+
<!-- NEXT TITLE --></p>
|
|
1389
|
+
<h4>Disable Campaign Pricing</h4>
|
|
1390
|
+
<p style="white-space: pre-wrap;">Disables campaign pricing.</p>
|
|
1391
|
+
<p><strong>URL:</strong> /rest-api/campaigns/{campaignId}/pricing.do<br>
|
|
1392
|
+
<strong>Method:</strong> DELETE<br>
|
|
1393
|
+
<strong>Response format:</strong> application/json</p>
|
|
1394
|
+
<p><strong>Error codes:</strong></p>
|
|
1395
|
+
<p>400 Bad Request - no campaign with such id exists<br>
|
|
1396
|
+
401 Unauthorized - authentication error<br>
|
|
1397
|
+
403 Forbidden - not enough permissions</p>
|
|
1398
|
+
<p><strong>Response sample:</strong><br>
|
|
1399
|
+
200 OK</p>
|
|
1400
|
+
<p><strong>Parameters:</strong></p>
|
|
1401
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1402
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1403
|
+
username - the given username<br>
|
|
1404
|
+
campaignId - the given campaign id<br>
|
|
1405
|
+
<!-- NEXT TITLE --></p>
|
|
1406
|
+
<p><!-- NEXT TITLE --></p>
|
|
1407
|
+
<h4>Update Campaign Country Pricing Batch</h4>
|
|
1408
|
+
<p style="white-space: pre-wrap;">Update the country campaign pricing information by campaign id from csv pricing file.</p>
|
|
1409
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/pricing/batch.do<br>
|
|
1410
|
+
<strong>Method:</strong> POST<br>
|
|
1411
|
+
<strong>Response format:</strong> application/json</p>
|
|
1412
|
+
<p><strong>Error codes:</strong></p>
|
|
1413
|
+
<p>400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign exists, or campaign pricing disabled for the given cam<br>
|
|
1414
|
+
Unauthorized - authentication error<br>
|
|
1415
|
+
403 Forbidden - not enough permissions</p>
|
|
1416
|
+
<p><strong>Request Parameters:</strong></p>
|
|
1417
|
+
<p>countryPricing - csv formatted file with country prices</p>
|
|
1418
|
+
<p><strong>Response sample:</strong><br>
|
|
1419
|
+
200 OK</p>
|
|
1420
|
+
<p><strong>Parameters:</strong></p>
|
|
1421
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1422
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1423
|
+
username - the given username<br>
|
|
1424
|
+
campaignId - the given campaign id<br>
|
|
1425
|
+
countryPrices - csv formatted file with country prices<br>
|
|
1426
|
+
<!-- NEXT TITLE --></p>
|
|
1427
|
+
<p><!-- NEXT TITLE --></p>
|
|
1428
|
+
<h4>Update Campaign Pricing</h4>
|
|
1429
|
+
<p style="white-space: pre-wrap;">Update the campaign pricing information by campaign id.</p>
|
|
1430
|
+
<p><strong>URL:</strong> /rest-api/campaign/{campaignId}/pricing.do<br>
|
|
1431
|
+
<strong>Method:</strong> POST<br>
|
|
1432
|
+
<strong>Response format:</strong> application/json</p>
|
|
1433
|
+
<p><strong>Error codes:</strong></p>
|
|
1434
|
+
<p>400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists<br>
|
|
1435
|
+
401 Unauthorized - authentication error<br>
|
|
1436
|
+
403 Forbidden - not enough permissions</p>
|
|
1437
|
+
<p><strong>Request Parameters:</strong></p>
|
|
1438
|
+
<p>price - campaign price as a double<br>
|
|
1439
|
+
paymentModel - FIXED_PRICE<br>
|
|
1440
|
+
pricingType - CPM, CPC or CPA</p>
|
|
1441
|
+
<p><strong>Response sample:</strong><br>
|
|
1442
|
+
200 OK</p>
|
|
1443
|
+
<p><strong>Parameters:</strong></p>
|
|
1444
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1445
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1446
|
+
username - the given username<br>
|
|
1447
|
+
campaignId - the given campaign id</p>
|
|
1448
|
+
<p><!-- NEXT TITLE --><br>
|
|
1449
|
+
<!-- NEXT TITLE --></p>
|
|
1450
|
+
<h3 id="banman" align="center">Banner Management</h3>
|
|
1451
|
+
<p><!-- NEXT TITLE --></p>
|
|
1452
|
+
<h4>Creates banner for given campaign id</h4>
|
|
1453
|
+
<p><strong>URL:</strong> /rest-api/banner/create.do.</p>
|
|
1454
|
+
<p><strong>Method:</strong> POST.</p>
|
|
1455
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
1456
|
+
<p><strong>Error codes:</strong></p>
|
|
1457
|
+
<ul>
|
|
1458
|
+
<li>400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists.</li>
|
|
1459
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
1460
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
1461
|
+
</ul>
|
|
1462
|
+
<p><strong>Response sample:</strong><br>
|
|
1463
|
+
200 OK.</p>
|
|
1464
|
+
<p>Request parameters:<br></p>
|
|
1465
|
+
<ul>
|
|
1466
|
+
<li><b>placementType</b> - required, values are SITE_PLACEMENT,VIDEO_PLACEMENT, APPLICATION_PLACEMENT or MOBILE_SITE_PLACEMENT</li>
|
|
1467
|
+
<li><b>campaignId</b> - required, the given campaign id</li>
|
|
1468
|
+
<li><b>active</b> - active status of banner as a boolean</li>
|
|
1469
|
+
<li><b>name</b> </li>
|
|
1470
|
+
<li><b>allowNewPlacementsAutoLinking</b> - permission for banner to be linked to new placements automatically as boolean</li>
|
|
1471
|
+
<li><b>autolinkCategories</b> - ID's of publishing categories for autolinking.</li>
|
|
1472
|
+
<li><b>weight</b> - integer value</li>
|
|
1473
|
+
<li><b>adUnitId</b> - available values - see /rest-api/banner/adunit/values.do </li>
|
|
1474
|
+
<li><b>adUnitHeight</b> - height, required for Custom ad unit. ignored for not a Custom ad unit. (long value)
|
|
1475
|
+
</li><li><b>adUnitWidth</b> - width, required for Custom ad unit. ignored for not a Custom ad unit. (long value)
|
|
1476
|
+
</li><li><b>bannerType</b> - available values are EXTERNAL_FILE, CODE, MOBILE_ADVERTISING_NETWORK, LOCAL_FILE, EXTERNAL_FILE, EXTERNAL_VIDEO, LOCAL_VIDEO, APPLICATION_ADVERTISING_NETWORK, TEMPLATE</li>
|
|
1477
|
+
<li><b>flashBannerLink</b> </li>
|
|
1478
|
+
<li><b>imageBannerLink</b> </li>
|
|
1479
|
+
<li><b>videoFileLink</b> </li>
|
|
1480
|
+
<li><b>flashFile</b> </li>
|
|
1481
|
+
<li><b>imageFile</b> </li>
|
|
1482
|
+
<li><b>videoFile</b> </li>
|
|
1483
|
+
<li><b>templateId</b> - id of template being used if banner type is TEMPLATE. Required by template properties are to be passed along.</li>
|
|
1484
|
+
<li><b>thirdTrackingCode</b> </li>
|
|
1485
|
+
<li><b>code</b> - for CODE banner type </li>
|
|
1486
|
+
<li><b>url</b> - for EXTERNAL_FILE banner type</li>
|
|
1487
|
+
<li><b>inStreamVideoType</b> - for video banners, values are LINEAR_VIDEO_AD, NON_LINEAR_VIDEO_AD</li>
|
|
1488
|
+
<li><b>mobileAdvertisingNetwork</b> - for MOBILE_ADVERTISING_NETWORK banner type</li>
|
|
1489
|
+
<li><b>mobileAdvertisingNetworkParameters</b> - map of parameters,for MOBILE_ADVERTISING_NETWORK banner type,<br>
|
|
1490
|
+
for example: mobileAdvertisingNetworkParameters[PUBLISHER_ALIAS]=somepub, list of available params for each network<br>
|
|
1491
|
+
can be found using /rest-api/banner/mobilenetworks.do
|
|
1492
|
+
</li>
|
|
1493
|
+
<li><b>applicationOperatingSystem</b> – required for APPLICATION_ADVERTISING_NETWORK banner type, values are ANDROID, IOS </li>
|
|
1494
|
+
<li><b>applicationAdCategory</b> – required for APPLICATION_ADVERTISING_NETWORK banner type, values are INTERSTITIAL, BANNER </li>
|
|
1495
|
+
<li><b>applicationAdvertisingNetwork</b> – for APPLICATION_ADVERTISING_NETWORK banner type </li>
|
|
1496
|
+
<li><b>applicationAdvertisingNetworkParameters</b> – map of parameters,for APPLICATION_ADVERTISING_NETWORK banner type,
|
|
1497
|
+
</li>
|
|
1498
|
+
<li><b>additionalParameters['flashVars']</b> – additional parameters for flash creative (if present). Format: key=value, url encoded.</li>
|
|
1499
|
+
</ul>
|
|
1500
|
+
<p>
|
|
1501
|
+
Response sample:<br><br>
|
|
1502
|
+
200 OK</p>
|
|
1503
|
+
<p><strong>Parameters:</strong></p>
|
|
1504
|
+
<ul>
|
|
1505
|
+
<li>hash — an MD5 digest of a concatenated username’s md5 password and a given timestamp;</li>
|
|
1506
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
1507
|
+
<li>username — a given username.</li>
|
|
1508
|
+
</ul>
|
|
1509
|
+
<p><!-- NEXT TITLE --><br>
|
|
1510
|
+
<!-- NEXT TITLE --></p>
|
|
1511
|
+
<h4>Copy|Move the banner</h4>
|
|
1512
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/{operation}/{campaignId}.do.</p>
|
|
1513
|
+
<p><strong>Method:</strong> POST.</p>
|
|
1514
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
1515
|
+
<p><strong>Error codes:</strong></p>
|
|
1516
|
+
<ul>
|
|
1517
|
+
<li>400 Bad Request – wrong request format. E.g. wrong types for parameters or no banner|campaign with such id exists.</li>
|
|
1518
|
+
<li>401 Unauthorized – authentication error.</li>
|
|
1519
|
+
<li>403 Forbidden – not enough permissions.</li>
|
|
1520
|
+
</ul>
|
|
1521
|
+
<p><strong>Response sample:</strong><br>
|
|
1522
|
+
200 OK.</p>
|
|
1523
|
+
<p><strong>Parameters:</strong></p>
|
|
1524
|
+
<ul>
|
|
1525
|
+
<li>hash — an MD5 digest of a concatenated username’s md5 password and a given timestamp;</li>
|
|
1526
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
1527
|
+
<li>username — a given username;</li>
|
|
1528
|
+
<li>bannerId – the given banner id;</li>
|
|
1529
|
+
<li>campaignId – id of campaign where to move/copy banner to;</li>
|
|
1530
|
+
<li>operation – operation to perform (literal, either COPY or MOVE);</li>
|
|
1531
|
+
<li>copyCount – numbers of copies, not required, defaults to 1;</li>
|
|
1532
|
+
<li>keepBannersLinked – boolean, whether or not preserve banners linkage, defaults to false.</li>
|
|
1533
|
+
</ul>
|
|
1534
|
+
<p><!-- NEXT TITLE --><br>
|
|
1535
|
+
<!-- NEXT TITLE --></p>
|
|
1536
|
+
<h4>Get Banner</h4>
|
|
1537
|
+
<p style="white-space: pre-wrap;">Get the banner by id.</p>
|
|
1538
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}.do<br>
|
|
1539
|
+
<strong>Method:</strong> GET<br>
|
|
1540
|
+
<strong>Response format:</strong> application/json</p>
|
|
1541
|
+
<p><strong>Error codes:</strong></p>
|
|
1542
|
+
<p>401 Unauthorized – authentication error<br>
|
|
1543
|
+
403 Forbidden – not enough permissions<br>
|
|
1544
|
+
404 Not Found – no banner for such id found</p>
|
|
1545
|
+
<p><strong>Response sample:</strong><br>
|
|
1546
|
+
200 OK</p>
|
|
1547
|
+
<p><strong>Parameters:</strong></p>
|
|
1548
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1549
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1550
|
+
username – the given username<br>
|
|
1551
|
+
bannerId – the given banner id</p>
|
|
1552
|
+
<p><!-- NEXT TITLE --><br>
|
|
1553
|
+
<!-- NEXT TITLE --></p>
|
|
1554
|
+
<h4>Get Banners</h4>
|
|
1555
|
+
<p style="white-space: pre-wrap;">Get the list of all banners for the given user.</p>
|
|
1556
|
+
<p><strong>URL:</strong> /rest-api/banners.do<br>
|
|
1557
|
+
<strong>Method:</strong> GET<br>
|
|
1558
|
+
<strong>Response format:</strong> application/json</p>
|
|
1559
|
+
<p><strong>Error codes:</strong></p>
|
|
1560
|
+
<p>401 Unauthorized – authentication error</p>
|
|
1561
|
+
<p><strong>Response sample:</strong><br>
|
|
1562
|
+
200 OK</p>
|
|
1563
|
+
<p><strong>Parameters:</strong></p>
|
|
1564
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1565
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1566
|
+
username – the given username<br>
|
|
1567
|
+
advertisingCategories – IDs of categories to filter down result to (optional)<br>
|
|
1568
|
+
campaignId – ID of banners’ parent campaign (optional).</p>
|
|
1569
|
+
<p><!-- NEXT TITLE --><br>
|
|
1570
|
+
<!-- NEXT TITLE --></p>
|
|
1571
|
+
<h4>Get Banners URLs</h4>
|
|
1572
|
+
<p style="white-space: pre-wrap;">Get the list of configured landing urls for given banners</p>
|
|
1573
|
+
<p><strong>URL:</strong> /rest-api/banners/urls.do<br>
|
|
1574
|
+
<strong>Method:</strong> GET<br>
|
|
1575
|
+
<strong>Response format:</strong> application/json</p>
|
|
1576
|
+
<p><strong>Error codes:</strong></p>
|
|
1577
|
+
<p>401 Unauthorized – authentication error</p>
|
|
1578
|
+
<p><strong>Response sample:</strong><br>
|
|
1579
|
+
200 OK</p>
|
|
1580
|
+
<p><strong>Parameters:</strong></p>
|
|
1581
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1582
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1583
|
+
username – the given username<br>
|
|
1584
|
+
advertisingCategories – IDs of advertising categories to filter down result to (optional)<br>
|
|
1585
|
+
bannerIds – IDs of banners to filter down result to (optional)</p>
|
|
1586
|
+
<p><!-- NEXT TITLE --><br>
|
|
1587
|
+
<!-- NEXT TITLE --></p>
|
|
1588
|
+
<h4>Update Banner</h4>
|
|
1589
|
+
<p style="white-space: pre-wrap;">Update the banner active state, autolinking facility and autolinking categories.</p>
|
|
1590
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/update.do<br>
|
|
1591
|
+
<strong>Method:</strong> POST<br>
|
|
1592
|
+
<strong>Response format:</strong> application/json</p>
|
|
1593
|
+
<p><strong>Error codes:</strong></p>
|
|
1594
|
+
<p>400 Bad Request – wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1595
|
+
401 Unauthorized – authentication error<br>
|
|
1596
|
+
403 Forbidden – not enough permissions</p>
|
|
1597
|
+
<p><strong>Request Parameters:</strong></p>
|
|
1598
|
+
<p>active – active status of banner as a boolean<br>
|
|
1599
|
+
allowNewPlacementsAutoLinking – permission for banner to be linked to new placements automatically as boolean<br>
|
|
1600
|
+
autolinkCategories – ID’s of publishing categories for autolinking.</p>
|
|
1601
|
+
<p><strong>Response sample:</strong><br>
|
|
1602
|
+
200 OK</p>
|
|
1603
|
+
<p><strong>Parameters:</strong></p>
|
|
1604
|
+
<p>hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1605
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1606
|
+
username – the given username<br>
|
|
1607
|
+
bannerId – the given banner id<br>
|
|
1608
|
+
<!-- NEXT TITLE --><br>
|
|
1609
|
+
<!-- NEXT TITLE --></p>
|
|
1610
|
+
<h4>Delete Banner</h4>
|
|
1611
|
+
<p style="white-space: pre-wrap;">Deletes the banner.</p>
|
|
1612
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/delete.do<br>
|
|
1613
|
+
<strong>Method:</strong> DELETE<br>
|
|
1614
|
+
<strong>Response format:</strong> application/json</p>
|
|
1615
|
+
<p><strong>Error codes:</strong><br>
|
|
1616
|
+
400 Bad Request – wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1617
|
+
401 Unauthorized – authentication error<br>
|
|
1618
|
+
403 Forbidden – not enough permissions<br>
|
|
1619
|
+
<strong>Response sample:</strong><br>
|
|
1620
|
+
200 OK</p>
|
|
1621
|
+
<p><strong>Parameters:</strong><br>
|
|
1622
|
+
hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1623
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1624
|
+
username – the given username<br>
|
|
1625
|
+
bannerId – the given banner id</p>
|
|
1626
|
+
<p><!-- NEXT TITLE --><br>
|
|
1627
|
+
<!-- NEXT TITLE --></p>
|
|
1628
|
+
<h4>Get Ad Unit Values By Banner Type</h4>
|
|
1629
|
+
<p style="white-space: pre-wrap;">Get the available banner adunit values.</p>
|
|
1630
|
+
<p><strong>URL:</strong> /rest-api/banners/{bannerType}/adunit/values.do<br>
|
|
1631
|
+
<strong>Method:</strong> GET<br>
|
|
1632
|
+
<strong>Response format:</strong> application/json</p>
|
|
1633
|
+
<p><strong>Error codes:</strong></p>
|
|
1634
|
+
<p>401 Unauthorized – authentication error<br>
|
|
1635
|
+
403 Forbidden – not enough permissions<br>
|
|
1636
|
+
404 Not Found – no banner for such id found<br>
|
|
1637
|
+
<strong>Response sample:</strong><br>
|
|
1638
|
+
200 OK</p>
|
|
1639
|
+
<p><strong>Parameters:</strong><br>
|
|
1640
|
+
hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1641
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1642
|
+
username – the given username<br>
|
|
1643
|
+
bannerType – type of banner. Available values are LOCAL_FILE, EXTERNAL_FILE, CODE, MOBILE_ADVERTISING_NETWORK, APPLICATION_ADVERTISING_NETWORK, LOCAL_VIDEO, EXTERNAL_VIDEO, URL, VAST_2_0_TAG_URL, TEMPLATE, OPENRTB_DSP</p>
|
|
1644
|
+
<p><!-- NEXT TITLE --><br>
|
|
1645
|
+
<!-- NEXT TITLE --></p>
|
|
1646
|
+
<h4>Get Banner Ad Unit Values</h4>
|
|
1647
|
+
<p style="white-space: pre-wrap;">Get the available banner adunit values.</p>
|
|
1648
|
+
<p><strong>URL:</strong> /rest-api/banner/adunit/values.do<br>
|
|
1649
|
+
<strong>Method:</strong> GET<br>
|
|
1650
|
+
<strong>Response format:</strong> application/json</p>
|
|
1651
|
+
<p><strong>Error codes:</strong></p>
|
|
1652
|
+
<p>401 Unauthorized – authentication error<br>
|
|
1653
|
+
403 Forbidden – not enough permissions<br>
|
|
1654
|
+
404 Not Found – no banner for such id found<br>
|
|
1655
|
+
<strong>Response sample:</strong><br>
|
|
1656
|
+
200 OK</p>
|
|
1657
|
+
<p><strong>Parameters:</strong><br>
|
|
1658
|
+
hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1659
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1660
|
+
username – the given username<br>
|
|
1661
|
+
placementType – - available values are SITE_PLACEMENT or MOBILE_SITE_PLACEMENT</p>
|
|
1662
|
+
<p><!-- NEXT TITLE --><br>
|
|
1663
|
+
<!-- NEXT TITLE --></p>
|
|
1664
|
+
<h4>Get Mobile Networks</h4>
|
|
1665
|
+
<p style="white-space: pre-wrap;">Get the available mobile advertising networks.</p>
|
|
1666
|
+
<p><strong>URL:</strong> /rest-api/banner/mobilenetworks.do<br>
|
|
1667
|
+
<strong>Method:</strong> GET<br>
|
|
1668
|
+
<strong>Response format:</strong> application/json</p>
|
|
1669
|
+
<p><strong>Error codes:</strong></p>
|
|
1670
|
+
<p>401 Unauthorized – authentication error<br>
|
|
1671
|
+
403 Forbidden – not enough permissions<br>
|
|
1672
|
+
404 Not Found – no banner for such id found<br>
|
|
1673
|
+
<strong>Response sample:</strong><br>
|
|
1674
|
+
200 OK</p>
|
|
1675
|
+
<p><strong>Parameters:</strong><br>
|
|
1676
|
+
hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1677
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1678
|
+
username – the given username</p>
|
|
1679
|
+
<p><!-- NEXT TITLE --><br>
|
|
1680
|
+
<!-- NEXT TITLE --></p>
|
|
1681
|
+
<h4>Get Placements For Banner</h4>
|
|
1682
|
+
<p style="white-space: pre-wrap;">Get the banner by id.</p>
|
|
1683
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/placements.do<br>
|
|
1684
|
+
<strong>Method:</strong> GET<br>
|
|
1685
|
+
<strong>Response format:</strong> application/json</p>
|
|
1686
|
+
<p><strong>Error codes:</strong></p>
|
|
1687
|
+
<p>401 Unauthorized – authentication error<br>
|
|
1688
|
+
403 Forbidden – not enough permissions<br>
|
|
1689
|
+
404 Not Found – no banner for such id found<br>
|
|
1690
|
+
<strong>Response sample:</strong><br>
|
|
1691
|
+
200 OK<br>
|
|
1692
|
+
{id: 1, name: “bannerName1″}</p>
|
|
1693
|
+
<p><strong>Parameters:</strong><br>
|
|
1694
|
+
hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1695
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1696
|
+
username – the given username<br>
|
|
1697
|
+
bannerId – the given banner id</p>
|
|
1698
|
+
<p><!-- NEXT TITLE --><br>
|
|
1699
|
+
<!-- NEXT TITLE --></p>
|
|
1700
|
+
<h4>Update Banners Urls Batch</h4>
|
|
1701
|
+
<p style="white-space: pre-wrap;">Update landing urls for specified banners.</p>
|
|
1702
|
+
<p><strong>URL:</strong> /rest-api/banners/urls.do<br>
|
|
1703
|
+
<strong>Method:</strong> POST<br>
|
|
1704
|
+
<strong>Response format:</strong> application/json</p>
|
|
1705
|
+
<p><strong>Error codes:</strong><br>
|
|
1706
|
+
400 Bad Request – wrong request format. E.g. wrong types for parameters or no banner exists.<br>
|
|
1707
|
+
401 Unauthorized – authentication error<br>
|
|
1708
|
+
403 Forbidden – not enough permissions<br>
|
|
1709
|
+
Request body: json formatted string of banner to url mappings as follows:<br>
|
|
1710
|
+
[{"id":1,"url":"http://example.com"}, ...]</p>
|
|
1711
|
+
<p><strong>Response sample:</strong><br>
|
|
1712
|
+
200 OK</p>
|
|
1713
|
+
<p>Method returns json formatted string with errors that occurred during execution. Format:<br>
|
|
1714
|
+
{“success”:false, : } Example:<br>
|
|
1715
|
+
{“160″:”no_url_property_found”,”success”:false}</p>
|
|
1716
|
+
<p><strong>Parameters:</strong><br>
|
|
1717
|
+
hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1718
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1719
|
+
username – the given username</p>
|
|
1720
|
+
<p><!-- NEXT TITLE --></p>
|
|
1721
|
+
<h4 id="bancap" align="center"><span style="text-decoration: underline;">Banner Capping API</span></h4>
|
|
1722
|
+
<p><!-- NEXT TITLE --></p>
|
|
1723
|
+
<h4>Get Action Capping</h4>
|
|
1724
|
+
<p style="white-space: pre-wrap;">Get the banner action capping information by banner id.</p>
|
|
1725
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/actionCapping.do<br>
|
|
1726
|
+
<strong>Method:</strong> GET<br>
|
|
1727
|
+
<strong>Response format:</strong> application/json</p>
|
|
1728
|
+
<p><strong>Error codes:</strong><br>
|
|
1729
|
+
401 Unauthorized – authentication error<br>
|
|
1730
|
+
403 Forbidden – not enough permissions<br>
|
|
1731
|
+
404 Not Found – no action capping set for such banner<br>
|
|
1732
|
+
<strong>Response sample:</strong><br>
|
|
1733
|
+
200 OK</p>
|
|
1734
|
+
<p><strong>Parameters:</strong><br>
|
|
1735
|
+
hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
1736
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
1737
|
+
username – the given username<br>
|
|
1738
|
+
bannerId – the given banner id</p>
|
|
1739
|
+
<p><!-- NEXT TITLE --><br>
|
|
1740
|
+
<!-- NEXT TITLE --></p>
|
|
1741
|
+
<h4>Get Click Capping</h4>
|
|
1742
|
+
<p style="white-space: pre-wrap;">Get the banner click capping information by banner id.</p>
|
|
1743
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/clickCapping.do<br>
|
|
1744
|
+
<strong>Method:</strong> GET<br>
|
|
1745
|
+
<strong>Response format:</strong> application/json</p>
|
|
1746
|
+
<p><strong>Error codes:</strong><br>
|
|
1747
|
+
401 Unauthorized – authentication error<br>
|
|
1748
|
+
403 Forbidden – not enough permissions<br>
|
|
1749
|
+
404 Not Found – no click capping set for such banner<br>
|
|
1750
|
+
<strong>Response sample:</strong><br>
|
|
1751
|
+
200 OK<br>
|
|
1752
|
+
{id: 1, paymentModel: “CPM”, price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }</p>
|
|
1753
|
+
<p><strong>Parameters:</strong><br>
|
|
1754
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1755
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1756
|
+
username - the given username<br>
|
|
1757
|
+
bannerId - the given banner id</p>
|
|
1758
|
+
<p><!-- NEXT TITLE --><br>
|
|
1759
|
+
<!-- NEXT TITLE --></p>
|
|
1760
|
+
<h4>Get Frequency Capping</h4>
|
|
1761
|
+
<p style="white-space: pre-wrap;">Get the banner frequency capping information by banner id.</p>
|
|
1762
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/frequencyCapping.do<br>
|
|
1763
|
+
<strong>Method:</strong> GET<br>
|
|
1764
|
+
<strong>Response format:</strong> application/json</p>
|
|
1765
|
+
<p><strong>Error codes:</strong><br>
|
|
1766
|
+
401 Unauthorized - authentication error<br>
|
|
1767
|
+
403 Forbidden - not enough permissions<br>
|
|
1768
|
+
404 Not Found - no frequency capping set for such banner<br>
|
|
1769
|
+
<strong>Response sample:</strong><br>
|
|
1770
|
+
200 OK<br>
|
|
1771
|
+
{id: 1, paymentModel: "CPM", price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }</p>
|
|
1772
|
+
<p><strong>Parameters:</strong><br>
|
|
1773
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1774
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1775
|
+
username - the given username<br>
|
|
1776
|
+
bannerId - the given banner id</p>
|
|
1777
|
+
<p><!-- NEXT TITLE --><br>
|
|
1778
|
+
<!-- NEXT TITLE --></p>
|
|
1779
|
+
<h4>Remove Action Capping</h4>
|
|
1780
|
+
<p style="white-space: pre-wrap;">Removes the banner action capping by banner id.</p>
|
|
1781
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/actionCapping.do<br>
|
|
1782
|
+
<strong>Method:</strong> DELETE<br>
|
|
1783
|
+
<strong>Response format:</strong> application/json</p>
|
|
1784
|
+
<p><strong>Error codes:</strong><br>
|
|
1785
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1786
|
+
401 Unauthorized - authentication error<br>
|
|
1787
|
+
403 Forbidden - not enough permissions<br>
|
|
1788
|
+
<strong>Response sample:</strong><br>
|
|
1789
|
+
200 OK</p>
|
|
1790
|
+
<p><strong>Parameters:</strong><br>
|
|
1791
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1792
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1793
|
+
username - the given username<br>
|
|
1794
|
+
bannerId - the given banner id</p>
|
|
1795
|
+
<p><!-- NEXT TITLE --><br>
|
|
1796
|
+
<!-- NEXT TITLE --></p>
|
|
1797
|
+
<h4>Remove Click Capping</h4>
|
|
1798
|
+
<p style="white-space: pre-wrap;">Removes the banner click capping by banner id.</p>
|
|
1799
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/clickCapping.do<br>
|
|
1800
|
+
<strong>Method:</strong> DELETE<br>
|
|
1801
|
+
<strong>Response format:</strong> application/json</p>
|
|
1802
|
+
<p><strong>Error codes:</strong><br>
|
|
1803
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1804
|
+
401 Unauthorized - authentication error<br>
|
|
1805
|
+
403 Forbidden - not enough permissions<br>
|
|
1806
|
+
<strong>Response sample:</strong><br>
|
|
1807
|
+
200 OK</p>
|
|
1808
|
+
<p><strong>Parameters:</strong><br>
|
|
1809
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1810
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1811
|
+
username - the given username<br>
|
|
1812
|
+
bannerId - the given banner id</p>
|
|
1813
|
+
<p><!-- NEXT TITLE --><br>
|
|
1814
|
+
<!-- NEXT TITLE --></p>
|
|
1815
|
+
<h4>Remove Frequency Capping</h4>
|
|
1816
|
+
<p style="white-space: pre-wrap;">Removes the banner frequency capping by banner id.</p>
|
|
1817
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/frequencyCapping.do<br>
|
|
1818
|
+
<strong>Method:</strong> DELETE<br>
|
|
1819
|
+
<strong>Response format:</strong> application/json</p>
|
|
1820
|
+
<p><strong>Error codes:</strong><br>
|
|
1821
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1822
|
+
401 Unauthorized - authentication error<br>
|
|
1823
|
+
403 Forbidden - not enough permissions<br>
|
|
1824
|
+
<strong>Response sample:</strong><br>
|
|
1825
|
+
200 OK</p>
|
|
1826
|
+
<p><strong>Parameters:</strong><br>
|
|
1827
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1828
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1829
|
+
username - the given username<br>
|
|
1830
|
+
bannerId - the given banner id</p>
|
|
1831
|
+
<p><!-- NEXT TITLE --><br>
|
|
1832
|
+
<!-- NEXT TITLE --></p>
|
|
1833
|
+
<h4>Set Action Capping</h4>
|
|
1834
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner action capping values by banner id.</p>
|
|
1835
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/actionCapping/set.do<br>
|
|
1836
|
+
<strong>Method:</strong> POST<br>
|
|
1837
|
+
<strong>Response format:</strong> application/json</p>
|
|
1838
|
+
<p><strong>Error codes:</strong><br>
|
|
1839
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1840
|
+
401 Unauthorized - authentication error<br>
|
|
1841
|
+
403 Forbidden - not enough permissions<br>
|
|
1842
|
+
404 Not Found - banner not found<br>
|
|
1843
|
+
<strong>Response sample:</strong><br>
|
|
1844
|
+
200 OK</p>
|
|
1845
|
+
<p><strong>Parameters:</strong><br>
|
|
1846
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1847
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1848
|
+
username - the given username<br>
|
|
1849
|
+
bannerId - the given banner id<br>
|
|
1850
|
+
amount - amount of capping<br>
|
|
1851
|
+
period - period for capping<br>
|
|
1852
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
1853
|
+
evenDistribution - - value for even distribution (true/false)</p>
|
|
1854
|
+
<p><!-- NEXT TITLE --><br>
|
|
1855
|
+
<!-- NEXT TITLE --></p>
|
|
1856
|
+
<h4>Set Click Capping</h4>
|
|
1857
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner click capping values by banner id.</p>
|
|
1858
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/clickCapping/set.do<br>
|
|
1859
|
+
<strong>Method:</strong> POST<br>
|
|
1860
|
+
<strong>Response format:</strong> application/json</p>
|
|
1861
|
+
<p><strong>Error codes:</strong><br>
|
|
1862
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1863
|
+
401 Unauthorized - authentication error<br>
|
|
1864
|
+
403 Forbidden - not enough permissions<br>
|
|
1865
|
+
404 Not Found - banner not found<br>
|
|
1866
|
+
<strong>Response sample:</strong><br>
|
|
1867
|
+
200 OK</p>
|
|
1868
|
+
<p><strong>Parameters:</strong><br>
|
|
1869
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1870
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1871
|
+
username - the given username<br>
|
|
1872
|
+
bannerId - the given banner id<br>
|
|
1873
|
+
amount - amount of capping<br>
|
|
1874
|
+
period - period for capping<br>
|
|
1875
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
1876
|
+
evenDistribution - - value for even distribution (true/false)</p>
|
|
1877
|
+
<p><!-- NEXT TITLE --><br>
|
|
1878
|
+
<!-- NEXT TITLE --></p>
|
|
1879
|
+
<h4>Set Frequency Capping</h4>
|
|
1880
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner frequency capping values by banner id.</p>
|
|
1881
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/frequencyCapping/set.do<br>
|
|
1882
|
+
<strong>Method:</strong> POST<br>
|
|
1883
|
+
<strong>Response format:</strong> application/json</p>
|
|
1884
|
+
<p><strong>Error codes:</strong><br>
|
|
1885
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1886
|
+
401 Unauthorized - authentication error<br>
|
|
1887
|
+
403 Forbidden - not enough permissions<br>
|
|
1888
|
+
404 Not Found - banner not found<br>
|
|
1889
|
+
<strong>Response sample:</strong><br>
|
|
1890
|
+
200 OK</p>
|
|
1891
|
+
<p><strong>Parameters:</strong><br>
|
|
1892
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1893
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1894
|
+
username - the given username<br>
|
|
1895
|
+
bannerId - the given banner id<br>
|
|
1896
|
+
amount - amount of capping<br>
|
|
1897
|
+
period - period for capping<br>
|
|
1898
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
1899
|
+
evenDistribution - - value for even distribution (true/false)</p>
|
|
1900
|
+
<p><!-- NEXT TITLE --><br>
|
|
1901
|
+
<!-- NEXT TITLE --></p>
|
|
1902
|
+
<h4>Update Action Capping</h4>
|
|
1903
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner action capping values by banner id.</p>
|
|
1904
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/actionCapping/update.do<br>
|
|
1905
|
+
<strong>Method:</strong> POST<br>
|
|
1906
|
+
<strong>Response format:</strong> application/json</p>
|
|
1907
|
+
<p><strong>Error codes:</strong><br>
|
|
1908
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1909
|
+
401 Unauthorized - authentication error<br>
|
|
1910
|
+
403 Forbidden - not enough permissions<br>
|
|
1911
|
+
404 Not Found - no click capping enabled or banner not found<br>
|
|
1912
|
+
<strong>Response sample:</strong><br>
|
|
1913
|
+
200 OK</p>
|
|
1914
|
+
<p><strong>Parameters:</strong><br>
|
|
1915
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1916
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1917
|
+
username - the given username<br>
|
|
1918
|
+
bannerId - the given banner id<br>
|
|
1919
|
+
amount - amount of capping<br>
|
|
1920
|
+
period - period for capping<br>
|
|
1921
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
1922
|
+
evenDistribution - - value for even distribution (true/false)</p>
|
|
1923
|
+
<p><!-- NEXT TITLE --><br>
|
|
1924
|
+
<!-- NEXT TITLE --></p>
|
|
1925
|
+
<h4>Update Click Capping</h4>
|
|
1926
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner click capping values by banner id.</p>
|
|
1927
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/clickCapping/update.do<br>
|
|
1928
|
+
<strong>Method:</strong> POST<br>
|
|
1929
|
+
<strong>Response format:</strong> application/json</p>
|
|
1930
|
+
<p><strong>Error codes:</strong><br>
|
|
1931
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1932
|
+
401 Unauthorized - authentication error<br>
|
|
1933
|
+
403 Forbidden - not enough permissions<br>
|
|
1934
|
+
404 Not Found - no click capping enabled or banner not found<br>
|
|
1935
|
+
<strong>Response sample:</strong><br>
|
|
1936
|
+
200 OK</p>
|
|
1937
|
+
<p><strong>Parameters:</strong><br>
|
|
1938
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1939
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1940
|
+
username - the given username<br>
|
|
1941
|
+
bannerId - the given banner id<br>
|
|
1942
|
+
amount - amount of capping<br>
|
|
1943
|
+
period - period for capping<br>
|
|
1944
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
1945
|
+
evenDistribution - - value for even distribution (true/false)</p>
|
|
1946
|
+
<p><!-- NEXT TITLE --><br>
|
|
1947
|
+
<!-- NEXT TITLE --></p>
|
|
1948
|
+
<h4>Update Frequency Capping</h4>
|
|
1949
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner frequency capping values by banner id.</p>
|
|
1950
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/frequencyCapping/update.do<br>
|
|
1951
|
+
<strong>Method:</strong> POST<br>
|
|
1952
|
+
<strong>Response format:</strong> application/json</p>
|
|
1953
|
+
<p><strong>Error codes:</strong><br>
|
|
1954
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
1955
|
+
401 Unauthorized - authentication error<br>
|
|
1956
|
+
403 Forbidden - not enough permissions<br>
|
|
1957
|
+
404 Not Found - no frequency capping enabled or banner not found<br>
|
|
1958
|
+
<strong>Response sample:</strong><br>
|
|
1959
|
+
200 OK</p>
|
|
1960
|
+
<p><strong>Parameters:</strong><br>
|
|
1961
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1962
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1963
|
+
username - the given username<br>
|
|
1964
|
+
bannerId - the given banner id<br>
|
|
1965
|
+
amount - amount of capping<br>
|
|
1966
|
+
period - period for capping<br>
|
|
1967
|
+
periodType - period type, available values: HOUR, DAY, WEEK, MONTH, YEAR<br>
|
|
1968
|
+
evenDistribution - - value for even distribution (true/false)</p>
|
|
1969
|
+
<p><!-- NEXT TITLE --></p>
|
|
1970
|
+
<h4 id="banlim" align="center"><span style="text-decoration: underline;">Banner Limits API</span></h4>
|
|
1971
|
+
<p><!-- NEXT TITLE --></p>
|
|
1972
|
+
<h4>Disable Limits</h4>
|
|
1973
|
+
<p style="white-space: pre-wrap;">Disables banner limits.</p>
|
|
1974
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/limits.do<br>
|
|
1975
|
+
<strong>Method:</strong> DELETE<br>
|
|
1976
|
+
<strong>Response format:</strong> application/json</p>
|
|
1977
|
+
<p><strong>Error codes:</strong><br>
|
|
1978
|
+
400 Bad Request - no banner with such id exists<br>
|
|
1979
|
+
401 Unauthorized - authentication error<br>
|
|
1980
|
+
403 Forbidden - not enough permissions<br>
|
|
1981
|
+
<strong>Response sample:</strong><br>
|
|
1982
|
+
200 OK</p>
|
|
1983
|
+
<p><strong>Parameters:</strong><br>
|
|
1984
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
1985
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
1986
|
+
username - the given username<br>
|
|
1987
|
+
bannerId - the given banner id</p>
|
|
1988
|
+
<p><!-- NEXT TITLE --><br>
|
|
1989
|
+
<!-- NEXT TITLE --></p>
|
|
1990
|
+
<h4>Get Limits</h4>
|
|
1991
|
+
<p style="white-space: pre-wrap;">Get the banner limits information by banner id.</p>
|
|
1992
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/limits.do<br>
|
|
1993
|
+
<strong>Method:</strong> GET<br>
|
|
1994
|
+
<strong>Response format:</strong> application/json</p>
|
|
1995
|
+
<p><strong>Error codes:</strong><br>
|
|
1996
|
+
401 Unauthorized - authentication error<br>
|
|
1997
|
+
403 Forbidden - not enough permissions<br>
|
|
1998
|
+
404 Not Found - no limits set for such banner<br>
|
|
1999
|
+
<strong>Response sample:</strong><br>
|
|
2000
|
+
200 OK</p>
|
|
2001
|
+
<p><strong>Parameters:</strong><br>
|
|
2002
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2003
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2004
|
+
username - the given username<br>
|
|
2005
|
+
bannerId - the given banner id</p>
|
|
2006
|
+
<p><!-- NEXT TITLE --><br>
|
|
2007
|
+
<!-- NEXT TITLE --></p>
|
|
2008
|
+
<h4>Reset Limits</h4>
|
|
2009
|
+
<p style="white-space: pre-wrap;">Resets the banner limits counter values by banner id and counter type.</p>
|
|
2010
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/limits/reset.do<br>
|
|
2011
|
+
<strong>Method:</strong> POST<br>
|
|
2012
|
+
<strong>Response format:</strong> application/json</p>
|
|
2013
|
+
<p><strong>Error codes:</strong><br>
|
|
2014
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2015
|
+
401 Unauthorized - authentication error<br>
|
|
2016
|
+
403 Forbidden - not enough permissions<br>
|
|
2017
|
+
404 Not Found - no limit enabled for the banner<br>
|
|
2018
|
+
<strong>Response sample:</strong><br>
|
|
2019
|
+
200 OK</p>
|
|
2020
|
+
<p><strong>Parameters:</strong><br>
|
|
2021
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2022
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2023
|
+
username - the given username<br>
|
|
2024
|
+
bannerId - the given banner id<br>
|
|
2025
|
+
limitCounters - list of counters to reset, available values: TOTAL_IMPRESSIONS, TOTAL_CLICKS, TOTAL_REVENUE, DAILY_IMPRESSIONS, DAILY_CLICKS, DAILY_REVENUE</p>
|
|
2026
|
+
<p><!-- NEXT TITLE --><br>
|
|
2027
|
+
<!-- NEXT TITLE --></p>
|
|
2028
|
+
<h4>Set Limits</h4>
|
|
2029
|
+
<p style="white-space: pre-wrap;">Set the banner limits information by banner id.</p>
|
|
2030
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/limits/set.do<br>
|
|
2031
|
+
<strong>Method:</strong> POST<br>
|
|
2032
|
+
<strong>Response format:</strong> application/json</p>
|
|
2033
|
+
<p><strong>Error codes:</strong><br>
|
|
2034
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2035
|
+
401 Unauthorized - authentication error<br>
|
|
2036
|
+
403 Forbidden - not enough permissions<br>
|
|
2037
|
+
<strong>Request Parameters:</strong><br>
|
|
2038
|
+
Long totalImpressionsLimit; Long totalClicksLimit; Double totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit; Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double totalBudget; Long dailyImpressions; Long dailyClicks; Double dailyBudget;<br>
|
|
2039
|
+
startDate - limit start, "yyyy-MM-dd-HH-mm"<br>
|
|
2040
|
+
endDate - limit end, "yyyy-MM-dd-HH-mm"<br>
|
|
2041
|
+
totalImpressionsLimit - limit for impressions<br>
|
|
2042
|
+
totalClicksLimit - limit for clicks<br>
|
|
2043
|
+
totalBudgetLimit - limit for budget<br>
|
|
2044
|
+
dailyImpressionsLimit - daily limit for impressions<br>
|
|
2045
|
+
dailyClicksLimit - daily limit for clicks<br>
|
|
2046
|
+
dailyBudgetLimit - daily limit for budget<br>
|
|
2047
|
+
totalImpressions - current value for impressions<br>
|
|
2048
|
+
totalClicks - current value for clicks<br>
|
|
2049
|
+
totalBudget - current value for budget<br>
|
|
2050
|
+
dailyImpressions - value for impressions for current day<br>
|
|
2051
|
+
dailyClicks - value for clicks for current day<br>
|
|
2052
|
+
dailyBudget - value for budget for current day<br>
|
|
2053
|
+
<strong>Response sample:</strong><br>
|
|
2054
|
+
200 OK</p>
|
|
2055
|
+
<p><strong>Parameters:</strong><br>
|
|
2056
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2057
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2058
|
+
username - the given username<br>
|
|
2059
|
+
bannerId - the given banner id</p>
|
|
2060
|
+
<p><!-- NEXT TITLE --><br>
|
|
2061
|
+
<!-- NEXT TITLE --></p>
|
|
2062
|
+
<h4>Update Limits</h4>
|
|
2063
|
+
<p style="white-space: pre-wrap;">Updates the banner limits information by banner id.</p>
|
|
2064
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/limits/update.do<br>
|
|
2065
|
+
<strong>Method:</strong> POST<br>
|
|
2066
|
+
<strong>Response format:</strong> application/json</p>
|
|
2067
|
+
<p><strong>Error codes:</strong><br>
|
|
2068
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2069
|
+
401 Unauthorized - authentication error<br>
|
|
2070
|
+
403 Forbidden - not enough permissions<br>
|
|
2071
|
+
404 Not Found - no limits enabled or banner not found<br>
|
|
2072
|
+
<strong>Request Parameters:</strong><br>
|
|
2073
|
+
Long totalImpressionsLimit; Long totalClicksLimit; Double totalBudgetLimit; Long dailyImpressionsLimit; Long dailyClicksLimit; Double dailyBudgetLimit; Long totalImpressions; Long totalClicks; Double totalBudget; Long dailyImpressions; Long dailyClicks; Double dailyBudget;<br>
|
|
2074
|
+
startDate - limit start, milliseconds<br>
|
|
2075
|
+
endDate - limit end, milliseconds<br>
|
|
2076
|
+
totalImpressionsLimit - limit for impressions<br>
|
|
2077
|
+
totalClicksLimit - limit for clicks<br>
|
|
2078
|
+
totalBudgetLimit - limit for budget<br>
|
|
2079
|
+
dailyImpressionsLimit - daily limit for impressions<br>
|
|
2080
|
+
dailyClicksLimit - daily limit for clicks<br>
|
|
2081
|
+
dailyBudgetLimit - daily limit for budget<br>
|
|
2082
|
+
totalImpressions - current value for impressions<br>
|
|
2083
|
+
totalClicks - current value for clicks<br>
|
|
2084
|
+
totalBudget - current value for budget<br>
|
|
2085
|
+
dailyImpressions - value for impressions for current day<br>
|
|
2086
|
+
dailyClicks - value for clicks for current day<br>
|
|
2087
|
+
dailyBudget - value for budget for current day<br>
|
|
2088
|
+
<strong>Response sample:</strong><br>
|
|
2089
|
+
200 OK</p>
|
|
2090
|
+
<p><strong>Parameters:</strong><br>
|
|
2091
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2092
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2093
|
+
username - the given username<br>
|
|
2094
|
+
bannerId - the given banner id</p>
|
|
2095
|
+
<p><!-- NEXT TITLE --></p>
|
|
2096
|
+
<h4 id="bantar" align="center"><span style="text-decoration: underline;">Banner Targeting API</span></h4>
|
|
2097
|
+
<p><!-- NEXT TITLE --></p>
|
|
2098
|
+
<h4>Create Browser Target</h4>
|
|
2099
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the browser targeting by banner id.</p>
|
|
2100
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/create.do<br>
|
|
2101
|
+
<strong>Method:</strong> POST<br>
|
|
2102
|
+
<strong>Response format:</strong> application/json</p>
|
|
2103
|
+
<p><strong>Error codes:</strong><br>
|
|
2104
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2105
|
+
401 Unauthorized - authentication error<br>
|
|
2106
|
+
403 Forbidden - not enough permissions<br>
|
|
2107
|
+
<strong>Response sample:</strong><br>
|
|
2108
|
+
200 OK</p>
|
|
2109
|
+
<p><strong>Parameters:</strong><br>
|
|
2110
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2111
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2112
|
+
username - the given username<br>
|
|
2113
|
+
bannerId - the given banner id<br>
|
|
2114
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
2115
|
+
browser -<br>
|
|
2116
|
+
relation -<br>
|
|
2117
|
+
browserVersion -</p>
|
|
2118
|
+
<p><!-- NEXT TITLE --><br>
|
|
2119
|
+
<!-- NEXT TITLE --></p>
|
|
2120
|
+
<h4>Create Channel Target</h4>
|
|
2121
|
+
<p style="white-space: pre-wrap;">Sets the banner channel targeting by banner id.</p>
|
|
2122
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/channel/create.do<br>
|
|
2123
|
+
<strong>Method:</strong> POST<br>
|
|
2124
|
+
<strong>Response format:</strong> application/json</p>
|
|
2125
|
+
<p><strong>Error codes:</strong><br>
|
|
2126
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2127
|
+
401 Unauthorized - authentication error<br>
|
|
2128
|
+
403 Forbidden - not enough permissions<br>
|
|
2129
|
+
<strong>Response sample:</strong><br>
|
|
2130
|
+
200 OK</p>
|
|
2131
|
+
<p><strong>Parameters:</strong><br>
|
|
2132
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2133
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2134
|
+
username - the given username<br>
|
|
2135
|
+
bannerId - the given banner id<br>
|
|
2136
|
+
channel -<br>
|
|
2137
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2138
|
+
<p><!-- NEXT TITLE --><br>
|
|
2139
|
+
<!-- NEXT TITLE --></p>
|
|
2140
|
+
<h4>Create Coookie Value Target</h4>
|
|
2141
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner cookie value targeting by banner id.</p>
|
|
2142
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/cookie/create.do<br>
|
|
2143
|
+
<strong>Method:</strong> POST<br>
|
|
2144
|
+
<strong>Response format:</strong> application/json</p>
|
|
2145
|
+
<p><strong>Error codes:</strong><br>
|
|
2146
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2147
|
+
401 Unauthorized - authentication error<br>
|
|
2148
|
+
403 Forbidden - not enough permissions<br>
|
|
2149
|
+
<strong>Response sample:</strong><br>
|
|
2150
|
+
200 OK</p>
|
|
2151
|
+
<p><strong>Parameters:</strong><br>
|
|
2152
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2153
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2154
|
+
username - the given username<br>
|
|
2155
|
+
bannerId - the given banner id<br>
|
|
2156
|
+
cookieName -<br>
|
|
2157
|
+
cookieValue -<br>
|
|
2158
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2159
|
+
<p><!-- NEXT TITLE --><br>
|
|
2160
|
+
<!-- NEXT TITLE --></p>
|
|
2161
|
+
<h4>Create Country Target</h4>
|
|
2162
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner country targeting by banner id.</p>
|
|
2163
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/country/create.do<br>
|
|
2164
|
+
<strong>Method:</strong> POST<br>
|
|
2165
|
+
<strong>Response format:</strong> application/json</p>
|
|
2166
|
+
<p><strong>Error codes:</strong><br>
|
|
2167
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2168
|
+
401 Unauthorized - authentication error<br>
|
|
2169
|
+
403 Forbidden - not enough permissions<br>
|
|
2170
|
+
<strong>Response sample:</strong><br>
|
|
2171
|
+
200 OK</p>
|
|
2172
|
+
<p><strong>Parameters:</strong><br>
|
|
2173
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2174
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2175
|
+
username - the given username<br>
|
|
2176
|
+
bannerId - the given banner id<br>
|
|
2177
|
+
countryCode - - ISO country code<br>
|
|
2178
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2179
|
+
<p><!-- NEXT TITLE --><br>
|
|
2180
|
+
<!-- NEXT TITLE --></p>
|
|
2181
|
+
<h4>Create Custom Parameter Target</h4>
|
|
2182
|
+
<p style="white-space: pre-wrap;">Sets custom parameter targeting by banner id.</p>
|
|
2183
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/custom/create.do<br>
|
|
2184
|
+
<strong>Method:</strong> POST<br>
|
|
2185
|
+
<strong>Response format:</strong> application/json</p>
|
|
2186
|
+
<p><strong>Error codes:</strong><br>
|
|
2187
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2188
|
+
401 Unauthorized - authentication error<br>
|
|
2189
|
+
403 Forbidden - not enough permissions<br>
|
|
2190
|
+
<strong>Response sample:</strong><br>
|
|
2191
|
+
200 OK</p>
|
|
2192
|
+
<p><strong>Parameters:</strong><br>
|
|
2193
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2194
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2195
|
+
username - the given username<br>
|
|
2196
|
+
bannerId - the given banner id<br>
|
|
2197
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
2198
|
+
expression - - valid expression (Sample: ($p1==1 || $p1=='a') && ($p2>=12 && $p2<=22) )</p>
|
|
2199
|
+
<p><!-- NEXT TITLE --><br>
|
|
2200
|
+
<!-- NEXT TITLE --></p>
|
|
2201
|
+
<h4>Create Day Of Week Target</h4>
|
|
2202
|
+
<p style="white-space: pre-wrap;">Sets day of week targeting by banner id.</p>
|
|
2203
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/dayofweek/create.do<br>
|
|
2204
|
+
<strong>Method:</strong> POST<br>
|
|
2205
|
+
<strong>Response format:</strong> application/json</p>
|
|
2206
|
+
<p><strong>Error codes:</strong><br>
|
|
2207
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2208
|
+
401 Unauthorized - authentication error<br>
|
|
2209
|
+
403 Forbidden - not enough permissions<br>
|
|
2210
|
+
<strong>Response sample:</strong><br>
|
|
2211
|
+
200 OK</p>
|
|
2212
|
+
<p><strong>Parameters:</strong><br>
|
|
2213
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2214
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2215
|
+
username - the given username<br>
|
|
2216
|
+
bannerId - the given banner id<br>
|
|
2217
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
2218
|
+
dayOfWeek - - available values are MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY,SUNDAY</p>
|
|
2219
|
+
<p><!-- NEXT TITLE --><br>
|
|
2220
|
+
<!-- NEXT TITLE --></p>
|
|
2221
|
+
<h4>Create Device Format Target</h4>
|
|
2222
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner device targeting by banner id.</p>
|
|
2223
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/deviceformat/create.do<br>
|
|
2224
|
+
<strong>Method:</strong> POST<br>
|
|
2225
|
+
<strong>Response format:</strong> application/json</p>
|
|
2226
|
+
<p><strong>Error codes:</strong><br>
|
|
2227
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2228
|
+
401 Unauthorized - authentication error<br>
|
|
2229
|
+
403 Forbidden - not enough permissions<br>
|
|
2230
|
+
<strong>Response sample:</strong><br>
|
|
2231
|
+
200 OK</p>
|
|
2232
|
+
<p><strong>Parameters:</strong><br>
|
|
2233
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2234
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2235
|
+
username - the given username<br>
|
|
2236
|
+
bannerId - the given banner id<br>
|
|
2237
|
+
deviceFormat -<br>
|
|
2238
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2239
|
+
<p><!-- NEXT TITLE --><br>
|
|
2240
|
+
<!-- NEXT TITLE --></p>
|
|
2241
|
+
<h4>Create Device Target</h4>
|
|
2242
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner mobile carrier targeting by banner id.</p>
|
|
2243
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/mobilecarrier/create.do<br>
|
|
2244
|
+
<strong>Method:</strong> POST<br>
|
|
2245
|
+
<strong>Response format:</strong> application/json</p>
|
|
2246
|
+
<p><strong>Error codes:</strong><br>
|
|
2247
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2248
|
+
401 Unauthorized - authentication error<br>
|
|
2249
|
+
403 Forbidden - not enough permissions<br>
|
|
2250
|
+
<strong>Response sample:</strong><br>
|
|
2251
|
+
200 OK</p>
|
|
2252
|
+
<p><strong>Parameters:</strong><br>
|
|
2253
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2254
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2255
|
+
username - the given username<br>
|
|
2256
|
+
bannerId - the given banner id<br>
|
|
2257
|
+
device -<br>
|
|
2258
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2259
|
+
<p><!-- NEXT TITLE --><br>
|
|
2260
|
+
<!-- NEXT TITLE --></p>
|
|
2261
|
+
<h4>Create Device Vendor Target</h4>
|
|
2262
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner device vendor targeting by banner id.</p>
|
|
2263
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/devicevendor/create.do<br>
|
|
2264
|
+
<strong>Method:</strong> POST<br>
|
|
2265
|
+
<strong>Response format:</strong> application/json</p>
|
|
2266
|
+
<p><strong>Error codes:</strong><br>
|
|
2267
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2268
|
+
401 Unauthorized - authentication error<br>
|
|
2269
|
+
403 Forbidden - not enough permissions<br>
|
|
2270
|
+
<strong>Response sample:</strong><br>
|
|
2271
|
+
200 OK</p>
|
|
2272
|
+
<p><strong>Parameters:</strong><br>
|
|
2273
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2274
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2275
|
+
username - the given username<br>
|
|
2276
|
+
bannerId - the given banner id<br>
|
|
2277
|
+
deviceVendor -<br>
|
|
2278
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2279
|
+
<p><!-- NEXT TITLE --><br>
|
|
2280
|
+
<!-- NEXT TITLE --></p>
|
|
2281
|
+
<h4>Create Domain Target</h4>
|
|
2282
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner referrer domain targeting by banner id.</p>
|
|
2283
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/domain/create.do<br>
|
|
2284
|
+
<strong>Method:</strong> POST<br>
|
|
2285
|
+
<strong>Response format:</strong> application/json</p>
|
|
2286
|
+
<p><strong>Error codes:</strong><br>
|
|
2287
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2288
|
+
401 Unauthorized - authentication error<br>
|
|
2289
|
+
403 Forbidden - not enough permissions<br>
|
|
2290
|
+
<strong>Response sample:</strong><br>
|
|
2291
|
+
200 OK</p>
|
|
2292
|
+
<p><strong>Parameters:</strong><br>
|
|
2293
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2294
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2295
|
+
username - the given username<br>
|
|
2296
|
+
bannerId - the given banner id<br>
|
|
2297
|
+
domain -<br>
|
|
2298
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2299
|
+
<p><!-- NEXT TITLE --><br>
|
|
2300
|
+
<!-- NEXT TITLE --></p>
|
|
2301
|
+
<h4>Create Ip Range Target</h4>
|
|
2302
|
+
<p style="white-space: pre-wrap;">Sets ip range targeting by banner id.<br>
|
|
2303
|
+
Params - Valid IP range (Sample: from 194.222.012.001 to 194.223.07.01)</p>
|
|
2304
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/iprange/create.do<br>
|
|
2305
|
+
<strong>Method:</strong> POST<br>
|
|
2306
|
+
<strong>Response format:</strong> application/json</p>
|
|
2307
|
+
<p><strong>Error codes:</strong><br>
|
|
2308
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2309
|
+
401 Unauthorized - authentication error<br>
|
|
2310
|
+
403 Forbidden - not enough permissions<br>
|
|
2311
|
+
<strong>Response sample:</strong><br>
|
|
2312
|
+
200 OK</p>
|
|
2313
|
+
<p><strong>Parameters:</strong><br>
|
|
2314
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2315
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2316
|
+
username - the given username<br>
|
|
2317
|
+
bannerId - the given banner id<br>
|
|
2318
|
+
ipFrom - valid ip from for range<br>
|
|
2319
|
+
ipTo - valid ip to for range<br>
|
|
2320
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2321
|
+
<p><!-- NEXT TITLE --><br>
|
|
2322
|
+
<!-- NEXT TITLE --></p>
|
|
2323
|
+
<h4>Create Language Target</h4>
|
|
2324
|
+
<p style="white-space: pre-wrap;">Sets (and enables if was disabled) the banner language targeting by banner id.</p>
|
|
2325
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/language/create.do<br>
|
|
2326
|
+
<strong>Method:</strong> POST<br>
|
|
2327
|
+
<strong>Response format:</strong> application/json</p>
|
|
2328
|
+
<p><strong>Error codes:</strong><br>
|
|
2329
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2330
|
+
401 Unauthorized - authentication error<br>
|
|
2331
|
+
403 Forbidden - not enough permissions<br>
|
|
2332
|
+
<strong>Response sample:</strong><br>
|
|
2333
|
+
200 OK</p>
|
|
2334
|
+
<p><strong>Parameters:</strong><br>
|
|
2335
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2336
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2337
|
+
username - the given username<br>
|
|
2338
|
+
bannerId - the given banner id<br>
|
|
2339
|
+
languageCode - - language code<br>
|
|
2340
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2341
|
+
<p><!-- NEXT TITLE --><br>
|
|
2342
|
+
<!-- NEXT TITLE --></p>
|
|
2343
|
+
<h4>Create Location Target</h4>
|
|
2344
|
+
<p style="white-space: pre-wrap;">Sets location targeting by banner id.</p>
|
|
2345
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/location/create.do<br>
|
|
2346
|
+
<strong>Method:</strong> POST<br>
|
|
2347
|
+
<strong>Response format:</strong> application/json</p>
|
|
2348
|
+
<p><strong>Error codes:</strong><br>
|
|
2349
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2350
|
+
401 Unauthorized - authentication error<br>
|
|
2351
|
+
403 Forbidden - not enough permissions<br>
|
|
2352
|
+
<strong>Response sample:</strong><br>
|
|
2353
|
+
200 OK</p>
|
|
2354
|
+
<p><strong>Parameters:</strong><br>
|
|
2355
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2356
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2357
|
+
username - the given username<br>
|
|
2358
|
+
bannerId - the given banner id<br>
|
|
2359
|
+
countryCode -<br>
|
|
2360
|
+
regionName -<br>
|
|
2361
|
+
cityName -<br>
|
|
2362
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2363
|
+
<p><!-- NEXT TITLE --><br>
|
|
2364
|
+
<!-- NEXT TITLE --></p>
|
|
2365
|
+
<h4>Create Mobile Carrier Target</h4>
|
|
2366
|
+
<p style="white-space: pre-wrap;">Sets the banner mobile carrier targeting by banner id.</p>
|
|
2367
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/mobilecarrier/create.do<br>
|
|
2368
|
+
<strong>Method:</strong> POST<br>
|
|
2369
|
+
<strong>Response format:</strong> application/json</p>
|
|
2370
|
+
<p><strong>Error codes:</strong><br>
|
|
2371
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2372
|
+
401 Unauthorized - authentication error<br>
|
|
2373
|
+
403 Forbidden - not enough permissions<br>
|
|
2374
|
+
<strong>Response sample:</strong><br>
|
|
2375
|
+
200 OK</p>
|
|
2376
|
+
<p><strong>Parameters:</strong><br>
|
|
2377
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2378
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2379
|
+
username - the given username<br>
|
|
2380
|
+
bannerId - the given banner id<br>
|
|
2381
|
+
rule - EXCLUDE or INCLUDE<br>
|
|
2382
|
+
mobileCarriers - - array of mobile carrier names</p>
|
|
2383
|
+
<p><!-- NEXT TITLE --><br>
|
|
2384
|
+
<!-- NEXT TITLE --></p>
|
|
2385
|
+
<h4>Create OS Target</h4>
|
|
2386
|
+
<p style="white-space: pre-wrap;">Sets operating system targeting by banner id.</p>
|
|
2387
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/os/create.do<br>
|
|
2388
|
+
<strong>Method:</strong> POST<br>
|
|
2389
|
+
<strong>Response format:</strong> application/json</p>
|
|
2390
|
+
<p><strong>Error codes:</strong><br>
|
|
2391
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2392
|
+
401 Unauthorized - authentication error<br>
|
|
2393
|
+
403 Forbidden - not enough permissions<br>
|
|
2394
|
+
<strong>Response sample:</strong><br>
|
|
2395
|
+
200 OK</p>
|
|
2396
|
+
<p><strong>Parameters:</strong><br>
|
|
2397
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2398
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2399
|
+
username - the given username<br>
|
|
2400
|
+
bannerId - the given banner id<br>
|
|
2401
|
+
operatingSystem - -<br>
|
|
2402
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2403
|
+
<p><!-- NEXT TITLE --><br>
|
|
2404
|
+
<!-- NEXT TITLE --></p>
|
|
2405
|
+
<h4>Create Screen Resolution Target</h4>
|
|
2406
|
+
<p style="white-space: pre-wrap;">Sets the banner screen resolution targeting by banner id.</p>
|
|
2407
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/resolution/create.do<br>
|
|
2408
|
+
<strong>Method:</strong> POST<br>
|
|
2409
|
+
<strong>Response format:</strong> application/json</p>
|
|
2410
|
+
<p><strong>Error codes:</strong><br>
|
|
2411
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2412
|
+
401 Unauthorized - authentication error<br>
|
|
2413
|
+
403 Forbidden - not enough permissions<br>
|
|
2414
|
+
<strong>Response sample:</strong><br>
|
|
2415
|
+
200 OK</p>
|
|
2416
|
+
<p><strong>Parameters:</strong><br>
|
|
2417
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2418
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2419
|
+
username - the given username<br>
|
|
2420
|
+
bannerId - the given banner id<br>
|
|
2421
|
+
relation - - available values LOWER, GREATER, LOWER_EQUAL, GREATER_EQUAL, EQUAL<br>
|
|
2422
|
+
screenWidth -<br>
|
|
2423
|
+
screenHeight -<br>
|
|
2424
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2425
|
+
<p><!-- NEXT TITLE --><br>
|
|
2426
|
+
<!-- NEXT TITLE --></p>
|
|
2427
|
+
<h4>Create Time Range Target</h4>
|
|
2428
|
+
<p style="white-space: pre-wrap;">Sets time range targeting by banner id.</p>
|
|
2429
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/timerange/create.do<br>
|
|
2430
|
+
<strong>Method:</strong> POST<br>
|
|
2431
|
+
<strong>Response format:</strong> application/json</p>
|
|
2432
|
+
<p><strong>Error codes:</strong><br>
|
|
2433
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2434
|
+
401 Unauthorized - authentication error<br>
|
|
2435
|
+
403 Forbidden - not enough permissions<br>
|
|
2436
|
+
<strong>Response sample:</strong><br>
|
|
2437
|
+
200 OK</p>
|
|
2438
|
+
<p><strong>Parameters:</strong><br>
|
|
2439
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2440
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2441
|
+
username - the given username<br>
|
|
2442
|
+
bannerId - the given banner id<br>
|
|
2443
|
+
timeFrom - String in format 24h format hh:MM , where hh - hours, MM - minutes<br>
|
|
2444
|
+
timeTo - String in format 24h format hh:MM , where hh - hours, MM - minutes<br>
|
|
2445
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2446
|
+
<p><!-- NEXT TITLE --><br>
|
|
2447
|
+
<!-- NEXT TITLE --></p>
|
|
2448
|
+
<h4>Create Wifi Traffic Target</h4>
|
|
2449
|
+
<p style="white-space: pre-wrap;">Sets the banner wifi traffic targeting by banner id.</p>
|
|
2450
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/wifi/create.do<br>
|
|
2451
|
+
<strong>Method:</strong> POST<br>
|
|
2452
|
+
<strong>Response format:</strong> application/json</p>
|
|
2453
|
+
<p><strong>Error codes:</strong><br>
|
|
2454
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2455
|
+
401 Unauthorized - authentication error<br>
|
|
2456
|
+
403 Forbidden - not enough permissions<br>
|
|
2457
|
+
<strong>Response sample:</strong><br>
|
|
2458
|
+
200 OK</p>
|
|
2459
|
+
<p><strong>Parameters:</strong><br>
|
|
2460
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2461
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2462
|
+
username - the given username<br>
|
|
2463
|
+
bannerId - the given banner id<br>
|
|
2464
|
+
rule - EXCLUDE or INCLUDE</p>
|
|
2465
|
+
<p><!-- NEXT TITLE --><br>
|
|
2466
|
+
<!-- NEXT TITLE --></p>
|
|
2467
|
+
<h4>Get Targeting</h4>
|
|
2468
|
+
<p style="white-space: pre-wrap;">Get the banner targeting by id and by banner id.</p>
|
|
2469
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/{targetId}.do<br>
|
|
2470
|
+
<strong>Method:</strong> GET<br>
|
|
2471
|
+
<strong>Response format:</strong> application/json</p>
|
|
2472
|
+
<p><strong>Error codes:</strong><br>
|
|
2473
|
+
401 Unauthorized - authentication error<br>
|
|
2474
|
+
403 Forbidden - not enough permissions<br>
|
|
2475
|
+
404 Not Found - no targeting with given id found for given banner<br>
|
|
2476
|
+
<strong>Response sample:</strong><br>
|
|
2477
|
+
200 OK</p>
|
|
2478
|
+
<p><strong>Parameters:</strong><br>
|
|
2479
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2480
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2481
|
+
username - the given username<br>
|
|
2482
|
+
bannerId - the given banner id</p>
|
|
2483
|
+
<p><!-- NEXT TITLE --><br>
|
|
2484
|
+
<!-- NEXT TITLE --></p>
|
|
2485
|
+
<h4>Get Targetings</h4>
|
|
2486
|
+
<p style="white-space: pre-wrap;">Get the banner targetings by banner id.</p>
|
|
2487
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targetings.do<br>
|
|
2488
|
+
<strong>Method:</strong> GET<br>
|
|
2489
|
+
<strong>Response format:</strong> application/json</p>
|
|
2490
|
+
<p><strong>Error codes:</strong><br>
|
|
2491
|
+
401 Unauthorized - authentication error<br>
|
|
2492
|
+
403 Forbidden - not enough permissions<br>
|
|
2493
|
+
<strong>Response sample:</strong><br>
|
|
2494
|
+
200 OK</p>
|
|
2495
|
+
<p><strong>Parameters:</strong><br>
|
|
2496
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2497
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2498
|
+
username - the given username<br>
|
|
2499
|
+
bannerId - the given banner id</p>
|
|
2500
|
+
<p><!-- NEXT TITLE --><br>
|
|
2501
|
+
<!-- NEXT TITLE --></p>
|
|
2502
|
+
<h4>Get Targeting Types</h4>
|
|
2503
|
+
<p style="white-space: pre-wrap;">Get the banner targeting types by banner id.</p>
|
|
2504
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/types.do<br>
|
|
2505
|
+
<strong>Method:</strong> GET<br>
|
|
2506
|
+
<strong>Response format:</strong> application/json</p>
|
|
2507
|
+
<p><strong>Error codes:</strong><br>
|
|
2508
|
+
401 Unauthorized - authentication error<br>
|
|
2509
|
+
403 Forbidden - not enough permissions<br>
|
|
2510
|
+
404 Not Found - no targeting with given id found for given banner<br>
|
|
2511
|
+
<strong>Response sample:</strong><br>
|
|
2512
|
+
200 OK</p>
|
|
2513
|
+
<p><strong>Parameters:</strong><br>
|
|
2514
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2515
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2516
|
+
username - the given username<br>
|
|
2517
|
+
bannerId - the given banner id</p>
|
|
2518
|
+
<p><!-- NEXT TITLE --><br>
|
|
2519
|
+
<!-- NEXT TITLE --></p>
|
|
2520
|
+
<h4>Remove Targeting</h4>
|
|
2521
|
+
<p style="white-space: pre-wrap;">Removes targeting by targeting id and banner id.</p>
|
|
2522
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/{targetId}/delete.do<br>
|
|
2523
|
+
<strong>Method:</strong> DELETE<br>
|
|
2524
|
+
<strong>Response format:</strong> application/json</p>
|
|
2525
|
+
<p><strong>Error codes:</strong><br>
|
|
2526
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2527
|
+
401 Unauthorized - authentication error<br>
|
|
2528
|
+
403 Forbidden - not enough permissions<br>
|
|
2529
|
+
404 Not Found - no targeting with given id found for given banner<br>
|
|
2530
|
+
<strong>Response sample:</strong><br>
|
|
2531
|
+
200 OK</p>
|
|
2532
|
+
<p><strong>Parameters:</strong><br>
|
|
2533
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2534
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2535
|
+
username - the given username<br>
|
|
2536
|
+
bannerId - the given banner id<br>
|
|
2537
|
+
targetId - the given target id<br>
|
|
2538
|
+
<!-- NEXT TITLE --></p>
|
|
2539
|
+
<p><!-- NEXT TITLE --></p>
|
|
2540
|
+
<h4>Disable Targeting</h4>
|
|
2541
|
+
<p style="white-space: pre-wrap;">Disables targeting for given banner.</p>
|
|
2542
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/disable.do<br>
|
|
2543
|
+
<strong>Method:</strong> POST<br>
|
|
2544
|
+
<strong>Response format:</strong> application/json</p>
|
|
2545
|
+
<p><strong>Error codes:</strong><br>
|
|
2546
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2547
|
+
401 Unauthorized - authentication error<br>
|
|
2548
|
+
403 Forbidden - not enough permissions<br>
|
|
2549
|
+
404 Not Found - no targeting with given id found for given banner<br>
|
|
2550
|
+
<strong>Response sample:</strong><br>
|
|
2551
|
+
200 OK</p>
|
|
2552
|
+
<p><strong>Parameters:</strong><br>
|
|
2553
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2554
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2555
|
+
username - the given username<br>
|
|
2556
|
+
bannerId - the given banner id</p>
|
|
2557
|
+
<p><!-- NEXT TITLE --><br>
|
|
2558
|
+
<!-- NEXT TITLE --></p>
|
|
2559
|
+
<h4>Enable Targeting</h4>
|
|
2560
|
+
<p style="white-space: pre-wrap;">Enables targeting for given banner.</p>
|
|
2561
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/enable.do<br>
|
|
2562
|
+
<strong>Method:</strong> POST<br>
|
|
2563
|
+
<strong>Response format:</strong> application/json</p>
|
|
2564
|
+
<p><strong>Error codes:</strong><br>
|
|
2565
|
+
400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2566
|
+
401 Unauthorized - authentication error<br>
|
|
2567
|
+
403 Forbidden - not enough permissions<br>
|
|
2568
|
+
404 Not Found - no targeting with given id found for given banner<br>
|
|
2569
|
+
<strong>Response sample:</strong><br>
|
|
2570
|
+
200 OK</p>
|
|
2571
|
+
<p><strong>Parameters:</strong><br>
|
|
2572
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2573
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2574
|
+
username - the given username<br>
|
|
2575
|
+
bannerId - the given banner id</p>
|
|
2576
|
+
<p><!-- NEXT TITLE --><br>
|
|
2577
|
+
<!-- NEXT TITLE --></p>
|
|
2578
|
+
<h4 id="banlin" align="center"><span style="text-decoration: underline;">Banner Placement Linking API</span></h4>
|
|
2579
|
+
<p><!-- NEXT TITLE --></p>
|
|
2580
|
+
<h4>Create or Update Banner Placements</h4>
|
|
2581
|
+
<p style="white-space: pre-wrap;">Overwrites banner to placement links.</p>
|
|
2582
|
+
<p><strong>URL:</strong> /rest-api/banners/{bannerId}/placements.do<br>
|
|
2583
|
+
<strong>Method:</strong> PUT<br>
|
|
2584
|
+
<strong>Response format:</strong> application/json</p>
|
|
2585
|
+
<p><strong>Error codes:</strong></p>
|
|
2586
|
+
<p>401 Unauthorized - authentication error<br>
|
|
2587
|
+
<strong>Response sample:</strong><br>
|
|
2588
|
+
200 OK<br>
|
|
2589
|
+
{"success":true, id:} - success, returns id of affected zone record<br>
|
|
2590
|
+
{"success":false} - error {"success":false, "error":"permission_denied"} - error due to insufficient privileges</p>
|
|
2591
|
+
<p><strong>Parameters:</strong><br>
|
|
2592
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2593
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2594
|
+
username - the given username<br>
|
|
2595
|
+
ids - placements identifiers (mandatory)</p>
|
|
2596
|
+
<p><!-- NEXT TITLE --><br>
|
|
2597
|
+
<!-- NEXT TITLE --></p>
|
|
2598
|
+
<h4>Delete Banner Placements</h4>
|
|
2599
|
+
<p style="white-space: pre-wrap;">Removes banner to placement links.</p>
|
|
2600
|
+
<p><strong>URL:</strong> /rest-api/banners/{bannerId}/placements.do<br>
|
|
2601
|
+
<strong>Method:</strong> DELETE<br>
|
|
2602
|
+
<strong>Response format:</strong> application/json</p>
|
|
2603
|
+
<p><strong>Error codes:</strong></p>
|
|
2604
|
+
<p>401 Unauthorized - authentication error<br>
|
|
2605
|
+
<strong>Response sample:</strong><br>
|
|
2606
|
+
200 OK<br>
|
|
2607
|
+
{"success":true, id:} - success, returns id of affected zone record<br>
|
|
2608
|
+
{"success":false} - error {"success":false, "error":"permission_denied"} - error due to insufficient privileges</p>
|
|
2609
|
+
<p><strong>Parameters:</strong><br>
|
|
2610
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2611
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2612
|
+
username - the given username<br>
|
|
2613
|
+
removeIds - ids of new placements to link banner (mandatory)<br>
|
|
2614
|
+
<!-- NEXT TITLE --><br>
|
|
2615
|
+
<!-- NEXT TITLE --></p>
|
|
2616
|
+
<h4>Get Banner Placements List</h4>
|
|
2617
|
+
<p style="white-space: pre-wrap;">Get the list of all linked placements for given banner. Returns only banners of types SITE_PLACEMENT, MOBILE_SITE_PLACEMENT and NON_STANDARD_SITE_PLACEMENT</p>
|
|
2618
|
+
<p><strong>URL:</strong> /rest-api/banners/{bannerId}/placements.do<br>
|
|
2619
|
+
<strong>Method:</strong> GET<br>
|
|
2620
|
+
<strong>Response format:</strong> application/json</p>
|
|
2621
|
+
<p><strong>Error codes:</strong></p>
|
|
2622
|
+
<p>401 Unauthorized - authentication error<br>
|
|
2623
|
+
<strong>Response sample:</strong><br>
|
|
2624
|
+
200 OK<br>
|
|
2625
|
+
[{"id":1, "name":"First Placement"}, ...]</p>
|
|
2626
|
+
<p><strong>Parameters:</strong><br>
|
|
2627
|
+
hash - an MD5 digest of a concatenated username’s md5 password and a given timestamp<br>
|
|
2628
|
+
timestamp – UNIX timestamp used in hash generation<br>
|
|
2629
|
+
username – the given username<br>
|
|
2630
|
+
<!-- NEXT TITLE --></p>
|
|
2631
|
+
<h4 id="bantar" align="center"><span style="text-decoration: underline;">Banner Pricing API</span></h4>
|
|
2632
|
+
<p><!-- NEXT TITLE --></p>
|
|
2633
|
+
<h4>Get Banner Pricing</h4>
|
|
2634
|
+
<p style="white-space: pre-wrap;">Get the banner pricing information by banner id.</p>
|
|
2635
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/pricing.do<br>
|
|
2636
|
+
<strong>Method:</strong> GET<br>
|
|
2637
|
+
<strong>Response format:</strong> application/json</p>
|
|
2638
|
+
<p><strong>Error codes:</strong><br>
|
|
2639
|
+
401 Unauthorized – authentication error<br>
|
|
2640
|
+
403 Forbidden – not enough permissions<br>
|
|
2641
|
+
404 Not Found – no banner pricing for such banner<br>
|
|
2642
|
+
<strong>Response sample:</strong><br>
|
|
2643
|
+
200 OK<br>
|
|
2644
|
+
{id: 1, paymentModel: “CPM”, price: 0.03, countries: [{country: "US", price: 0.02}, {country: "UK", price: 0.025}, ... }</p>
|
|
2645
|
+
<p><strong>Parameters:</strong><br>
|
|
2646
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2647
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2648
|
+
username - the given username<br>
|
|
2649
|
+
bannerId - the given banner id<br>
|
|
2650
|
+
<!-- NEXT TITLE --><br>
|
|
2651
|
+
<!-- NEXT TITLE --></p>
|
|
2652
|
+
<h4>Disable Banner Country Pricing</h4>
|
|
2653
|
+
<p style="white-space: pre-wrap;">Remove country banner pricing by banner id.</p>
|
|
2654
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/pricing/{countryCode}.do<br>
|
|
2655
|
+
<strong>Method:</strong> DELETE<br>
|
|
2656
|
+
<strong>Response format:</strong> application/json</p>
|
|
2657
|
+
<p><strong>Error codes:</strong></p>
|
|
2658
|
+
<p>400 Bad Request - wrong request format. No banner or banner pricing is not enabled for the given banner<br>
|
|
2659
|
+
401 Unauthorized - authentication error<br>
|
|
2660
|
+
403 Forbidden - not enough permissions</p>
|
|
2661
|
+
<p><strong>Response sample:</strong><br>
|
|
2662
|
+
200 OK</p>
|
|
2663
|
+
<p><strong>Parameters:</strong></p>
|
|
2664
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2665
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2666
|
+
username - the given username<br>
|
|
2667
|
+
bannerId - the given banner id<br>
|
|
2668
|
+
countryCode - 2 symbol country code corresponding to ISO 3166<br>
|
|
2669
|
+
<!-- NEXT TITLE --><br>
|
|
2670
|
+
<!-- NEXT TITLE --></p>
|
|
2671
|
+
<h4>Disable Banner Pricing</h4>
|
|
2672
|
+
<p style="white-space: pre-wrap;">Disables banner pricing.</p>
|
|
2673
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/pricing.do<br>
|
|
2674
|
+
<strong>Method:</strong> DELETE<br>
|
|
2675
|
+
<strong>Response format:</strong> application/json</p>
|
|
2676
|
+
<p><strong>Error codes:</strong></p>
|
|
2677
|
+
<p>400 Bad Request - no banner with such id exists<br>
|
|
2678
|
+
401 Unauthorized - authentication error<br>
|
|
2679
|
+
403 Forbidden - not enough permissions</p>
|
|
2680
|
+
<p><strong>Response sample:</strong><br>
|
|
2681
|
+
200 OK</p>
|
|
2682
|
+
<p><strong>Parameters:</strong></p>
|
|
2683
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2684
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2685
|
+
username - the given username<br>
|
|
2686
|
+
bannerId - the given banner id<br>
|
|
2687
|
+
<!-- NEXT TITLE --><br>
|
|
2688
|
+
<!-- NEXT TITLE --></p>
|
|
2689
|
+
<h4>Get Banner Pricing</h4>
|
|
2690
|
+
<p style="white-space: pre-wrap;">Get the banner pricing information by banner id.</p>
|
|
2691
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/pricing.do<br>
|
|
2692
|
+
<strong>Method:</strong> GET<br>
|
|
2693
|
+
<strong>Response format:</strong> application/json</p>
|
|
2694
|
+
<p><strong>Error codes:</strong></p>
|
|
2695
|
+
<p>401 Unauthorized - authentication error<br>
|
|
2696
|
+
403 Forbidden - not enough permissions<br>
|
|
2697
|
+
404 Not Found - no banner pricing for such banner</p>
|
|
2698
|
+
<p><strong>Response sample:</strong><br>
|
|
2699
|
+
200 OK</p>
|
|
2700
|
+
<p><strong>Parameters:</strong></p>
|
|
2701
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2702
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2703
|
+
username - the given username<br>
|
|
2704
|
+
bannerId - the given banner id<br>
|
|
2705
|
+
<!-- NEXT TITLE --><br>
|
|
2706
|
+
<!-- NEXT TITLE --></p>
|
|
2707
|
+
<h4>Update Banner Pricing</h4>
|
|
2708
|
+
<p style="white-space: pre-wrap;">Update the banner pricing information by banner id.</p>
|
|
2709
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/pricing.do<br>
|
|
2710
|
+
<strong>Method:</strong> POST<br>
|
|
2711
|
+
<strong>Response format:</strong> application/json</p>
|
|
2712
|
+
<p><strong>Error codes:</strong></p>
|
|
2713
|
+
<p>400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2714
|
+
401 Unauthorized - authentication error<br>
|
|
2715
|
+
403 Forbidden - not enough permissions</p>
|
|
2716
|
+
<p><strong>Request Parameters:</strong></p>
|
|
2717
|
+
<p>price - banner price as a double<br>
|
|
2718
|
+
paymentModel - payment model as a string. Should be one of following: CPM, CPC, CPA</p>
|
|
2719
|
+
<p><strong>Response sample:</strong><br>
|
|
2720
|
+
200 OK</p>
|
|
2721
|
+
<p><strong>Parameters:</strong></p>
|
|
2722
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2723
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2724
|
+
username - the given username<br>
|
|
2725
|
+
bannerId - the given banner id<br>
|
|
2726
|
+
<!-- NEXT TITLE --><br>
|
|
2727
|
+
<!-- NEXT TITLE --></p>
|
|
2728
|
+
<h4>Update Banner Country Pricing</h4>
|
|
2729
|
+
<p style="white-space: pre-wrap;">Update the country banner pricing information by banner id.</p>
|
|
2730
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/pricing/{countryCode}.do<br>
|
|
2731
|
+
<strong>Method:</strong> POST<br>
|
|
2732
|
+
<strong>Response format:</strong> application/json</p>
|
|
2733
|
+
<p><strong>Error codes:</strong></p>
|
|
2734
|
+
<p>400 Bad Request - wrong request format. E.g. wrong types for parameters, no banner or country with such code exists, or banner pricing dis<br>
|
|
2735
|
+
401 Unauthorized - authentication error<br>
|
|
2736
|
+
403 Forbidden - not enough permissions</p>
|
|
2737
|
+
<p><strong>Request Parameters:</strong></p>
|
|
2738
|
+
<p>price - banner price as a double</p>
|
|
2739
|
+
<p><strong>Response sample:</strong><br>
|
|
2740
|
+
200 OK</p>
|
|
2741
|
+
<p><strong>Parameters:</strong></p>
|
|
2742
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2743
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2744
|
+
username - the given username<br>
|
|
2745
|
+
bannerId - the given banner id<br>
|
|
2746
|
+
countryCode - 2 symbol country code corresponding to ISO 3166<br>
|
|
2747
|
+
<!-- NEXT TITLE --><br>
|
|
2748
|
+
<!-- NEXT TITLE --></p>
|
|
2749
|
+
<h4>Update Banner Country Pricing Batch</h4>
|
|
2750
|
+
<p style="white-space: pre-wrap;">Update the country banner pricing information by banner id from csv file.</p>
|
|
2751
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/pricing/batch<br>
|
|
2752
|
+
<strong>Method:</strong> POST<br>
|
|
2753
|
+
<strong>Response format:</strong> application/json</p>
|
|
2754
|
+
<p><strong>Error codes:</strong></p>
|
|
2755
|
+
<p>400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner exists, or banner pricing disabled for the given banne<br>
|
|
2756
|
+
401 Unauthorized - authentication error<br>
|
|
2757
|
+
403 Forbidden - not enough permissions</p>
|
|
2758
|
+
<p><strong>Request Parameters:</strong></p>
|
|
2759
|
+
<p>countryPrices - csv formatted file with prices by countries</p>
|
|
2760
|
+
<p><strong>Response sample:</strong><br>
|
|
2761
|
+
200 OK</p>
|
|
2762
|
+
<p><strong>Parameters:</strong></p>
|
|
2763
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2764
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2765
|
+
username - the given username<br>
|
|
2766
|
+
bannerId - the given banner id<br>
|
|
2767
|
+
countryPrices - csv formatted file with prices by countries<br>
|
|
2768
|
+
<!-- NEXT TITLE --><br>
|
|
2769
|
+
<!-- NEXT TITLE --></p>
|
|
2770
|
+
<h4>Disable Banner Frequency Capping</h4>
|
|
2771
|
+
<p style="white-space: pre-wrap;">Disables banner frequency capping.</p>
|
|
2772
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/capping/frequency.do<br>
|
|
2773
|
+
<strong>Method:</strong> DELETE<br>
|
|
2774
|
+
<strong>Response format:</strong> application/json</p>
|
|
2775
|
+
<p><strong>Error codes:</strong></p>
|
|
2776
|
+
<p>400 Bad Request - no banner with such id exists<br>
|
|
2777
|
+
401 Unauthorized - authentication error<br>
|
|
2778
|
+
403 Forbidden - not enough permissions</p>
|
|
2779
|
+
<p><strong>Response sample:</strong><br>
|
|
2780
|
+
200 OK</p>
|
|
2781
|
+
<p><strong>Parameters:</strong></p>
|
|
2782
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2783
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2784
|
+
username - the given username<br>
|
|
2785
|
+
bannerId - the given banner id<br>
|
|
2786
|
+
<!-- NEXT TITLE --><br>
|
|
2787
|
+
<!-- NEXT TITLE --></p>
|
|
2788
|
+
<h4>Get Advertising Categories</h4>
|
|
2789
|
+
<p style="white-space: pre-wrap;">Get the list of all configured advertising categories.</p>
|
|
2790
|
+
<p><strong>URL:</strong> /rest-api/categories/advertising.do<br>
|
|
2791
|
+
<strong>Method:</strong> GET<br>
|
|
2792
|
+
<strong>Response format:</strong> application/json<br>
|
|
2793
|
+
<strong>Error codes:</strong><br>
|
|
2794
|
+
401 Unauthorized - authentication error<br>
|
|
2795
|
+
<strong>Response sample:</strong><br>
|
|
2796
|
+
200 OK<br>
|
|
2797
|
+
<strong>Parameters:</strong><br>
|
|
2798
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2799
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2800
|
+
username - the given username<br>
|
|
2801
|
+
<!-- NEXT TITLE --><br>
|
|
2802
|
+
<!-- NEXT TITLE --></p>
|
|
2803
|
+
<h4>Get Publishing Categories</h4>
|
|
2804
|
+
<p style="white-space: pre-wrap;">Get the list of all configured publishing categories.</p>
|
|
2805
|
+
<p><strong>URL:</strong> /rest-api/categories/publishing.do<br>
|
|
2806
|
+
<strong>Method:</strong> GET<br>
|
|
2807
|
+
<strong>Response format:</strong> application/json</p>
|
|
2808
|
+
<p><strong>Error codes:</strong></p>
|
|
2809
|
+
<p>401 Unauthorized - authentication error</p>
|
|
2810
|
+
<p><strong>Response sample:</strong><br>
|
|
2811
|
+
200 OK</p>
|
|
2812
|
+
<p><strong>Parameters:</strong></p>
|
|
2813
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2814
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2815
|
+
username - the given username</p>
|
|
2816
|
+
<p><!-- NEXT TITLE --></p>
|
|
2817
|
+
<p><!-- NEXT TITLE --></p>
|
|
2818
|
+
<h4>Update Banner Frequency Capping</h4>
|
|
2819
|
+
<p style="white-space: pre-wrap;">Update the banner frequency capping information by banner id.</p>
|
|
2820
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/capping/frequency.do<br>
|
|
2821
|
+
<strong>Method:</strong> POST<br>
|
|
2822
|
+
<strong>Response format:</strong> application/json</p>
|
|
2823
|
+
<p><strong>Error codes:</strong></p>
|
|
2824
|
+
<p>400 Bad Request - wrong request format. E.g. wrong types for parameters or no banner with such id exists<br>
|
|
2825
|
+
401 Unauthorized - authentication error<br>
|
|
2826
|
+
403 Forbidden - not enough permissions</p>
|
|
2827
|
+
<p><strong>Request Parameters:</strong></p>
|
|
2828
|
+
<p>amount - number of events as a double<br>
|
|
2829
|
+
periodType - period type as a string. Should be one of following: HOUR,DAY,WEEK,MONTH,YEAR<br>
|
|
2830
|
+
flat - enforce uniform distribution of events within time frame (boolean).<br>
|
|
2831
|
+
period - number of periods as long.</p>
|
|
2832
|
+
<p><strong>Response sample:</strong><br>
|
|
2833
|
+
200 OK</p>
|
|
2834
|
+
<p><strong>Parameters:</strong></p>
|
|
2835
|
+
<p>hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
2836
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
2837
|
+
username - the given username<br>
|
|
2838
|
+
bannerId - the given banner id<br>
|
|
2839
|
+
<!-- NEXT TITLE --><br>
|
|
2840
|
+
<!-- NEXT TITLE --></p>
|
|
2841
|
+
<h4>Get linked banners for placement</h4>
|
|
2842
|
+
<p><strong>URL:</strong> /rest-api/banner/placement/{placementId}/banners.do</p>
|
|
2843
|
+
<p><strong>Method:</strong> GET.</p>
|
|
2844
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
2845
|
+
<p><strong>Error codes:</strong></p>
|
|
2846
|
+
<ul>
|
|
2847
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
2848
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
2849
|
+
<li>404 Not Found - no placement for such id found.</li>
|
|
2850
|
+
</ul>
|
|
2851
|
+
<p><strong>Response sample:</strong><br>
|
|
2852
|
+
200 OK.<br>
|
|
2853
|
+
<code><br>
|
|
2854
|
+
{id: 1, name: "bannerName1"}<br>
|
|
2855
|
+
</code></p>
|
|
2856
|
+
<p><strong>Parameters:</strong></p>
|
|
2857
|
+
<ul>
|
|
2858
|
+
<li>hash - a MD5 digest of concatenated username's md5 password and the given timestamp;</li>
|
|
2859
|
+
<li>timestamp - UNIX timestamp used in hash generation;</li>
|
|
2860
|
+
<li>username - the given username;</li>
|
|
2861
|
+
<li>placementId - the given placement id.</li>
|
|
2862
|
+
</ul>
|
|
2863
|
+
<p><!-- NEXT TITLE --></p>
|
|
2864
|
+
<p><!-- NEXT TITLE --></p>
|
|
2865
|
+
<h4>Get the available application advertising networks</h4>
|
|
2866
|
+
<p><strong>URL:</strong> /rest-api/banner/applicationnetworks.do.</p>
|
|
2867
|
+
<p><strong>Method:</strong> GET.</p>
|
|
2868
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
2869
|
+
<p><strong>Error codes:</strong></p>
|
|
2870
|
+
<ul>
|
|
2871
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
2872
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
2873
|
+
<li>404 Not Found - no banner for such id found.</li>
|
|
2874
|
+
</ul>
|
|
2875
|
+
<p><strong>Response sample:</strong><br>
|
|
2876
|
+
200 OK.</p>
|
|
2877
|
+
<p><strong>Parameters:</strong></p>
|
|
2878
|
+
<ul>
|
|
2879
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
2880
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
2881
|
+
<li>username — a given username.</li>
|
|
2882
|
+
</ul>
|
|
2883
|
+
<p><!-- NEXT TITLE --><br>
|
|
2884
|
+
<!-- NEXT TITLE --></p>
|
|
2885
|
+
<h4>Get the list of all advertisers of given user account with campaigns and banners</h4>
|
|
2886
|
+
<p>Requires ALL or SHARED level on VIEW permission for INVENTORY items.<br>
|
|
2887
|
+
When SHARED level being used, share of any type must be present between requester and entity being requested.</p>
|
|
2888
|
+
<p><strong>URL:</strong> /rest-api/advertisers-tree.do.</p>
|
|
2889
|
+
<p><strong>Method:</strong> GET.</p>
|
|
2890
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
2891
|
+
<p><strong>Error codes:</strong></p>
|
|
2892
|
+
<ul>
|
|
2893
|
+
<li>401 Unauthorized - authentication error</li>
|
|
2894
|
+
</ul>
|
|
2895
|
+
<p><strong>Response sample:</strong><br>
|
|
2896
|
+
200 OK.<br>
|
|
2897
|
+
<code><br>
|
|
2898
|
+
[{"id":1,"name":"First Advertiser", "campaigns":[...,"banners":[...]]},…]<br>
|
|
2899
|
+
</code></p>
|
|
2900
|
+
<p><strong>Parameters:</strong></p>
|
|
2901
|
+
<ul>
|
|
2902
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
2903
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
2904
|
+
<li>username — a given username;</li>
|
|
2905
|
+
<li>advertisingCategories - IDs of advertising categories to filter down result to (optional).</li>
|
|
2906
|
+
</ul>
|
|
2907
|
+
<p><!-- NEXT TITLE --><br>
|
|
2908
|
+
<!-- NEXT TITLE --></p>
|
|
2909
|
+
<h4>Get the list of all mobile advertising networks</h4>
|
|
2910
|
+
<p><strong>URL:</strong> /rest-api/adnetworks/mobileNetworks.do.</p>
|
|
2911
|
+
<p><strong>Method:</strong> GET.</p>
|
|
2912
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
2913
|
+
<p><strong>Error codes:</strong></p>
|
|
2914
|
+
<ul>
|
|
2915
|
+
<li>401 Unauthorized - authentication error</li>
|
|
2916
|
+
</ul>
|
|
2917
|
+
<p><strong>Response sample:</strong><br>
|
|
2918
|
+
200 OK.<br>
|
|
2919
|
+
<code><br>
|
|
2920
|
+
[{"id":1, "name":"First Placement"}, ...]<br>
|
|
2921
|
+
</code></p>
|
|
2922
|
+
<p><strong>Parameters:</strong></p>
|
|
2923
|
+
<ul>
|
|
2924
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
2925
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
2926
|
+
<li>username — a given username.</li>
|
|
2927
|
+
</ul>
|
|
2928
|
+
<p><!-- NEXT TITLE --><br>
|
|
2929
|
+
<!-- NEXT TITLE --></p>
|
|
2930
|
+
<h4>Get the AdUnit list</h4>
|
|
2931
|
+
<p><strong>URL:</strong> /rest-api/adunit/list.do.<br>
|
|
2932
|
+
<strong>Method:</strong> GET.<br>
|
|
2933
|
+
<strong>Response format:</strong> application/json.<br>
|
|
2934
|
+
<strong>Error codes:</strong></p>
|
|
2935
|
+
<ul>
|
|
2936
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
2937
|
+
</ul>
|
|
2938
|
+
<p><strong>Response sample:</strong><br>
|
|
2939
|
+
200 OK.<br>
|
|
2940
|
+
<code><br>
|
|
2941
|
+
[{"id":1,"height":250,"width":300,"name":"Medium Rectangle (300x250)","custom":false},{"id":2,"height":150,"width":180,"name":"Rectangle (180x150)","custom":false}, ...]<br>
|
|
2942
|
+
</code><br>
|
|
2943
|
+
<strong>Parameters:</strong></p>
|
|
2944
|
+
<ul>
|
|
2945
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
2946
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
2947
|
+
<li>username — a given username.</li>
|
|
2948
|
+
</ul>
|
|
2949
|
+
<p><!-- NEXT TITLE --></p>
|
|
2950
|
+
<h3 id="actman" align="center">Action Management API</h3>
|
|
2951
|
+
<p><!-- NEXT TITLE --></p>
|
|
2952
|
+
<h4>Get all actions shared to user</h4>
|
|
2953
|
+
<p><strong>URL:</strong> /rest-api/actions.do.<br>
|
|
2954
|
+
<strong>Method:</strong> GET.<br>
|
|
2955
|
+
<strong>Response format:</strong> application/json.<br>
|
|
2956
|
+
<strong>Error codes:</strong></p>
|
|
2957
|
+
<ul>
|
|
2958
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
2959
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
2960
|
+
</ul>
|
|
2961
|
+
<p><strong>Parameters:</strong></p>
|
|
2962
|
+
<ul>
|
|
2963
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
2964
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
2965
|
+
<li>username — a given username.</li>
|
|
2966
|
+
</ul>
|
|
2967
|
+
<p><!-- NEXT TITLE --><br>
|
|
2968
|
+
<!-- NEXT TITLE --></p>
|
|
2969
|
+
<h4>Get the action by action key</h4>
|
|
2970
|
+
<p><strong>URL:</strong> /rest-api/action/{actionKey}.do.</p>
|
|
2971
|
+
<p><strong>Method:</strong> GET.</p>
|
|
2972
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
2973
|
+
<p><strong>Error codes:</strong></p>
|
|
2974
|
+
<ul>
|
|
2975
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
2976
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
2977
|
+
<li>404 Not Found - no action with given actionKey found for given campaign.</li>
|
|
2978
|
+
</ul>
|
|
2979
|
+
<p><strong>Parameters:</strong></p>
|
|
2980
|
+
<ul>
|
|
2981
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
2982
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
2983
|
+
<li>username — a given username.</li>
|
|
2984
|
+
</ul>
|
|
2985
|
+
<p><!-- NEXT TITLE --><br>
|
|
2986
|
+
<!-- NEXT TITLE --></p>
|
|
2987
|
+
<h4>Updates action</h4>
|
|
2988
|
+
<p><strong>URL:</strong> /rest-api/action/{actionKey}/update.do.</p>
|
|
2989
|
+
<p><strong>Method:</strong> POST.</p>
|
|
2990
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
2991
|
+
<p><strong>Error codes:</strong></p>
|
|
2992
|
+
<ul>
|
|
2993
|
+
<li>400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.</li>
|
|
2994
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
2995
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
2996
|
+
</ul>
|
|
2997
|
+
<p><strong>Parameters:</strong></p>
|
|
2998
|
+
<ul>
|
|
2999
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
3000
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
3001
|
+
<li>username — a given username;</li>
|
|
3002
|
+
<li>key - action key;</li>
|
|
3003
|
+
<li>name - action name;</li>
|
|
3004
|
+
<li>clickToConversionTimeFrame - period for click to conversion;</li>
|
|
3005
|
+
<li>clickToConversionTimeFramePeriodType — period type, available values: HOUR, DAY, WEEK, MONTH, YEAR;</li>
|
|
3006
|
+
<li>viewToConversionTimeFrame — period for view to conversion;</li>
|
|
3007
|
+
</ul>
|
|
3008
|
+
<p><!-- NEXT TITLE --><br>
|
|
3009
|
+
<!-- NEXT TITLE --></p>
|
|
3010
|
+
<h4>Creates new action</h4>
|
|
3011
|
+
<p><strong>URL:</strong> /rest-api//action/create.do.<br>
|
|
3012
|
+
<strong>Method:</strong> POST.<br>
|
|
3013
|
+
<strong>Response format:</strong> application/json.<br>
|
|
3014
|
+
<strong>Error codes:</strong></p>
|
|
3015
|
+
<ul>
|
|
3016
|
+
<li>400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.</li>
|
|
3017
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
3018
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
3019
|
+
</ul>
|
|
3020
|
+
<p><strong>Parameters:</strong></p>
|
|
3021
|
+
<ul>
|
|
3022
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
3023
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
3024
|
+
<li>username — a given username;</li>
|
|
3025
|
+
<li>name — action name;</li>
|
|
3026
|
+
<li>clickToConversionTimeFrame - period for click to conversion;</li>
|
|
3027
|
+
<li>clickToConversionTimeFramePeriodType — period type, available values: HOUR, DAY, WEEK, MONTH, YEAR;</li>
|
|
3028
|
+
<li>viewToConversionTimeFrame — period for view to conversion;</li>
|
|
3029
|
+
<li>viewToConversionTimeFramePeriodType — period type, available values: HOUR, DAY, WEEK, MONTH, YEAR.</li>
|
|
3030
|
+
</ul>
|
|
3031
|
+
<p><!-- NEXT TITLE --><br>
|
|
3032
|
+
<!-- NEXT TITLE --></p>
|
|
3033
|
+
<h4>Removes action by action key</h4>
|
|
3034
|
+
<p><strong>URL:</strong> /rest-api//action/{actionKey}/delete.do.<br>
|
|
3035
|
+
<strong>Method:</strong> DELETE.<br>
|
|
3036
|
+
<strong>Response format:</strong> application/json.<br>
|
|
3037
|
+
<strong>Error codes:</strong></p>
|
|
3038
|
+
<ul>
|
|
3039
|
+
<li>400 Bad Request - wrong request format. E.g. wrong types for parameters or no campaign with such id exists.</li>
|
|
3040
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
3041
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
3042
|
+
<li>404 Not Found - no action with given actionKey found for given campaign.</li>
|
|
3043
|
+
</ul>
|
|
3044
|
+
<p><strong>Response sample:</strong><br>
|
|
3045
|
+
200 OK.<br>
|
|
3046
|
+
<strong>Parameters:</strong></p>
|
|
3047
|
+
<ul>
|
|
3048
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
3049
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
3050
|
+
<li>username — a given username.</li>
|
|
3051
|
+
</ul>
|
|
3052
|
+
<p><!-- NEXT TITLE --></p>
|
|
3053
|
+
<h3 id="tempman" align="center">Templates Management API</h3>
|
|
3054
|
+
<p><!-- NEXT TITLE --></p>
|
|
3055
|
+
<h4>Get the list of all template properties required|supported by given template</h4>
|
|
3056
|
+
<p><strong>URL:</strong> /rest-api/template/{templateId}/properties.do.</p>
|
|
3057
|
+
<p><strong>Method:</strong> GET.</p>
|
|
3058
|
+
<p><strong>Response format:</strong> application/json.</p>
|
|
3059
|
+
<p><strong>Error codes:</strong></p>
|
|
3060
|
+
<ul>
|
|
3061
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
3062
|
+
<li>403 Forbidden - not enough permissions.</li>
|
|
3063
|
+
<li>404 Not Found - no template for such id found.</li>
|
|
3064
|
+
</ul>
|
|
3065
|
+
<p><strong>Response sample:</strong><br>
|
|
3066
|
+
200 OK.<br>
|
|
3067
|
+
<code><br>
|
|
3068
|
+
[{"allowedContentTypes":"image/png","required":true,"key":"$$BANNER_SMALL$$"},<br>
|
|
3069
|
+
{"allowedContentTypes":"image/png","required":true,"key":"$$IMG_1$$"},<br>
|
|
3070
|
+
{"maxLength":255,"required":true,"url":false,"key":"$$LANDING_URL$$"}]<br>
|
|
3071
|
+
</code></p>
|
|
3072
|
+
<p><strong>Parameters:</strong></p>
|
|
3073
|
+
<ul>
|
|
3074
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
3075
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
3076
|
+
<li>username — a given username;</li>
|
|
3077
|
+
<li>templateId the given template id.</li>
|
|
3078
|
+
</ul>
|
|
3079
|
+
<p><!-- NEXT TITLE --><br>
|
|
3080
|
+
<!-- NEXT TITLE --></p>
|
|
3081
|
+
<h4>Get the list of all templates available to a user</h4>
|
|
3082
|
+
<p><strong>URL:</strong> /rest-api/template/list.do.<br>
|
|
3083
|
+
<strong>Method:</strong> GET.<br>
|
|
3084
|
+
<strong>Response format:</strong> application/json.<br>
|
|
3085
|
+
<strong>Error codes:</strong></p>
|
|
3086
|
+
<ul>
|
|
3087
|
+
<li>401 Unauthorized - authentication error.</li>
|
|
3088
|
+
</ul>
|
|
3089
|
+
<p><strong>Response sample:</strong><br>
|
|
3090
|
+
200 OK.<br>
|
|
3091
|
+
<code><br>
|
|
3092
|
+
[{"id":1,"title":"Foo","propertiesCount":10,"placementType":"NON_STANDARD_SITE_PLACEMENT"},<br>
|
|
3093
|
+
{"id":2,"title":"Bar","propertiesCount":2,"placementType":"SITE_PLACEMENT"}]<br>
|
|
3094
|
+
</code></p>
|
|
3095
|
+
<p><strong>Parameters:</strong></p>
|
|
3096
|
+
<ul>
|
|
3097
|
+
<li>hash — an MD5 digest of a concatenated username's md5 password and a given timestamp;</li>
|
|
3098
|
+
<li>timestamp — UNIX timestamp used for hash generation;</li>
|
|
3099
|
+
<li>username — a given username.</li>
|
|
3100
|
+
</ul>
|
|
3101
|
+
<p><!-- NEXT TITLE --></p>
|
|
3102
|
+
<p><!-- NEXT TITLE --></p>
|
|
3103
|
+
<h4>Get Browsers</h4>
|
|
3104
|
+
<p style="white-space: pre-wrap;">Get available major browsers values for browser targeting type.</p>
|
|
3105
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/browsers/values.do<br>
|
|
3106
|
+
<strong>Method:</strong> GET<br>
|
|
3107
|
+
<strong>Response format:</strong> application/json</p>
|
|
3108
|
+
<p><strong>Error codes:</strong><br>
|
|
3109
|
+
401 Unauthorized - authentication error<br>
|
|
3110
|
+
403 Forbidden - not enough permissions<br>
|
|
3111
|
+
404 Not Found - no targeting with given id found for given banner<br>
|
|
3112
|
+
<strong>Response sample:</strong><br>
|
|
3113
|
+
200 OK</p>
|
|
3114
|
+
<p><strong>Parameters:</strong><br>
|
|
3115
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3116
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3117
|
+
username - the given username<br>
|
|
3118
|
+
bannerId - the given banner id</p>
|
|
3119
|
+
<p><!-- NEXT TITLE --><br>
|
|
3120
|
+
<!-- NEXT TITLE --></p>
|
|
3121
|
+
<h4>Get Chrome Browsers</h4>
|
|
3122
|
+
<p style="white-space: pre-wrap;">Get available chrome browser version values for browser targeting type.</p>
|
|
3123
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/browsers/chrome/values.do<br>
|
|
3124
|
+
<strong>Method:</strong> GET<br>
|
|
3125
|
+
<strong>Response format:</strong> application/json</p>
|
|
3126
|
+
<p><strong>Error codes:</strong><br>
|
|
3127
|
+
401 Unauthorized - authentication error<br>
|
|
3128
|
+
403 Forbidden - not enough permissions<br>
|
|
3129
|
+
404 Not Found - no banner found<br>
|
|
3130
|
+
<strong>Response sample:</strong><br>
|
|
3131
|
+
200 OK</p>
|
|
3132
|
+
<p><strong>Parameters:</strong><br>
|
|
3133
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3134
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3135
|
+
username - the given username<br>
|
|
3136
|
+
bannerId - the given banner id</p>
|
|
3137
|
+
<p><!-- NEXT TITLE --><br>
|
|
3138
|
+
<!-- NEXT TITLE --></p>
|
|
3139
|
+
<h4>Get Country Regions</h4>
|
|
3140
|
+
<p style="white-space: pre-wrap;">Get available regions for given country.</p>
|
|
3141
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/country/region/values.do<br>
|
|
3142
|
+
<strong>Method:</strong> GET<br>
|
|
3143
|
+
<strong>Response format:</strong> application/json</p>
|
|
3144
|
+
<p><strong>Error codes:</strong><br>
|
|
3145
|
+
401 Unauthorized - authentication error<br>
|
|
3146
|
+
403 Forbidden - not enough permissions<br>
|
|
3147
|
+
404 Not Found - no banner found<br>
|
|
3148
|
+
<strong>Response sample:</strong><br>
|
|
3149
|
+
200 OK</p>
|
|
3150
|
+
<p><strong>Parameters:</strong><br>
|
|
3151
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3152
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3153
|
+
username - the given username<br>
|
|
3154
|
+
bannerId - the given banner id<br>
|
|
3155
|
+
countryCode - the given country code</p>
|
|
3156
|
+
<p><!-- NEXT TITLE --><br>
|
|
3157
|
+
<!-- NEXT TITLE --></p>
|
|
3158
|
+
<h4>Get Device Format Values</h4>
|
|
3159
|
+
<p style="white-space: pre-wrap;">Get available device formats values for device format targeting type.</p>
|
|
3160
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/device/format/values.do<br>
|
|
3161
|
+
<strong>Method:</strong> GET<br>
|
|
3162
|
+
<strong>Response format:</strong> application/json</p>
|
|
3163
|
+
<p><strong>Error codes:</strong><br>
|
|
3164
|
+
401 Unauthorized - authentication error<br>
|
|
3165
|
+
403 Forbidden - not enough permissions<br>
|
|
3166
|
+
404 Not Found - no banner found<br>
|
|
3167
|
+
<strong>Response sample:</strong><br>
|
|
3168
|
+
200 OK</p>
|
|
3169
|
+
<p><strong>Parameters:</strong><br>
|
|
3170
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3171
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3172
|
+
username - the given username<br>
|
|
3173
|
+
bannerId - the given banner id</p>
|
|
3174
|
+
<p><!-- NEXT TITLE --><br>
|
|
3175
|
+
<!-- NEXT TITLE --></p>
|
|
3176
|
+
<h4>Get Device Values</h4>
|
|
3177
|
+
<p style="white-space: pre-wrap;">Get available devices values for device targeting type.</p>
|
|
3178
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/device/values.do<br>
|
|
3179
|
+
<strong>Method:</strong> GET<br>
|
|
3180
|
+
<strong>Response format:</strong> application/json</p>
|
|
3181
|
+
<p><strong>Error codes:</strong><br>
|
|
3182
|
+
401 Unauthorized - authentication error<br>
|
|
3183
|
+
403 Forbidden - not enough permissions<br>
|
|
3184
|
+
404 Not Found - no banner found<br>
|
|
3185
|
+
<strong>Response sample:</strong><br>
|
|
3186
|
+
200 OK</p>
|
|
3187
|
+
<p><strong>Parameters:</strong><br>
|
|
3188
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3189
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3190
|
+
username - the given username<br>
|
|
3191
|
+
bannerId - the given banner id</p>
|
|
3192
|
+
<p><!-- NEXT TITLE --><br>
|
|
3193
|
+
<!-- NEXT TITLE --></p>
|
|
3194
|
+
<h4>Get Device Vendor Values</h4>
|
|
3195
|
+
<p style="white-space: pre-wrap;">Get available device vendor values for device vendor targeting type.</p>
|
|
3196
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/device/vendor/values.do<br>
|
|
3197
|
+
<strong>Method:</strong> GET<br>
|
|
3198
|
+
<strong>Response format:</strong> application/json</p>
|
|
3199
|
+
<p><strong>Error codes:</strong><br>
|
|
3200
|
+
401 Unauthorized - authentication error<br>
|
|
3201
|
+
403 Forbidden - not enough permissions<br>
|
|
3202
|
+
404 Not Found - no banner found<br>
|
|
3203
|
+
<strong>Response sample:</strong><br>
|
|
3204
|
+
200 OK</p>
|
|
3205
|
+
<p><strong>Parameters:</strong><br>
|
|
3206
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3207
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3208
|
+
username - the given username<br>
|
|
3209
|
+
bannerId - the given banner id</p>
|
|
3210
|
+
<p><!-- NEXT TITLE --><br>
|
|
3211
|
+
<!-- NEXT TITLE --></p>
|
|
3212
|
+
<h4>Get Firefox Browsers</h4>
|
|
3213
|
+
<p style="white-space: pre-wrap;">Get available firefox browser version values for browser targeting type.</p>
|
|
3214
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/browsers/firefox/values.do<br>
|
|
3215
|
+
<strong>Method:</strong> GET<br>
|
|
3216
|
+
<strong>Response format:</strong> application/json</p>
|
|
3217
|
+
<p><strong>Error codes:</strong><br>
|
|
3218
|
+
401 Unauthorized - authentication error<br>
|
|
3219
|
+
403 Forbidden - not enough permissions<br>
|
|
3220
|
+
404 Not Found - no banner found<br>
|
|
3221
|
+
<strong>Response sample:</strong><br>
|
|
3222
|
+
200 OK</p>
|
|
3223
|
+
<p><strong>Parameters:</strong><br>
|
|
3224
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3225
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3226
|
+
username - the given username<br>
|
|
3227
|
+
bannerId - the given banner id</p>
|
|
3228
|
+
<p><!-- NEXT TITLE --><br>
|
|
3229
|
+
<!-- NEXT TITLE --></p>
|
|
3230
|
+
<h4>Get IE Browsers</h4>
|
|
3231
|
+
<p style="white-space: pre-wrap;">Get available Safari browser version values for browser targeting type.</p>
|
|
3232
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/browsers/ie/values.do<br>
|
|
3233
|
+
<strong>Method:</strong> GET<br>
|
|
3234
|
+
<strong>Response format:</strong> application/json</p>
|
|
3235
|
+
<p><strong>Error codes:</strong><br>
|
|
3236
|
+
401 Unauthorized - authentication error<br>
|
|
3237
|
+
403 Forbidden - not enough permissions<br>
|
|
3238
|
+
404 Not Found - no banner found<br>
|
|
3239
|
+
<strong>Response sample:</strong><br>
|
|
3240
|
+
200 OK</p>
|
|
3241
|
+
<p><strong>Parameters:</strong><br>
|
|
3242
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3243
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3244
|
+
username - the given username<br>
|
|
3245
|
+
bannerId - the given banner id</p>
|
|
3246
|
+
<p><!-- NEXT TITLE --><br>
|
|
3247
|
+
<!-- NEXT TITLE --></p>
|
|
3248
|
+
<h4>Get Languages</h4>
|
|
3249
|
+
<p style="white-space: pre-wrap;">Get available languages.</p>
|
|
3250
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/language/values.do<br>
|
|
3251
|
+
<strong>Method:</strong> GET<br>
|
|
3252
|
+
<strong>Response format:</strong> application/json</p>
|
|
3253
|
+
<p><strong>Error codes:</strong><br>
|
|
3254
|
+
401 Unauthorized - authentication error<br>
|
|
3255
|
+
403 Forbidden - not enough permissions<br>
|
|
3256
|
+
404 Not Found - no banner found<br>
|
|
3257
|
+
<strong>Response sample:</strong><br>
|
|
3258
|
+
200 OK</p>
|
|
3259
|
+
<p><strong>Parameters:</strong><br>
|
|
3260
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3261
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3262
|
+
username - the given username<br>
|
|
3263
|
+
bannerId - the given banner id</p>
|
|
3264
|
+
<p><!-- NEXT TITLE --><br>
|
|
3265
|
+
<!-- NEXT TITLE --></p>
|
|
3266
|
+
<h4>Get Mobile Carriers</h4>
|
|
3267
|
+
<p style="white-space: pre-wrap;">Get available mobile carriers names for mobile carrier targeting type.</p>
|
|
3268
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/mobilecarriers/values.do<br>
|
|
3269
|
+
<strong>Method:</strong> GET<br>
|
|
3270
|
+
<strong>Response format:</strong> application/json</p>
|
|
3271
|
+
<p><strong>Error codes:</strong><br>
|
|
3272
|
+
401 Unauthorized - authentication error<br>
|
|
3273
|
+
403 Forbidden - not enough permissions<br>
|
|
3274
|
+
404 Not Found - no targeting with given id found for given banner<br>
|
|
3275
|
+
<strong>Response sample:</strong><br>
|
|
3276
|
+
200 OK</p>
|
|
3277
|
+
<p><strong>Parameters:</strong><br>
|
|
3278
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3279
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3280
|
+
username - the given username<br>
|
|
3281
|
+
bannerId - the given banner id</p>
|
|
3282
|
+
<p><!-- NEXT TITLE --><br>
|
|
3283
|
+
<!-- NEXT TITLE --></p>
|
|
3284
|
+
<h4>Get OS Values</h4>
|
|
3285
|
+
<p style="white-space: pre-wrap;">Get available operating systems values for operating system targeting type.</p>
|
|
3286
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/os/values.do<br>
|
|
3287
|
+
<strong>Method:</strong> GET<br>
|
|
3288
|
+
<strong>Response format:</strong> application/json</p>
|
|
3289
|
+
<p><strong>Error codes:</strong><br>
|
|
3290
|
+
401 Unauthorized - authentication error<br>
|
|
3291
|
+
403 Forbidden - not enough permissions<br>
|
|
3292
|
+
404 Not Found - no banner found<br>
|
|
3293
|
+
<strong>Response sample:</strong><br>
|
|
3294
|
+
200 OK</p>
|
|
3295
|
+
<p><strong>Parameters:</strong><br>
|
|
3296
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3297
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3298
|
+
username - the given username<br>
|
|
3299
|
+
bannerId - the given banner id</p>
|
|
3300
|
+
<p><!-- NEXT TITLE --><br>
|
|
3301
|
+
<!-- NEXT TITLE --></p>
|
|
3302
|
+
<h4>Get OS Versions by OS Name</h4>
|
|
3303
|
+
<p style="white-space: pre-wrap;">Gets available versions of an OS for operating system targeting type.</p>
|
|
3304
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/os/{osName}/versions.do<br>
|
|
3305
|
+
<strong>Method:</strong> GET<br>
|
|
3306
|
+
<strong>Response format:</strong> application/json</p>
|
|
3307
|
+
<p><strong>Error codes:</strong><br>
|
|
3308
|
+
401 Unauthorized - authentication error<br>
|
|
3309
|
+
403 Forbidden - not enough permissions<br>
|
|
3310
|
+
404 Not Found - no campaign found<br>
|
|
3311
|
+
<strong>Response sample:</strong><br>
|
|
3312
|
+
200 OK</p>
|
|
3313
|
+
<p><strong>Parameters:</strong><br>
|
|
3314
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3315
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3316
|
+
username - the given username<br>
|
|
3317
|
+
bannerId - the given campaign id</p>
|
|
3318
|
+
<p><!-- NEXT TITLE --><br>
|
|
3319
|
+
<!-- NEXT TITLE --></p>
|
|
3320
|
+
<h4>Get Regions Cities</h4>
|
|
3321
|
+
<p style="white-space: pre-wrap;">Get available cities for given country region.</p>
|
|
3322
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/country/region/city/values.do<br>
|
|
3323
|
+
<strong>Method:</strong> GET<br>
|
|
3324
|
+
<strong>Response format:</strong> application/json</p>
|
|
3325
|
+
<p><strong>Error codes:</strong><br>
|
|
3326
|
+
401 Unauthorized - authentication error<br>
|
|
3327
|
+
403 Forbidden - not enough permissions<br>
|
|
3328
|
+
404 Not Found - no banner found<br>
|
|
3329
|
+
<strong>Response sample:</strong><br>
|
|
3330
|
+
200 OK</p>
|
|
3331
|
+
<p><strong>Parameters:</strong><br>
|
|
3332
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3333
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3334
|
+
username - the given username<br>
|
|
3335
|
+
bannerId - the given banner id<br>
|
|
3336
|
+
countryCode - the given country code<br>
|
|
3337
|
+
regionName - the given region name</p>
|
|
3338
|
+
<p><!-- NEXT TITLE --><br>
|
|
3339
|
+
<!-- NEXT TITLE --></p>
|
|
3340
|
+
<h4>Get Safari Browsers</h4>
|
|
3341
|
+
<p style="white-space: pre-wrap;">Get available Safari browser version values for browser targeting type.</p>
|
|
3342
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/browsers/safari/values.do<br>
|
|
3343
|
+
<strong>Method:</strong> GET<br>
|
|
3344
|
+
<strong>Response format:</strong> application/json</p>
|
|
3345
|
+
<p><strong>Error codes:</strong><br>
|
|
3346
|
+
401 Unauthorized - authentication error<br>
|
|
3347
|
+
403 Forbidden - not enough permissions<br>
|
|
3348
|
+
404 Not Found - no banner found<br>
|
|
3349
|
+
<strong>Response sample:</strong><br>
|
|
3350
|
+
200 OK</p>
|
|
3351
|
+
<p><strong>Parameters:</strong><br>
|
|
3352
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3353
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3354
|
+
username - the given username<br>
|
|
3355
|
+
bannerId - the given banner id</p>
|
|
3356
|
+
<p><!-- NEXT TITLE --><br>
|
|
3357
|
+
<!-- NEXT TITLE --></p>
|
|
3358
|
+
<h4>Get Screen Resolution Values</h4>
|
|
3359
|
+
<p style="white-space: pre-wrap;">Get available screen resolutions values for screen resolution targeting type.</p>
|
|
3360
|
+
<p><strong>URL:</strong> /rest-api/banner/{bannerId}/targeting/resolution/values.do<br>
|
|
3361
|
+
<strong>Method:</strong> GET<br>
|
|
3362
|
+
<strong>Response format:</strong> application/json</p>
|
|
3363
|
+
<p><strong>Error codes:</strong><br>
|
|
3364
|
+
401 Unauthorized - authentication error<br>
|
|
3365
|
+
403 Forbidden - not enough permissions<br>
|
|
3366
|
+
404 Not Found - no banner found<br>
|
|
3367
|
+
<strong>Response sample:</strong><br>
|
|
3368
|
+
200 OK</p>
|
|
3369
|
+
<p><strong>Parameters:</strong><br>
|
|
3370
|
+
hash - an MD5 digest of a concatenated username's md5 password and a given timestamp<br>
|
|
3371
|
+
timestamp - UNIX timestamp used in hash generation<br>
|
|
3372
|
+
username - the given username<br>
|
|
3373
|
+
bannerId - the given banner id</p>
|
|
3374
|
+
<p><!-- NEXT TITLE --></p>
|
|
3375
|
+
</div>
|
|
3376
|
+
<div class="postinfo">
|
|
3377
|
+
<div class="authorinfo">
|
|
3378
|
+
<!--By epadmin<br />
|
|
3379
|
+
24 / 10 / 2013 <br />-->
|
|
3380
|
+
|
|
3381
|
+
|
|
3382
|
+
</div>
|
|
3383
|
+
|
|
3384
|
+
<!--<div class="share">
|
|
3385
|
+
<div class="shareitem">
|
|
3386
|
+
<g:plusone size="tall" annotation="none" href="http://epom.com/support/advertiser-api-2/"></g:plusone>
|
|
3387
|
+
</div>
|
|
3388
|
+
<div class="shareitem">
|
|
3389
|
+
<a href="http://twitter.com/share" class="twitter-share-button" data-url="http://epom.com/support/advertiser-api-2/" data-count="horizontal" rel="nofollow">Tweet</a>
|
|
3390
|
+
</div>
|
|
3391
|
+
<div class="shareitem">
|
|
3392
|
+
<fb:like href="http://epom.com/support/advertiser-api-2/" layout="button_count" show_faces="true" width="90" font="lucida grande"></fb:like>
|
|
3393
|
+
</div>
|
|
3394
|
+
</div>-->
|
|
3395
|
+
|
|
3396
|
+
</div>
|
|
3397
|
+
<div class="comments">
|
|
3398
|
+
<!-- You can start editing here. -->
|
|
3399
|
+
<!-- If comments are closed. -->
|
|
3400
|
+
<!--p class="nocomments">Comments are closed.</p-->
|
|
3401
|
+
</div>
|
|
3402
|
+
<!--<div class="morelink"><a href="--><!--">more</a></div>-->
|
|
3403
|
+
</div>
|
|
3404
|
+
|
|
3405
|
+
|
|
3406
|
+
|
|
3407
|
+
</div>
|
|
3408
|
+
<div class="left">
|
|
3409
|
+
|
|
3410
|
+
<!--<span class="menuTitle">Search</span>-->
|
|
3411
|
+
<div id="search">
|
|
3412
|
+
<form method="get" id="searchform" action="http://epom.com/support/">
|
|
3413
|
+
<div>
|
|
3414
|
+
<input name="s" id="s" class="absmid" style="width: 190px;" type="text">
|
|
3415
|
+
<input src="advertiser_files/searchbtn.png" class="absmid" type="image">
|
|
3416
|
+
</div>
|
|
3417
|
+
</form>
|
|
3418
|
+
</div>
|
|
3419
|
+
<li id="collapscat-7" class="widget widget_collapscat"><h2 class="widgettitle">Publisher & Advertiser Accounts</h2>
|
|
3420
|
+
<ul id="widget-collapscat-7-top" class="collapsing categories list">
|
|
3421
|
+
<ul><li class="collapsing categories item"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_002.html" title="Quick Start Guide">Quick Start Guide</a></li>
|
|
3422
|
+
<li class="collapsing categories item"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_005.html" title="Epom Referral Program">Epom Referral Program</a></li>
|
|
3423
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_006.html" title="View all posts filed under Inventory Management">Inventory Management</a></span>
|
|
3424
|
+
<div id="collapsCat-3:7" style="display: none;">
|
|
3425
|
+
<ul><li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_007.html" title="View all posts filed under Plugins for WordPress and Joomla!">Plugins for WordPress and Joomla!</a></span>
|
|
3426
|
+
<div id="collapsCat-76:7" style="display: none;">
|
|
3427
|
+
</div>
|
|
3428
|
+
</li> <!-- ending subcategory -->
|
|
3429
|
+
</ul> </div>
|
|
3430
|
+
</li> <!-- ending subcategory -->
|
|
3431
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_008.html" title="View all posts filed under Campaign Management">Campaign Management</a></span>
|
|
3432
|
+
<div id="collapsCat-88:7" style="display: none;">
|
|
3433
|
+
<ul><li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_009.html" title="View all posts filed under Targeting">Targeting</a></span>
|
|
3434
|
+
<div id="collapsCat-90:7" style="display: none;">
|
|
3435
|
+
</div>
|
|
3436
|
+
</li> <!-- ending subcategory -->
|
|
3437
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_010.html" title="View all posts filed under CPA Campaign Management">CPA Campaign Management</a></span>
|
|
3438
|
+
<div id="collapsCat-114:7" style="display: none;">
|
|
3439
|
+
<ul><li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_011.html" title="View all posts filed under Server to server tracking">Server to server tracking</a></span>
|
|
3440
|
+
<div id="collapsCat-145:7" style="display: none;">
|
|
3441
|
+
</div>
|
|
3442
|
+
</li> <!-- ending subcategory -->
|
|
3443
|
+
</ul> </div>
|
|
3444
|
+
</li> <!-- ending subcategory -->
|
|
3445
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_012.html" title="View all posts filed under Third Party Tracking">Third Party Tracking</a></span>
|
|
3446
|
+
<div id="collapsCat-115:7" style="display: none;">
|
|
3447
|
+
</div>
|
|
3448
|
+
</li> <!-- ending subcategory -->
|
|
3449
|
+
</ul> </div>
|
|
3450
|
+
</li> <!-- ending subcategory -->
|
|
3451
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_013.html" title="View all posts filed under Reports & Analytics">Reports & Analytics</a></span>
|
|
3452
|
+
<div id="collapsCat-92:7" style="display: none;">
|
|
3453
|
+
</div>
|
|
3454
|
+
</li> <!-- ending subcategory -->
|
|
3455
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_014.html" title="View all posts filed under Rich Media Ads">Rich Media Ads</a></span>
|
|
3456
|
+
<div id="collapsCat-93:7" style="display: none;">
|
|
3457
|
+
<ul><li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_015.html" title="View all posts filed under Rich Media Templates for Display">Rich Media Templates for Display</a></span>
|
|
3458
|
+
<div id="collapsCat-98:7" style="display: none;">
|
|
3459
|
+
</div>
|
|
3460
|
+
</li> <!-- ending subcategory -->
|
|
3461
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_016.html" title="View all posts filed under Rich Media Templates for Mobile Web">Rich Media Templates for Mobile Web</a></span>
|
|
3462
|
+
<div id="collapsCat-99:7" style="display: none;">
|
|
3463
|
+
</div>
|
|
3464
|
+
</li> <!-- ending subcategory -->
|
|
3465
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_017.html" title="View all posts filed under Rich Media Templates for Application Ad Campaigns">Rich Media Templates for Application Ad Campaigns</a></span>
|
|
3466
|
+
<div id="collapsCat-100:7" style="display: none;">
|
|
3467
|
+
</div>
|
|
3468
|
+
</li> <!-- ending subcategory -->
|
|
3469
|
+
</ul> </div>
|
|
3470
|
+
</li> <!-- ending subcategory -->
|
|
3471
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_018.html" title="View all posts filed under Administration">Administration</a></span>
|
|
3472
|
+
<div id="collapsCat-96:7" style="display: none;">
|
|
3473
|
+
</div>
|
|
3474
|
+
</li> <!-- ending subcategory -->
|
|
3475
|
+
</ul><li style="display: none;"></li>
|
|
3476
|
+
</ul>
|
|
3477
|
+
</li>
|
|
3478
|
+
<li id="collapscat-9" class="widget widget_collapscat"><h2 class="widgettitle">Network Account</h2>
|
|
3479
|
+
<ul id="widget-collapscat-9-top" class="collapsing categories list">
|
|
3480
|
+
<ul><li class="collapsing categories item"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_003.html" title="Quick Start Guide">Quick Start Guide</a></li>
|
|
3481
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_019.html" title="View all posts filed under White Labeling">White Labeling</a></span>
|
|
3482
|
+
<div id="collapsCat-127:9" style="display: none;">
|
|
3483
|
+
</div>
|
|
3484
|
+
</li> <!-- ending subcategory -->
|
|
3485
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_020.html" title="View all posts filed under System Settings">System Settings</a></span>
|
|
3486
|
+
<div id="collapsCat-128:9" style="display: none;">
|
|
3487
|
+
</div>
|
|
3488
|
+
</li> <!-- ending subcategory -->
|
|
3489
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_021.html" title="View all posts filed under Users and Roles">Users and Roles</a></span>
|
|
3490
|
+
<div id="collapsCat-129:9" style="display: none;">
|
|
3491
|
+
</div>
|
|
3492
|
+
</li> <!-- ending subcategory -->
|
|
3493
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_022.html" title="View all posts filed under Default Roles Settings">Default Roles Settings</a></span>
|
|
3494
|
+
<div id="collapsCat-130:9" style="display: none;">
|
|
3495
|
+
</div>
|
|
3496
|
+
</li> <!-- ending subcategory -->
|
|
3497
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_023.html" title="View all posts filed under Inventory">Inventory</a></span>
|
|
3498
|
+
<div id="collapsCat-131:9" style="display: none;">
|
|
3499
|
+
</div>
|
|
3500
|
+
</li> <!-- ending subcategory -->
|
|
3501
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_024.html" title="View all posts filed under Campaigns">Campaigns</a></span>
|
|
3502
|
+
<div id="collapsCat-132:9" style="display: none;">
|
|
3503
|
+
<ul><li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_025.html" title="View all posts filed under Campaigns and Banners Prioritization">Campaigns and Banners Prioritization</a></span>
|
|
3504
|
+
<div id="collapsCat-133:9" style="display: none;">
|
|
3505
|
+
</div>
|
|
3506
|
+
</li> <!-- ending subcategory -->
|
|
3507
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_026.html" title="View all posts filed under Campaings and Banners Settings">Campaings and Banners Settings</a></span>
|
|
3508
|
+
<div id="collapsCat-134:9" style="display: none;">
|
|
3509
|
+
</div>
|
|
3510
|
+
</li> <!-- ending subcategory -->
|
|
3511
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_027.html" title="View all posts filed under CPA Campaigns">CPA Campaigns</a></span>
|
|
3512
|
+
<div id="collapsCat-135:9" style="display: none;">
|
|
3513
|
+
<ul><li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_028.html" title="View all posts filed under Server-to-Server Tracking">Server-to-Server Tracking</a></span>
|
|
3514
|
+
<div id="collapsCat-144:9" style="display: none;">
|
|
3515
|
+
</div>
|
|
3516
|
+
</li> <!-- ending subcategory -->
|
|
3517
|
+
</ul> </div>
|
|
3518
|
+
</li> <!-- ending subcategory -->
|
|
3519
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_029.html" title="View all posts filed under 3rd Party Tracking">3rd Party Tracking</a></span>
|
|
3520
|
+
<div id="collapsCat-136:9" style="display: none;">
|
|
3521
|
+
</div>
|
|
3522
|
+
</li> <!-- ending subcategory -->
|
|
3523
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_030.html" title="View all posts filed under Rich Media">Rich Media</a></span>
|
|
3524
|
+
<div id="collapsCat-137:9" style="display: none;">
|
|
3525
|
+
<ul><li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_031.html" title="View all posts filed under Templates for Display">Templates for Display</a></span>
|
|
3526
|
+
<div id="collapsCat-138:9" style="display: none;">
|
|
3527
|
+
</div>
|
|
3528
|
+
</li> <!-- ending subcategory -->
|
|
3529
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_032.html" title="View all posts filed under Templates for Mobile Web">Templates for Mobile Web</a></span>
|
|
3530
|
+
<div id="collapsCat-139:9" style="display: none;">
|
|
3531
|
+
</div>
|
|
3532
|
+
</li> <!-- ending subcategory -->
|
|
3533
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_033.html" title="View all posts filed under Templates for Application Ad Campaigns">Templates for Application Ad Campaigns</a></span>
|
|
3534
|
+
<div id="collapsCat-140:9" style="display: none;">
|
|
3535
|
+
</div>
|
|
3536
|
+
</li> <!-- ending subcategory -->
|
|
3537
|
+
</ul> </div>
|
|
3538
|
+
</li> <!-- ending subcategory -->
|
|
3539
|
+
</ul> </div>
|
|
3540
|
+
</li> <!-- ending subcategory -->
|
|
3541
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_034.html" title="View all posts filed under Reports">Reports</a></span>
|
|
3542
|
+
<div id="collapsCat-141:9" style="display: none;">
|
|
3543
|
+
</div>
|
|
3544
|
+
</li> <!-- ending subcategory -->
|
|
3545
|
+
<li class="collapsing categories expandable"><span class="collapsing categories expand"><span class="sym"><img src="advertiser_files/expand.gif" alt="expand"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_035.html" title="View all posts filed under Billing">Billing</a></span>
|
|
3546
|
+
<div id="collapsCat-142:9" style="display: none;">
|
|
3547
|
+
</div>
|
|
3548
|
+
</li> <!-- ending subcategory -->
|
|
3549
|
+
<li class="collapsing categories expandable parent"><span class="collapsing categories collapse"><span class="sym"><img src="advertiser_files/collapse.gif" alt="collapse"></span><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_036.html" title="View all posts filed under API Reference">API Reference</a></span>
|
|
3550
|
+
<div id="collapsCat-143:9" style="display: block;">
|
|
3551
|
+
<ul><li class="collapsing categories item self"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_037.html" title="Advertiser API">Advertiser API</a></li>
|
|
3552
|
+
<li class="collapsing categories item"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_038.html" title="Publisher API">Publisher API</a></li>
|
|
3553
|
+
<li class="collapsing categories item"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_039.html" title="Sign-up REST API">Sign-up REST API</a></li>
|
|
3554
|
+
<li class="collapsing categories item"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_040.html" title="Analytics REST API">Analytics REST API</a></li>
|
|
3555
|
+
<li class="collapsing categories item"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_041.html" title="Login REST API">Login REST API</a></li>
|
|
3556
|
+
<li class="collapsing categories item"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_042.html" title="API Requests Sample Scripts">API Requests Sample Scripts</a></li>
|
|
3557
|
+
</ul> </div>
|
|
3558
|
+
</li> <!-- ending subcategory -->
|
|
3559
|
+
</ul><li style="display: none;"></li>
|
|
3560
|
+
</ul>
|
|
3561
|
+
</li>
|
|
3562
|
+
|
|
3563
|
+
<span class="menuTitle" style="display: none;">Epom Market</span>
|
|
3564
|
+
<div class="links" style="display: none;">
|
|
3565
|
+
<ul>
|
|
3566
|
+
<li>
|
|
3567
|
+
<a indepth="true" title="Post: How to Activate Epom Market" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_043.html">How to Activate Epom Market</a>
|
|
3568
|
+
</li>
|
|
3569
|
+
<li>
|
|
3570
|
+
<a indepth="true" title="Post: Working with Epom Market" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_044.html">Working with Epom Market</a>
|
|
3571
|
+
</li>
|
|
3572
|
+
<li>
|
|
3573
|
+
<a indepth="true" title="Post: Epom Direct Ads" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_045.html">Epom Direct Ads</a>
|
|
3574
|
+
</li>
|
|
3575
|
+
<li>
|
|
3576
|
+
<a indepth="true" title="Post: Forgot Epom Market password" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_046.html">Forgot Epom Market password</a>
|
|
3577
|
+
</li>
|
|
3578
|
+
<li>
|
|
3579
|
+
<a indepth="true" title="Post: Epom Market revenue" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default_047.html">Epom Market revenue</a>
|
|
3580
|
+
</li>
|
|
3581
|
+
</ul>
|
|
3582
|
+
</div>
|
|
3583
|
+
|
|
3584
|
+
<span class="menuTitle" style="display: none;">Video Guide</span>
|
|
3585
|
+
<div class="links">
|
|
3586
|
+
<ul>
|
|
3587
|
+
</ul>
|
|
3588
|
+
</div>
|
|
3589
|
+
|
|
3590
|
+
<span class="menuTitle"><a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/glossary-posts.html">Glossary</a></span>
|
|
3591
|
+
</div>
|
|
3592
|
+
|
|
3593
|
+
|
|
3594
|
+
|
|
3595
|
+
|
|
3596
|
+
<div class="footer">
|
|
3597
|
+
<div class="inner_grad"></div>
|
|
3598
|
+
<div class="inner_links">
|
|
3599
|
+
|
|
3600
|
+
<div class="ll">Copyright © Epom Inc. All Rights Reserved</div>
|
|
3601
|
+
<div class="lr">
|
|
3602
|
+
<a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/default.html">Home</a>
|
|
3603
|
+
<a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/about.html" target="_top">About</a>
|
|
3604
|
+
<a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/contact_us.html" target="_top">Contact Us</a>
|
|
3605
|
+
<a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/client_support.html" target="_top">Client Support</a>
|
|
3606
|
+
<a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/terms.html" target="_top">Terms of Service</a>
|
|
3607
|
+
<a indepth="true" href="file:///home/adrian/.mozilla/firefox/60377aof.default/ScrapBook/data/20150713132650/privacy_policy.html" target="_top">Privacy</a>
|
|
3608
|
+
</div>
|
|
3609
|
+
|
|
3610
|
+
</div>
|
|
3611
|
+
</div>
|
|
3612
|
+
|
|
3613
|
+
</div>
|
|
3614
|
+
|
|
3615
|
+
|
|
3616
|
+
|
|
3617
|
+
|
|
3618
|
+
|
|
3619
|
+
|
|
3620
|
+
|
|
3621
|
+
|
|
3622
|
+
|
|
3623
|
+
|
|
3624
|
+
</div>
|
|
3625
|
+
|
|
3626
|
+
|
|
3627
|
+
</body></html>
|