Overview
The Creative Instance API V4 allows users to manage creative instances. A creative instance is the entity in which an ad and a creative are linked within a placement.
Use the Creative Instance API V4 to:
- Create a creative instance
- Get a creative instance
- List creative instances by ad unit node ID or creative ID
- Activate or deactivate a creative instance
- Update a creative instance
- Delete a creative instance
NOTE
The Creative Instance API V4 is JSON-only. XML is not supported.
Uniform Resource Identifiers (URI)
| Environment | URI |
|---|---|
| Staging | https://api.stg.freewheel.tv/services/v4/creative_instances |
| Production | https://api.freewheel.tv/services/v4/creative_instances |
Attributes
| Name | Type | Description | Creatable? | Updatable? | Included in Basic GET? | Required on Create? | Notes |
|---|---|---|---|---|---|---|---|
| id | FW_ID | The ID of the creative instance | No | No | Yes | N/A | |
| ad_id | FW_ID | The ID of the ad linked to the creative instance | No | No | Yes | Yes | Either ad_id or creative_id must be used with the list endpoint. |
| creative_id | FW_ID | The ID of the creative linked to the creative instance | No | No | Yes | Yes | Either ad_id or creative_id must be used with the list endpoint. |
| placement_id | FW_ID | The ID of the placement associated with the creative instance | No | No | Yes | N/A | |
| tracking_name | String | The name of the tracking metrics of the creative instance | Yes | Yes | No | No | |
| status | Boolean | The status of the creative instance | No | Yes | Yes | No | Default is ACTIVE. These values must be provided in ALL CAPITAL letters. |