Overview
The Campaign API V3 allows users to manage campaigns and retrieve a complete list of associated insertion orders. Broadly speaking, a campaign is the part of the MRM sale structure that encompasses all billable sales under a single product messaging. In technical terms, a campaign is a grouping of insertion orders that organizes sales for a particular advertiser.
Use the Campaign API to accomplish the following tasks:
- List campaigns
- Create a campaign
- Update a campaign
- Show campaign information
- Delete a campaign
- List insertion orders of a campaign
Uniform Resource Identifiers (URI)
Campaigns
| Environment | URI |
|---|---|
| Production | https://api.freewheel.tv/services/v3/campaign.xml |
| Staging | https://api.stg.freewheel.tv/services/v3/campaign.xml |
Insertion Orders
| Environment | URI |
|---|---|
| Production | https://api.freewheel.tv/services/v3/campaign/{campaign_id}/insertion_orders.xml |
| Staging | https://api.stg.freewheel.tv/services/v3/campaign/{campaign_id}/insertion_orders.xml |
Attributes
The following attributes are used when creating a campaign with the POST method. For an interactive example, see Create a Campaign.
| Name | Type | Description |
|---|---|---|
| name | string | Name of the campaign |
| description | string | Description of the campaign |
| advertiser_id | integer | Advertiser ID of the campaign |
| agency_id | integer | Agency ID of the campaign |
| external_id | string | External ID of the campaign |
| assignments | array | User assignment of the campaign |
| delivery | array | Delivery info of the campaign |
Assignments Child Attribute
| Name | Type | Description |
|---|---|---|
| assigned_user | object | Assigned user of the campaign |
Assigned User Child Attribute
| Name | Type | Description |
|---|---|---|
| user_id | integer | Assigned user ID |
Delivery Child Attribute
| Name | Type | Description |
|---|---|---|
| value | number | Frequency cap value |
| type | string | Frequency cap type. Valid values include: - IMPRESSION - PACKAGE |
| period | string | Frequency cap period. Specify the number of minutes with an integer or use one of the following valid values: - TEN_MIN - HOUR - DAY - WEEK - 30DAYS - STREAM - ASSET - SITE_SECTION - CAMPAIGN |
| advanced_fc_identity_level | string | Frequency cap identity level |