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:
- Name
- 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 URI | URI |
---|---|
Production | https://api.freewheel.tv/services/v3/advertiser.xml?[parameter1]=[query1]&... |
Staging | https://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/Node | Description | Data Type(s) | Creatable? | Updateable? | Included in basic GET? | Comments |
---|---|---|---|---|---|---|
id | Resource ID | FW_ID | No | No | Yes | Assigned automatically during POST |
name | The name of the advertiser | string | Required | Yes | Yes | |
external_id | External ID for the advertiser | string | Yes | Yes | Yes | |
billing_term | BILLING Term for the advertiser in the MRM system | string | Yes | Yes | Yes | |
contacts | Contacts for the advertiser | contacts attributes | Yes | Yes | No | |
assignments | User Assignments of the advertiser | assignment attributes | Yes | Yes | No | |
address | Address of the advertiser | address attributes | Yes | Yes | No | |
status | Status for the advertiser |
| No | No | Yes | These 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/Node | Description | Data Type(s) | Creatable? | Updateable? |
---|---|---|---|---|
contact_id | FreeWheel ID | No | No | |
contact_type |
| Yes | Yes | |
first_name | string | Yes | Yes | |
last_name | string | Yes | Yes | |
title | string | Yes | Yes | |
address_1 | string | Yes | Yes | |
address_2 | string | Yes | Yes | |
city | string | Yes | Yes | |
state_id | State from Geography Data | integer | Yes | Yes |
postal_code | string | Yes | Yes | |
country_id | Country ID from Geography Data | integer | Yes | Yes |
email_address_1 | string | Yes | Yes | |
email_address_2 | string | Yes | Yes | |
email_address_3 | string | Yes | Yes | |
work_phone | string | Yes | Yes | |
home_phone | string | Yes | Yes | |
fax_phone | string | Yes | Yes | |
other_phone | string | Yes | Yes | |
im_type | string | Yes | Yes | |
im_id | string | Yes | Yes | |
url | string | Yes | Yes |
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/Node | Description | Data Type(s) | Creatable? | Updateable? |
---|---|---|---|---|
user_id | Valid user ID | integer | Yes | Yes |
user_full_name | User full name | string | No | No |
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/Node | Description | Data Type(s) | Creatable? | Updateable? |
---|---|---|---|---|
address_1 | string | Yes | Yes | |
address_2 | string | Yes | Yes | |
city | string | Yes | Yes | |
postal_code | Local postal code | Integer | Yes | Yes |
state_id | State ID from Geography Data | string | Yes | Yes |
country_id | Country ID from Geography Data | Integer | Yes | Yes |