Data Dictionary

activity_type

The activity_type property represents the billable activity and can have one of the following enum values: custom_algorithm, measurement, optimization, climate_shield, green_media_product, planning, compensation.

ad_format

Platform or custom ad formats

ad_opportunities

The ad_opportunities property represents the number of auctioned ad slots received, calculated as requests multiplied by ad slots per request. It is of type integer and is tagged as a metric.

Example:123456789

ad_opportunities_processed

The ad_opportunities_processed property indicates the number of ad slots processed, such as those that pass QPS throttling logic. It is of type integer and is categorized as a metric.

Example:22321322

ad_opportunities_sent

The ad_opportunities_sent property signifies the number of ad slots sent to the bidder. It is of type integer and is classified as a metric.

Example:123456789

advertiser_id

The advertiser_id property is a string that is required if advertiser_name is provided. It is used as an identifier for the advertiser and is categorized as a transaction object.

Example:"1234"

advertiser_name

The advertiser_name property is a string representing the name of the advertiser. It is associated with the advertiser_id and falls under the transaction object category.

app

The app channel represents mobile applications offering display (banner, high impact, native...) or video out-stream ad experiences.

app_store

The app_store property represents the app store from which the application is downloaded. It is of type string and can have one of the following enum values: apple-app-store, google-play-store, amazon, roku, samsung, lg, vizio, microsoft.

Example:"apple-app-store"

asset_bytes_transferred

The asset_bytes_transferred property represents the number of bytes transferred for an asset. It is of type integer.

atp

The atp property indicates the ad tech platform to which the data applies. It defaults to the uploading organization. It is of type string.

Example:"adtech.ai"

audio_duration_seconds

The audio_udration_seconds field is associated with the creative group and is of type float.

Example:

• 14.2

average_view_seconds

The average_view_seconds property represents the average duration of a view in seconds. It is of type number.

Example:5.6

bidder_id

The bidder_id property signifies the bidder domain. It is of type string and is classified as an object.

Example:"appnexus.com"

brand

The brand property represents the brand name. It falls under the transaction object category and is of type string.

Example:"hasbro"

campaign_group_id

The campaign_group_id property is required if campaign_group_name is provided. It is associated with the campaign group and is of type string.

campaign_group_name

The campaign_group_name property represents the name of the campaign group. It is associated with the campaign group and is of type string.

campaign_id

The campaign_id property is required if campaign_name is provided. It is associated with the campaign and is of type string.

campaign_name

The campaign_name property represents the name of the campaign. It is associated with the campaign and is of type string.

channel

The channel property represents the channel and can have one of the following enum values: web, app, streaming-video, social, ctv-bvod, digital-audio, dooh.

clicks

The clicks property represents the number of clicks. It falls under the campaign metric category and is of type integer.

client

The client property represents the client identifier. It is of type string.

completed_views

The completed_views property represents the number of completed views. It falls under the campaign metric category and is of type integer.

completions

The completions property represents the number of completions. It falls under the campaign metric category and is of type integer.

conversions

The conversions property represents the number of conversions. It falls under the campaign metric category and is of type integer.

country

The country property represents the country ISO 3166-2 alpha-2 code or an Alpha-3 code, e.g., USA, or a country name. It is of type string.

Example:"US"

creative_group_id

The creative_group_id property is required if creative_group_name is provided. It is associated with the creative group and is of type string.

creative_group_name

The creative_group_name property represents the name of the creative group. It is associated with the creative group and is of type string.

creative_id

The creative_id property is required if creative_name is provided. It is associated with the creative and is of type string.

creative_name

The creative_name property represents the name of the creative. It is associated with the creative and is of type string.

CTV-BVOD

The ctv-bdov channel represents websites and/or mobile applications offering in-stream advertising in environments where the video is the primary content experience, is on-demand or live, and is typically long-form.

currency

The currency property represents the currency. It is of type string.

deal_id

The deal_id property is required if deal_name is provided. It is associated with the deal and is of type string.

Example: "deal_id"

deal_name

The deal_name property represents the name of the deal. It is associated with the deal and is of type string.

delivery_platform

The delivery_platform property represents the delivery platform. It is of type string.

device_type

The device_type property represents the type of device and can have one of the following enum values: phone, tablet, tv, pc, smart-speaker.

dooh

The dooh channel represents digital out-of-home screens.

filter_rate

The filter_rate property represents the rate of filtering applied. It is of type number.

first_quartile_completions

The first_quartile_completions property represents the number of completions in the first quartile. It is of type integer and is classified under the campaign metric category.

global_placement_id

The global_placement_id property serves as the primary key to identifying placements. It is of type string.

Example:"/1111/homepage#728x90"

gmp_compensation_rate

The gmp_compensation_rate property represents the GMP (Green Media Products) compensation rate. A value of 0 means no compensation, 1 means compensating for 100% of emissions, and a value greater than 1 would over-compensate. It is of type number.

Example:1

image_sizes_pixels

The images_sizes_pixels field is associated with the creative group and is of type string.

Example:["300x600,300x250"]

impressions

The impressions property represents the number of delivered impressions. It is of type integer.

Example:1000

insertion_order_id

The insertion_order_id property is required if insertion_order_name is provided. It is of type string.

insertion_order_name

The insertion_order_name property represents the name of the insertion order. It is of type string.

integration_method

The integration_method property represents the method of integration and can have one of the following enum values: prebid-client, prebid-server, ssp, tag-on-page, mediation, sdk. It is of type string.

inventory_id

The inventory_id property represents the domain, app ID, screen identifier, or podcast name. It is of type string.

Example:"nytimes.com"

is_gmp

The is_gmp property designates an impression as a GMP. It is of type boolean.

Example:true

line_item_id

The line_item_id property is required if line_item_name is provided. It is of type string.

line_item_name

The line_item_name property represents the name of the line item. It is of type string.

loss_rate

The loss_rate property represents the rate of loss. It is of type number.

max_placement_size

The max_placement_size property represents the maximum size of the placement. It is of type string.

media_owner

The media_owner property represents the media owner that owns the screen. It is of type string.

midpoints

The midpoints property represents the number of midpoints, content that has reached the midpoint of its duration. It is of type integer.

net_revenue_to_scope3

The net_revenue_to_scope3 property represents the revenue payable to Scope3. It is of type integer.

network

The network property represents the networking connection used by the end user's device and can have one of the following enum values: fixed, mobile. It is of type string.

online video (OLV)

The online video channel represents websites and/or mobile applications offering in-stream advertising in environments where video is not the primary content experience and is typically short-form.

operating_system

The operating_system property represents the operating system. It is of type string.

Example:"ios"

passthrough_rate

The passthrough_rate property represents the passthrough rate. It is of type number.

play_duration_seconds

The play_duration_seconds property represents the duration of play in seconds. It is of type number.

plays

The plays property represents the number of plays. It is of type integer.

po_number

The po_number property represents the required Post Office box number to be included on an invoice. It is of type integer.

progress_events

The progress_events property represents the number of progress events, such as 30s viewed or finished video (for skippable). It is of type integer.

region

The region property represents the 2- or 3-letter region code, only supported for Canada, US, and Australia. It is of type string.

Example:"NY"

rendered_height_pixels

The rendered_height_pixels field is associated with the creative group and is of type integer.

Example:1000

rendered_width_pixels

The rendered_width_pixels field is associated with the creative group and is of type integer.

Example:1000

reporting_identifier

The reporting_identifier property is used for reporting. It is of type string.

requests

The requests property represents the number of requests sent to the bidder. It may be lower than opportunities sent if podding is used properly. It is of type integer.

requests_sent

The requests_sent property represents the number of requests sent to the bidder. It may be lower than opportunities sent if podding is used properly. It is of type integer.

revenue

The revenue property represents the revenue. It is of type number.

row_identifier

The row_identifier property maps back to the row in the response, eliminating the need to pass back all fields. The field must be unique. It is of type string.

Example:"asdfa823"

seconds_streamed

The seconds_streamed property represents the number of seconds streamed. It is of type number.

seller_domain

The seller_domain property represents the canonical seller domain. It is of type string.

seller_id

The seller_id property represents who sees the ad opportunity from (null if we're the publisher). It would be the last entry in schain. It is of type string.

seller_name

The seller_name property represents the seller's name. It is of type string.

seller_placement_id

The seller_placement_id property represents the placement ID sent by the seller. It is of type string.

skips

The skips property represents the number of skips. It is of type integer.

social

The social channel represents websites and/or mobile applications that enable users to create and share content or to participate in social networking.

spend

The spend property represents the spend. It is of type number.

supply_chain

The supply_chain property represents the supply chain. It is of type string.

third_quartile_completions

The third_quartile_completions property represents the number of completions in the third quartile. It is of type integer.

total_audio_data_transfer_bytes

The total_audio_data_transfer_bytes field is associated with the creative group and is of type integer.

Example:150000

total_image_data_transfer_bytes

The total_image_data_transfer_bytes field is associated with the creative group and is of type integer.

Example:150000

total_video_data_transfer_bytes

The total_video_data_transfer_bytes field is associated with the creative group and is of type integer.

Example:500000

total_view_seconds

The total_view_seconds property represents the total view seconds. It is of type number.

time_in_view_seconds

The time_in_view_seconds field is associated with the creative group and is of type float.

Example:5.8

transaction_method

The transaction_method property represents the method used to buy the impressions and can have one of the following enum values: programmatic-open, programmatic-pmp, programmatic-guaranteed, direct, direct-takeover. It is of type string.

url

The url property represents the URL. It is of type string.

utc_datetime

The utc_datetime property represents the UTC 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 time zones. It is of type string and has the format date-time.

Example:2023-08-14 01:00:00

vendor

The vendor canonical name of the creative vendor. It is of type string.

Example:"celtra.com"

venue_category

The venue_category property represents the type of screen, used for screens with incomplete data. It is of type string.

Example:"bus-shelter"

video_bitrate_kbps

The video_bitrate_kbps field is associated with the creative group and is of type integer.

Example:5000

video_duration_seconds

The video_duration_seconds field is associated with the creative group and is of type float.

Example:14.2

video_size_bytes

The video_size_bytes field is associated with the creative group and is of type integer.

Example:150000

video_vast_bytes

The vide_vast_bytes field is associated with the creative group and is of type integer.

Example:150000

video_view_time_seconds

The video_view_time_seconds field is associated with the creative group and is of type float.

Example:6.6

video_view_rate

The video_view_rate field is associated with the creative group and is of type float.

Example:0.8

viewability_data_transfer_rate

The viewability_data_transfer_rate property represents the viewability data transfer rate. It is of type number.

viewability_metric_rate

The viewability_metric_rate property represents the viewability metric rate. It is of type number.

views

The views property represents the number of views. It is of type integer.

web

The web channel represents websites offering display (banner, high impact, native...) or video out-stream ad experiences.