Campaign API Documentation

From docs.airpush.com
Jump to: navigation, search

Contents

Preface

This document provides information required to use Airpush's Advertiser APIs.

Introduction

Airpush Advertiser Campaign API has been designed to let advertisers/resellers manage campaigns directly with REST APIs.

The following sections include description of entities contained in the APIs and the information required to work with campaigns, adgroups, and ads. Use cases with sample code for the APIs have also been included.

Authentication

An API Key is required for all inbound API requests. Advertisers will have to login into their account on Airpush portal and go to "API" section. Press Generate API KEY button to get apikey.

API Rate Limit for overall APIs is 5000 per day.

Parameters and description

List of mandatory parameters required to create Campaigns and Creatives :

Parameter Name Description Required
name Campaign Name Yes
accountId Account Id No
dailyBudget Default daily budget for campaign Yes
type Campaign Type such as Appwall,Push,Dialog ads etc.

Please refer to "Campaign Type" table mentioned below

Yes
bid Bid amount for each click Yes
bidType Bid type for the campaign Yes (for bidType CPM)
startDate Start date of the campaign and it must be same or greater than today Yes (In YYYY-MM-DD H:i format only)
endDate End date of the campaign No (In YYYY-MM-DD H:i format only)
category Campaign category Yes
countryId Comma separated list of countries that campaign should be targeted Yes
stateId Comma separated list of states that campaign should be targeted Yes
manufacturerId Comma separated list of manufacturers that campaign should be targeted Yes
deviceId Comma separated list of devices that campaign should be targeted Yes
carrierId Comma separated list of carriers that campaign should be targeted Yes
osVersion Android or iOS Version based on platform type (It takes provided OS version and above into consideration) Yes
apikey The api key of the user Yes
campaignId The id of the campaign whose creative is being created Yes
creativeName Name of the creative Yes
title Title of the creative to be displayed Yes (For Creative types push_creative_text, push_click_to_call, push_click_to_message, appwall, dialog_url, dialog_click_to_call, dialog_click_to_message, in_app_text)
text Description of the creative Yes (For creative types push_creative_text,push_click_to_call, push_click_to_message, appwall, dialog_click_to_call, in_app_text)
url The URL of the advertisement given by user Yes (For creative types push_creative_text, push_creative_banner, icon, appwall, landing_page, dialog_url, in_app_banner, in_app_text, icon_redirect, overlay_ad (for tag type 0), media_full_page (for tag type 4),media_expandables (for tag type 4),media_inline (for tag type 4), abstract_banner_large(for tag type 4), abstract_banner_small(for tag type 4))
destination The destination number where the creative is to be targeted. e.g. It can be a phone number. Yes (For creative types push_click_to_call, push_click_to_message, dialog_click_to_call, dialog_click_to_message, abstract_banner_small_cc, abstract_banner_small_cm, abstract_banner_large_cc, abstract_banner_large_cm)
message The message to be displayed Yes (For creative types push_click_to_message, dialog_click_to_message, abstract_banner_small_cc, abstract_banner_small_cm, abstract_banner_large_cc, abstract_banner_large_cm)
buttonText The text to be displayed on the button Yes (For creative types dialog_url, dialog_click_to_call, dialog_click_to_message )
iconLabel The text of the picture to be used for the creative Yes (For creative type icon)
textColor The color of the text Yes (For creative type in_app_text)
textBgColor The background of the text Yes (For creative type in_app_text)
image The image to be displayed Yes (For creative types push_creative_text, push_creative_banner, icon, push_click_to_call, push_click_to_message, appwall, in_app_text, in_app_banner, overlay_ad)
category The values are either Mobile or Tablet Yes (For creative type in_app_banner,overlay_ad, media_full_page, media_inline, media_expandables)
textContent Enter the content in HTML/Java Script/full script format Yes (For creative type in_app_banner when tagType is 1/2/3 AND for media_full_page, media_inline, media_expandables when tag type is 3)
support The values should be in binary format in a particular order. A table below defines the order. Yes (For creative types media_full_page, media_inline, media_expandables)
domain_name The values should be valid domain name. Yes (For campaign type in_app)
impressionTracker The value should be valid url prefixed with http/https. No (For creative type overlay_ad, in_app_text, in_app_banner)
url1 The URL of the advertisement given by user Yes (For creative types abstract_banner_small_cc, abstract_banner_small_cm, abstract_banner_large_cc, abstract_banner_large_cm)
url2 The URL of the advertisement given by user Yes (For creative types abstract_banner_small_cc, abstract_banner_small_cm, abstract_banner_large_cc, abstract_banner_large_cm)
enableFullpageads To enable full page ads for RMI campaign's creative No (For creative types media_full_page) Y/N
Campaign Types
push_wap
icon
push_click_to_call
push_click_to_message
appwall
landing_page
dialog_url
dialog_click_to_call
dialog_click_to_message
in_app
overlay_ad
rich_media_interstitial
rich_media_banner
icon_redirect
abstract_banner_large
abstract_banner_small
abstract_banner_large_cc
abstract_banner_large_cm
abstract_banner_small_cc
abstract_banner_small_cm
Campaign Categories
Arts & Entertainment
Automotive
Business
Careers
Education
Family & Parenting
Health & Fitness
Food & Drink
Hobbies & Interests
Home & Garden
Law, Gov't & Politics
News
Personal Finance
Society
Science
Pets
Sports
Style & Fashion
Technology & Computing
Travel
Real Estate
Shopping
Religion & Spirituality
Uncategorized
Non-Standard Content
Illegal Content
Games
Board Games/Puzzles
Card Games
Roleplaying Games
Arcade & Action Games
Casual Games
Sports Games
Brain & Puzzle Games
Live Wallpaper Games
Widgets Games
Cards & Casino Games
Racing Games

