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
Create an Advertiser .
Add agency relationships with Add Advertiser Relationships .
Activate an Advertiser
Use the advertiser to Create a Campaign .
For more information, see Workflow for creating a new Advertiser or Agency .
Environment URI Production https://api.freewheel.tv/services/v3/advertiser.xml
Staging https://api.stg.freewheel.tv/services/v3/advertiser.xml
The following attributes are used when creating an advertiser. For an interactive example, see Create an Advertiser .
Name Type Description name string Name of the advertiser. Mandatory field external_id string External ID for the advertiser metadata string Metadata of the advertiser billing_term string Billing term for the advertiser in the Streaming Hub system assignments object User assignments of the advertiser address object Address fields of the advertiser contacts object Contacts for the advertiser
Name Type Description assigned_user integer Object containing valid user IDs
Name Type Description user_id integer Valid user ID
Name Type Description industry_id integer Valid industry ID
This attribute set identifies an address for the advertiser. This attribute set is unrelated to contacts' address fields.
Name Type Description address_1 string Address line 1 address_2 string Address line 2 country_id Integer Country ID from Geography Data state_id string State ID from Geography Data city string City postal_code Integer Local postal code
Multiple contacts can be added to an advertiser.
Name Type Description contact_type string Valid values include PRIMARY, BILLING, or ADDITIONAL. ADDITIONAL is the default value first_name string First name last_name string Last name title string Title address_1 string Address line 1 address_2 string Address line 2 city string City state_id integer State from Geography Data postal_code string Postal code country_id integer Country ID from Geography Data email_address_1 string Email address 1 email_address_2 string Email address 2 email_address_3 string Email address 3 work_phone string Work phone home_phone string Home phone fax_phone string Fax phone other_phone string Other phone im_type string Custom IM type, such as Skype im_id string Custom IM ID, such as skype_id url string URL