Skip to end of metadata
Go to start of metadata

New Partner Fee Service - Breaking Change Notice - Xandr Console API

We are pleased to announce the release of the new Partner Fee service, an enhancement and replacement for the Broker Fee Service for augmented line items (ALIs). The Partner Fee Service will allow you to reserve a portion of your budget for third-party costs (costs owed to parties other than the publisher). Fees can be tracked on a CPM, cost share, or revenue share basis, and can be applied to multiple advertisers and line items, if desired. A single line item or advertiser can have multiple fees applied.

As part of this release, we will be automatically migrating commissions and serving fees on existing augmented line items to partner fees. We are also adding several new metrics to reports and standardizing how metrics are named and calculated across different reports, which will result in the deprecation of the some metrics.

Partner fees are not supported for standard or legacy line items.

Since this is a breaking change for the Console API, we will support two versions of the API for the next 60 days, as stated in our Breaking Changes policy. The new Partner Fee Service will be available for use on September 10, 2019. The final changeover date is November 12, 2019. 

Breaking Change Timeline

Changes will occur in the following phases:

Breaking Change Period (September 10-November 12, 2019)

As of September 10, 2019:

  • Partner fees are released for ALIs. The new Partner Fee Service is available for API users and the Partner Fees UI (login required) is available to Console UI users.
  • Broker fees are still supported for both augmented and standard line items. 
  • Broker fees on new and existing augmented line items are converted to partner fees automatically. Reporting data populates for serving fees, commissions, and partner fees.
  • New partner fees are not automatically converted to broker fees, but reporting data still populates in all three reporting columns (serving fees, commissions, and partner fees). 
  • Reporting includes new metrics:
    • Partner Fees - The total amount of third-party costs, budgeted using the Partner Fee Service, that have accrued on an augmented line item over the reported period of time.
    • Total Cost - The total amount of costs accrued over the reported period of time. This generally includes two types of costs, budgeted costs (media cost, data cost, partner fees, serving fees, commissions) and publisher revenue if you track publisher payouts on the platform.
    • Profit - To align the naming and definition of profit-related fields, we'll be adding new profit fields to several reports. Please see below for exact details on which fields will be added to which reports.

General Release (November 12, 2019)

As of November 12, 2019:

  • Broker fees are no longer supported for ALIs.
  • Broker fees previously created on insertion orders are supported only on child SLIs. 
  • Reporting field definitions change:
    • [Updated] Commissions and serving fees on ALIs are $0 going forward. Partner fees are the metric for third-party costs on ALIs going forward. This does not affect past data or reports.
    • [Updated] Existing profit metrics now include all costs (Total Cost) in their calculation. This does not affect past data or reports. 
      • Network Profit (network_profit) considers booked revenue and reseller revenue as "revenue". Therefore, Network Profit = (Booked Revenue - Reseller Revenue) - Total Costs.
      • Buyer Profit (profit) considers only booked revenue as "revenue". Therefore, Profit = Booked Revenue - Total Costs.
    • [Deprecated] All Revenue, Cost, and Profit variants that "include fees" or are "net commissions", such as profit_including_feescost_including_fees, and revenue_including_fees, are deprecated. These are no longer supported and return an error if requested in API calls.

New Services

Partner Fee Service

The Partner Fees Service allows you to reserve a portion of your budget for third-party costs (costs owed to parties other than the publisher). Fees can be tracked on a CPM, cost share, or revenue share basis, and can be applied to multiple advertisers and line items, if desired.

Updated Services

Advertiser Service

The Advertiser Service provides a new, read-only partner_fees field that displays the partner fees eligible for the specified advertiser.

Line Item Service

The Line Item Service - ALI provides a new partner_fees array that specifies the partner fees applied to the line item.

Deprecated Services

Broker Service

For augmented line items, the Broker Service is deprecated in favor of the Partner Fee Service. For standard line items, the Broker Fee Service will still be available.

Reporting Additions and Changes

New reporting metrics for partner fees will be released on September 10, 2019. On November 12, 2019, after 60 days, as stated in our Breaking Changes policy, we will update some metrics to support the Partner Fee service and remove some metrics that will then be irrelevant or obsolete.