Device Frame works

Android OS Versions:

Version Name
1.6 DONUT
2.0 Eclair
2.1 Eclair
2.2 Froyo
2.3 GingerBread
2.3.3 GingerBread
3.0 HoneyComb
3.1 HoneyComb
3.2 HoneyComb
4.0 Ice Cream Sandwich
4.0.3 Ice Cream Sandwich
4.1 JellyBean
4.2 JellyBean
4.3 Jelly Bean
4.4 KitKat
5.0 Lollipop
5.0.2 Lollipop
5.1 Lollipop

iOS Versions:

Version Name
1 IOS 1.0
2 IOS 2.0
3 IOS 3.0
4 IOS 4.0
5 IOS 5.0
6 IOS 6.0
7 IOS 7.0


Campaign and Creative Type relation:

Campaign Type Creative Types
push_wap push_creative_text, push_creative_banner, push_big_picture
icon icon
push_click_to_call push_click_to_call
push_click_to_message push_click_to_message
appwall appwall
landing_page landing_page
dialog_url dialog_url
dialog_click_to_call dialog_click_to_call
dialog_click_to_message dialog_click_to_message
in_app in_app_text, in_app_banner
overlay_ad overlay_ad
rich_media_interstitial media_full_page
rich_media_banner media_expandables, media_inline
icon_redirect icon_redirect
abstract_banner_large abstract_banner_large
abstract_banner_small abstract_banner_small
abstract_banner_large_cc abstract_banner_large_cc
abstract_banner_large_cm abstract_banner_large_cm
abstract_banner_small_cc abstract_banner_small_cc
abstract_banner_small_cm abstract_banner_small_cm

Creative Image configuration

Creative Type Image Configuration Required
push_creative_text Internal / External

External image Properties:

  width  => 72,
  height => 72,
  size   => 50
either of one
push_creative_banner External:

Properties:

  width  =>320,
  height =>50,
  size   =>50kb
      OR
  width  =>728,
  height =>90,
  size   =>50kb
Yes
push_big_picture External:

Properties:

Image:
  width  => 96,
  height => 96,
  size   => 50
Banner:
  width  => 400,
  height => 250,
  size   => 150
Both
icon External:

Properties:

  width  =>96,
  height =>96
  size   =>50kb
Yes
push_click_to_call Internal Yes
push_click_to_message Internal Yes
appwall External:

Properties:

  width=>72,
  height=>72
  size =>50kb
landing_page NA No
dialog_url NA No
dialog_click_to_call NA No
dialog_click_to_message NA No
in_app_text Internal Yes
in_app_banner External
  Properties:
  'Mobile':  width  => 320,
             height => 50,
             size   => 50kb
                  OR
             width  => 468,
             height => 60,
             size   => 50kb
  'Tablet':  width  => 728,
             height => 90,
             size   => 50kb
                  OR
             width  => 300,
             height => 250,
             size   => 50kb
