Create banner capping
Creates a new capping rule for the specified banner, controlling how frequently events (impressions, clicks, or actions) occur within a time window.
https://YOUR-NETWORK-DOMAIN/rest-api/banner/capping/{bannerId}.do Creates a new capping rule for the specified banner, controlling how frequently events (impressions, clicks, or actions) occur within a time window. The capping type determines which event category is capped (e.g. BANNER_FREQUENCY for impressions, BANNER_CLICKS for clicks). The response JSON carries the new record, with its assigned id, under capping. Requires UPDATE permission on the banner's advertiser, MANAGE_CAPPING_AND_LIMITATIONS enabled, and the permission of the capping type and subject.
Path Params
bannerId integer required
Numeric ID of the banner to add the capping rule to
42 Form Params
type string required
Type of the capping to create. A type of another level is rejected with 'Capping type is incompatible with entity'
BANNER_FREQUENCY amount integer required
Maximum number of events allowed within the specified period
1000 period integer required
Length of the capping time window, expressed in units defined by periodType
24 periodType string required
Unit of the capping period. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR
HOUR flat boolean required
When true, events are distributed evenly (flat) across the period instead of being served/counted as fast as possible
true subject string
Entity used to identify unique users for capping. Optional; allowed values: USER_COOKIE, USER_SERVER_SIDE, USER_MIXED, IP, LES_IP
USER_COOKIE actionId integer
Conversion action the capping counts, from the action list. Only for an ACTIONS capping type, and not together with flat=true; omitted counts every action. Fixed once the capping exists
25 Responses
200
Capping created: {success, capping:{id, type, amount, period, periodType, flat, subject, actionId, actionName, ...}}
400
Invalid capping, or actionId on a type that is not an ACTIONS capping, together with flat=true, or naming a video or viewability event
401
Authentication error
403
Not enough permissions for the entity, the capping type or the subject
404
The entity, or the conversion action named by actionId, is not found or deleted