Additionally, we will be making a few updates to better align the naming and definition of profit metrics across reporting. Please see the table below for explicit details on which fields are new, modified, or deprecated in specific reports.

New Metrics

As of September 10, 2019, the following new metrics will be added to reporting:

Third-Party Costs  

partner_fees - The total amount of third-party costs, budgeted using the Partner Fees Service, that have accrued on an augmented line item over the reported period of time.

During the breaking change period (September 10, 2019 - November 12, 2019), the commissions and serving_fees fields will also include the relevant partner_fees for augmented line items to ensure continuity in reporting. As of November 12, 2019, commissions and serving fees will be automatically migrated to partner fees, which will appear in the partner_fees field, and commissions and serving fees will no longer be populated for augmented line items.

Total Costs

The total cost metrics represent all costs that are paid out to third parties. For buyers, total cost is all costs included in the budget, including media cost, data cost, partner fees, serving fees, and commissions. For sellers, total cost is any publisher revenue paid out to publishers, whether as revshare or CPM.

  • total_cost - media cost + data cost + partner fees + commissions + serving fees OR publisher revenue
  • total_cost_ecpm - (total cost/imps) * 1,000
  • total_cost_epc - total cost/clicks
  • total_cost_ecpa - total cost/conversions

During the breaking change period, we will add logic to ensure we prevent double-counting third-party costs (partner fees vs commissions and serving fees) in total cost metrics for ALIs.

Network Profit

The network profit metrics represent the sum of booked revenue and reseller revenue minus total cost.

  • network_profit - (booked revenue + reseller revenue) - total cost
  • network_profit_ecpm - (network profit/imps) * 1,000
  • network_profit_ecpc - network profit/clicks
  • network_profit_ecpa - network profit/conversions
  • network_profit_margin - network profit/(booked revenue + reseller revenue)

Changed Metrics

As of November 12, 2019, the following metrics will be updated to provide information based on partner fees:

Third-Party Costs

Commissions and serving fees will no longer accrue on augmented line items in reporting. They should be created as partner fees and will be tracked in by the partner_fees metric in reporting.

  • commissions - This will be $0 for augmented line items going forward. Past data will not be affected.
  • serving_fees - This will be $0 for augmented line items going forward. Past data will not be affected.

Buyer Profit

The buyer profit metrics represent booked revenue minus all budgeted costs.

Historically, we have used "profit" inconsistently for both network profit and buyer profit. Now network profit (network_profit) is calculated using booked revenue plus reseller revenue, and buyer profit (profit) is calculated using only booked revenue.

  • profit - booked revenue - total cost
  • profit_ecpm - (profit/imps) * 1,000
  • profit_ecpc - profit/clicks
  • profit_ecpa - profit/conversions
  • profit_margin - profit/booked revenue

Deprecated Metrics

As of November 12, 2019, the following metrics will no longer be supported:

  • revenue_including_fees
  • rpm_including_fees
  • total_revenue_including_fees
  • revenue_ecpm_including_fees
  • revenue_ecpc_including_fees
  • cost_including_fees
  • cpm_including_fees
  • cost_ecpc_including_fees
  • cost_ecpa_including_fees
  • profit_including_fees
  • ppm_including_fees
  • profit_net_including_fees
  • profit_ecpm_including_fees
  • profit_margin_including_fees
  • profit_including_data_cost

Summary of Changes for Each Report

Network Analytics

Report Type: network_analytics

Documentation: Network Analytics

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
partner_feesnewpartner_fees No change
commissionsmodifiedIncludes equivalent partner_fees for ALIs during the breaking change window.$0 for ALIs. Previous data will not be impacted.
serving_feesmodifiedIncludes equivalent partner_fees for ALIs during the breaking change window.$0 for ALIs. Previous data will not be impacted.
total_costnew

media_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
network_profitnew(booked_revenue + reseller_revenue) - total_costNo change
network_profit_ecpmnew(network_profit / imps) * 1,000No change
network_profit_ecpcnewnetwork_profit / clicksNo change
network_profit_ecpanewnetwork_profit / conversionsNo change
network_profit_marginnewnetwork_profit / (booked_revenue + reseller_revenue)No change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_buying_currencymodifiedbooked_revenue - media_cost (in the buying currency)

