Advertiser Management

getAdvertiserListByAgencyID

Description: Get a list of all advertisers associated with an agency by providing the agency ID

Implementation: URL/adv/agc/[agencyId]

Note: starting with v4.1.0, this method returns an unnamed array of all advertisers (breaking changes).

Method: GET

Json example

Method: 
    GET http://api.example.com/adv/agc/2

getAdvertiser

Description: Get the details of an existing advertiser

Implementation: URL/adv/[advertiserId]

Method: GET

Json example

Method: 
    GET http://api.example.com/adv/4

addAdvertiser

Description: Add new advertiser

Implementation: URL/adv/new

Method: POST/PUT

Requested parameters

addAdvertiser
Name Description Allowed Values Required / Optional Default
advertiserName name of the advertiser string required
agencyId Id of the agency number optional null
contactName contact name phone number optional null
emailAddress email address string optional null

Json example

Method: 
    POST http://api.example.com/adv/new
Request Header:
    Content-Type:text/javascript
Request Body:
    {
        "advertiserName":"Test new Advertiser creation",
        "contactName":"Peter Pan",
        "emailAddress":"peter.pan@example.com"
    }

Starting with v4.0, the addAdvertiser function will return full details of the newly created advertiser, instead of just {“OK”}. This enables developers to quickly retrieve the ID of the newly created entity, and to check the default values assigned to attributes that were not included in the call to create the new entity.


modifyAdvertiser

Description: Modify existing advertiser

Implementation: URL/adv/[advertiserId]

Method: POST/PUT

Requested parameters:

modifyAdvertiser
Name Description Allowed Values Required / Optional Default
advertiserName name of the advertiser string optional null
agencyId Id of the agency number optional null
contactName contact name phone number optional null
emailAddress email address string optional null

Json example

Method: 
    POST http://api.example.com/adv/4
Request Header:
    Content-Type:text/javascript
Request Body:
    {
        "advertiserName":"Test Advertiser - modified",
        "contactName":"Peter B Pan"
    }

deleteAdvertiser

Description: Delete an existing advertiser

Implementation: URL/adv/[advertiserId]

Method: DELETE

Json example

Method: 
    DELETE http://api.example.com/adv/4

Current version

The most recently released version of the Revive Adserver REST API is v4.2.0 (publication date July 12, 2017).

See Release Notes

Compatibility

Revive Adserver REST API is compatible with all versions of Revive Adserver v4.0 and higher. It may also be compatible with Revive Adserver v3.x (and also with OpenX Source v2.8 and higher), but this can not be guaranteed.

Revive Adserver REST API is compatible with all supported versions of PHP, including PHP7.

Also see Technical Requirements, Product Content, and Installation Instructions.