Entity Read Files Format - V2

Shared Types

These types define the nested fields in some tables; these fields do not have their own tables.

Numeric Id type

Scalar Description
integer A 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
integer An enumeration of multiple possible options. The different options are described in more detail in the parent type.

Time type

Scalar Description
integer A 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
integer The 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
integer A percentage shown in millis (1/1,000 of a percent), for example 100 means 0.1%.

FileSummary type

Field Name Type Description
name
string The file's file name (not including the bucket or directory name).
num_records
integer The number of entities in the file.
version
integer The 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
id
Numeric 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.
name
string The UI-visible name of the entity.
active
boolean Status 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_code
string Integration code set by the user

ExchangeSettings type

Field Name Type Description
exchange_id
Numeric Id The ID for the exchange. Joinable with SupportedExchange .id
seat_id
string Seat ID for the exchange
seat_user_name
string The user name related to this seat (only applicable for Right Media non-RTB seats).

ApprovalStatus type

Field Name Type Description
auditor
Enum 0=DOUBLECLICK_BID_MANAGER
1=DOUBLECLICK_AD_EXCHANGE
2=APPNEXUS
3=APPNEXUS_MICROSOFT
4=RIGHT_MEDIA_NON_RTB
status
Enum 0=APPROVED
1=REJECTED
2=PENDING
3=NO_AUDIT
4=UN_AUDITABLE
5=UNKNOWN
6=IN_AUDIT
feedback
string Feedback form the auditor which may cotain additional information such as rejection reasons.
sync_time
Time Last time that the entity was synced with the auditor
external_id
Numeric 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_usec
Time Start time of the budget period.
end_time_usec
Time End time of the budget period.
max_impressions
integer Maximum number of impressions for this budget. If this field is missing it is an unlimited-impression budget.
max_spend_advertiser_micros
integer Maximum spend (in advertiser currency micros) for this budget. If this field is missing it is an unlimited-spend budget.
pacing_type
Enum 0=FLIGHT
1=DAILY
pacing_max_impressions
integer Maximum 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_micros
integer Maximum 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_distribution
Enum 0=ASAP
1=EVEN
2=AHEAD

FrequencyCap type

Field Name Type Description
max_impressions
integer The maximum number of impressions in each capping interval.
time_unit
Enum The unit of time:
0=MINUTE
1=HOUR
2=DAY
3=WEEK
4=MONTH
5=LIFE_TIME
time_range
integer The 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_micros
integer CPM 1 Fee in advertiser currency micros.
cpm_fee_2_advertiser_micros
integer CPM 2 Fee in advertiser currency micros.
cpm_fee_3_advertiser_micros
integer CPM 3 Fee in advertiser currency micros.
cpm_fee_4_advertiser_micros
integer CPM 4 Fee in advertiser currency micros.
cpm_fee_5_advertiser_micros
integer CPM 5 Fee in advertiser currency micros.
media_fee_percent_1_millis
integer Media Fee 1 in Percentage Milli
media_fee_percent_2_millis
integer Media Fee 2 in Percentage Milli
media_fee_percent_3_millis
integer Media Fee 3 in Percentage Milli
media_fee_percent_4_millis
integer Media Fee 4 in Percentage Milli
media_fee_percent_5_millis
integer Media Fee 5 in Percentage Milli
cpm_fee_1_cost_type
Enum 0=DEFAULT_COST_TYPE
1=BID_MANAGER_FEE
2=THIRDPARTY_AD_SERVER
3=DOUBLE_VERIFY
4=ADSAFE
5=ADXPOSE
6=VIZU
7=AGGREGATE_KNOWLEDGE
8=TERACENT
9=EVIDON
10=ATD_FEE
11=DMP_FEE
12=INTEGRAL_AD_SCIENCE_PREBID
13=DOUBLE_VERIFY_PREBID
14=SHOP_LOCAL
15=TRUST_METRICS
16=MEDIACOST_DATA
17=INTEGRAL_AD_SCIENCE_VIDEO
18=MOAT_VIDEO
19=NIELSON_OCR
20=COMSCORE_VCE
21=ADLOOX
22=ADLOOX_PREBID
23=EXTRA_XBID_FEE
24=ADLINGO_FEE
25=CUSTOM_FEE_1
26=CUSTOM_FEE_2
27=CUSTOM_FEE_3
28=CUSTOM_FEE_4
29=CUSTOM_FEE_5

