Creative Instance API v4

Introduction

A Creative Instance is the entity in which an ad and a creative are linked within a placement.

You can use this API to:

  • Create a Creative Instance
  • Get a Creative Instance
  • List Creative Instances, by Ad Unit Node ID or Creative ID
  • Activate a Creative Instance
  • 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 at this time. Requests must be made in JSON format. Responses are returned in JSON as well.

Resources

URIs

EnvironmentURI
Staginghttps://api.stg.freewheel.tv/services/v4/creative_instances
Productionhttps://api.freewheel.tv/services/v4/creative_instances
NameTypeDescriptionCreatable?Updatable?Included in Basic GET?Required on Create?Notes
idFW_IDThe ID of the creative instanceNoNoYesN/A
ad_idFW_IDThe ID of the ad linked to the creative instanceNoNoYesYesEither ad_id or creative_id must be used with the list endpoint.
creative_idFW_IDThe ID of the creative linked to the creative instanceNoNoYesYesEither ad_id or creative_id must be used with the list endpoint.
placement_idFW_IDThe ID of the placement associated with the creative instanceNoNoYesN/A
tracking_nameStringThe name of the tracking metrics of the creative instanceYesYesNoNo
statusBooleanThe status of the creative instanceNoYesYesNoDefault is ACTIVE.

These values must be provided in ALL CAPITAL letters.