booked_revenue - total_cost (in the buying currency)

profit_selling_currencymodifiedbooked_revenue - media_cost (in the selling currency)

booked_revenue - total_cost (in the selling currency)

profit_ecpmnew((booked_revenue - total_cost) / imps) * 1,000No change
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenueNo change
ppmdeprecated No changeReturns error
ppm_buying_currencydeprecated No changeReturns error
ppm_selling_currencydeprecated No changeReturns error
profit_including_feesdeprecated No changeReturns error
cost_including_feesdeprecated No changeReturns error
revenue_including_feesdeprecated No changeReturns error
cpm_including_feesdeprecated No changeReturns error
rpm_including_feesdeprecated No changeReturns error
ppm_including_feesdeprecated No changeReturns error

Network Advertiser Analytics

Report Type: network_advertiser_analytics

Documentation:  Network Advertiser Analytics

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
partner_feesnewpartner_feesNo change
commissionsmodifiedIncludes equivalent partner_fees for ALIs during the breaking change window.$0 for ALIs. Previous data will not be impacted.
serving_feesmodifiedIncludes equivalent partner_fees for ALIs during the breaking change window.$0 for ALIs. Previous data will not be impacted.
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpmmodified
((booked_revenue - media_cost) / imps) * 1,000((booked_revenue - total_cost) / imps) * 1,000
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginmodified(booked_revenue - media_cost) / booked_revenue(booked_revenue - total_cost) / booked_revenue
profit_including_feesdeprecatedNo changeReturns error
total_revenue_including_feesdeprecatedNo changeReturns error
total_revenue_including_fees_adv_currencydeprecatedNo changeReturns error
revenue_ecpa_including_feesdeprecatedNo changeReturns error
revenue_ecpa_including_fees_adv_currencydeprecatedNo changeReturns error
revenue_ecpc_including_feesdeprecatedNo changeReturns error
revenue_ecpc_including_fees_adv_currencydeprecatedNo changeReturns error
revenue_ecpm_including_feesdeprecatedNo changeReturns error
revenue_ecpm_including_fees_adv_currencydeprecatedNo changeReturns error
cost_ecpa_including_feesdeprecatedNo changeReturns error
cost_ecpc_including_feesdeprecatedNo changeReturns error
cost_ecpm_including_feesdeprecatedNo changeReturns error
profit_net_including_feesdeprecatedNo changeReturns error
profit_ecpm_including_feesdeprecatedNo changeReturns error
profit_margin_including_feesdeprecatedNo changeReturns error
total_revenue_including_fees_pixeldeprecatedNo changeReturns error


Network Publisher Analytics

Report Type: network_publisher_analytics

Documentation: Network Publisher Analytics

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
partner_feesnewpartner_feesNo change
commissionsmodifiedIncludes equivalent partner_fees for ALIs during the breaking change window.$0 for ALIs. Previous data will not be impacted.
serving_feesmodifiedIncludes equivalent partner_fees for ALIs during the breaking change window.$0 for ALIs. Previous data will not be impacted.
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
network_profitmodified

booked_revenue + reseller_revenue - media_cost

booked_revenue + reseller_revenue - total_cost
network_profit_ecpmnew((booked_revenue + reseller_revenue - total_cost) / imps) * 1,000No change
network_profit_ecpcnew(booked_revenue + reseller_revenue - total_cost) / clicksNo change
network_profit_ecpanew(booked_revenue + reseller_revenue - total_cost) / conversionsNo change
network_profit_marginnew(booked_revenue + reseller_revenue - total_cost) / (booked_revenue + reseller_revenue)No change
network_ppmdeprecatedNo changeReturns error
network_roideprecatedNo changeReturns error
network_roi_net_commissionsdeprecatedNo changeReturns error
network_revenue_net_commissionsdeprecatedNo changeReturns error
network_profit_net_commissionsdeprecatedNo changeReturns error
network_rpm_net_commissionsdeprecatedNo changeReturns error
network_ppm_net_commissionsdeprecatedNo changeReturns error

Network Video Analytics

Report Type: video_analytics_network

Documentation:  Network Video Analytics

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
network_profitnewbooked_revenue + reseller_revenue - total_cost

No change

