Overview
The Inventory Package API V4 can create, retrieve, and update inventory packages in your network. Inventory packages consist of standardized inventory (standard attributes) and non-standardized inventory (network items). Once created, inventory packages can be used for campaign targeting.
Marketplace clients can use this API to accomplish the following tasks:
- Get a list of inventory packages belonging to the current network. Retrieved IDs are essential for further Marketplace Inventory trafficking through Placement API V3
- Create inventory package that include or exclude standard attributes and networks items
- Update inventory packages with new targeting goals
- Activate or deactivate existing inventory packages
Note
To enable Marketplace, contact your account representative.
Note
This API supports JSON format only. XML format is not supported.
General Resource Uniform Resource Identifiers (URI)
| Type | URI |
|---|---|
| Production Instance | https://api.freewheel.tv/services/v4/inventory_packages?{param1}={query1}&... |
| Staging Instance | https://api.stg.freewheel.tv/services/v4/inventory_packages?{param1}={query1}&... |
Query Parameters
Note
Parameters and values are case-sensitive.
| Parameter | Type | Description |
|---|---|---|
| name | string | Specify filtering criteria by inventory package name. Filtering can match names composed of continuous characters with specified strings. Maximum character length is 255. For example, a request containing ?name=STB retrieves a list of all inventory packages whose names contains the characters STB, like STBVOD package or Linear STB package. |
| status | enum | Specify filtering criteria by inventory package status. Valid values:
|
| page | int32 | Specify the number of pages in the returned list. Default value = 1 Maximum value = 1000 |
| per_page | int32 | Specify the number of items shown on each page. Default value = 20 Valid value range = 5-50 |
| updated_at | string | Use the following syntax to filter inventory packages by last updated time:
Use the following syntax to sort the list of inventory packages by the time of last updated:
|
Request Body Attributes
User can include these attributes when creating an inventory package with the POST method. This table also provides information on whether the attribute can be updated via PUT. For an interactive example, see Create Inventory Package
| Name | Type | Description | Mandatory? | Creatable? | Updatable? |
|---|---|---|---|---|---|
| id | FW_ID | ID of an inventory package | Yes | Yes | No |
| name | string | Name of an inventory package | Yes | Yes | Yes |
| description | string | Description of an inventory package | No | Yes | Yes |
| status | enum | Status of an inventory package Valid values: ACTIVE INACTIVE | Yes | No | Yes |
| targeting | object | INCLUDE or EXCLUDE standard attributes and network items. Must include at least 1 standard attribute. | Yes, if SSP targeting is not configured. | Yes | Yes |
| ssp_targeting | object | INCLUDE or EXCLUDE SSP-specific standard attributes and network items. Must include at least 1 standard attribute. | Yes, if MRM targeting is not configured. | Yes | Yes |
| created_at | date-time string | Creation time of an inventory package | Yes | ||
| updated_at | date-time string | Last-updated time of an inventory package | Yes |
Targeting Attributes
The following attributes apply to thetargeting andssp_targetingobjects.
Note
SSP targeting is gated by a network function. Please contact your FreeWheel account team to enable this feature.
| Name | Type | Description | Mandatory? | Creatable? | Updatable? |
|---|---|---|---|---|---|
| include | object | Consists of sets of standard attributes and network items and their logical relationship | Yes | Yes | Yes |
| exclude | object | Consists of sets of standard attributes and network items and their logical relationship | No | Yes | Yes |
Include Object Attributes
| Name | Type | Description | Mandatory? | Creatable? | Updatable? |
|---|---|---|---|---|---|
| sets | array | Array of items such as standard attributes and network items that need to be targeted | No | Yes | Yes |
| item_sets | array of objects | List of items that need to be targeted | No | Yes | Yes |
| relationship | string | Valid values: AND OR | Yes | Yes | Yes |
Exclude Object Attributes
| Name | Type | Description | Mandatory? | Creatable? | Updatable? |
|---|---|---|---|---|---|
| item_sets | array of objects | Sets of standard attributes or network item values, and their logical relationship | Yes | Yes | Yes |
Item Sets Attributes
| Name | Type | Description | Mandatory? | Creatable? | Updatable? |
|---|---|---|---|---|---|
| item_lists | array of objects | List of items to target | Yes | Yes | Yes |
| targeting_type | string | Valid values: For targeting, CONTENT, PLATFORM, GEO, VIDEO, SITE For SSP targeting, CONTENT, PLATFORM, GEO, SSP | Yes | Yes | Yes |
| relationship | string | Valid values: AND OR | Yes | Yes | Yes |
Item Lists Attributes
| Name | Type | Description | Mandatory? | Creatable? | Updatable? |
|---|---|---|---|---|---|
| relationship | string | Valid values: AND OR | Yes | Yes | Yes |
| items | array of objects | Array of items such as standard attributes and network items based on the selected targeting type | Yes | Yes | Yes |
Item Lists Object Attributes
| Name | Type | Description | Mandatory? | Creatable? | Updatable? |
|---|---|---|---|---|---|
| id | string | ID of the targeted item | Yes | Yes | Yes |
| type | string | Valid values: For targeting, STANDARD_CONTENT_PROGRAMMER, STANDARD_CONTENT_BRAND, STANDARD_CONTENT_CHANNEL, INVENTORY_SOURCE, STANDARD_GENRE, STANDARD_CONTENT_LANGUAGE, STANDARD_CONTENT_RATING, STANDARD_CONTENT_FORM, STREAM_MODE, STANDARD_CONTENT_DAYPART, STANDARD_SUBSCRIPTION_MODEL, STANDARD_CONTENT_CREDENTIAL_STATUS, STANDARD_CONTENT_TERRITORY, STANDARD_CONTENT_SERIES, ENDPOINT, ENDPOINT_OWNER, STANDARD_DEVICE, STANDARD_ENVIRONMENT, STANDARD_OS, IP_ENABLED_AUDIENCE,GEO, STATE, DMA, POSTAL_CODE, COUNTRY, ASSET, ASSET_GROUP, SERIES, SECTION, SECTION_GROUP, SITE For SSP targeting, STANDARD_SSP_CHANNEL, STANDARD_PUBLISHER, STANDARD_IAB_CATEGORY, STANDARD_SSP_ENDPOINT, STANDARD_APP, STANDARD_SITE_DOMAIN | Yes | Yes | Yes |