Campaign Set Status
Introduction
A campaign set in Nexta is meant both a bookkeeping device and as an abstraction.
In the bookkeeping use case, a user might group a set of campaign because they are related in some way, that the user finds useful, and the campaign are operated as if they were not on a set, i.e. individual campaigns.
In the abstraction use case, the user might or might not care about the individual campaigns, in the sense that exactly what campaigns are running can be considered a technical detail, as long as some business requirements are met.
The Campaign Set Status end-point provides a simple interface for controlling the effective status of a campaign set, and by extension all entities within the set, being campaigns, Rules, and optimization. The end-point is mainly meant to support the abstraction use case.
Usage
The swagger documentation of the end-point sits on this location on Nexta’s public gateway.
The call signature is /api/v3.0/campaign-set/{clientId}/{id}/status, where clientId is the Nexta client id and id the campaign set id.
The payload is very simple
{
"status": "Active"/"Paused"
}
If called with Active the end-point will configure all campaigns, all rules, and all optimization to be active and the set as a whole will be able to deliver, unless there underlying non-API related issues, like too narrow targeting, no banners etc. If called with Paused the end-point will configure all campaigns, all Rules, and all optimization to be paused, and stay paused, and not deliver anything until called with Active again.
In case any of any failures, an appropriate status code and extensive description of the failure will be returned.
Behind the scenes
Behind the scenes this end-point runs a simple relatively procedure of looping through all campaigns performing the following operations:
- Disable/enable all activation/Dynamic Rules
- Active/pause campaign
- Disable/enable optimization
And on the set level, all Dynamic Rules are disabled/enabled. Set level activation Rules will soon be deprecated.