AdvertServe User Manual

Campaigns :: Update API Module

Update

Description

Allows you to update the properties of an existing campaign. Only properties that are provided in the request will be updated. All other properties will remain unchanged and keep their existing values. Please reference create for actual data requirements if you are unsure which fields are required.

Module URI

Hyperlink /servlet/control/api/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)
idIntegerYes123 Must be the ID# of an existing campaign
nameStringNoACME 468x60 Banner Must be a String containing no more than 80 characters
statusbooleanNotrue Must be a boolean value equal to either true or false
notesStringNoN/A Must be a String containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
alerts_recipients_administratorsCSV
Integer
NoN/A 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 administrator(s). If any types of alerts are enabled, at least one recipient must be specified. That can be an administrator, the advertiser, or other e-mail addresses for non-system users so long as there is at least one recipient out of those three types of users.
alerts_recipients_advertiserbooleanNofalse Must be a boolean value equal to either true or false
alerts_recipients_othersCSVNoN/A Must be a CSV list of e-mail addresses separated by line breaks and containing no more than 65,535 characters
alerts_report_typeIntegerNo0 Must be an Integer equal to one of the following values:
  • 0 = No Attachment
  • 1 = CSV
  • 2 = Excel
  • 3 = PDF
  • 4 = Text
alerts_report_rangeIntegerNo0 Must be an Integer equal to one of the following values:
  • 0 = Start Date
  • 1 = Current Month
  • 2 = One Week
  • 3 = Two Weeks
  • 4 = Three Weeks
  • 5 = One Month
  • 6 = Two Months
  • 7 = Three Months
  • 8 = Four Months
  • 9 = Five Months
  • 10 = Six Months
  • 11 = One Year
alerts_report_data_custombooleanNofalse Must be a boolean value equal to either true or false
alerts_report_data_dailybooleanNotrue Must be a boolean value equal to either true or false
alerts_report_data_geographybooleanNofalse Must be a boolean value equal to either true or false
alerts_report_data_groupsbooleanNotrue Must be a boolean value equal to either true or false
alerts_report_data_hourlybooleanNotrue Must be a boolean value equal to either true or false
alerts_report_data_keywordsbooleanNofalse Must be a boolean value equal to either true or false
alerts_report_data_mediabooleanNotrue Must be a boolean value equal to either true or false
alerts_report_data_networkbooleanNofalse Must be a boolean value equal to either true or false
alerts_report_data_publishersbooleanNofalse Must be a boolean value equal to either true or false
alerts_report_data_referrerbooleanNofalse Must be a boolean value equal to either true or false
alerts_report_data_softwarebooleanNofalse Must be a boolean value equal to either true or false
alerts_report_data_zonesbooleanNotrue Must be a boolean value equal to either true or false
alerts_startdatebooleanNofalse Must be a boolean value equal to either true or false
alerts_stopdatebooleanNofalse Must be a boolean value equal to either true or false
alerts_daysbooleanNofalse Must be a boolean value equal to either true or false
alerts_days_triggerIntegerNo1 Must be an Integer value between 1 and 31 if alerts_days is true
alerts_viewsbooleanNofalse Must be a boolean value equal to either true or false
alerts_views_triggerIntegerNo5 Must be an Integer value between 5 and 95 if alerts_views is true
alerts_clicksbooleanNofalse Must be a boolean value equal to either true or false
alerts_clicks_triggerIntegerNo5 Must be an Integer value between 5 and 95 if alerts_clicks is true
alerts_actionsbooleanNofalse Must be a boolean value equal to either true or false
alerts_actions_triggerIntegerNo5 Must be an Integer value between 5 and 95 if alerts_actions is true
alerts_max_viewsbooleanNofalse Must be a boolean value equal to either true or false
alerts_max_clicksbooleanNofalse Must be a boolean value equal to either true or false
alerts_max_actionsbooleanNofalse Must be a boolean value equal to either true or false
alerts_periodicbooleanNofalse Must be a boolean value equal to either true or false
alerts_periodic_triggerIntegerNo0 Must be an Integer equal to one of the following values if alerts_periodic is true:
  • 0 = Never
  • 1 = Daily
  • 2 = Weekly
  • 3 = Bi-Weekly
  • 4 = Monthly
  • 5 = Bi-Monthly
  • 6 = Quarterly
