Epom Ad Server REST API allows obtaining Bid Pricing for CPC and CPM Campaigns via API request.

The general syntax for the API request should be:

http://example.com/ads-api-v3?key=XXXXXXXXXXXXXXX&format=xml-bids&add_price=true

where:

  • http://example.com/ads-api-v3 – request URL (taken from the API tab of the Invocation Codes pane of the Placement card).
  • key – Unique Identifier of the Placement (taken from the API tab of the Invocation Codes pane of the Placement card).
  • format=xml-bids – response format.
  • add_price=true

Example response:

<response>
<success>true</success>
<bids>
<bid>
<creative>
http://example.com/111111.png
</creative>
<click>
http://example.com/cr?b=2605&p=3389&ch=&cps=&c=627
&l=UA&h=1b3871deec514cb6f403d05d83daa1a6&t=1467106993118&
sh=800.0&sw=1280.0&epomUUID=bb387b20-3d14-11e6-a689-ecf4bbd39e5c&
ad.trans.id=nrvsw990yk40&u=https%3A%2F%2Fexample.com%2F
</click>
<title/>
<adUnit>
<width>300</width>
<height>250</height>
</adUnit>
<bidPrice>0.0013</bidPrice>
<beacons>
<beacon>
http://example.com/impression.gif?b=2605&p=3389&ch=&
ad.trans.id=nrvsw990yk40&ap=&cps=&c=627&l=UA&
h=1b3871deec514cb6f403d05d83daa1a6&t=1467106993117&
s=b6d98ddd05b3488edc5de81b74df37f4&tz=&sh=800&sw=1280
</beacon>
<beacon/>
</beacons>
</bid>
</bids>
</response>


Get Placement Bid Floor Information

Returns Bid Floor information for the given Placement ID. Requires Read level permission for INVENTORY permission.

URL: /rest-api/bid-floor/placement/{placementId}.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 – permission violation.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.

Create or Update Placement Bid Floor

Sets or updates Bid Floor for the given Placement ID. Requires Enabled permission for INVENTORY and BID FLOOR MANAGEMENT permissions.

URL: /rest-api/bid-floor/placement/{placementId}/update.do

Method: POST

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 – permission violation.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • country – ISO country code.
  • bidFloor – bid floor value (double).

Delete Placement Bid Floor

Deletes Bid Floor for the given Placement ID. Requires Enabled permission for INVENTORY and BID FLOOR MANAGEMENT permissions.

URL: /rest-api/bid-floor/placement/{placementId}/delete.do

Method: POST

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 – permission violation.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used for hash generation.
  • username – a given username.
  • country – ISO country code.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.