campaign

Add Campaign

Changed on

Add a Campaign

post/campaign

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/campaign
  • Auth
    none declared

Request body application/x-www-form-urlencoded

typestring required

Type of campaign, either list|ad

namestring required

Name for this Campaign

folderIdinteger

Folder ID to which this object should be assigned to

layoutIdsinteger[]

An array of layoutIds to assign to this Campaign, in order.

cyclePlaybackEnabledinteger

When cycle based playback is enabled only 1 Layout from this Campaign will be played each time it is in a Schedule loop. The same Layout will be shown until the 'Play count' is achieved.

playCountinteger

In cycle based playback, how many plays should each Layout have before moving on?

listPlayOrderstring

In layout list, how should campaigns in the schedule with the same play order be played?

targetTypestring

For ad campaigns, how do we measure the target? plays|budget|imp

targetinteger

For ad campaigns, what is the target count for playback over the entire campaign

Response

successful operation

campaignIdinteger

The Campaign Id

ownerIdinteger

The userId of the User that owns this Campaign

typestring

The type of campaign, either list, ad, playlist or media

campaignstring

The name of the Campaign

isLayoutSpecificinteger

A 0|1 flag to indicate whether this is a Layout specific Campaign or not.

numberLayoutsinteger

The number of Layouts associated with this Campaign

totalDurationinteger

The total duration of the campaign (sum of layout's durations)

folderIdinteger

The id of the Folder this Campaign belongs to

permissionsFolderIdinteger

The id of the Folder responsible for providing permissions for this Campaign

cyclePlaybackEnabledinteger

Flag indicating whether this Campaign has cycle based playback enabled

playCountinteger

In cycle based playback, how many plays should each Layout have before moving on?

listPlayOrderstring

In list campaign types, how should the layouts play out?

targetTypestring

For an ad campaign, what's the target type, plays|budget|imp

targetinteger

For an ad campaign, what's the target (expressed in targetType)

startDtinteger

For an ad campaign, what's the start date

endDtinteger

For an ad campaign, what's the end date

playsinteger

The number of plays achived by this campaign

spendnumber double

The amount of spend in cents/pence/etc

impressionsnumber double

The number of impressions achived by this campaign

lastPopIdinteger

The latest proof of play ID aggregated into the stats

ref1string

Reference field 1

ref2string

Reference field 1

ref3string

Reference field 1

ref4string

Reference field 1

ref5string

Reference field 1

Changes

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

      added the media type application/json for the response with the status

  • 8e1275395104Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type application/json for the response with the status