The ATD_FEE represents the Agency Trading Desk fee.
cpm_fee_2_cost_type
Enum Same as for cpm_fee_1_cost_type .
cpm_fee_3_cost_type
Enum Same as for cpm_fee_1_cost_type .
cpm_fee_4_cost_type
Enum Same as for cpm_fee_1_cost_type .
cpm_fee_5_cost_type
Enum Same as for cpm_fee_1_cost_type .
media_fee_percent_1_cost_type
Enum Same as for cpm_fee_1_cost_type .
media_fee_percent_2_cost_type
Enum Same as for cpm_fee_1_cost_type .
media_fee_percent_3_cost_type
Enum Same as for cpm_fee_1_cost_type .
media_fee_percent_4_cost_type
Enum Same as for cpm_fee_1_cost_type .
media_fee_percent_5_cost_type
Enum Same as for cpm_fee_1_cost_type .
cpm_fee_1_bill_to_type
Enum 0=DEFAULT_BILL_TO_TYPE
1=INVITE_MEDIA
2=PARTNER
cpm_fee_2_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .
cpm_fee_3_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .
cpm_fee_4_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .
cpm_fee_5_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .
media_fee_percent_1_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .
media_fee_percent_2_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .
media_fee_percent_3_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .
media_fee_percent_4_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .
media_fee_percent_5_bill_to_type
Enum Same as for cpm_fee_1_bill_to_type .

PartnerRevenueModel type

Field Name Type Description
type
Enum 0=CPM
1=MEDIA_COST_MARKUP
2=TOTAL_MEDIA_COST_MARKUP
amount_advertiser_micros
integer The revenue amount in advertiser current micros. This value is only set if the type is CPM .
media_cost_markup_percent_millis
integer The revenue percentage markup in Percentage Milli . This value is only set if the type is MEDIA_COST_MARKUP or TOTAL_MEDIA_COST_MARKUP .
post_view_conversion_tracking_fraction
float Fraction 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_id
Numeric Id The ID of the tracking pixel - note that two CostTrackingPixel s may share the same pixel_id but have different view or click window values.

This value can be joined with Pixel .common_data.id .
view_window_minutes
integer The number of minutes in which to look for post-view conversions.
click_window_minutes
integer The number of minutes in which to look for post-click conversions.
floodlight_activity_id
Numeric Id CM Floodlight activity ids. This value can be joined with Pixel .dcm_floodlight_id .

Target type

Field Name Type Description
criteria_id
Numeric Id Joinable with another table depending on the type defined in the TargetList . This value might be missing.
parameter
string Additional parameter whose definition depends on the type defined in the TargetList . This value might be missing.
excluded
boolean When 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 types representing the union of targets.
excluded
boolean When 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 types for inventory sources. Target .criteria_id is joinable with InventorySource .id and Target .parameter is undefined.
geo_locations
[Target] Array of Target types for geo locations. Target .criteria_id is joinable with GeoLocation .id and Target .parameter is undefined.
ad_position
Target A Target indicating the advert's position on the publisher page. The Target .criteria_id values are
0=ALL_POSITIONS
1=ABOVE_THE_FOLD
2=BELOW_THE_FOLD
3=UNKNOWN_POSITION

Target .parameter is undefined.
net_speed
Target A Target indicating the network speed.
The Target .criteria_id values are:
0=ALL_CONNECTION_SPEEDS
1=BROADBAND (2.0mbps and faster).
2=DIALUP (56 kbps and slower).
3=UNKNOWN_CONNECTION_SPEED
4=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 is undefined.
browsers
TargetUnion TargetUnion type for browsers. Target .criteria_id is joinable with Browser .id and Target .parameter is undefined.
device_criteria
[Target] Array of Target types for device criteria. Target .criteria_id is joinable with DeviceCriteria .id and Target .parameter is undefined.
languages
TargetUnion TargetUnion type for language. Target .criteria_id is joinable with Language .id and Target .parameter is undefined.
day_parting
TargetUnion TargetUnion type for day parting. Target .criteria_id has 6 digits: (TimeZone)(DayOfWeek)(StartTime)(EndTime)

TimeZone:
0=USER
1=EASTERN
2=PACIFIC
3=LONDON
4=COPENHAGEN
5=SYDNEY
6=AUCKLAND
7=HONG_KONG
8=TOKYO
9=CALCUTTA
10=ADVERTISER


DayOfWeek:
0=MONDAY
1=TUESDAY
2=WEDNESDAY
3=THURSDAY
4=FRIDAY
5=SATURDAY
6=SUNDAY


StartTime:
Minutes since midnight, divied by 15. Range from 0 to 95.