alerts_views_incrementbooleanNofalse Must be a boolean value equal to either true or false
alerts_views_increment_triggerIntegerNo10,000 Must be an Integer value greater than zero if alerts_views_increment is true
alerts_clicks_incrementbooleanNofalse Must be a boolean value equal to either true or false
alerts_clicks_increment_triggerIntegerNo100 Must be an Integer value greater than zero if alerts_clicks_increment is true
alerts_actions_incrementbooleanNofalse Must be a boolean value equal to either true or false
alerts_actions_increment_triggerIntegerNo10 Must be an Integer value greater than zero if alerts_actions_increment is true
alerts_over_deliverybooleanNofalse Must be a boolean value equal to either true or false
alerts_over_delivery_triggerIntegerNo5 Must be an Integer value between 5 and 95 if alerts_over_delivery is true
alerts_under_deliverybooleanNofalse Must be a boolean value equal to either true or false
alerts_under_delivery_triggerIntegerNo5 Must be an Integer value between 5 and 95 if alerts_under_delivery is true
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
custom_operator[1-10]IntegerNo1 Must be an Integer equal to one of the following values:
  • 1 = Equals
  • 2 = Not Equal
  • 3 = Contains
  • 4 = Excludes
  • 5 = Greater Than
  • 6 = Less Than
  • 7 = Greater Than Or Equal To
  • 8 = Less Than Or Equal To
  • 9 = Regular Expression
  • 10 = Between
custom_data[1-10]CSVNoN/A Must be a CSV list of target values separated by line breaks and containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
schedule_start_dateDateNo2011-01-01 Must be a Date in yyyy-MM-dd format
schedule_start_hourIntegerNo12 Must be an Integer value between 0 and 23 based on 24-hour clock convention
schedule_start_minuteIntegerNo30 Must be an Integer value between 0 and 59 based on 60-minute clock convention
schedule_stop_dateDateNo2011-01-31 Must be a Date in yyyy-MM-dd format
schedule_stop_hourIntegerNo23 Must be an Integer value between 0 and 23 based on 24-hour clock convention
schedule_stop_minuteIntegerNo59 Must be an Integer value between 0 and 59 based on 60-minute clock convention
schedule_weekdaysCSV
Integer
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more of the following Integer values:
  • 1 = Sunday
  • 2 = Monday
  • 3 = Tuesday
  • 4 = Wednesday
  • 5 = Thursday
  • 6 = Friday
  • 7 = Saturday
schedule_hoursIntegerNoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more Integer values between 0 and 23 based on 24-hour clock convention.
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
capping_view_limitIntegerNo0 Must be an Integer value greater than or equal to zero -- if equal to zero then view capping is disabled
capping_view_timeoutIntegerNo1440 Must be an Integer value between 1 and 129,600 if capping_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).
capping_click_limitIntegerNo0 Must be an Integer value greater than or equal to zero -- if equal to zero then click capping is disabled
capping_click_timeoutIntegerNo1440 Must be an Integer value between 1 and 129,600 if capping_click_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).
capping_action_limitIntegerNo0 Must be an Integer value greater than or equal to zero -- if equal to zero then action capping is disabled
capping_action_timeoutIntegerNo1440 Must be an Integer value between 1 and 129,600 if capping_action_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).
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
limits_maxviewsLongNo0 Must be an Long value greater than or equal to zero. If equal to zero the campaign will run with unlimited views. If greater than zero, the campaign will expire when the specified number of views has been delivered.
even_distributebooleanNofalse Must be a boolean value equal to either true or false. Can only be set to true if a schedule_start_date, schedule_stop_date, and limits_maxviews have been specified. In addition, the start and stop dates must both be in the future and the stop date must be after the start date.
limits_maxclicksLongNo0 Must be an Long value greater than or equal to zero. If equal to zero the campaign will run with unlimited clicks. If greater than zero, the campaign will expire when the specified number of clicks has been delivered.
limits_maxactionsLongNo0 Must be an Long value greater than or equal to zero. If equal to zero the campaign will run with unlimited actions. If greater than zero, the campaign will expire when the specified number of actions has been delivered.
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
geography_continentCSV
Integer
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may one or more of the following Integer values:
  • 1 = Africa
  • 2 = Antarctica
  • 3 = Asia
  • 4 = Australia
  • 5 = Europe
  • 6 = North America
  • 7 = South America
  • 8 = Oceania
