Introduction
A content package is an advanced combination of different content assets such as videos, sites, groups, etc. Once created, a Content Package can be targeted when trafficking a Placement.
The differences between this API and Placement API v3 content targeting via content package is that this API is used to create, edit and view a network's content package, whereas the Placement API v3 content targeting via content package is used to set content targeting using a predefined content package, either created by this API or in the UI.
You can use this API to accomplish the following content package tasks:
- View a content package
- Create a content package
- Edit a content package
Related Documentation
Refer to the following documentation for more information about FreeWheel products and APIs:
Resources
URI(s)
The Content Package API v3 identifies two Uniform Resource Identifiers (URIs), a List and an Instance as identified in the following table:
| Type of URI | URI |
|---|---|
| Production | https://api.freewheel.tv/v3/content_packages/[FW_ID].xml?[parameter1]=[query1]&... |
| Staging | https://api.stg.freewheel.tv/v3/content_packages/[FW_ID].xml?[parameter1]=[query1]&... |
Content Package API Attributes
Attributes represent and describe data associated with an object, in this case the Content Package object. Attributes are organized in sets. The attribute set determines the fields that are available during data entry, and the values that appear to the client. Use Content Package API Attributes in conjunction with Content Package API methods to accomplish your ad tech objectives.
Basic Attributes
Basic attributes describe fundamental properties of a content package.
The attributes below can all be included in basic GET requests.
| Parameter | Description | Data Type(s) | Creatable? | Updateable? | Comments |
|---|---|---|---|---|---|
| id | The ID of the content package | FW_ID | No | No | Assigned automatically upon creation of the package |
| name | The Name of the content package | String | Required | Yes | Content Package Name must be unique in a network |
| include | Contains all media items and their MRM IDs. Possible media object:
| Normal Include/Exclude Content Package Details ; Advanced Include Content Package Details | Yes | Yes | |
| exclude | Same format as include | Normal Include/Exclude Content Package Details | Yes | Yes | |
| created_at | Date and time that the Content Package is created | Datetime | No | No | The Datetime format follows ISO 8061 format in UTC timezone, with precision to seconds. For example: 2016-09-04T10:59:01Z |
| status | The status of the content package |
| No | Yes | These values must be provided in ALL CAPITAL letters. When a package is created via the API the status will be set to 'INACTIVE' by default. |
Normal Include/Exclude Content Package Details
The attributes below can all be included in basic GET requests.
| Function/Node | Description | Value Type | Creatable? | Updateable? |
|---|---|---|---|---|
| video | Video asset content items | Set<FW_ID> | Yes | Yes |
| series | Series content items | Set<FW_ID> | Yes | Yes |
| video_group | Video group content items | Set<FW_ID> | Yes | Yes |
| site_section | Site section content items | Set<FW_ID> | Yes | Yes |
| site | Site content items | Set<FW_ID> | Yes | Yes |
| site_group | Site group content items | Set<FW_ID> | Yes | Yes |
Advanced Include Content Package Details
The attributes below can be included in basic GET requests.
| Function/Node | Description | Value Type | Creatable? | Updateable? | Comments |
|---|---|---|---|---|---|
| set | Sets of content object groups | Set | Yes | Yes | A maximum of Only support 3 sets is supported. |
| relation_between_sets | The relationship between two sets | Set<'AND', 'OR'> | Yes | Yes | Valid and required only when there are two or more sets; The number of relation_between_sets node should be set to - 1. |
Set Attributes - Child Attributes of Advanced Include Content Package Details Attributes
The attributes below are all creatable and can be included in basic GET requests.
| Function/Node | Description | Value Type | Updateable? | Comments |
|---|---|---|---|---|
| video | Video asset content items | Set<FW_ID> | Yes | |
| series | Series content items | Set<FW_ID> | Yes | |
| video_group | Video group content items | Set<FW_ID> | Yes | |
| site_section | Site section content items | Set<FW_ID> | Yes | |
| site | Site content items | Set<FW_ID> | Yes | |
| site_group | Site group content items | Set<FW_ID> | Yes | |
| relation_in_set | The relationship of content objects within the set | 'AND', 'OR' | Yes | A single set can only have one relation_in_set node. |