EndTime:
Minutes since midnight, dividied by 15. Range from 1 to 96.

For example a value of 200380 means Monday 00:45 to 20:00 in Pacific time.

Target .parameter is undefined.
audience_intersect
[TargetUnion] Array of TargetUnion types for the intersection of audiences, for example
[{“union”: [A, B]},
 {“union”: [C, D]},
 {“union”: [E, F],
 “excluded”: true}]
Would mean "(A OR B) AND (C OR D) AND NOT (E OR F)".

Target .criteria_id is joinable with UserList .id and Target .parameter is the pixel recency value in microseconds. If this value is missing then it means targeting all audiences.
keywords
[Target] Array of Target types for keywords. Target .criteria_id is undefined and Target .parameter is a single keyword.
kct_include_uncrawled_sites
boolean Flag to indicate whether unindexed websites should be included in the KCT.
page_categories
[Target] Array of Target types for AdExchange page verticals . Target .criteria_id is the numeric ID of a vertical and Target .parameter is undefined.
universal_channels
[Target] Array of Target types for channels. Target .criteria_id is joinable with UniversalChannel .id and Target .parameter is undefined.
sites
[Target] Array of Target types for sites. Target .criteria_id is joinable with UniversalSite .id or is not set if the site is not in UniversalSite . Target .parameter is a site such as google.com but is not necessarily found in UniversalSite .
isps
TargetUnion TargetUnion type for Internet Service Provider. Target .criteria_id is joinable with ISP .id and Target .parameter is undefined.

SummaryFile type

Field Name Type Description
file
[FileSummary] An array of zero or more FileSummary entries. If this array is empty then there was no data generated on that date.

UserListAdvertiserPricing type

Field Name Type Description
pricing
UserListPricing
advertiser_id
Numeric Id

UserListPricing type

Field Name Type Description
cost_type
string
currency_code
string ISO 4217 three-letter currency code, for example USD for US Dollars.
cost_micros
Currency Micro

Private Tables

Partner table

Field Name Type Description
common_data
EntityCommonData Contains the common data about this partner such as name and ID.
currency_code
string ISO 4217 three-letter currency code, for example USD for US Dollars.
exchange_settings
[ExchangeSettings] Array of ExchangeSettings types containing information such as their seat IDs. Only enabled exchanges will be present.
default_partner_costs
PartnerCosts Contains information about the deafault costs for this partner.
default_partner_revenue_model
PartnerRevenueModel Contains information about the default revenue model for this partner.
default_target_list
TargetList Contains the default targeting options for the partner. Currently only default geo-targeting is supported here.

Advertiser table

Field Name Type Description
common_data
EntityCommonData Contains the common data about this advertiser such as name and ID.
partner_id
Numeric Id The ID of the parent partner object. Joinable with Partner .common_data.id .
currency_code
string ISO 4217 three-letter currency code, for example USD for US Dollars.
timezone_code
string The 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_url
string The 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_configuration
Enum 0=NONE
1=NORMAL
2=HYBRID
dcm_network_id
Numeric Id The ID of the CM360 network. This value will be missing if the dcm_configuration is set as NONE .
dcm_advertiser_id
Numeric Id The ID of the CM360 advertiser. This value will be missing if the dcm_configuration is set as NONE .
dcm_floodlight_group_id
Numeric 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_tags
boolean OBA tags are enabled when this is set as true .

Campaign table

Field Name Type Description
common_data
EntityCommonData Contains the common data about this campaign such as name and ID.
advertiser_id
Numeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id
budget
Budget The planned budget for this campaign. Includes the start time and end time.
frequency_cap
FrequencyCap The frequency cap active for this campaign. This value will be missing if there is no frequency cap set.
default_target_list
TargetList Contains information about the targeting in effect for this campaign.
uses_video_creatives
boolean When set to true, video insertion orders will be recommended.
uses_display_creatives
boolean When set to true, display insertion orders will be recommended.
uses_audio_creatives
boolean When set to true, audio insertion orders will be recommended.
objective
Enum Values are:
1 = BRAND_AWARENESS
2 = ONLINE_ACTION
3 = OFFLINE_ACTION
4 = APP_INSTALL
metric
Enum 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 = IMPRESSIONS
2 = VIEWABLE_IMPRESSIONS
3 = CPM
4 = CPV
5 = UNIQUES
6 = GRP
7 = TRP
8 = VCR
9 = CPA
10 = ROAS
11 = CTR
12 = CPC
13 = CVR
14 = CPI
15 = VIEWABLE_PERCENT
16 = CPIAVC
17 = OTHER
objective_description
String When the metric is OTHER this is the short the description of the metric.
metric_amount_micros
integer The target amount for the metric in micros.

