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 Description Type
website Yes

Contains the ID of the Website.

For example,

website”: {“entry_id”: 1805 }

This is site entry ID or site ID.

object
productId Yes

Displays the product ID

of the selected products.

int
sizeMaster Yes Contains the list f the sizeMaster JSON object. object

Following table describes the parameters wrapped by the adUnit – sizeMaster object:

Parameters Is Required Description Type
entry_id Yes Includes the complete list of JSON objects which contain 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
adServeTypeId Yes (Only in case of Header Bidding) 3 int

Following table describes the parameters wrapped by the adUnit – sizeMaster object: Response

Parameters Type Description
message String

Displays the success or

error message for

the operation performed

by the users.

statusCode int

Displays the status code

for the operation performed

by the users.For example,

it will display 200 for success

and 406 for error.

data object

Stores the ID or entry ID

of the size unit if the

data object contains JSON.

This ID can be used for unit

updation of json: {“ids”: 6657,

“name”:”www.testincremntx1123.com_160_600″}

Response Parameters

Example: Website 

1. Request API: 

https://api.incremntx.com/ip/addunit

Method: POST

Request:

{
“sizeMaster”: [{
“entry_id”: 16,
“adType”: {
“entry_id”: 1
}
}],
“website”: {
“entry_id”: 12398
},
“productId”: 1
}

Response:

{
“message”: ” 300 x 600 Unit is added successfully for selected Website”,
“data”:
{
“id”: 0,
“name”: “[ClientSite.com_300_600_0]”,
“ids”:
[
45172
]
},
“statusCode”: 200
}

Example: Website (Header Bidding)

{
“sizeMaster”: [{
“adServeTypeId”: 3,
“entry_id”: 1,
“adType”: {
“entry_id”: 1
}
}],
“website”: {
“entry_id”: 12753
},
“productId”: 1
}Response : Website (Header Bidding){
“message”: ” 160 x 600 Unit is added successfully for selected Website”,
“data”: {
“id”: 0,
“name”: “[headerbiddingsizetest1.com_160_600_1]”,
“ids”: [
46543
]
},
“statusCode”: 200
}

 

1. Request API:

Example: Mobile App

https://api.incremntx.com/ip/addunit

Method: POST

Request:

{
“sizeMaster”: [{
“entry_id”: 21,
“adType”: {
“entry_id”: 6
}
}, {
“entry_id”: 44,
“adType”: {
“entry_id”: 6
}
}
}],
“website”: {
“entry_id”: 12400
},
“productId”: 3,
“commentsHistory”: []
}

 

Response:

{
“message”: ” 300 x 50, 300 x 50 Units are added successfully for selected Mobile App”,
“data”: {
“id”: 0,
“name”: “[MobileSite.com_300_50_0, MobileSite.com_300_50_0]”,
“ids”: [45176, 45177]
},
“statusCode”: 200
}

 

Example: Vast

1. Request API:

https://api.incremntx.com/ip/addunit

Method: POST

Request:

{
“sizeMaster”: [{
“entry_id”: 0,
“adType”: {
“entry_id”: 11
}
}, {
“entry_id”: 56,
“adType”: {
“entry_id”: 11
}
}],
“website”: {
“entry_id”: 12399
},
“productId”: 5,
}

 

Response:

{
“message”: ” VAST 3.0 Unit is added successfully for selected Vast”,
“data”:
{
“id”: 0,
“name”: “[VastSite.com_VAST3.0_0]”,
“ids”:
[
45174
]
},
“statusCode”: 200
}

 

Update Website AdUnit

 URL: https://api.incremntx.com/ip/updateunit

Method: POST

Request:

{

“entry_id”: 45172, “unitName”: “ClientSite.com_300_600_0”, “statusId”: 1

}

Response:

{

“message”: “Ad Unit 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...

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

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