network_profit_ecpmnew(network_profit / imps) * 1,000No change
network_profit_ecpcnewnetwork_profit / clicksNo change
network_profit_ecpanewnetwork_profit / conversionsNo change
network_profit_marginnewnetwork_profit / (booked_revenue + reseller_revenue)No change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpmnew((booked_revenue - total_cost) / imps) * 1,000No change
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenueNo change

ppm

deprecated No changeReturns error

cpm_including_fees

deprecated No changeReturns error
rpm_including_feesdeprecatedNo changeReturns error
ppm_including_feesdeprecatedNo changeReturns error


Network Advertiser Video Analytics

Report Type: video_analytics_network_advertiser

Documentation:  Network Advertiser Video Analytics

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpmmodified

((booked_revenue - media_cost) / imps) * 1,000

((booked_revenue - total_cost) / imps) * 1,000
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginmodified

(booked_revenue - media_cost) / booked_revenue

(booked_revenue - total_cost) / booked_revenue

Network Publisher Video Analytics

Report Type: video_analytics_network_publisher

Documentation:  Network Publisher Video Analytics

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
network_profitmodified

booked_revenue + reseller_revenue - media_cost

booked_revenue + reseller_revenue - total_cost
network_profit_ecpmnew((booked_revenue + reseller_revenue - total_cost) / imps) * 1,000No change
network_profit_ecpcnew(booked_revenue + reseller_revenue - total_cost) / clicksNo change
network_profit_ecpanew(booked_revenue + reseller_revenue - total_cost) / conversionsNo change
network_profit_marginnew(booked_revenue + reseller_revenue - total_cost) / (booked_revenue + reseller_revenue)No change
network_ppmdeprecated No changeReturns error
network_roideprecated No changeReturns error

Buyer Segment Performance

Report Type: buyer_segment_performance

Documentation: Buyer Segment Performance Report

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
partner_feesnewpartner_feesNo change
commissionsmodifiedIncludes equivalent partner_fees for ALIs during the breaking change window.$0 for ALIs. Previous data will not be impacted.
serving_feesmodifiedIncludes equivalent partner_fees for ALIs during the breaking change window.$0 for ALIs. Previous data will not be impacted.
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpmmodified
((booked_revenue - media_cost) / imps) * 1,000((booked_revenue - total_cost) / imps) * 1,000
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenue

No change

Seller Brand Review

Report Type: seller_brand_review

Documentation:  Seller Brand Review Report

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
network_profitnew(booked_revenue + reseller_revenue) - total_cost

No change

network_profit_ecpmnew(network_profit / imps) * 1,000No change
network_profit_ecpcnewnetwork_profit / clicksNo change
network_profit_ecpanewnetwork_profit / conversionsNo change
network_profit_marginnewnetwork_profit / (booked_revenue + reseller_revenue)No change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpmnew((booked_revenue - total_cost) / imps) * 1,000No change
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenueNo change

ppm

deprecated No changeReturns error

Network Creative Frequency and Recency

Report Type: network_advertiser_frequency_recency

Documentation:  Network Creative Frequency and Recency

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
profitnewbooked_revenue - total_costNo change
profit_ecpmmodified

((booked_revenue - total_cost) / imps) * 1,000

((booked_revenue - total_cost) / imps) * 1,000
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenueNo change

Network Site Domain Performance Report

Report Type: network_site_domain_performance

Documentation:  Network Site Domain Performance

Upcoming Changes:

 

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpmmodified
((booked_revenue - media_cost) / imps) * 1,000((booked_revenue - total_cost) / imps) * 1,000
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenue

No change

Site Domain Performance Report

Report Type: site_domain_performance

Documentation:  Site Domain Performance

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpmmodified
((booked_revenue - media_cost) / imps) * 1,000((booked_revenue - total_cost) / imps) * 1,000
profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenue

No change

Geo Analytics

Report Type: geo_analytics

Documentation:  Geo Analytics Report

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpmnew ((booked_revenue - total_cost) / imps) * 1,000

No change

profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenue

No change

Network Carrier Analytics

Report Type: network_carrier_analytics

Documentation:  Network Carrier Analytics

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
network_profitnew(booked_revenue + reseller_revenue) - total_cost

No change