geography_continent_unknownbooleanNofalse Must be a boolean value equal to either true or false
geography_countryCSV
String
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more ISO 3166 standard country codes: Country Code Reference List
geography_country_unknownbooleanNofalse Must be a boolean value equal to either true or false
geography_state_provinceCSVNoN/A Must be a CSV list of non-abbreviated state/province names separated by line breaks and containing no more than 65,535 characters. For US states and Canadian provinces you may use ISO 3166-2 standard abbreviations: US/Canada State/Province Abbreviations List Upon creation of the campaign, the abbreviations will be automatically converted into their full names.
geography_state_province_unknownbooleanNofalse Must be a boolean value equal to either true or false
geography_cityCSVNoN/A Must be a CSV list of non-abbreviated city names separated by line breaks and containing no more than 65,535 characters
geography_city_unknownbooleanNofalse Must be a boolean value equal to either true or false
geography_postalCSVNoN/A Must be a CSV list of zip/postal codes separated by line breaks and containing no more than 65,535 characters
geography_postal_unknownbooleanNofalse Must be a boolean value equal to either true or false
geography_dmaCSV
Integer
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more designated marketing area codes: DMA Code Reference List
geography_dma_unknownbooleanNofalse Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
keywords_targetCSVNoN/A Must be a CSV list of keywords and phrases separated by line breaks and containing no more than 65,535 characters. Keywords and phrases can be matched with fuzzy or exact algorithms, required, excluded, or by frequency. Please see the Keyword Targeting Syntax Reference for more information and examples.
keywords_forcebooleanNotrue Must be a boolean value equal to either true or false
keywords_blockCSVNoN/A Must be a CSV list of keywords and phrases separated by line breaks and containing no more than 65,535 characters. Keywords and phrases can be matched with fuzzy or exact algorithms, required, excluded, or by frequency. Please see the Keyword Targeting Syntax Reference for more information and examples.
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
network_target_ipsCSVNoN/A Must be a CSV list of IP addresses separated by line breaks and containing no more than 65,535 characters. Wildcards in the form of [0-255] can be used to match ranges of IP addresses. For example, you can use 192.168.1.[32-64] to match all IP addresses from 192.168.1.32 through 192.168.1.64. Additionally, partial IP addresses can be entered, such as 192.168.1. to match all IP addresses from 192.168.1.1 to 192.168.1.255 because IP addresses are matched from left to right.
network_block_ipsCSVNoN/A Must be a CSV list of IP addresses separated by line breaks and containing no more than 65,535 characters. Wildcards in the form of [0-255] can be used to match ranges of IP addresses. For example, you can use 192.168.1.[32-64] to match all IP addresses from 192.168.1.32 through 192.168.1.64. Additionally, partial IP addresses can be entered, such as 192.168.1. to match all IP addresses from 192.168.1.1 to 192.168.1.255 because IP addresses are matched from left to right.
network_target_hostsCSVNoN/A Must be a CSV list of hostnames separated by line breaks and containing no more than 65,535 characters. Wildcards in the form of * can be used to match variations of hostnames. For example, you can enter *.earthlink.net to match any hostname for that domain. Note that you can also use *.earthlink.* to match .com, .org, .net, etc... versions of a domain.
network_block_hostsCSVNoN/A Must be a CSV list of hostnames separated by line breaks and containing no more than 65,535 characters. Wildcards in the form of * can be used to match variations of hostnames. For example, you can enter *.earthlink.net to match any hostname for that domain. Note that you can also use *.earthlink.* to match .com, .org, .net, etc... versions of a domain.
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
publishersCSV
Integer
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must be the ID# of an existing publisher(s)
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
rates_advertiser_cpmDoubleNo5.00 Must be a Double greater than or equal to 0.00
rates_advertiser_cpcDoubleNo1.25 Must be a Double greater than or equal to 0.00
rates_advertiser_cpaDoubleNo25.00 Must be a Double greater than or equal to 0.00
rates_advertiser_flatDoubleNo2500.00 Must be a Double greater than or equal to 0.00
rates_publisher_cpmDoubleNo5.00 Must be a Double greater than or equal to 0.00
rates_publisher_cpcDoubleNo1.25 Must be a Double greater than or equal to 0.00
rates_publisher_cpaDoubleNo25.00 Must be a Double greater than or equal to 0.00
rates_publisher_flatDoubleNo2500.00 Must be a Double greater than or equal to 0.00
rates_notesStringNoN/A Must be a String containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
referrer_targetCSVNoN/A Must be a CSV list of URL(s) or path/file name patterns separated by line breaks and containing no more than 65,535 characters. Wildcards such as http://google.* may be used to match .com, .org, .net, etc... variations of a domain. Partial referrers may be entered, such as http://cnn.com/ to match all referrers that start with http://cnn.com/ since referrers are matched from left to right. Additionally, the www. prefix is stripped from referrers prior to comparison, so http://www.cnn.com/ is treated as equal to http://cnn.com/
referrer_blockCSVNoN/A Must be a CSV list of URL(s) or path/file name patterns separated by line breaks and containing no more than 65,535 characters. Wildcards such as http://google.* may be used to match .com, .org, .net, etc... variations of a domain. Partial referrers may be entered, such as http://cnn.com/ to match all referrers that start with http://cnn.com/ since referrers are matched from left to right. Additionally, the www. prefix is stripped from referrers prior to comparison, so http://www.cnn.com/ is treated as equal to http://cnn.com/
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
retargeting_min_daysIntegerNo0 Must be an Integer between 0 and 1,825 (up to 5 years)
retargeting_max_daysIntegerNo90 Must be an Integer between 0 and 1,825 (up to 5 years)
retargeting_targetCSV
String
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more segment aliases.
retargeting_blockCSV
String
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more segment aliases.
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
software_browserCSV
Integer
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more of the following Integer values:
  • 1 = AOL
  • 2 = MSN
  • 3 = Web TV
  • 4 = Lynx
  • 5 = NeoPlanet
  • 6 = NetCaptor
  • 7 = NetPositive
  • 8 = Opera
  • 9 = Internet Explorer
  • 10 = HotJava
  • 11 = Konqueror
  • 12 = OmniWeb
  • 13 = iCab
  • 14 = Safari
  • 15 = Netscape
  • 16 = Mozilla Firefox
  • 17 = Google Chrome
  • 18 = Java MIDP/CLDC (Mobile)
  • 19 = Firefox (Mobile)
  • 20 = Internet Explorer (Mobile)
  • 21 = Opera (Mobile)
  • 22 = Safari (Mobile)
