Frequency Capping Targeting

  • 2 minute(s) read
Prev Next

Set a limit on how frequently an ad is displayed to a user within a specified time frame.

The Yahoo DSP supports FREQUENCY_CAPPING targeting for lines serving display and video ads.

Endpoint

/traffic/lines/{id}/targeting

  • Use the GET method to retrieve the target frequency capping configured for the specified line.

  • Use the POST method to apply the target frequency capping targeting to a specified line.

Required and Supported Parameters

The targeting resource is defined by the following FREQUENCY_CAPPING targeting type-specific fields.

Parameter

Description

Data Type

Create

Update

hhFrequencyCapEnabled

A value of false means the limit will be set by People/Device. A value of true means the limit will be set by Household. Limit the frequency capping by Household is only for CTV lines.

boolean

Optional

Optional

Line Frequency Cap Object

A Line Frequency Cap object defines multi-layer frequency capping for the line.

The lineFrequencyCap can be used to set up to 3 layers of frequency capping.

Parameter

Description

Data Type

Create

Update

frequencyCapValueMinute

Specifies the maximum number of impressions to serve per minute.

integer

Optional

Optional

frequencyCapValueHour

Specifies the maximum number of impressions to serve per hour.

integer

Optional

Optional

frequencyCapPeriodMultiHour

Specifies the line frequency capping period. Supports 6 hours or 12 hours.

Values

  • 6

  • 12

integer

Optional

Optional

frequencyCapValueMultiHour

Specifies the maximum number of impressions to serve over 6 or 12 hours. This is required when frequencyCapPeriodMultiHour is specified.

integer

Optional

Optional

frequencyCapValueDay

Specifies the maximum number of impressions to serve per day.

integer

Optional

Optional

frequencyCapValueWeek

Specifies the maximum number of impressions to serve per week.

integer

Optional

Optional

frequencyCapValueMonth

Specifies the maximum number of impressions to serve per month.

integer

Optional

Optional

frequencyCapPacingType

Specifies the frequency cap pacing type. Supports EVEN pacing type.

Values

  • EVEN

string

Required

Required

Add/Update Frequency Cap Targeting

Add or update frequency capping controls for the specified line.

POST traffic/lines/{id}/targeting/

Parameters

The line ID is specified in the path of the URL. All other parameters are specified in the body of the application/json payload.

Sample Request URL

POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/{id}/targeting/

Sample Request Body

{
 "hhFrequencyCapEnabled": false,
   "lineFrequencyCap": {
       "frequencyCapValueMinute": 0,
       "frequencyCapValueHour": 0,
       "frequencyCapPeriodMultiHour": 0,
       "frequencyCapValueMultiHour": 0,
       "frequencyCapValueDay": 5,
       "frequencyCapValueWeek": 6,
       "frequencyCapValueMonth": 7
   },
   "types": [
       {
           "name": "FREQUENCY_CAPPING",
           "isTargeted": true
       }
   ]
}

Sample Response

{
  "response": {
   "hhFrequencyCapEnabled": false,
    "lineFrequencyCap": {
      "frequencyCapValueMinute": 0,
      "frequencyCapValueHour": 0,
      "frequencyCapValueDay": 5,
      "frequencyCapValueWeek": 6,
      "frequencyCapValueMonth": 7,
      "frequencyCapPeriodMultiHour": 0,
      "frequencyCapValueMultiHour": 0,
      "lineId": 123456
    },
    "types": [
      {
        "isTargeted": true,
        "name": "FREQUENCY_CAPPING"
      }
    ]
  },
  "errors": null,
  "timeStamp": "2025-09-19T21:35:37.599Z"
}

Related articles