network_profit_ecpmnew(network_profit / imps) * 1,000No change
network_profit_ecpcnewnetwork_profit / clicksNo change
network_profit_ecpanewnetwork_profit / conversionsNo change
network_profit_marginnewnetwork_profit / (booked_revenue + reseller_revenue)No change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpm new ((booked_revenue - total_cost) / imps) * 1,000

No change

profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenue

No change

ppmdeprecated No changeReturns error

Network Device Analytics 

Report Type: network_device_analytics

Documentation: Network Device Analytics

Upcoming Changes:

FieldChangeDuring the Breaking Change PeriodAfter the Breaking Change Period
total_costnewmedia_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue

Note: We have added logic to prevent double counting third-party fees during the breaking change period.

No change
total_cost_ecpmnew(total_cost / imps) * 1,000No change
total_cost_ecpcnewtotal_cost / clicksNo change
total_cost_ecpanewtotal_cost / conversionsNo change
network_profitnew(booked_revenue + reseller_revenue) - total_cost

No change

network_profit_ecpmnew(network_profit / imps) * 1,000No change
network_profit_ecpcnewnetwork_profit / clicksNo change
network_profit_ecpanewnetwork_profit / conversionsNo change
network_profit_marginnewnetwork_profit / (booked_revenue + reseller_revenue)No change
profitmodifiedbooked_revenue - media_costbooked_revenue - total_cost
profit_ecpm new ((booked_revenue - total_cost) / imps) * 1,000

No change

profit_ecpcnew(booked_revenue - total_cost) / clicksNo change
profit_ecpanew(booked_revenue - total_cost) / conversionsNo change
profit_marginnew(booked_revenue - total_cost) / booked_revenue

No change

ppmdeprecated No changeReturns error


Example Reporting Changes

Here's an example of how the report calculations will change over the breaking change period. Currently, profit only accounts for media cost, without considering commissions, serving fees, partner fees, or data costs. After the breaking change period, profit will account for all of those fees and costs.

 PreviousDuring the Breaking Change PeriodAfter the Breaking Change Period
Booked revenue$100$100$100
Media cost$60$60$60
Commissions$10$10$0
Serving fees$5$5$0
Partner feesn/a$15$15
Data cost$5$5$5
Total costn/a$80$80
Profit$40$40$20
CalculationProfit = booked revenue - media cost. Does not include commissions, serving fees, partner fees, or data cost.Profit = booked revenue - media cost. Does not include commissions, serving fees, partner fees, or data cost.Profit = booked revenue - (media cost + commissions + serving fees + partner fees + data cost)
 

Log-Level Data

The Standard Feed field partner_fees reports the sum of all partner fees applied to a line item. Definitions for existing commission and serving fee fields in the feed are affected as described in the table below.

FieldDefinition 

commission_cpm

Commission (in USD) if used in the UI or API.  

During the Breaking Change Period: Commissions for standard line items, commissions + equivalent partner fees for ALIs. 
After the Breaking Change Period: Commissions for standard line items, $0 for ALIs. Commissions created on ALIs prior to this date will be automatically migrated to partner fees. Previous data will not be impacted.

commission_revshare

Commission (in USD) if used in the UI or API. 

During the Breaking Change Period: Commissions for standard line items, commissions + equivalent partner fees for ALIs. 
After the Breaking Change Period: Commissions for standard line items, $0 for ALIs. Commissions created on ALIs prior to this date will be automatically migrated to partner fees. Previous data will not be impacted

serving_fees_cpm

The serving fees in addition to media costs to when serving an ad (in USD).

During the Breaking Change Period: Serving fees for standard line items, serving fees + equivalent partner fees for ALIs. 
After the Breaking Change Period: Serving fees for standard line items, $0 for ALIs. Serving fees created on ALIs prior to this date will be automatically migrated to partner fees. Previous data will not be impacted.

serving_fees_revshare

The revenue share in addition to media costs when serving an ad (in USD).

During the Breaking Change Period: Serving fees for standard line items, serving fees + equivalent partner fees for ALIs. 
After the Breaking Change Period: Serving fees for standard line items, $0 for ALIs. Serving fees created on ALIs prior to this date will be automatically migrated to partner fees. Previous data will not be impacted

  • No labels