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.
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.
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.
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.
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).
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.
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.
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.
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
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.
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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-07 UTC."],[[["Entity Read Files, providing data on advertisers, campaigns, and other entities, will be sunset on October 31, 2024, requiring migration to the Display & Video 360 API."],["Shared data types like `Numeric Id`, `Enum`, `Time`, and custom types like `Budget` and `FrequencyCap` are used across various entities to represent specific attributes."],["Data is organized into tables like `Advertiser`, `Campaign`, `LineItem`, and `Creative`, each containing specific fields relevant to their respective entities."],["Tables are interconnected via joinable fields, enabling linking and analysis of data across entities, such as joining `Advertiser` and `Campaign` using `advertiser_id`."],["The `InventorySource` table provides details about ad inventory, including its source, accessibility for advertisers, and associated costs."]]],["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"]]
