Advertiser API V3

Overview

The Advertiser API V3 manages advertisers in a network. This API enables users to execute the following operations on advertisers and their related attributes:

  • Obtain a high-level view of active campaigns, divided by advertiser
  • View a list of information about a specific advertiser, such as its contact information or financial information
  • Return a list of advertisers for de-duplicating, consolidating, or reconciling an advertiser list
  • Create an advertiser
  • Edit an advertiser
  • Set parent agency and brand relationships

Workflows

Create an Active Advertiser

  1. Create an Advertiser.
  2. Add agency relationships with Add Advertiser Relationships.
  3. Activate an Advertiser
  4. Use the advertiser to Create a Campaign.

For more information, see Workflow for creating a new Advertiser or Agency.

Uniform Resource Identifiers (URI)

EnvironmentURI
Productionhttps://api.freewheel.tv/services/v3/advertiser.xml
Staginghttps://api.stg.freewheel.tv/services/v3/advertiser.xml

Attributes

The following attributes are used when creating an advertiser. For an interactive example, see Create an Advertiser.

NameTypeDescription
namestringName of the advertiser. Mandatory field
external_idstringExternal ID for the advertiser
metadatastringMetadata of the advertiser
billing_termstringBilling term for the advertiser in the Streaming Hub system
assignmentsobjectUser assignments of the advertiser
addressobjectAddress fields of the advertiser
contactsobjectContacts for the advertiser

Assignments Object

NameTypeDescription
assigned_userintegerObject containing valid user IDs

Assigned_User Object

NameTypeDescription
user_idintegerValid user ID

Industry Object

NameTypeDescription
industry_idintegerValid industry ID

Address Object

This attribute set identifies an address for the advertiser. This attribute set is unrelated to contacts' address fields.

NameTypeDescription
address_1stringAddress line 1
address_2stringAddress line 2
country_idIntegerCountry ID from Geography Data
state_idstringState ID from Geography Data
citystringCity
postal_codeIntegerLocal postal code

Contacts Object

Multiple contacts can be added to an advertiser.

NameTypeDescription
contact_typestringValid values include PRIMARY, BILLING, or ADDITIONAL. ADDITIONAL is the default value
first_namestringFirst name
last_namestringLast name
titlestringTitle
address_1stringAddress line 1
address_2stringAddress line 2
citystringCity
state_idintegerState from Geography Data
postal_codestringPostal code
country_idintegerCountry ID from Geography Data
email_address_1stringEmail address 1
email_address_2stringEmail address 2
email_address_3stringEmail address 3
work_phonestringWork phone
home_phonestringHome phone
fax_phonestringFax phone
other_phonestringOther phone
im_typestringCustom IM type, such as Skype
im_idstringCustom IM ID, such as skype_id
urlstringURL