The Adzerk Developer Hub

Welcome to the Adzerk developer hub. You'll find comprehensive guides and documentation to help you start working with Adzerk as quickly as possible, as well as support if you get stuck. Let's jump right in!

Ad Capping

Overview

Ad Capping refers to the automatic stopping of a Flight upon hitting a certain metric.

For instance, you may want to have a Flight stop showing ads once it hits 10M impressions. Or, you may have promised 5K clicks to an advertiser, and want it to automatically turn-off when it hits it.

What You Can Cap On

Ad Capping is set at the Flight level. The exception is for ad caping using revenue budgets (see below for more info on that).

You set them at the Daily and/or Lifetime level and can cap by Impressions, Clicks, Conversions, or Revenue.

Lifetime caps apply to the entire history of the ad/flight/etc. If you need to increase the cap of a flight etc. that has hit its cap, you will need to set the new cap as the old cap plus the additional cap amount.

Setting Caps

For more information on setting caps, click here.

Cap Type is where you set the target metric, and Daily and Lifetime are where you set the target amount.

Budget Capping

BETA

This feature is in Beta. Contact your account manager to get started.

Budget caps (or revenue caps) will stop an ad from serving once a budget is reached. For example, if a flight is priced at $1.00 CPM and the budget is $1000, the flight will stop serving when Adzerk records 1 million impressions.

The budget can be set on advertiser, campaign, or flight objects.

Budget caps also work for second-price auctions and RTB flights where there isn't a steady stream of revenue per event.

We will respect the most restrictive budgets. For example, if the budget for an advertiser is $5000 but the Flight budget is $1K, we will stop at $1K.

Budget caps do not work with flat-rate flights. Also, flat-rate prices will be ignored in a campaign or advertiser's overall budget.

Setting a Budget Cap on Advertiser - API

  1. Use the Create Advertisers endpoint
  2. Alongside needed fields, set the CapType = 4
  3. Set an integer for a DailyCapAmount or a LifetimeCapAmount or both (USD)

Setting a Budget Cap on Campaign - API

  1. Use the Create Campaigns endpoint
  2. Alongside needed fields, set the CapType = 4
  3. Set an integer for a DailyCapAmount or a LifetimeCapAmount or both (USD)

Setting a Budget Cap on a Flight - API

  1. Use the Create Flight endpoint
  2. Alongside needed fields, set the CapType = 4
  3. Set an integer for a DailyCapAmount or a LifetimeCapAmount or both (USD)

Any cap types you do not set will be returned in the response with a value of null.

Setting a Budget Cap on Advertiser - UI

  1. Campaigns --> Advertisers --> Advertiser Name --> Settings
  2. Under Revenue Settings, set either a Daily cap (in dollars), a Lifetime cap (in dollars), or both
  3. Save

Setting a Budget Cap on Campaign - UI

  1. Campaigns --> Advertisers --> Campaign Title --> Settings
  2. Under Revenue Caps, set either a Daily cap (in dollars), a Lifetime cap (in dollars), or both
  3. Save

Setting a Budget Cap on a Flight - UI

  1. In Flight General Settings, select the right Budget Cap Type under the Cap drop-down
  2. Set either a Daily cap (in dollars), a Lifetime cap (in dollars), or both
  3. Save

Viewing Advertiser and Campaign Budget Caps on a Flight

BETA: In UI 2.0, you can view the budget caps for a flight's advertiser and campaign on the flight settings page. In addition, you can view how much revenue the campaign and advertiser have currently earned toward their cap.

The budget cap data is located in the General Settings section of the flight settings:

To get started using this feature, contact your account manager.

Ad Capping