Site Creation API
Website:
Add Website:
Add site API helps you to add new Website as well as adunits with different sizes.
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 |
Product ID | Yes |
Consist radio button which decides the ad type. For example Website, Mobile App & Vast. Kindly refer Product ID table. |
String |
Website Name | Yes |
Includes all the parameters which helps to add the site and app details. |
String |
Category | Yes |
Consists list of categories choose any one of them by default fist item of the list is selected. |
Object |
ad unit | Yes |
Consists the list of sizeMaster JavaScript Object Notation (JSON) Object. |
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 f or example, testweb.com. |
String |
iabCategoriseId | Yes |
Sends the integer master ID of category for example, 1 or 2 etc. Minimum 3 iab categories for each site. |
int |
mobileApp | Yes |
Accepts a boolean value, if the value is true, it will create a mobile ad. |
boolean |
productId | Yes | Displays the product ID of the selected products. | int |
pagead | Yes |
Accepts a boolean value, if the value is true then it will create a page ad. |
boolean |
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 |
adServeTypeId | Yes(only in case of Header Bidding) | 3 | int |
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 Website if the data object contains JSON. This ID can be used for site updation json: {“id”: 1810, |
“name”: “www.testincremntx1123.com”} |
Response Parameters
1. Request API:
URL: https://api.incremntx.com/ip/addwebsitenapp
Method: POST
Request: { |
Response: { |
API Request : Header Bidding
{ “website”: { “siteName”: “headerbiddingsizetest1.com”, “hostName”: “headerbiddingsizetest1.com”, “rtbCategories”: “IAB1,IAB2,IAB3”, “mobileFooterAds”: false, “mobilePageAds”: false, “mobileApp”: false, “productId”: 1, “pagead”: true, “footerad”: false, “marginad”: false }, “adUnit”: { “sizeMaster”: [{ “adServeTypeId”: 3, “entry_id”: 3, “adType”: { “entry_id”: 1 } }] } } |
Response:
{ “message”: “Website added successfully. Your account manager will contact you soon shortly.”, “data”: { “id”: 12753, “name”: “headerbiddingsizetest1.com” }, “statusCode”: 200 } |
Site Update
URL: https://api.incremntx.com/ip/updatewebsite
Method: POST
Request: { |
Response: { |