InsertionOrder table

Field Name Type Description
common_data
EntityCommonData
advertiser_id
Numeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id .
campaign_id
Numeric Id The ID of the parent campaign object.
overall_budget
Budget 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_cap
FrequencyCap The frequency cap active for this insertion order. This value will be missing if there is no frequency cap set.
default_partner_costs
PartnerCosts
default_target_list
TargetList

LineItem table

Field Name Type Description
common_data
EntityCommonData
line_item_type
Enum 0=RTB
1=RMX_NON_RTB
2=RTB_EXPANDABLE
3=RTB_MOBILE
4=RTB_VIDEO
5=TRUEVIEW
6=NON_RTB_EXCHANGES
7=RTB_AUDIO
8=GMAIL
9=ADWORDS_UAC
11=OUT_OF_HOME
insertion_order_id
Numeric 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_micros
integer The maximum CPM value in advertiser currency micros.
performance_goal
Enum 0=NONE (vCPM is disabled)
1=CPC
2=CPA
3=ROI
4=CPCV
5=CPM
6=AVCPM
7=IMP_VALUE_ROAS
8=CIVA
9=IVO_TEN
10=AV_VIEWED
11=INCREMENTAL_CONVERSIONS
goal_advertiser_micros
integer The vCPM goal in advertiser currency micros. This value will be missing if the performance_goal is set as NONE .
partner_revenue_model
PartnerRevenueModel The partner revenue model being used for this line item.
cost_tracking_pixels
[CostTrackingPixel] Array of CostTrackingPixels assigned to track this line item.
Budget
Budget The overall budget for this line item. Includes the start time and the end time.
frequency_cap
FrequencyCap The frequency cap active for this line item. This value will be missing if there is no frequency cap set.
partner_costs
PartnerCosts
target_list
TargetList Contains information about the targeting in effect for this line item.

Creative table

Field Name Type Description
common_data
EntityCommonData
advertiser_id
Numeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id .
dcm_placement_id
Numeric Id The CM360 placement ID associated with this creative.
width_pixels
integer The width of the creative in pixels.
height_pixels
integer The height of the creative in pixels.
approval_status
[ApprovalStatus] An array containing ApprovalStatus objects representing the status of the creatives in exchanges which approve creatives.
expanding_direction
Enum 0=Not Expandable
1=Expanding Up
2=Expanding Down
3=Expanding Left
4=Expanding Right
5=Expanding Up Left
6=Expanding Up Right
7=Expanding Down Left
8=Expanding Down Right
9=Expanding Up or Down
10=Expanding Left or Right
11=Expanding Any Diagonal
creative_type
Enum 0=Image or HTML5
1=Expandable
2=Video
3=Mobile
4=Native Site
5=Facebook Exchange Page Post (News Feed) Ads
6=Templated App Install Mobile Ads (Banner)
10=Native Site Square
12=Templated App Install Mobile Ads (Interstitial/Video Interstitial)
13=Lightbox
14=Native App Install
15=Native App Install Square
16=Audio
17=Publisher Hosted
18=Native Video
22=Flipbook
23=Templated App Install Video
24=TRACKING

Pixel table

Field Name Type Description
common_data
EntityCommonData
advertiser_id
Numeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id .
partner_id
Numeric Id The ID of the parent partner object. Joinable with Partner .common_data.id .
dcm_floodlight_id
Numeric Id The DFA Floodlight ID associated with this pixel.
allow_google_redirect
boolean
allow_rm_redirect
boolean When set to true the pixel will be enabled for reidrection to/from Right Media.
remarketing_enabled
boolean When 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_secure
boolean When 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_data
EntityCommonData
advertiser_id
Numeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id .
partner_id
Numeric Id The ID of the parent advertiser's managing partner object. Joinable with Partner .common_data.id .
remarketing_enabled
boolean When set to true this activity will be enabled for use in targeting.
ssl_required
boolean When set to true tags are required to be compliant.

InventorySource table

Field Name Type Description
id
Numeric Id Unique key for the inventory source.
unclassified
boolean When set to true all unclassified inventory will be included.
inventory_name
string The 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_id
Numeric 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.id , permissioned to use this inventory source.

Note: If an inventory source is available to ALL advertisers, this field will not be present.

external_id
string The 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_micros
integer The effective floor price of this inventory source in currency micros.
min_cpm_currency_code
string The 3-letter ISO 4217 currency code used for the min_cpm_micros .

