Introduction

A campaign is the order of the MRM sale structure that houses all billable sales within a single product messaging. Technically speaking, campaign is a grouping of Insertion Orders that broadly organizes sales for a particular advertiser. See MRM Campaign Organization.

You can use this API to accomplish the following campaign tasks:

Get List of campaigns
Create campaign
Update campaign
Delete campaign
Show campaign information
List insertion orders of a campaign

Resources

URI(s)

The Campaign API v3 identifies these Uniform Resource Identifiers (URIs):

Environment	URI
Instance	`https://api.freewheel.tv/services/v3/campaign/[FW_ID].xml?[parameter1]=[query1]&...`
List	`https://api.freewheel.tv/services/v3/campaign.xml?[parameter1]=[query1]&...`
List Insertion Orders	`https://api.freewheel.tv/services/v3/campaign/[FW_ID]/insertion_orders.xml?[parameter1]=[query1]&...`

Campaign API Attributes

Attributes represent and describe data associated with an object, in this case the Campaign object. Attributes are organized in sets. Each attribute set determines the fields available during data entry, and the values that appear to the client. Use Campaign API attributes in conjunction with Campaign API methods to accomplish your ad tech objectives.

Basic Attributes

Basic attributes describe fundamental properties of a campaign.

Function/Node	Description	Value(s)*	Creatable?*	Updateable?	Included in basic GET?	Comments
id	The FW ID of the campaign	FW_ID	No	No	Yes
name	The name of the campaign	String	Required	Yes	Yes
advertiser_id	The FW ID of the advertiser to which the campaign belongs	FW_ID	Required	Yes	Yes
agency_id	The FW ID of the agency to which the campaign belongs	FW_ID	No	Yes	Yes	This field is automatically cleared when updating `advertiser_id`.
description	The Description of the campaign	String	Yes	Yes	Yes
external_id	The external ID of the campaign	String	Yes	Yes	Yes
metadatas	The metadata of the campaign	Metadatas Attributes	Yes	Yes	No
assignments	The user assignment of the campaign	Assignments Attributes	Yes	Yes	No
delivery	The delivery info of the campaign	Delivery Attributes	Yes	Yes	No
status	The status of the campaign	'ACTIVE', 'IN_ACTIVE', 'FINISHED'.	No	No	Yes	These values must be provided in ALL CAPITAL letters.
start_date	The start date of the campaign	Date-Time (YYYY-MM-DD HH:MM:SS UTC)	No	No	Yes
end_date	The end date of the campaign	Date-Time (YYYY-MM-DD HH:MM:SS UTC)	No	No	Yes
created_at	The create time of the campaign	Date-Time (YYYY-MM-DD HH:MM:SS UTC)	No	No	Yes
updated_at	The last updated time of the campaign	Date-Time (YYYY-MM-DD HH:MM:SS UTC)	No	No	Yes
network_id	The network ID of the campaign	FW_ID	No	No	Yes

Assignments Attribute

Function/Node	Description	Data Type(s)	Creatable?	Updateable?	Included in basic GET?
assigned_user	Array of assigned user(s)	Assigned User Attributes	Yes	Yes	Yes

Assigned User Attributes - Child of Assignments Attribute

Function/Node	Description	Data Type(s)	Creatable?	Updateable?	Included in basic GET?
user_id	Value user ID	Integer	Yes	Yes	Yes
user_full_name	User full name	String	No	No	Yes

Delivery Attribute

Function/Node	Description	Data Type(s)*	Creatable?	Updateable?	Included in basic GET?	Comments
frequency_cap	Set of frequency caps, for each frequency cap	Frequency Cap Attributes	Yes	Yes	No	Only 3 frequency caps are supported at most.

Frequency Cap Attributes - Child of Delivery Attribute

The following attributes are all included in basic GET requests.

Function/Node	Description	Data Type(s)*	Creatable?	Updateable?
value	The cap value	Yes	Yes	Yes
type	The cap type valid values: IMPRESSION PACKAGE	Enum	Yes	Yes
period	The cap period valid enum values: TEN_MIN HOUR DAY WEEK 30DAYS STREAM ASSET SITE_SECTION CAMPAIGN	Integer: Specified in minutes	Yes	Yes

Campaign API V3