Introduction
A Creative Instance is the entity in which an ad and a creative are linked within a placement.
Users can leverage this API to:
- Create a Creative Instance
- Get a Creative Instance
- List Creative Instances by Ad Unit Node ID or Creative ID
- Activate/deactivate a Creative Instance
- Update a Creative Instance
- Delete a Creative Instance
Note
The Creative Instance API v4 does not support XML requests or responses. Requests must be made in JSON format. Responses are returned in JSON as well.
Resources
URIs
| Environment | URI |
|---|---|
| Staging | https://api.stg.freewheel.tv/services/v4/creative_instances |
| Production | https://api.freewheel.tv/services/v4/creative_instances |
| 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. |
| created_at | DateTime | The time and day the creative instance was created. | No | No | Yes | N/A | This field reflects the first time the creative was linked to the ad unit. This field will not change if the the creative and ad unit are unlinked and relinked. |
| updated_at | DateTime | The time and day the creative instance was updated. | No | No | Yes | N/A |