Entity Read Files Format - V2
Stay organized with collections
Save and categorize content based on your preferences.
outlined_flag
Entity Read Files (ERF) are being sunsetted, and users should transition to the Display & Video 360 API.
V2 ERF files have a specific format outlined in the document, categorized into Shared Types, Private Tables, and Public Tables.
Null scalars and empty arrays are not included in ERF files.
Null scalars as well as empty arrays are omitted from the files.
Shared Types
These types define the nested fields in some tables; these fields do not have their own tables.
Numeric Id type
Scalar Description integerA numerical ID number used as an identifier for entities. The IDs should not be treated as universally unique, for example there may be the same ID value used for a Campaign that is also used for a Pixel.
Enum type
Scalar Description integerAn enumeration of multiple possible options. The different options are described in more detail in the parent type.
Time type
Scalar Description integerA unix time in microseconds (1/1,000,000 second), for example 1330403779608570 represents Tuesday February 28th 2012 04:36:19.608570.
Currency Micro type
Scalar Description integerThe currency-specific amount in micros (1/1,000,000 of a currency unit), for example if the currency was EUR, 75000000 would mean €75 or if the currency was USD, 250000 would mean $0.25. There is no conversion to or from dollar amounts.
Percentage Milli type
Scalar Description integerA percentage shown in millis (1/1,000 of a percent), for example 100 means 0.1%.
FileSummary type
Field Name Type Description namestringThe file's file name (not including the bucket or directory name). num_recordsintegerThe number of entities in the file. versionintegerThe major version number of the file. This number may change if new versions of the entity data format are created in the future.
EntityCommonData type
Field Name Type Description idNumeric Id Unique ID within each entity type - for example with Partner entities this ID would be the Partner ID, for Advertisers it would be the Advertiser ID and so on. namestringThe UI-visible name of the entity. activebooleanStatus as set by the user - the entity may not be serving for other reasons, e.g. a depleted budget, out of flight and so on. integration_codestringIntegration code set by the user
ExchangeSettings type
Field Name Type Description exchange_idNumeric Id The ID for the exchange. Joinable with SupportedExchange .id seat_idstringSeat ID for the exchange seat_user_namestringThe user name related to this seat (only applicable for Right Media non-RTB seats).
ApprovalStatus type
Field Name Type Description auditorEnum 0=DOUBLECLICK_BID_MANAGERstatusEnum 0=APPROVEDfeedbackstringFeedback form the auditor which may cotain additional information such as rejection reasons. sync_timeTime Last time that the entity was synced with the auditor external_idNumeric Id Populated only if auditor is APPNEXUS, APPNEXUS_MICROSOFT or RIGHT_MEDIA_NON_RTB. This is the id of the entity in the auditor space.
Budget type
Field Name Type Description start_time_usecTime Start time of the budget period. end_time_usecTime End time of the budget period. max_impressionsintegerMaximum number of impressions for this budget. If this field is missing it is an unlimited-impression budget. max_spend_advertiser_microsintegerMaximum spend (in advertiser currency micros) for this budget. If this field is missing it is an unlimited-spend budget. pacing_typeEnum 0=FLIGHTpacing_max_impressionsintegerMaximum number of impressions per pacing interval set by the pacing_type. If this field is missing then there is not limit on impressions. pacing_max_spend_advertiser_microsintegerMaximum spend (in advertiser currency micros) per pacing interval set by the pacing_type. If this field is missing then there is not limit on spend. pacing_distributionEnum 0=ASAP
FrequencyCap type
Field Name Type Description max_impressionsintegerThe maximum number of impressions in each capping interval. time_unitEnum The unit of time:0=MINUTE time_rangeintegerThe number of time_units, for example if the time_unit were 1 then a value of 6 for time_range is 6 hours.
PartnerCosts type
Field Name Type Description cpm_fee_1_advertiser_microsintegerCPM 1 Fee in advertiser currency micros. cpm_fee_2_advertiser_microsintegerCPM 2 Fee in advertiser currency micros. cpm_fee_3_advertiser_microsintegerCPM 3 Fee in advertiser currency micros. cpm_fee_4_advertiser_microsintegerCPM 4 Fee in advertiser currency micros. cpm_fee_5_advertiser_microsintegerCPM 5 Fee in advertiser currency micros. media_fee_percent_1_millisintegerMedia Fee 1 in Percentage Milli media_fee_percent_2_millisintegerMedia Fee 2 in Percentage Milli media_fee_percent_3_millisintegerMedia Fee 3 in Percentage Milli media_fee_percent_4_millisintegerMedia Fee 4 in Percentage Milli media_fee_percent_5_millisintegerMedia Fee 5 in Percentage Milli cpm_fee_1_cost_typeEnum 0=DEFAULT_COST_TYPEATD_FEE represents the Agency Trading Desk fee.cpm_fee_2_cost_typeEnum Same as for cpm_fee_1_cost_type. cpm_fee_3_cost_typeEnum Same as for cpm_fee_1_cost_type. cpm_fee_4_cost_typeEnum Same as for cpm_fee_1_cost_type. cpm_fee_5_cost_typeEnum Same as for cpm_fee_1_cost_type. media_fee_percent_1_cost_typeEnum Same as for cpm_fee_1_cost_type. media_fee_percent_2_cost_typeEnum Same as for cpm_fee_1_cost_type. media_fee_percent_3_cost_typeEnum Same as for cpm_fee_1_cost_type. media_fee_percent_4_cost_typeEnum Same as for cpm_fee_1_cost_type. media_fee_percent_5_cost_typeEnum Same as for cpm_fee_1_cost_type. cpm_fee_1_bill_to_typeEnum 0=DEFAULT_BILL_TO_TYPEcpm_fee_2_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type. cpm_fee_3_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type. cpm_fee_4_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type. cpm_fee_5_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type. media_fee_percent_1_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type. media_fee_percent_2_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type. media_fee_percent_3_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type. media_fee_percent_4_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type. media_fee_percent_5_bill_to_typeEnum Same as for cpm_fee_1_bill_to_type.
PartnerRevenueModel type
Field Name Type Description typeEnum 0=CPMamount_advertiser_microsintegerThe revenue amount in advertiser current micros. This value is only set if the type is CPM. media_cost_markup_percent_millisintegerThe revenue percentage markup in Percentage Milli MEDIA_COST_MARKUP or TOTAL_MEDIA_COST_MARKUP. post_view_conversion_tracking_fractionfloatFraction of post-view conversions to be counted for conversion tracking. If it is 0, only post-click conversions are counted; if 1.0 all conversions are tracked.
CostTrackingPixel type
Field Name Type Description pixel_idNumeric Id The ID of the tracking pixel - note that two CostTrackingPixel pixel_id but have different view or click window values.Pixel .common_data.id view_window_minutesintegerThe number of minutes in which to look for post-view conversions. click_window_minutesintegerThe number of minutes in which to look for post-click conversions. floodlight_activity_idNumeric Id CM Floodlight activity ids. This value can be joined with Pixel .dcm_floodlight_id
Target type
Field Name Type Description criteria_idNumeric Id Joinable with another table depending on the type defined in the TargetList parameterstringAdditional parameter whose definition depends on the type defined in the TargetList excludedbooleanWhen true this means that the target is excluded. A missing value means false.
TargetUnion type
Field Name Type Description union[Target] An array of Target excludedbooleanWhen true this means that the target union is excluded. A missing value means false.
TargetList type
Field Name Type Description
inventory_sources[Target] Array of
Target Target .criteria_idInventorySource .idTarget .parameter
geo_locations[Target] Array of Target Target .criteria_idGeoLocation .idTarget .parameter ad_positionTarget A Target Target .criteria_id0=ALL_POSITIONSTarget .parameter
net_speedTarget A Target Target .criteria_id0=ALL_CONNECTION_SPEEDS1=BROADBAND (2.0mbps and faster).2=DIALUP (56 kbps and slower).3=UNKNOWN_CONNECTION_SPEED4=EDGE (Enhanced Data for GSM Evolution (2G). 57 kbps and faster).5=UMT (Universal Mobile Telecom System (3G). 384 kbps and faster).6=DSL (Digital Subscriber Line. 768 kbps and faster).7=HSDPA (High-Speed Downlink Packet Access (3.5G). 1.8mpbs and faster).Target .parameter
browsersTargetUnion TargetUnion Target .criteria_idBrowser .idTarget .parameterdevice_criteria[Target] Array of Target types for device criteria. Target .criteria_idDeviceCriteria .idTarget .parameterlanguagesTargetUnion TargetUnion Target .criteria_idLanguage .idTarget .parameterday_partingTargetUnion TargetUnion Target .criteria_id(TimeZone)(DayOfWeek)(StartTime)(EndTime)0=USER0=MONDAY200380 means Monday 00:45 to 20:00 in Pacific time.Target .parameteraudience_intersect[TargetUnion] Array of TargetUnion
[{“union”: [A, B]},
{“union”: [C, D]},
{“union”: [E, F],
“excluded”: true}] Target .criteria_idUserList .idTarget .parameter keywords[Target] Array of Target Target .criteria_idTarget .parameter kct_include_uncrawled_sitesbooleanFlag to indicate whether unindexed websites should be included in the KCT. page_categories[Target] Array of Target AdExchange page verticals . Target .criteria_idTarget .parameter universal_channels[Target] Array of Target Target .criteria_idUniversalChannel .idTarget .parameter sites[Target] Array of Target Target .criteria_idUniversalSite .idUniversalSite. Target .parametergoogle.com but is not necessarily found in
UniversalSite ispsTargetUnion TargetUnion Target .criteria_idISP .idTarget .parameter
SummaryFile type
Field Name Type Description file[FileSummary] An array of zero or more FileSummary
UserListAdvertiserPricing typeUserListPricing type
Field Name Type Description cost_typestringcurrency_codestringISO 4217 three-letter currency code, for example USD for US Dollars. cost_microsCurrency Micro
Private Tables
Partner table
Field Name Type Description common_dataEntityCommonData Contains the common data about this partner such as name and ID. currency_codestringISO 4217 three-letter currency code, for example USD for US Dollars. exchange_settings[ExchangeSettings] Array of ExchangeSettings default_partner_costsPartnerCosts Contains information about the deafault costs for this partner. default_partner_revenue_modelPartnerRevenueModel Contains information about the default revenue model for this partner. default_target_listTargetList Contains the default targeting options for the partner. Currently only default geo-targeting is supported here.
Advertiser table
Field Name Type Description common_dataEntityCommonData Contains the common data about this advertiser such as name and ID. partner_idNumeric Id The ID of the parent partner object. Joinable with Partner .common_data.id currency_codestringISO 4217 three-letter currency code, for example USD for US Dollars. timezone_codestringThe canonical timezone code, for example "America/Los_Angeles". If the dfa_configuration is set as NORMAL or HYBRID this value will be the same as the associated DFA advertiser's time zone. landing_page_urlstringThe default landing page URL. available_channel_ids[integer]Array of integers containing the available channels associated with this advertiser. Joinable with UniversalChannel .id blacklist_channel_id[integer]Array of integers containing the blacklist channels for this advertiser. Joinable with UniversalChannel .id dcm_configurationEnum 0=NONEdcm_network_idNumeric Id The ID of the CM360 network. This value will be missing if the dcm_configuration is set as NONE. dcm_advertiser_idNumeric Id The ID of the CM360 advertiser. This value will be missing if the dcm_configuration is set as NONE. dcm_floodlight_group_idNumeric Id This value will be missing if the dcm_configuration is set as NONE. dcm_syncable_site_ids[Numeric Id] Array of Numeric Id types for each syncable site for this advertiser. enable_oba_tagsbooleanOBA tags are enabled when this is set as true.
Campaign table
Field Name Type Description common_dataEntityCommonData Contains the common data about this campaign such as name and ID. advertiser_idNumeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id budgetBudget The planned budget for this campaign. Includes the start time and end time. frequency_capFrequencyCap The frequency cap active for this campaign. This value will be missing if there is no frequency cap set. default_target_listTargetList Contains information about the targeting in effect for this campaign. uses_video_creativesbooleanWhen set to true, video insertion orders will be recommended. uses_display_creativesbooleanWhen set to true, display insertion orders will be recommended. uses_audio_creativesbooleanWhen set to true, audio insertion orders will be recommended. objectiveEnum
Values are:1 = BRAND_AWARENESS2 = ONLINE_ACTION3 = OFFLINE_ACTION4 = APP_INSTALL metricEnum
Key performance indicator. Use this field to keep track of the primary metric you'll use to evaluate the success of your campaign.
Possible values are:1 = IMPRESSIONS2 = VIEWABLE_IMPRESSIONS3 = CPM4 = CPV5 = UNIQUES6 = GRP7 = TRP8 = VCR9 = CPA10 = ROAS11 = CTR12 = CPC13 = CVR14 = CPI15 = VIEWABLE_PERCENT16 = CPIAVC17 = OTHER
objective_descriptionStringWhen the metric is OTHER this is the short the description of the metric. metric_amount_microsintegerThe target amount for the metric in micros.
InsertionOrder table
Field Name Type Description common_dataEntityCommonData advertiser_idNumeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id campaign_idNumeric Id The ID of the parent campaign object. overall_budgetBudget The overall budget for this insertion order. Includes the start time and the end time. scheduled_segments[Budget] Contains any scheduled budget segments. This array might be empty or entirely absent. frequency_capFrequencyCap The frequency cap active for this insertion order. This value will be missing if there is no frequency cap set. default_partner_costsPartnerCosts default_target_listTargetList
LineItem table
Field Name Type Description common_dataEntityCommonData line_item_typeEnum 0=RTB
insertion_order_idNumeric Id The ID of the parent insertion order object. Joinable with
InsertionOrder .common_data.id
creative_ids[Numeric Id] An array of creatives that are assigned to this line item. Joinable with Creative .common_data.id max_cpm_advertiser_microsintegerThe maximum CPM value in advertiser currency micros. performance_goalEnum 0=NONE (vCPM is disabled)1=CPCgoal_advertiser_microsintegerThe vCPM goal in advertiser currency micros. This value will be missing if the performance_goal is set as NONE. partner_revenue_modelPartnerRevenueModel The partner revenue model being used for this line item. cost_tracking_pixels[CostTrackingPixel] Array of CostTrackingPixels assigned to track this line item. BudgetBudget The overall budget for this line item. Includes the start time and the end time. frequency_capFrequencyCap The frequency cap active for this line item. This value will be missing if there is no frequency cap set. partner_costsPartnerCosts target_listTargetList Contains information about the targeting in effect for this line item.
Creative table
Field Name Type Description common_dataEntityCommonData advertiser_idNumeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id dcm_placement_idNumeric Id The CM360 placement ID associated with this creative. width_pixelsintegerThe width of the creative in pixels. height_pixelsintegerThe height of the creative in pixels. approval_status[ApprovalStatus] An array containing ApprovalStatus expanding_directionEnum 0=Not Expandable
creative_typeEnum 0=Image or HTML5
Pixel table
Field Name Type Description common_dataEntityCommonData advertiser_idNumeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id partner_idNumeric Id The ID of the parent partner object. Joinable with Partner .common_data.id dcm_floodlight_idNumeric Id The DFA Floodlight ID associated with this pixel. allow_google_redirectbooleanallow_rm_redirectbooleanWhen set to true the pixel will be enabled for reidrection to/from Right Media. remarketing_enabledbooleanWhen set to true this pixel will be enabled for use in targeting. This value will be present only if the parent advertiser's dfa_configuration is set as NONE. is_securebooleanWhen set to true this pixel will use HTTPS. This value will be present only if the parent advertiser's dfa_configuration is set as NONE.
Floodlight Activity table
Field Name Type Description common_dataEntityCommonData advertiser_idNumeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id partner_idNumeric Id The ID of the parent advertiser's managing partner object. Joinable with Partner .common_data.id remarketing_enabledbooleanWhen set to true this activity will be enabled for use in targeting. ssl_requiredbooleanWhen set to true tags are required to be compliant.
InventorySource table
Field Name Type Description idNumeric Id Unique key for the inventory source. unclassifiedbooleanWhen set to true all unclassified inventory will be included. inventory_namestringThe name of the inventory source as shown in the UI. This field may be absent. If inventory_name is absent and unclassified is true, it refers to the unclassified inventory of the exchange. If it is absent and unclassified is false, the inventory source is exchange level inventory. exchange_idNumeric Id The ID of the exchange where this inventory source is available. Joinable with SupportedExchange .id accessing_advertisers[Numeric Id] An array of advertiser IDs, joinable with Advertiser .common_data.idNote: If an inventory source is available to ALL advertisers, this field will not be present.
external_idstringThe external ID given to this inventory source and defined by the exchange, typically known as a deal or seller ID. This field might be absent. min_cpm_microsintegerThe effective floor price of this inventory source in currency micros. min_cpm_currency_codestringThe 3-letter ISO 4217 currency code used for the min_cpm_micros.
UserList table
Field Name Type Description idNumeric Id Unique key for the user list. namestringThe name of the user list as shown in the UI. data_partner_idNumeric Id Joinable with DataPartner .id accessing_advertisers[Numeric Id] An array of advertiser IDs, joinable with Advertiser .common_data.idNote: If a user list is available to ALL advertisers, this field will not be present.
partner_pricingUserListPricing Cost type will always be CPM, Currency Code will always be USD. advertiser_pricings[UserListAdvertiserPricing] Cost type will always be CPM, Currency Code will always be USD.
CustomAffinity table
Field Name Type Description
idNumeric Id Unique key for the custom affinity.
namestringThe name of the custom affinity as shown in the UI.
descriptionstringThe description of the custom affinity as shown in the UI.
advertiser_idNumeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id
UniversalChannel table
Field Name Type Description idNumeric Id Unique key for the channel. namestringThe name of the channel as shown in the UI. site_ids[Numeric Id] An array containing the IDs of the UniversalSite UniversalSite .id accessing_advertisers[Numeric Id] An array of advertiser IDs, joinable with Advertiser .common_data.idNote: If a channel is available to ALL advertisers, this field will not be present.
is_deletedbooleanWhen set to true no new line items will be able to target this channel, butexisting line items that already target this channel will continue to do so. is_brand_safe_channelbooleanWhen set to true this channel can be used for brand safety filtering. Currently this is true only for the 4 built in brand safety tiers.
NegativeKeywordList table
Field Name Type Description
idNumeric Id Unique key for the negative keyword list.
namestringThe name of the negative keyword list as shown in the UI.
advertiser_idNumeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id
Public Tables
SupportedExchange table
Field Name Type Description idNumeric Id Unique key for the exchange. namestringName of the exchange, for example Ad Exchange.
DataPartner table
Field Name Type Description idNumeric Id Unique key for the third party data provider. namestringName of the third party data provider, for example BlueKai.
UniversalSite table
Field Name Type Description idNumeric Id Unique key for the universal site. namestringThe site URL or name, for example google.com or Google Unclassified.
SiteIdToPlacementId table
Field Name Type Description siteIdNumeric Id Mapping from Universal Site ID to Web Placement IDs. placementIdNumeric Id The web placement URL or name, for example google.com or Google Unclassified.
GeoLocation table
Field Name Type Description idNumeric Id Unique key for the geo location. canonical_namestringComma-concatenated string of location and its parents. Example: "Seattle, Washington, United States". geo_namestringName of location. Example: "Seattle". country_codestringISO-3166 alpha-2 country code for this geo location, for example US. region_codestringISO-3166-2 subdivision code for this geo location, for example US-WA. This field might be missing. city_namestringThe name of the city for this geo location, for example Seattle. This field might be missing. postal_codestringThe postal code for this geo location, for example 98033. This field might be missing. dma_codeintegerThe DMA code for this geo location, for example 510. This field might be missing.
Language table
Field Name Type Description idNumeric Id Unique key for this language. codestringISO-639-1 code for this language, or one of zh_CN for Chinese (simplified), zh_TW for Chinese (traditional), or other for other languages.
DeviceCriteria table
Field Name Type Description idNumeric Id Unique key for this Device Criteria. is_mobilebooleanIf true, this criterion covers only mobile devices. If false, this entry covers only non-mobile devices, even if its name (e.g., "Other") does not indicate so. namestringThe familiar name of the Device Criteria. criteria_typeEnum 0=OPERATING_SYSTEMoperating_system_idNumeric Id Identifies the operating system. This field is only populated when the criteria_type is 0. mobile_brand_namestringThe brand name of the device. This field is only populated when the criteria_type is 1. mobile_model_namestringThe model name of the device. This field is only populated when the criteria_type is 1. Optional. mobile_make_model_idNumeric Id Identifies the model number of the device. This field is only populated when the criteria_type is 1. Optional. device_typeEnum Indicates the type of device. This field is only populated when the criteria_type is 2.0=COMPUTER
Browser table
Field Name Type Description idNumeric Id Unique key for this browser. is_mobilebooleanIf true, this criterion covers only mobile devices. If false, this entry covers only non-mobile devices, even if its name (e.g., "Other") does not indicate so. namestringThe familiar name of the browser, for example Safari 5. It does not include the full user-agent string.
Isp table
Field Name Type Description idNumeric Id Unique key for this Internet Service Provider. is_mobilebooleanIf true, this criterion covers only mobile devices. If false, this entry covers only non-mobile devices, even if its name (e.g., "Other") does not indicate so. namestringThe name of this Internet Service Provider. secondary_criteria_idintegerOptional alternative ID that can be used to identify the entity.
AppCollection table
Field Name Type Description idNumeric Id Unique key for this app collection. namestringThe name of this app collection.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[null,null,["Last updated 2025-08-28 UTC."],[],["Key data elements include numerical IDs for entities, with non-unique values across different types. Files omit null scalars and empty arrays. Time is recorded as Unix timestamps. Currency is measured in micros. Percentages are in millis. Entity files contain common data like IDs, names, and statuses. Budget settings specify timeframes, impression caps, spending, and pacing. Partner costs and revenue models define fees, markup percentages, and billing. Targeting information involves criteria, exclusions, and unions for inventory sources, geo-locations, devices, and more. Entity Read files are to be replaced by Display & Video 360 API.\n"]]
