Creative Delivery

Upload creative delivery data to share with partners

Use Cases for the Creative Delivery API

The Creative Delivery API uploads information about creatives into the Scope3 system for modeling and inclusion in reports, dashboards, and other Scope3 tools.

Getting Started

To use the Creative Delivery schema you will need to gather delivery data, configure field mappings, and send the data to Scope3. This process can be managed using the Integrate tool in the CSP.

Once data has been uploaded and approved, it will be processed through the Creative API. The results will be available for reporting in the CSP and can also (through a configuration in the Integrate tool) be pushed back into a cloud bucket for use in your proprietary systems.

Data can used directly or Share Data with Clients.

Methodology: Key Contributors to Emissions

The major contributors to emissions for creative delivery are 1) data transfer to the consumer device, 2) energy use by the consumer device to render and display the creative, and 3) energy use by servers to select and deliver the assets of the creative.

Data Transfer

Scope3 uses the time-based "power model" to calculate energy use from streaming applications, and the bytes-based "conventional model" for all other scenarios. All data transfer to the client device should be included including calls to CDNs, embedded pixels, and ad servers.

Consumer Device

Scope3 is building a database of power consumption of common creative templates provided by dynamic creative and rich media vendors. To learn more about the underlying creative methodology see our methodology documentation.

Server Energy Use

Each request to a server should be factored into the emissions calculation. Scope3 works with each creative vendor to calculate emissions per impression and adds this to the provided data.

Methodology: Counting and Metrics

Reported metrics are often different between buyer and seller due to invalid traffic filtering, brand safety blocks, and counting differences between platforms. Scope3 models this difference as a passthrough_rate that represents the number of impressions counted by the advertiser divided by the number of impressions that the publisher attempted to deliver (or the opposite metric, filter_rate, which is the inverse).

Most metrics can be provided as raw integers: impressions, views, clicks, completions, completed_views, first_quartile_completions, midpoints, plays, progress_events, skips, and third_quartile_completions

View duration can be provided as either total_view_seconds (which will be divided by views) or average_view_seconds.

Taxonomy

Use the client field to identify the client. This will be mapped to an advertiser and/or an agency to share data with clients.

Scope3 provides a three-level hierarchy to identify creatives: brand, creative_group_id, and creative_id. We suggest using the canonical domain for the brand (eg kroger.com) to enable matching with other sources of emissions data.

Overview of the Input Format

The key fields for the Creative Delivery schema are below. There are many fields that can be added to refine the measurement - see full input schema documentation and the Data Dictionary for more information.

FieldExampleComments
row_identifierasdfa823This will be used on the response to map back to this row, eliminating the need to pass back all of the fields.

Must be unique.
utc_datetime2023-08-14 01:00:00The date and hour of the impression. We recommend sending hourly data to enable accurate emissions calculations, as the grid mix changes significantly throughout the day. Hourly data also enables reporting on local timezones.
countryFRThe two-letter country code where the impression was delivered
channelappThe channel where the impression is delivered
impressions1823821The number of impressions delivered with these characteristics
total_image_data_transfer_bytes150000Total bytes for the data transfer for the image itself for all impressions, ideally measured by the CDN

Overview of the Output Format

Output responses are configurable. Creative Delivery responses can contain supplied input fields and emissions measurement fields. Response configuration is done in the Integrate UI.

Available measurement response fields are:

FieldExampleComments
row_identifierasdfa823The same row identifier that was passed into the request
total_emissions_grams0.012Total emissions in grams using the selected framework
creative_delivery_emissions_grams0.012The emissions related to delivering the creative to a display surface.
emissions_frameworkscope3The underlying framework used to calculate emissions values.
emissions_breakdown{"breakdown":{"creativeDelivery":{"breakdown":{"adPlatform":{"emissions":0.06},"dataTransfer":{"emissions":4.045831827888176e-06}},"total":0.06000404583182788}},"framework":"scope3"}JSON data containing full emissions breakdown
coverage
parser_errorInvalid country code: CURACAOInput values are invalid
calculation_error
report_id