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.incremntx.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:

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.incremntx.com/ip/addwebsitenapp

https://api.incremntx.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.incremntx.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

}


 

Related Articles

IncrementX – Google Ad Manager Integration Guide

Step 1 - Ad Unit Creation (Go to Inventory -> Ad Units -> New Ad unit) In the Settings section Parent Ad unit should be “Top Level” Name will be the Ad Unit name which can be easily identified (Eg: websitename.com_IncrementX_300x250) Code is used to identify the...

Ads.txt – Implementation Guide

This document outlines the significance,purpose and acts as guide to implement Ads.txt for your IncrementX account. 1) What is Ads.txt? Ads.txt is a simple, flexible, and secure method for publishers and distributors to declare who is authorized to sell their...

Site and App Report

Sites & Apps Reports displays a detailed report on the sites and apps transactions done by the publishers. The Sites & Apps Reports display the Action, Date, Impressions, eCPM($), and Estimated Revenue($). The above is an example of  a Site and App Report, The...

Add New Ad Unit

After successfully adding Site & Apps, the Publisher can now start Adding New Ad Units by performing these simple steps: Click on Ad Unit Management, from the Sites & Apps menu as highlighted in the figure below. Click on +Add New Ad Unit. Once you have...

Sign Up for Publishers

In order to Monetize with IncrementX, as a Publisher, you can create a New Acount by Signing Up, which can be done in 2 ways : Either by clicking on the Getting Started or by Clicking on the Sign Up option on the top right corner of the page, both of the options are...

Add New Site & App

As a Publisher, you can Add New Site & App  by performing the following steps. From the Site & Apps menu, click on Add New Site and App and the following figure will be displayed: IncrementX lets the Publisher choose the Product Type,  which can be...

Ad Unit Creation API

1. Website: Method: POST URL: https://api.incremntx.com/ip/addunit add unit refers to ad placements in selected Website, Mobile App or Vast Site. Following table describes the parameters that contains the requested JSON body: Request Fields Parameters Is Required...

Mobile App Creation API

App: Add Mobile App: Add Mobile App helps you to add new Mobile app as well as adunits with different sizes.  Method: POST URL: https://api.incremntx.com/ip/addwebsitenapp In request there are two objects wrapped one is Website and the other is ad unit. Request Fields...