Vast Site Creation API

VAST:

Add Vast Site:

Add Vast App helps you to add new Vast site’s with different VAST versions.

Method: POST

URL: https://api.vertoz.com/ip/addwebsitenapp

For request there are two objects wrapped one is Website and the other is ad unit.

Request Fields

Parameters Is Required Description Type
Website Name Yes

Includes all the parameters which

helps to add the VAST Site details.

object
Category No Consists list of categories. String
VAST Yes  Contains the VAST details. String

Following table describes the parameters wrapped by the Website object:

Parameters Is Required Description Type
siteName Yes

Allows to enter the name of the

Website for example, testweb.com.

String
iabCategoriseId Yes

Sends the integer master ID

of category for example, 1 or 2 etc.

int
mobileApp Yes

Accepts a boolean value,

if the  value is true,

it will create a mobile ad.

boolean
pagead Yes

Accepts a boolean value,

if the value is true then

it will create a page ad.

boolean
productId Yes

Displays the product ID

of the selected products.

int
footerad Yes

Accepts a boolean value,

if the value is true,

then it will create

a footer ad.

boolean
marginad Yes

Accepts a boolean value,

if the value is true,

then it will create a margin ad.

boolean

Following table describes the parameters wrapped by the Ad unit object:[/nextpage]

Parameters Is Required Description Type
sizeMaster Yes

Includes the complete list of

JSON object which contains

the size ID and ad type ID

(for example, paged).

List Object

Following table describes the parameters wrapped by the Ad unit – sizeMaster object:

Parameters Is Required Description Type
entry_id Yes

Includes the complete list of

JSON objects which contains

the size ID and ad type ID

(for example, paged).

int
adType Yes

Holds the ad type ID

for example, “adType”:{“entry_id”: 1}

Object

Example:

1. Request API:

Method: POST

URL: https://api.vertoz.com/ip/addwebsitenapp

https://api.vertoz.com/ip/addwebsitenapp

Method: POST

Request:

{
“website”: {
“userId”: 0,
“templateId”: 0,
“status”: 0,
“siteDemandPartnerStatus”: [],
“siteName”: “VastSite.com”,
“hostName”: “VastSite.com”,
“rtbCategories”: “IAB1,IAB2,IAB3”,
“pagead”: false,
“productId”: 5,
“footerad”: false,
“marginad”: false
},
“adUnit”: {
“sizeMaster”: [{
“entry_id”: 55,
“adType”: {
“entry_id”: 11
}
}]
}
}

 

Response:

{
“message”: “Vast added successfully. Your account manager will contact you soon shortly.”,
“data”: {
“id”: 12399,
“name”: “VastSite.com”
},
“statusCode”: 200
}

 

Update VAST Site

URL: https://api.vertoz.com/ip/updatewebsite

Method: POST

Request:

{

“entry_id”: 12367, “userId”: 11429, “rtb”: true, “rtbBidValue”: 0, “rtbCategories”: “IAB1,IAB2,IAB3”, “status”: 1, “description”: “”, “productId”: 5, “templateId”: 0, “commentsHistory”: null, “siteDemandPartnerStatus”: []

}


Response:

{

“message”: “Video updated successfully”, “statusCode”: 200

}