Version 5.0
AdvertServe User Manual :: v5.0

Advertisers :: Create API Module

Create

Description

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

Module URI

Hyperlink /servlet/control/api/advertisers/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)
nameStringYesACME Company(None) Must be a String containing no more than 80 characters
usernameStringYesacme(None) Must be a String containing no more than 16 alphanumeric characters
passwordStringYesacme123(None) Must be a String containing between 6 and 16 characters
basisStringNostandardstandard Must be a String value equal to either standard or budget
statusbooleanNotruetrue Must be a boolean value equal to either true or false
remindersbooleanNotruetrue 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)
config_home_date_rangeStringNothirtyseven Must be a String equal to one of the following values:
  • today
  • yesterday
  • week
  • seven
  • lastweek
  • fourteen
  • month
  • thirty
  • lastmonth
  • quarter
  • ninety
  • lastquarter
config_home_media_filterStringNot_1(None) Optionally can be a String equal to t_# or s_# where # is the ID# of a base media type or size
config_home_compare_byStringNoclickratioecpm Must be a String equal to one of the following values:
  • sumviews
  • sumclicks
  • clickratio
  • sumactions
  • actionratio
  • subtotal
  • ecpm
config_home_item_countIntegerNo5025 Must be an Integer between 25 and 100
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
config_recent_email_frequencyStringNodailynever Must be a String equal to one of the following values:
  • never
  • daily
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday
  • sunday
  • weekly
  • biweekly
  • monthly
config_recent_email_formatStringNoTXTHTML Must be a String equal to one of the following values:
  • HTML
  • TXT
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
config_reports_hide_graphsbooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_hide_emptybooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_include_definitionsbooleanNofalsetrue Must be a boolean value equal to either true or false
config_reports_data_advertiserbooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_campaignbooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_conversionsbooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_custombooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_data_groupbooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_mediabooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_publisherbooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_zonebooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_dailybooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_eventsbooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_geographybooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_data_hourlybooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_interactivebooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_keywordsbooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_data_languagesbooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_data_networkbooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_data_referrerbooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_data_roibooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_sizebooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_softwarebooleanNotruefalse Must be a boolean value equal to either true or false
config_reports_data_videobooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_viewabilitybooleanNotruetrue Must be a boolean value equal to either true or false
config_reports_data_weatherbooleanNotruetrue Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
info_companyStringNoACME(None) Must be a String containing no more than 48 characters
info_nameStringYesJohn Doe(None) Must be a String containing no more than 48 characters
info_titleStringNoOwner(None) Must be a String containing no more than 48 characters
info_emailEmailYesjohn@acme.com(None) Must be an e-mail address containing no more than 64 characters
info_websiteURLNohttp://www.acme.com/(None) Must be a HTTP or HTTPS URL containing no more than 64 characters
info_addressStringNo123 Acme Street
New York, NY 10001
(None) Must be a String containing no more than 65,535 characters
info_phoneStringNo123-456-7890(None) Must be a String containing no more than 48 characters
info_mobileStringNo123-456-7890(None) Must be a String containing no more than 48 characters
info_faxStringNo123-456-7890(None) Must be a String containing no more than 48 characters
info_notesStringNoN/A(None) Must be a String containing no more than 65,535 characters
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
contacts_name[1-5]StringMaybeJane Doe(None) Must be a String containing no more than 48 characters. Not required by default. However, it is required if contacts_email[1-5] has a value.
contacts_title[1-5]StringNoOwner(None) Must be a String containing no more than 48 characters
contacts_email[1-5]EmailMaybejane@acme.com(None) Must be an e-mail address containing no more than 64 characters. Not required by default. However, it is required if contacts_name[1-5] has a value.
contacts_phone[1-5]StringNo123-456-7890(None) Must be a String containing no more than 48 characters
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
permissionsCSV
String
NoN/A(None) 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 String values:

LOGIN, ACCOUNTS, ACCOUNTS_VIEW, ACCOUNTS_EDIT, MEDIA, MEDIA_LISTING, MEDIA_SEARCH, MEDIA_PREVIEW, MEDIA_VIEW, MEDIA_STATUS, FILES, FILES_NEW, FILES_RENAME, CAMPAIGNS, CAMPAIGNS_LISTING, CAMPAIGNS_SEARCH, CAMPAIGNS_VIEW, CAMPAIGNS_STATUS, REPORTS, REPORTS_ACCOUNTING, REPORTS_GENERAL, REPORTS_CAMPAIGNS, REPORTS_GROUPS, REPORTS_MEDIA, REPORTS_PUBLISHERS, REPORTS_ZONES, REPORTS_CONVERSIONS, REPORTS_CUSTOM, REPORTS_DAILY, REPORTS_ENGAGEMENT, REPORTS_EVENTS, REPORTS_GEOGRAPHY, REPORTS_HOURLY, REPORTS_INTERACTIVE, REPORTS_KEYWORDS, REPORTS_LANGUAGES, REPORTS_NETWORK, REPORTS_REFERRER, REPORTS_ROI, REPORTS_SOFTWARE, REPORTS_VIDEO, REPORTS_VIEWABILITY, REPORTS_WEATHER, TOOLS

If omitted the advertiser will be created with the default account permissions!
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
prebid_adapterStringNoN/A(None) Must be the name of a valid Prebid.js adapter that is installed in the system.
prebid_adjustmentDecimalNo0.8000.000 Optional percentage adjustment that can be applied to bids to account for gross versus net, which must be expressed as a decimal between 0.00 and 1.00
prebid_parameter_name[1-10]StringNoN/A(None) Optional parameter names that will be sent with bids. Must be a String containing no more than 48 characters.
prebid_parameter_value[1-10]StringNoN/A(None) Optional parameter values that will be sent with bids. Must be a String containing no more than 48 characters.
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
competitorsCSV
Integer
NoN/A(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 advertiser(s)
competitors_selfbooleanNofalsefalse Must be a boolean value equal to either true or false
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
gabooleanNotruefalse Must be a boolean value equal to either true or false
ga_sourceStringNoacme(Your Customer ID) Must be a String containing no more than 80 characters
ga_mediumStringNoemailbanner Must be a String containing no more than 80 characters
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
optoutCSV
Integer
NoN/A(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)
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
pixels_viewIntegerNo123(None) Must be the ID# of an existing pixel
pixels_clickIntegerNo123(None) Must be the ID# of an existing pixel
pixels_actionIntegerNo123(None) Must be the ID# of an existing pixel
pixels_retargetingIntegerNo123(None) Must be the ID# of an existing pixel
Parameter NameParameter TypeRequired?Example ValueDefault ValueValidation Rules (If Applicable)
regulations_actionsStringNoN/A(None) Must be the alias of an existing segment, which will render actions non-countable when users are tagged with it.
regulations_countryCSV
String
NoN/A(None) 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
regulations_keywordsCSV
String
NoN/A(None) Must be a CSV list of keywords and phrases separated by line breaks and containing no more than 262,144 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.

XML Response

Hyperlink /servlet/control/api/advertisers/create?secret=(key)&name=ACME&username=acme&password=acme123&info_name=John+Doe&info_email=john@acme.com


<id>123</id>

JSON Response

Hyperlink /servlet/control/api/advertisers/create?secret=(key)&output=json&name=ACME&username=acme&password=acme123&info_name=John+Doe&info_email=john@acme.com


{ "id" : 123 }