Version 5.0
AdvertServe User Manual :: v5.0

Zones :: Create API Module

Create

Description

Allows you to create a new zone with the specified properties.

Module URI

Hyperlink /servlet/control/api/zones/create

Parameters

Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad(None) Must be a String containing no more than 32 characters
outputStringNoxmlxml Must be a String equal to either json or xml
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
nameStringYesExample.com / Home / 728x90(None) Must be a unique String containing no more than 80 characters
groupIntegerYes123(None) Must be the ID# of an existing group
typeIntegerYes1(None) Must be an Integer equal to one of the following values:
  • 1 = Banner
  • 2 = Text
  • 3 = Window
  • 4 = Dynamic
  • 5 = Page Peel
  • 7 = VAST Video (Linear)
  • 8 = VAST Overlay (Non-Linear)
  • 6 = Wallpaper
sizeIntegerMaybe123(None) Must be the ID# of an existing size. Only required with the banner media type.
desktopbooleanNofalsetrue Must be a boolean value equal to either true or false
phoneIntegerNo123(None) Must be the ID# of an existing zone of the same type. A value of zero may be used to indicate no substitution is desired. If hiding the zone is desired, a value of -1 may be used instead so that no impressions are registered.
tabletIntegerNo123(None) Must be the ID# of an existing zone of the same type. A value of zero may be used to indicate no substitution is desired. If hiding the zone is desired, a value of -1 may be used instead so that no impressions are registered.
targetingCSV
Integer
NoN/A4,8 This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include any of the following Integer values:

  • 1 = CUSTOM
  • 2 = DATETIME
  • 3 = GEOGRAPHY
  • 4 = KEYWORDS
  • 5 = NETWORK
  • 6 = REFERRERS
  • 7 = SOFTWARE
  • 8 = THEMES
  • 9 = RETARGETING
  • 10 = LANGUAGES
  • 11 = WEATHER
If omitted the zone will be created with the default exclusive targeting permissions!
view_limitIntegerNo00 Must be an Integer value greater than or equal to zero -- if equal to zero then view capping is disabled
view_timeoutIntegerNo14401440 Must be an Integer value between 1 and 129,600 if view_limit is greater than zero. The unit of measure for this value is minutes. Thus it's possible to set it between 1 minute and 90 days (60 minutes * 24 hours * 90 days = 129,600 minutes).
view_pixelIntegerNo123(None) Must be the ID# of an existing pixel
click_pixelIntegerNo123(None) Must be the ID# of an existing pixel
action_pixelIntegerNo123(None) Must be the ID# of an existing pixel
defaultsbooleanNotruetrue Must be a boolean value equal to either true or false
refreshbooleanNotruefalse Must be a boolean value equal to either true or false
refresh_intervalIntegerNo3010 Must be an Integer value greater or equal to than zero if refresh is true
refresh_limitIntegerNo060 Must be an Integer value greater than or equal to zero if refresh is true
statusbooleanNotruetrue Must be a boolean value equal to either true or false
notesStringNoN/A(None) Must be a String containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
publishersCSV
Integer
No123(None) This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must contain the ID# of an existing publisher(s)

XML Response

Hyperlink /servlet/control/api/zones/create?secret=(key)&name=Example.com%20%2F%20Forums%20%2F%20160x600&group=20&type=1&size=13


<id>123</id>

JSON Response

Hyperlink /servlet/control/api/zones/create?secret=(key)&output=json&name=Example.com%20%2F%20Forums%20%2F%20160x600&group=20&type=1&size=13


{ "id" : 123 }