GMP Upload
This API allows Scope3 partners to upload GMP data for emissions and compensations calculations
Upload Methods
Cloud bucket (preferred): we support data sharing via Google Cloud Storage, Amazon S3, and Microsoft Azure Blob. You can find instructions for configuring your bucket here. We plan to add support for additional cloud providers over the coming months. Please contact your Customer Success Manager to discuss options if you do not use one of the three cloud providers listed above.
POST API: we have an API endpoint for passing CSVs using the below schema. The file limit size is 100MB. If you are interested in enabling, please submit a ticket.
Business Logic
In the event an issue arises during data processing, our support team will reach out. Please submit a ticket if you have an inquiry.
- We will automatically set the
sellerfield to the customer that is uploading the GMP data when the seller field is not provided . - We will not process files including dates that have been previously billed.
CSV Schema
The primary schema is described by the "field name" column below. The first row of the (comma separated) CSV should always contain the field names. The API supports various field name aliases to support the default format from various ad tech platforms.
| Field Name | Required | Data Type | Supported Column Name Headers | Description | Example |
|---|---|---|---|---|---|
| date | ✅ | string | datetime_date, day, day_date, current_date_date, event_date | Date in UTC. Supported Date Structures: YYYY-MM-DD YYYY/MM/DD YYYYMMDD MM-DD-YYYY MM/DD/YYYY MMDDYYYY | 05-04-2022 |
| impressions | ✅ | number | impression, paid_billable_impressions, imps, ad server impressions, total_line_item_level_impressions, ad_impressions | Sum of impressions for these dimensions | 1000 |
| inventory_id | Require at least one of: inventory_id, app, or domain | string | inventory, ad_unit | Fully qualified domain name or app ID (same as inventoryId in campaign API) | nytimes.com |
| app | Require at least one of: inventory_id, app, or domain | string | bundle_id, app_bundle_id, app_url, app_bundle, app_id | com.nytimes.android | |
| domain | Require at least one of: inventory_id, app, or domain | string | page_domain, publisher_domain, site_domain, page_url, allowed_domain, embeded_domain, origin_domain, website_domain | nytimes.com | |
| country | string | ip_country, user_geo_country, geo_country, country_code, country_name | ISO 3166-1 alpha-2 country code. If a country code is not provided, the default global emissions value is used. | US | |
| region | string | ISO 3166-2 region code. If a region is not provided, then the default country value is used. Regions are currently only supported in US, AU, CA. | NY | ||
| device_type | Enum Options: phone, pc, tv, tablet | device_category, device_name, device_type_name | The consumer’s device. If a value is provided outside of the options, we do a best attempt to map any other client inputs such as smart phone ctv etc to the correct device type. If we are unable to map a device or one is not provided, we will infer the device type from the the channel or the device field. | pc | |
| channel | Enum Options: display-web, display-app, streaming-video, social, display, mobile | display-web | |||
| network | Enum Options: fixed, mobile | The networking connection used by the end user's device. | fixed | ||
| deal_id | string | demand_deal, curated_deal, order, seller_deal_id, programmatic_deal_id, deal_id_keycode | The deal id | DEAL-158781 | |
| deal_name | string | demand deal name, programmatic_deal_name, deal | The deal name | CLIENT - BRAND - Q1 - US | |
| transaction_method | Enum Options: programmatic-pmp. programmatic-open. programmatic-guaranteed. direct, direct-takeover | buying_method | The method used to buy the impressions | programmatic-open | |
| buying_platform_domain | string | dsp, programmatic_buyer_id | The domain of the DSP (or exchange) that bought the impression | thetradedesk.com | |
| buying_platform_name | string | dsp_name, buyer_platform_name, programmatic_buyer, buyer_network_name, ad_source_name | The Trade Desk | ||
| buying_seat_name | string | dsp_account_name, bidder | |||
| buying_seat_id | string | member, seat, buyer_seat_id | The seat ID on the DSP that bought the impression - generally maps to a trading desk or agency | 1234 | |
| landing_page_domain | string | advertiser_landing_page | Advertiser landing page | dyson.com | |
| brand_name | string | brand, advertiser_name, advertiser, global_advertiser_name, advertizer_name, advertizer, global_advertizer_name | Dyson |
Updated 12 months ago