software_osCSV
Integer
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and may include one or more of the following Integer values:
  • 1 = AIX
  • 2 = BSD
  • 3 = IRIX
  • 4 = Linux
  • 5 = Mac
  • 6 = Sun
  • 7 = Unix
  • 8 = Windows 3.x
  • 9 = Windows 95
  • 10 = Windows 98
  • 11 = Windows NT
  • 12 = Windows Me
  • 13 = Windows 2000
  • 14 = Windows XP
  • 15 = OS/2
  • 16 = HP-UX
  • 17 = Open VMS
  • 18 = Windows Vista
  • 19 = Windows 7
  • 20 = Windows 8
  • 21 = Android
  • 22 = BlackBerry
  • 23 = iOS
  • 24 = PalmOS
  • 25 = SymbianOS
  • 26 = Windows Mobile
  • 27 = Java/J2ME
Parameter NameParameter TypeRequired?Example ValueValidation Rules (If Applicable)
themesCSV
Integer
NoN/A This multiple value parameter can be in the form of either a single CSV parameter value or multiple parameter values and must be the ID# of an existing theme(s)

XML Response

Hyperlink /servlet/control/api/campaigns/update?secret=(key)&id=123&name=ACME+468x60+Banner


<success/>

JSON Response

Hyperlink /servlet/control/api/campaigns/update?secret=(key)&output=json&id=123&name=ACME+468x60+Banner


{ "success" : true }