Banner Areas Requests

A banner area refers to a predefined area (zone) on your site to host the companion banner ad (<div>). You need to create one div per companion banner area in the HTML code next to your video player with the desired dimensions and a unique ID. A suggestion is to name this div using its IAB standard naming and size (for example, <div id="IAB_Medium_Rectangle_300x250" style="width:300px; height="250px" ...</div>. The companion areas (zones) you created need to be registered with your Pulse account in order to traffic ads to them. Send your Account Manager a list of your desired companion area IDs and they will help you set them up, or contact them for more information.

Getting Started

  • Base URL: https://api.videoplaza.com/v3/banner-areas.
  • Requests: GET requests are used. You pass parameters by using common REST parameters like PATH, as well as HTTP HEADERS. The body of the requests should be provided in JSON format and encoded using UTF-8.
  • Responses: All responses contain an HTTP status code in the header and the body is in JSON format.
  • Swagger documentation: Campaign API v3 - Banner Areas
  • Related user documentation:
The Banner Areas API allows you to:
Note: Only successful responses are shown in the examples. Details about unsuccessful responses are found in the swagger documentation.

List All Banner Areas

Method GET
URL https://api.videoplaza.com/v3/banner-areas
Header Authentication header (x-o-api-key)
Content type application/json
URL params -
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body:

[
    {
        "id": "<string>",
        "description": "<string>",
        "type": "<string>",
        "name": "<string>",
        "height": "<integer>",
        "width": "<integer>"       
    },
    {
        "id": "<string>",
        "description": "<string>",
        "type": "<string>",
        "name": "<string>",
        "height": "<integer>",
        "width": "<integer>"       
    }
]

Example

Request header:

GET /v3/banner-areas HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

[
    {
        "id": "5b1a118e-c5ce-11e1-82b9-00259065db80",
        "description": "Medium rectangle",
        "type": "companion_banner_flash",
        "name": "IAB_Medium_Rectangle_300x250",
        "height": 250,
        "width": 300
    },
    {
        "id": "9afcf060-c5cd-11e1-82b9-00259065db80",
        "description": "Leaderboard",
        "type": "companion_banner_javascript",
        "name": "IAB_Leaderboard_728x90",
        "height": 90,
        "width": 728
    },
    {
        "id": "a191822e-c5cd-11e1-82b9-00259065db80",
        "description": "Banner",
        "type": "companion_banner_javascript",
        "name": "IAB_Banner_468x60",
        "height": 60,
        "width": 468
    }
]

Get Banner Area by Banner Area ID

Method GET
URL https://api.videoplaza.com/v3/banner-areas/{id)
Header Authentication header (x-o-api-key)
Content type application/json
URL params Category ID
Query params -
Body -
Success response

HTTP status: 200 OK

Header: -

Body:

{
    "id": "<string>",
    "description": "<string>",
    "type": "<string>",
    "name": "<string>",
    "height": "<integer>",
    "width": "<integer>"       
}

Example

Request header:

GET /v3/banner-areas/9afcf060-c5cd-11e1-82b9-00259065db80 HTTP/1.1
Host: api.videoplaza.com
Content-type: application/json
x-o-api-key="<your key>"

Request body: NA

Success response:

HTTP status:
  200 (OK)

{
    "id": "9afcf060-c5cd-11e1-82b9-00259065db80",
    "description": "Leaderboard",
    "type": "companion_banner_javascript",
    "name": "IAB_Leaderboard_728x90",
    "height": 90,
    "width": 728
}
https://help.ooyala.com/sites/all/libraries/dita/en/video-advertising/oadtech/ad_serving/dg/rest_banner_areas_endpoint.html

Was this article helpful?