Yes
overlay_ad External
  Properties:
  'Mobile':  width  => 300,
             height => 250,
             size   => 40kb
                  OR
             width  => 320,
             height => 480,
             size   => 50kb
  'Tablet':  width  => 550,
             height => 480,
             size   => 50kb
Yes

External: Image url must be present on server and it should not be relative path. The image types allowed are: jpg, jpeg and png. gif images are allowed only for in_app_banner ads.

Internal: Airpush has defined its own way of categorizing campaigns to certain groups.


Internal Image Values

Category
books_and_reference
business
comics
communications
contests
education
entertainment
finance
games
health_and_fitness
libraries_and_demo
lifestyle
media_and_video
medical
music_and_audio
news_and_magazine
personalization
photography
productivity
ringtones
shopping
social
sports
tools
travel_and_icon

Support

Order in which the values should be given is listed below. '0' represents disable and '1' represents '0'.

Support Parameters
Call
SMS
Store picture
Calendar Event
In-Line Video
Full Screen Video

Tag types

Value Description
0 Ad URL and image
1 html
2 Java Script
3 Entire Script
4 url

NOTE: 1. For tagType = 0, the value of category field while creating a creative should be either 'Mobile' or 'Tablet'. 2. For tagType = 1 or 2 or 3, the content of the text should be added in the field name, 'textContent'. The number of characters allowed here is 3000.

Sample APIs

The below mentioned sample url will be used for all requests.

Sample Url: http://openapi.airpush.com/<METHOD NAME>?apikey=<API KEY>&<BODY PARAMETER>

Request End Points:

MetaData

Country List

To get all countries with their ids Url:http://openapi.airpush.com/getCountryList?apikey=123

State List

Url:http://openapi.airpush.com/getStateListByCountry?apikey=123&countryId=<comma separated countryids'>

Manufacturer List

Url:http://openapi.airpush.com/getManufacturerList?apikey=123

Phone model List

Url:http://openapi.airpush.com/getDeviceListByManufacturer?apikey=123&manufacturerId=<comma separated manufacturerid's>

Carrier List

Url:http://openapi.airpush.com/getCarrierListByCountry?apikey=123&countryId=<comma separated countryid's>

Campaign Category List

Url:http://openapi.airpush.com/getCampaignCategoryList?apikey=123

Browser List

Url:http://openapi.airpush.com/getBrowserList?apikey=123


Campaign

Create a New Campaign

Method Name: createCampaign

Body Parameter:

Parameter Name is campaigns and

Value is

 {    
   "campaign_info": {        
       "name": "xyz_0025",
       "dailyBudget": 100,
       "type": "text",
       "startDate": "2013-06-15 10:30",
       "endDate": " ",
       "category": "Automotive",
       "platformType": "Android"
   },
   "targetting_details": {
       "osVersion": "1.6",
       "bid": "0.01",
       "dayOfWeek": "Mon,Tue,Wed",
       "scheduleTime": {
           "Mon": "3-4,5-9",
           "Tue": "1-4,6-12",
           "Wed": "0-3,4-10,19-24"
       },
       "countryId": "92,5,6",
       "stateId": {
           "5": "3,5,6",
           "6": "4,3,12",
           "92": "2,4"
       },
       "domain_name": "www.yourdomain.com",
       "manufacturerId": "23,3",
       "deviceId": {
           "3": "9,10,11",
           "23": "2"
       },
       "carrierId": {
           "5": "3,5,8",
           "6": "10,11,2",
           "92": "1,2,3"
       }
   }
 }
    

Success Response format: {"status" => 200, "message" => "Campaign ID 'campaignId' has been created successfully"};

Error Response Format: {"status":"<error_code>","message":"<error_message>"}

Notes:

1) Minimum Daily budget is $10/day.

2) Minimum campaign bid for a campaign is $0.005.

3) Maximum Campaign bid for a campaign is $25. For the campaign type: 'rich_media_interstitial', the maximum bid allowed is $200.

4) For choosing 'ALL countries' the value of countryId should be '99999'.

5) For choosing 'ALL states' the value of stateId should be '999999'.

6) For choosing 'ALL devices' the value of manufacturerId should be '99999' and deviceId should be '999999'.

7) For choosing 'ALL phones' the value of manufacturerId should be '99998' and deviceId should be '999998'.

8) For choosing 'ALL tablets' the value of manufacturerId should be '99997' and deviceId should be '999997'.

9) For choosing 'ALL carriers' the value of carrierId should be '999999'.