UserList table

Field Name Type Description
id
Numeric Id Unique key for the user list.
name
string The name of the user list as shown in the UI.
data_partner_id
Numeric Id Joinable with DataPartner .id . This field is only set for third party user lists.
accessing_advertisers
[Numeric Id] An array of advertiser IDs, joinable with Advertiser .common_data.id , permissioned to use this user list.

Note: If a user list is available to ALL advertisers, this field will not be present.

partner_pricing
UserListPricing 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
id
Numeric Id Unique key for the custom affinity.
name
string The name of the custom affinity as shown in the UI.
description
string The description of the custom affinity as shown in the UI.
advertiser_id
Numeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id .

UniversalChannel table

Field Name Type Description
id
Numeric Id Unique key for the channel.
name
string The name of the channel as shown in the UI.
site_ids
[Numeric Id] An array containing the IDs of the UniversalSite s in this channel. Joinable with UniversalSite .id .
accessing_advertisers
[Numeric Id] An array of advertiser IDs, joinable with Advertiser .common_data.id , permissioned to use this channel.

Note: If a channel is available to ALL advertisers, this field will not be present.

is_deleted
boolean When 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_channel
boolean When 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
id Numeric Id Unique key for the negative keyword list.
name string The name of the negative keyword list as shown in the UI.
advertiser_id Numeric Id The ID of the parent advertiser object. Joinable with Advertiser .common_data.id .

Public Tables

SupportedExchange table

Field Name Type Description
id
Numeric Id Unique key for the exchange.
name
string Name of the exchange, for example Ad Exchange .

DataPartner table

Field Name Type Description
id
Numeric Id Unique key for the third party data provider.
name
string Name of the third party data provider, for example BlueKai .

UniversalSite table

Field Name Type Description
id
Numeric Id Unique key for the universal site.
name
string The site URL or name, for example google.com or Google Unclassified .

SiteIdToPlacementId table

Field Name Type Description
siteId
Numeric Id Mapping from Universal Site ID to Web Placement IDs.
placementId
Numeric Id The web placement URL or name, for example google.com or Google Unclassified .

GeoLocation table

Field Name Type Description
id
Numeric Id Unique key for the geo location.
canonical_name
string Comma-concatenated string of location and its parents. Example: "Seattle, Washington, United States".
geo_name
string Name of location. Example: "Seattle".
country_code
string ISO-3166 alpha-2 country code for this geo location, for example US .
region_code
string ISO-3166-2 subdivision code for this geo location, for example US-WA . This field might be missing.
city_name
string The name of the city for this geo location, for example Seattle . This field might be missing.
postal_code
string The postal code for this geo location, for example 98033 . This field might be missing.
dma_code
integer The DMA code for this geo location, for example 510 . This field might be missing.

Language table

Field Name Type Description
id
Numeric Id Unique key for this language.
code
string ISO-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
id
Numeric Id Unique key for this Device Criteria.
is_mobile
boolean If 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.
name
string The familiar name of the Device Criteria.
criteria_type
Enum 0=OPERATING_SYSTEM
1=MOBILE_MAKE_MODEL
2=DEVICE_TYPE
operating_system_id
Numeric Id Identifies the operating system. This field is only populated when the criteria_type is 0 .
mobile_brand_name
string The brand name of the device. This field is only populated when the criteria_type is 1 .
mobile_model_name
string The model name of the device. This field is only populated when the criteria_type is 1 . Optional.
mobile_make_model_id
Numeric Id Identifies the model number of the device. This field is only populated when the criteria_type is 1 . Optional.
device_type
Enum Indicates the type of device. This field is only populated when the criteria_type is 2 .

0=COMPUTER
1=OTHER
2=SMARTPHONE
3=TABLET
4=SMARTTV
5=CONNECTEDTV
6=SET_TOP_BOX
7=CONNECTEDDEVICE

Browser table

Field Name Type Description
id
Numeric Id Unique key for this browser.
is_mobile
boolean If 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.
name
string The familiar name of the browser, for example Safari 5 . It does not include the full user-agent string.

Isp table

Field Name Type Description
id
Numeric Id Unique key for this Internet Service Provider.
is_mobile
boolean If 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.
name
string The name of this Internet Service Provider.
secondary_criteria_id
integer Optional alternative ID that can be used to identify the entity.

AppCollection table

Field Name Type Description
id
Numeric Id Unique key for this app collection.
name
string The name of this app collection.
Create a Mobile Website
View Site in Mobile | Classic
Share by: