Frequency Capping Targeting
  • 1 Minute to read

    Frequency Capping Targeting


      Article summary

      This article describes resources that enable you to read and define frequency capping targeting.

      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
      • A GET request enables you to view frequency capping targets by the specified line.

      • A POST request enables you to target frequency capping with the specified line.

      Resources

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

      Parameter

      Parameter Type

      Description

      Data Type

      Required

      id

      path

      Specifies the line ID.

      integer

      Y

      frequencyCapPeriod

      body

      Specifies the frequency cap interval.

      • MINUTES

      • HOURLY

      • DAILY

      • WEEKLY

      • UNLIMITED - No limit to the number of times the ad can be displayed.

      string

      N

      frequencyCapValue

      body

      Specifies the number of impressions all for the selected frequencyCapPeriod. If frequencyCapPeriod selected is:

      • UNLIMITED - Do not provide frequencyCapPeriod in the payload.

      • MINUTES - The maximum time limit allowed for a minute is 5.

      • HOURLY - The maximum time limit allowed for an hour is 10.

      • DAILY - The maximum time limit allowed for a day is 20.

      • WEEKLY - The maximum time limit allowed for a week is 140.

      • MONTHLY - The maximum time limit allowed for a month is 600.

      string

      N

      serveUnknownUser

      body

      Specifies whether the ad is served to known or unknown users:

      • If true, serve to unknown users.

      • If false, serve to known users only.

      boolean

      N

      enableViewabilityFreqCap

      body

      Viewable Frequency ignores frequency limits until the impression is viewable.

      • If true, enable viewable frequency. Valid only when frequencyCapValue is either WEEKLY or MONTHLY.

      • If false, disable viewable frequency.

      boolean

      N

      types

      body

      Specifies an array of targeting types to target. To implement frequency capping, FREQUENCY_CAPPING targeting type must be specified.

      To learn more, refer to Targeting Types.

      array

      Y

      Note

      For a complete list of targeting resource fields, refer to Targeting Object.

      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.

      Example Request URL

      POST https://dspapi.admanagerplus.yahoo.com/traffic/lines/365277/targeting/

      Example Request Body

      {
        "frequencyCapPeriod": "MONTHLY",
        "frequencyCapValue": 4,
        "serveUnknownUser": true,
        "types": [
          {
            "name": "FREQUENCY_CAPPING",
            "isTargeted": true
          }
        ]
      }

      Example Response

      {
        "response": {
          "types": [
            {
              "name": "FREQUENCY_CAPPING",
              "isTargeted": true
            }
          ],
          "frequencyCapPeriod": "MONTHLY",
          "frequencyCapValue": 4,
          "serveUnknownUser": true
        },
        "errors": null,
        "timeStamp": "2019-10-20T04:04:25Z"
      }

      Additional Resources

      About Targeting


      Was this article helpful?