Example for 'ALL' targeting details for all the parameters:

   "countryId":"99999",
   "stateId": {
               "99999":"999999"
               },
   "manufacturerId":"99999",
   "deviceId":{
               "99999":"999999"
              },
   "carrierId":{
               "99999":"999999"
              }

10) You can choose 'ALL' States for one Country.

11) You can choose 'ALL' Carriers for one Country.

12) You can choose 'ALL' Devices for one Manufacturers.

Example for selecting:

   "countryId":"1,5,92",
   "stateId": {
               "1": "ALL",
               "5": "ALL",
               "92":"2,4"
               },
   "manufacturerId":"23,3",
   "deviceId":{
               "23":"ALL",
               "3" : "ALL"
              },
   "carrierId":{
               "1": "ALL",
               "5": "3,5,8",
               "92": "ALL"
              }


Platform Type The user has to specify the platform type on which he wants his campaigns to be targeted. The platform types are:

Platform Type
Android
iOS

Please Note:

- For the iOS platform, 'in_app','abstract_banner_large','abstract_banner_small' campaign types can be created.

- For iOS platform type, the expected manufaturerId value is either '861' (APPLE) or '99999' (ALL).

- For adding ALL devices to the iOS manufacturer, the expected value for deviceId is '999999' when manufaturerId value is '99999'


Day Parting The user can include the day parting functionality. In this functionality, the user can specify the day as well as the day time slots for each day. This functionality allows the user to specify when he wants his campaign to be targeted.

For specifying the day of the week, the values are to be filled in the parameter 'dayOfWeek' and for specifying the time slots the parameter 'scheduleTime' is to be filled in. A small example of day parting:

 {
   "dayOfWeek": "Mon,Tue,Fri",
   "scheduleTime": {
       "Mon": "3-4,6-10,12-19",
       "Tue": "0-24",
       "Wed": "5-6,8-10,12-14,15-18"
   }
 }

Note: If the user wants to create the day parting rules for 'Everyday', he just needs to fill in the dayOfWeek as Everyday. The scheduleTime is not be filled in.

Example: "dayOfWeek": "Everyday"


The complete JSON Format is given above.

Day Of Week
Mon
Tue
Wed
Thu
Fri
Sat
Sun
Everyday

View Campaign

Method Name: getCampaignDetailsById

Body Parameter:

Parameter name is campaigns and

Value is

 {
   "campaignId": "272"
 }

Update a campaign

Method Name: editCampaign

Body Parameter:

Parameter name is campaigns and

Value is

 {
   "campaignId": "115",
   "bid": "5",
   "dailyBudget": "20",
   "startDate": "2013-08-20 15:45",
   "endDate": "2013-08-25 10:15",
   "osVersion": "1.6",
   "dayOfWeek": "Mon,Tue,Wed",
   "scheduleTime": {
           "Mon": "3-4,5-9",
           "Tue": "1-4,6-12",
           "Wed": "0-3,4-10,19-24"
       },
   "countryId": "92,2,9,13",
   "stateId": {
       "5": "4,5,6,11",
       "9": "7,8,9",
       "92": "1,2,3"
   },
   "domain_name": "www.yourdomain.com",
   "manufacturerId": "13,12",
   "deviceId": {
       "12": "4,5",
       "13": "1,2,3"
   },
   "carrierId": {
       "5": "14,15",
       "9": "16,17",
       "92": "12,13"
   }
 }

Success Response Format: {"status" => 200, "message" => "Campaign id 'campaignId' has been updated successfully"}

Notes:

1) The user needs to provide only those fields which he wants to edit.

2) The 'ALL' Countries and 'ALL' States, 'ALL' Countries and 'ALL' Carriers AND 'ALL' Manufacturers and 'ALL' Devices Rules are same as for createCampaign API.

3) The 'ALL' States for one Country, 'ALL' Carriers for one Country AND 'ALL' Devices for one Manufacturer Rules are also same as for createCampaign API.

Deleting campaigns

Method Name: deleteCampaign

Body Parameters:

Parameter name is campaigns and

Value is

 {
   "campaignId": "107,234"
 }

Success Response Format: {"status" => 200, "message" => "Campaign id 'campaignId' has been deleted successfully"}

Copying a campaign

Method Name: copyCampaign

Body Parameters:

Parameter name is campaigns and

Value is

 {
   "campaignId": "105",
   "name": "copytest4"
 }

