Advertiser API V3

Introduction

An advertiser is the entity for which an advertisement speaks and which originates the payment for an advertisement.

The Advertiser API manages advertisers in your network. Version 3 of the Advertiser API enables you 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 when you are de-duplicating, consolidating, or reconciling an advertiser list
  • Create an advertiser
  • Edit an advertiser
  • Set parent agency and brand relationships
  • Add new campaigns to an advertiser

Related Documentation

Refer to the following documentation for more information about FreeWheel products and APIs:

Before You Begin

Set up your agency/advertiser relationships before you create a campaign.

How to Create a New Advertiser

You can find instructions for creating and approving a new advertiser here.

In MRM, an advertiser has two required fields:

  1. Name
  2. Industry Assignment

You can also include other metadata such as contact details.

Resources

URI(s)

The Agency API v3 identifies two Uniform Resource Identifiers (URIs) as identified in the following table:

Type of URIURI
Productionhttps://api.freewheel.tv/services/v3/advertiser.xml?[parameter1]=[query1]&...
Staginghttps://api.stg.freewheel.tv/services/v3/advertiser.xml?[parameter1]=[query1]&...

Advertiser Attributes

Basic Attributes

This attribute set identifies and defines an advertiser. Basic attributes describe fundamental properties of an advertiser.

Function/NodeDescriptionData Type(s)Creatable?Updateable?Included in basic GET?Comments
idResource IDFW_IDNoNoYesAssigned automatically during POST
nameThe name of the advertiserstringRequiredYesYes
external_idExternal ID for the advertiserstringYesYesYes
billing_termBILLING Term for the advertiser in the MRM systemstringYesYesYes
contactsContacts for the advertisercontacts attributesYesYesNo
assignmentsUser Assignments of the advertiserassignment attributesYesYesNo
addressAddress of the advertiseraddress attributesYesYesNo
statusStatus for the advertiser
  • APPROVED
  • INACTIVE
NoNoYesThese values must be provided in ALL CAPITAL letters.

Contacts Attributes

This attribute set identifies contacts for an advertiser. Contacts attributes identify various contacts for the advertiser, including ID, type of contact, name, title, address, email address, phone, and website. Use code similar to the Contacts POST example when you want to add a contact to the advertiser. You can add multiple contacts to each advertiser, as necessary.

All of the parameters below are included in the basic GET.

Function/NodeDescriptionData Type(s)Creatable?Updateable?
contact_idFreeWheel IDNoNo
contact_type
  • PRIMARY
  • BILLING
  • ADDITIONAL (Default setting)
YesYes
first_namestringYesYes
last_namestringYesYes
titlestringYesYes
address_1stringYesYes
address_2stringYesYes
citystringYesYes
state_idState from Geography DataintegerYesYes
postal_codestringYesYes
country_idCountry ID from Geography DataintegerYesYes
email_address_1stringYesYes
email_address_2stringYesYes
email_address_3stringYesYes
work_phonestringYesYes
home_phonestringYesYes
fax_phonestringYesYes
other_phonestringYesYes
im_typestringYesYes
im_idstringYesYes
urlstringYesYes

Assignment Attributes

This attribute set identifies an assignment and user role/group for the advertiser. Assignment attributes define the assigned users for this advertiser in combination with the Assigned User attributes set below.

Assigned User Attributes - Child Attributes of Assignment Attributes

This attribute set assigns a user for this advertiser. Assigned User attributes define a user ID, name, and relates to the primary user role for an advertiser.

All of the parameters below are included in the basic GET.

Function/NodeDescriptionData Type(s)Creatable?Updateable?
user_idValid user IDintegerYesYes
user_full_nameUser full namestringNoNo

Address Attributes

This attribute set identifies an address for the advertiser. Address attributes define the Advertiser's address. This attribute set is unrelated to the contacts' address fields.

All of the parameters below are included in the basic GET.

Function/NodeDescriptionData Type(s)Creatable?Updateable?
address_1stringYesYes
address_2stringYesYes
citystringYesYes
postal_codeLocal postal codeIntegerYesYes
state_idState ID from Geography DatastringYesYes
country_idCountry ID from Geography DataIntegerYesYes