eCPM Partitions

🚧

Caution

eCPM functionality and documentation is subject to change as the product evolves and changes.

eCPM Partitions allow you to track the eCPM performance data of your ads separately for different partitions of your inventory. This is particularly useful for optimizing auction performance.

For instance, an auction ad may serve both on a landing zone and elsewhere on your site. Since the ad's performance (as calculated as eCPM) may vary significantly between this zone and elsewhere, you can specify a partition when requesting ads to the zone via the Decision API:

{
  "placements": [
    {
      "networkId": 123,
      "siteId": 456,
      "adTypes": [5],
      "ecpmPartitions": ["landing"]
    }
  ]
}

The ad server will then use the eCPM associated with that partition for each ad when determining the auction winner rather than the overall eCPM for the ads across all partitions.

Using eCPM Partitions

To use an eCPM partition when making an ad request, pass the partition name as a string in an array on placements.ecpmPartitions on a Decision API request. (See the example above.) The name is case-insensitive.

If the partition doesn't exist, passing a new string will create a new partition.

When an eCPM partition is specified, the eCPM data for the specified partition will be used in auctions and for pricing. If there is no eCPM data for the partition, the normal burn-in process is applied, and the eCPM optimization options configured on the flight are used for the burn-in.

Events associated with the request contribute to both partition and overall eCPM data.

Data-shipping logs will include the EcpmPartitions property for requests associated
with an eCPM partition:

• Decision logs include the eCPM partition specified on the placement.
• Event logs (such as impression and click logs) include the partition when the event is associated with a Decision API request that specified one.

eCPM Partitions and Multi-Winner Placements

You can combine multiple eCPM partitions with multi-winner placements by specifying multiple partitions on the placement. For example:

{
  "placements": [
    {
      "networkId": 123,
      "siteId": 456,
      "adTypes": [5],
      "count":3,
      "ecpmPartitions": ["landing","main","footer"]
    }
  ]
}

In this case, each of the three multi-winner selections will use the partitions from the array in the order they are listed. The first selection will use landing, the second main, etc.

If the count is greater than the number of partitions, we will loop the list of partitions over the selections. If the count were 5 in this example, we would use landing for the fourth selection and main for the fifth.

Resource Limits and Limitations

• Partition-specific caps, goals or frequency capping are not supported at this time.
• The maximum length of a partition name is 8 characters.
• The ad servers support up to 20 active partitions per ad at any time.
• When there are more than 20 partitions for an ad, we will choose the 20 that most recently received events.