Success Response Format: {"status" => 200, "message" => "New campaign with 'newCampaignId' has been copied successfully"}

Changing status of campaign

Method Name: changeCampaignStatus

Body Parameters:

Parameter name is campaigns and

Value is

 {
   "campaignId": "105,107",
   "status": "pause"
 }

Success Response Format: {"status" => 200, "message" => "Your campaign status has been changed successfully"}

Note: You can only send "pause" or "active" as parameters while changing status.

List of campaigns for a given user

Method Name: getCampaignsByUserId

You just need to specify method name along with api key to get data.

Sample url: http://openapi.airpush.com/getCampaignsByUserId?apikey=xyz

Success Response Format: List of all the campaigns under this user.

Creative

Create an ad

Method Name: addCreative

Body parameters:

Parameter name is creatives and

Value is

 {    
   "campaignId": "517",
   "creativeName": "creative_new",
   "title": "title_creative",
   "url": "http://example.com",
   "creativeType": "push_creative_text",
   "destination": "5",
   "message": "the mesage is displayed",
   "buttonText": "ok",
   "text": "this is text",
   "iconLabel": "pic",
   "textColor": "#FF0000",
   "textBgColor": "#808000",
   "image": "books_and_reference",
   "category": "Mobile",
   "textContent": "here goes long text", 
   "tagType": "1",
   "enableFullpageads":"Y"
 }

