Version 5.0
AdvertServe User Manual :: v5.0

Zones :: Campaign Assignment API Module

Modules

Add Campaign Assignment

Description

Allows you to assign a campaign to an existing zone.

Module URI

Hyperlink /servlet/control/api/zones/campaigns/add

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)
zoneIntegerYes123(None) Must be the ID# of an existing zone
campaignIntegerYes123(None) Must be the ID# of an existing campaign
defaultbooleanNofalsefalse Must be a boolean value equal to either true or false
chainIntegerNo00 Must be an Integer between -50 and 50
priorityIntegerNo11 Must be an Integer between 1 and 100
statusbooleanNotruetrue Must be a boolean value equal to either true or false

XML Response

Hyperlink /servlet/control/api/zones/campaigns/add?secret=(key)&zone=123&campaign=123


<success/>

JSON Response

Hyperlink /servlet/control/api/zones/campaigns/add?secret=(key)&output=json&zone=123&campaign=123


{ "success" : true }

Update Campaign Assignment

Description

Allows you to modify the chain, priority, or status of a campaign that's already assigned to an existing zone.

Module URI

Hyperlink /servlet/control/api/zones/campaigns/update

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
outputStringNoxml Must be a String equal to either json or xml
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
zoneIntegerYes123 Must be the ID# of an existing zone
campaignIntegerYes123 Must be the ID# of an existing campaign
defaultbooleanNofalse Must be a boolean value equal to either true or false
chainIntegerNo0 Must be an Integer between -50 and 50
priorityIntegerNo1 Must be an Integer between 1 and 100
statusbooleanNotrue Must be a boolean value equal to either true or false

XML Response

Hyperlink /servlet/control/api/zones/campaigns/update?secret=(key)&zone=123&campaign=123&priority=25


<success/>

JSON Response

Hyperlink /servlet/control/api/zones/campaigns/update?secret=(key)&output=json&zone=123&campaign=123&priority=25


{ "success" : true }

Remove Campaign Assignment

Description

Allows you to remove a campaign from an existing zone.

Module URI

Hyperlink /servlet/control/api/zones/campaigns/remove

Parameters

Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
secretStringYesa78bf24c5a23581aceba1c5f51ac4cad Must be a String containing no more than 32 characters
outputStringNoxml Must be a String equal to either json or xml
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
zoneIntegerYes123 Must be the ID# of an existing zone
campaignIntegerYes123 Must be the ID# of an existing campaign

XML Response

Hyperlink /servlet/control/api/zones/campaigns/remove?secret=(key)&zone=123&campaign=123


<success/>

JSON Response

Hyperlink /servlet/control/api/zones/campaigns/remove?secret=(key)&output=json&zone=123&campaign=123


{ "success" : true }