Success Response Format: {"status" => 200,"message" => "Creative ID '"creative_id"' has been created successfully for the campaign ID '"campaign_id"'}

NOTE :

1. Multiple creatives CANNOT be added. Only single creatives are allowed to be added.

2. A special feature of creatives include multiple URLs. In "url" field, comma-separated url values is accepted.

3. Maximum number of "url" allowed per creative is 5. For creative type 'icon', maximum number of url should be 1.

4. url1 and url2 value should be ab.airpush.com prefixed with http/https.

5. The textColor and textBgColor values are expexted to be the color codes of the expected color.

6. For Big Picture Notification ads, the image URL as well as the Banner URL is to be specified. For uploading the banner, the url is to be given in the "banner" field. Therefore, the JSON for this type of creative should contain the image field as well as the banner fields. Example of the JSON:

 {    
   "campaignId": "517",
   "creativeName": "creative_new",
   "title": "title_creative",
   "url": "http://example.com",
   "creativeType": "push_big_picture", 
   "text": "this is text",    
   "image": "image_url",
   "banner": "banner_url"  
 }

Description for the category parameter For Rich Media Ads and Overlay Ads:

The values and the Configuration for these creatives:

1. overlay_ad:

category configurations
Mobile_1 300X250
Mobile_2 320X480
Tablet 550X480

2. For creatives under rich_media_banner campaign type:

category configurations
Mobile_1 320X250
Mobile_2 468X60
Tablet 728X90

3. media_full_page:


category configurations
BOTH
MOBILE
TABLET

View Creative

Method Name: getCreativeDetailsById

Body Parameters:

Parameter name is creatives and

Value is

 {    
   "creativeId": "960,961"
 }

Deleting creatives

Method Name: deleteCreative

Body Parameters:

Parameter name is creatives and

Value is

 {    
   "campaignId": "48",
   "creativeId": "959,234"
 }

Success Response Format: {"status" => 200, "message" => "Creative Ids 'creativeIds' have been deleted successfully"}

Changing Status of Creatives

Method Name: changeCreativeStatus

Body parameters:

Parameter name is creatives and

Value is

 {    
   "campaignId": "48",
   "creativeId": "960,961",
   "status": "pause"
 }

Success Response Format: {"status" => 200, "message" => "Status of creatives with ids 'creativeIds' have been changed successfully"}

List of Creatives for a campaign

Method Name: getCreativesByCampaignId

Body parameters:

Parameter name is creatives and

Value is

 {    
   "campaignId": "48"
 }

MULTIBID

The advertiser can have Multibid rules for his campaigns. He can assign different rules for his campaign getting served at different hours of the day. The fields to be added in the multibid are:

Fields Required
campaignId Yes
countryId No
stateId No
carrierId No
creativeId No
landingpageId No
manufacturerId No
deviceId No
osVerison No
networkGeneration No
publisherId No
appId No
hour No
bidPercentage Yes
deliveryCreativeId No
deliveryLandingpageId No
status Yes

Different types of osVersion available are:

Version Name
1.6 DONUT
2.0 Eclair
2.1 Eclair
2.2 Froyo
2.3 GingerBread
2.3.3 GingerBread
3.0 HoneyComb
3.1 HoneyComb
3.2 HoneyComb
4.0 Ice Cream Sandwich
4.0.3 Ice Cream Sandwich
4.1 JellyBean
4.2 JellyBean
4.3 Jelly Bean
4.4 KitKat
5.0 Lollipop
5.0.2 Lollipop
5.1 Lollipop

Different Network Generation Types available are as follows. The value of Connection Id is to filled for the networkGeneration parameter.

Connection Id Connection Name
17 HSDPA
13 UMTS
22 EDGE
14 HSPA
23 HSPA+
2 CDMA - EVDO REV. A
11 LTE
7 GPRS
1 CDMA - EVDO REV. 0
18 UNKNOWN
5 CDMA - EHRPD
4 CDMA - 1XRTT
6 EHRPD
10 HSUPA
19 HSPAPLUS
20 UMTS_HSPA
12 DC
16 HSPA PLUS
15 4G-LTE
21 CDMA


Some Restrictions on Multibid:

The advertiser can fill in the details mentioned above with some restrictions.

1. He can fill only one field amongst these four fields : creativeId, landingpageId, deliveryCreativeId, deliveryLandingpageId

2. The hour should have the value from 0 to 23.

3. The bid percentage value can vary from -95 to 500.

4. The multibid is only allowed upto 2nd level. It means that the advertiser can give values for either 1 or 2 amongst the following fields countryId,stateId, carrierId, creativeId, landingpageId, manufacturerId, deviceId, osVersion, networkGeneration, hour, appId, publisherId

5. To disable a particular targeting, one need to add attribute 'status' as 0 in JSON. To enable it, status parameter should be sent as 1.

6. There should not be multiple country Id and state id. User will have to provide with an array of JSON for multiple bidding rules.

7. The user can add multibid only for those campaigns which has received traffic since 7 days.

NOTES: 1. The user needs to format the parameters according to the need of the report type. The report type parameter should be placed above the drilldown parameter. For eg.: If the report type is country and drilldown is state, then the countryId params should be placed above the stateId param in the JSON. 2. If the user wishes to disable a particular multibid, he needs to use the updateMultibid API and put the status value as '0'. In the same way, If the user wants to enable a multibid, he need to use the updateMultibid API and put the status value as '1'.

Sample API

Adding rules for Multibid

The advertiser can add the rules of Multibid for his campaigns and creatives.

Method Name: addMultibid

Body Parameters:

Parameter name will be multibids and

Value is

  {
       "campaignId": "123",
       "countryId": "1",
       "stateId": "21",
       "carrierId": "",
       "creativeId": "1234",
       "landingpageId": "",
       "manufacturerId": "",
       "deviceId": "",
       "osVersion": "",
       "networkGeneration": "",
       "publisherId": "",
       "appId": "",
       "hour": "",
       "bidPercentage": "10",
       "deliveryCreativeId": "",
       "deliveryLandingpageId": "",
       "status": "1"
   }

Update Multibid

The advertiser can edit the multibid details for his campaigns using the Multibid id of that particular multibid. The only fields which can be updated are status and bidPercentage.

Method Name: updateMultibid

Body Parameters:

Parameter name will be multibids and

Value is

 {
   "multibidId": "123",
   "bidPercentage": "50",
   "status": "1 OR 0"
 }

Here, multibidId is a mandatory field. The 'status' field can either be 0(disable) or 1(enable)

View Multibid

The advertiser can view his multibid rules.

Method Name: viewMultibidById

Body Parameters:

Parameter name will be multibids and

Value is

   {        
       "multibidId": "12"
   }

Get Multibids List under a particular campaign

The advertiser can get the list of multibids under a campaign.

Method Name: getMultibidsList

Body Parameters:

Parameter name will be multibids and

Value is

   {        
       "campaignId": "12"
   }

Error Codes

Error Code Error Messages
2000 Invalid/Empty Email Format
2001 Invalid Campaign/Empty Name
2002 Invalid campaign bid format
2003 Start Date field cannot be empty
2004 Invalid campaign daily budget
2005 Invalid start date
2006 Invalid end date
2007 Invalid date format
2008 Country list is empty
2009 State list is empty
2010 Manufacturer list is empty
2011 Target device list is empty
2012 Carrier list is empty
2013 Campaign bid is less for this campaign type
2014 Campaign Budget is less than minimum budget
2015 Campaign type cannot be empty
2016 User doesn't exists
2017 Countries are not available in inventory
2018 Country and State information do not match
2019 Manufacturer not available in inventory
2020 Device and manufacturer list does not match or device information is not available in inventory
2021 Country and carrier list does not match or carrier information is not available in inventory
2022 Super charge option is not mentioned
2023 Invalid creatives
2024 Bid Validation has failed
2025 Image validation has failed
2026 Invalid creative type
2027 Invalid dayparting slot
2028 Missed mandatory paramaters
2029 Invalid Image path
2030 Image type not allowed
2031 Image URL is invalid
2032 Session id expired
2033 Campaign doesn't belong to user
2034 Country id selected and country id given in carrier targeting are different
2035 Bid amount exceeded allowed bid amount
2036 Super charge options are not available
2037 Country id selected and country id given in state targeting are different
2038 Manufacturer id selected and manufacture id given in device/phonemodel targeting are different
2039 Invalid Campaignid
2040 Campaign bid must be multiples of 0.005
2041 Campaign and creative data are empty
2042 Campaign Information is empty
2043 You have exceeded hourly transaction limit
2044 Bid should me multiple of 0.005
2045 Budget cannot be greater than 99999
2046 Campaign Name already exist
2047 Campaign Name length exceeded
2048 Creative Name length exceeded
2049 Creative title length exceeded
2050 Creative text length exceeded
2051 Campaign destination length exceeded
2052 Creative message length exceeded
2053 Creative button length exceeded
2054 Creative already exists with this name for this campaign
2055 Creative Name cannot have special characters
2056 Destination number cannot have special characters
2057 Bid is less than the allowed super charge min bid
2058 Invalid Creative Name
2059 Bid cannot have more than 3 decimal
2060 Campaign budget must be whole number
2061 Campaign cannot be edited
2062 No Parameters received
2063 Creative Name cannot be empty
2064 Please provide Campaign Id.
2065 Creative Destination length exceeded
2066 API Key Required
2067 Bid field cannot be empty
2068 Provide carrier list for the countries specified
2069 Budget is too less
2070 Manufacturer Field cannot be empty
2071 Device Field cannot be empty
2072 Carrier Field cannot be empty
2073 The bid percentage provided makes the campaign bid too low. Please provide a different bid percentage value.
2074 Campaign Name is too large
2075 -/|-*|-.|-_" are Not Allowed
2076 Creative could not be created
2077 Campaign could not be deleted
2078 Creative could not be deleted
2079 Creative does not exist
2080 Campaign does not exist
2081 Only those Campaigns can be paused which are running currently
2082 Campaign Information is not Available
2083 Campaign Copy unsuccessful
2084 Creative URL Cannot be empty
2085 Creative Title cannot be empty
2086 Wrong Format of Creative URL
2087 Button Text Value cannot be empty
2088 One Creative allowed per Appwall
2089 Target Framework cannot be left empty
2090 Only those Creatives can be paused which are running currently
2091 No campaigns under this User
2092 No Creatives under this Campaign
2093 Current Status cannot be retrieved
2094 The Minimum Bid amount is too less
2095 Only those campaigns can be activated which are paused currently
2096 Only those creatives can be activated which are paused currently
2097 Status cannot be changed
2098 Invalid Creative Id and Landing Page Id. Please provide only one value amongst the four
2099 Creative does not belong to this campaign
2100 The landing page id is invalid
2101 Percentage Bid Cannot be left empty
2102 Bid Percentage provided is not appropriate
2103 The hour entered is not appropriate
2104 The Multibid rule could not be created
2105 The Multibid rule could not be updated
2106 The Multibid rule does not exist
2107 Creative Details not available'
2108 Campaign does not belong to this user
2109 Unformatted Data
2110 Image size invalid
2111 Please enter correct format for support
2112 Tags could not be created
2113 Budget cannot be less than 0
2114 This campaign type does not exist
2115 This Category does not exist
2116 Provide state list for the countries specified
2117 Category filed cannot be empty
2118 Please enter a rule
2119 We dont allow more that 2nd level rule
2120 As you have chosen All countries. Please enter All states value
2121 Provide device list for the manufacturers specified
2122 User Informations not received
2123 Bid Percentage provided is too high
2124 Status field cannot be empty
2125 Please enter only 1 state Id
2126 Targetting Details were not saved successfully. Please try after some time.
2127 Please provide a proper status for the multibid. It can be either 0 or 1.
2128 Disabled list could not be updated
2129 Please enter only one carrier id
2130 This Carrier not available in inventory
2131 Please enter only one device Id
2132 This Device not available in inventory
2133 This Network Connection type is not available
2134 This OS Version is not available
2135 Module Details could not be retrieved
2136 This State not availaible in inventory
2137 The Multibid rule was not disabled successfully. Please try again.
2138 You can not select All States without choosing All Countries
2139 You can not choose specific states as you have chosen All countries. Please enter All states value'
2140 You can not select All Devices without choosing All Manufacturers
2141 You can not choose specific devices as you have chosen All manufacturers. Please enter All devices value
2142 You can not add a multibid rule for this campaign
2143 The country you specified has not received traffic since 7 days
2144 You cannot update the Bid Percentage for a disabled multibid
2145 You can upload either an image or a banner
2146 More than 5 URLs are not allowed per creative
2147 End Date cannot be less than the start date
2148 The content size is not within the range
2149 This tag type is not allowed
2150 No Multibids for this campaign
2151 Publisher Ids required
2152 The publisher ids where not disabled successfully. Please try after some time
2153 Please provide proper Publisher Ids
2154 Please provide more parameters for editing
2155 This campaign cannot be cloned.
2156 Please specify the Day of the week for day parting
2157 Please enter a correct day
2158 You can not specify time slots
2159 Please provide time slots for the days specified
2160 The slots are overlapping. Please provide proper time slots
2161 Please enter time slots within the range of 0 to 24
2162 Please specify the time slot for all the days specified
2163 The starting time slot should be lesser than the ending time slot.
2164 Platform Type cannot be left empty
2165 This Platform type is not availaible.
2166 The Manufacturer Id is incorrect according to the platform type chosen.
2167 The campaign type is not allowed for the platform type chosen.
2168 More than 1 URL are not allowed per icon creative.
2169 Bid Percentage should be multiple of 5.
2170 Please try updating the multibid as this rule already exists.
2171 Id is Invalid.
2172 The Campaign is already Disabled.
2173 The length of icon label should not be more than 30 characters.
2174 The creative URL provided is given multiple times.
2175 Sorry. The Creative does not belong to you.
2176 Please fill in the targeting details for this campaign.
2177 The color specified for the text is invalid. Please provide a proper color code.
2179 Please provide Creative Id.
2180 Please provide the Tag Type.
2181 Please provide at least one field to be edited.
2206 Only 1 Creative URL allowed for this type of creative.
2207 Please provide the text content.
2210 You can not choose specific carriers as you have chosen All countries. Please enter All carrier values.
2211 You can not select All Carriers without choosing All Countries.
2212 The Image URL does not exist.
2213 Creative Type field cannot be left empty.
2214 Please provide the status as 1 for adding Multibid rule.
2215 You can disable only an enabled Multibid.
2216 You cannot change the Bid Percentage value while disabling the multibid rule.
2217 Please provide a proper status for the adding the multibid. It can only be 1.
2218 We encountered an issue. Please try after some time.
2219 This is not the minimum value allowed.
2220 Please provide domain name.
2221 Enter a valid domain name.
2222 Domain name is mandatory for in_app campaign.Please provide domain name.
2223 Bid field is mandatory when editing country.
2224 Creative cannot be added for deleted campaign.
2240 Please provide Multibid Id.
2241 Please provide goal bid value greater than min bid.
2242 This campaign type is not allowed for CPM bid.
2243 CPM biding is not enabled for this account.
2244 RMI is already in CPM bid mode.
2245 Please enable abstract banner small campaign type.
2246 Please provide bid type.
2247 Please provide valid bid type value.
2252 You cannot edit platform.
2254 Please enable icrd campaign type.
2255 Target source cannot be empty.
2256 Current Bid value should not be greater than daily budget.
2257 Status can only be pause or active.
2258 Start date cannot be greater than end date.
2259 Please provide daily budget greater than bid.
2260 Special characters are not allowed in the beginning of text.
2261 Given targeting type not supported for this campaign.
2262 Mobile web is not enabled for this user.
2263 Please provide valid Url.
2264 Please provide single url for impression tracker.

Support Information

For any queries, please Contact us.

Personal tools
Namespaces

Variants
Actions
Toolbox