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 |
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 |
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 |
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 |
creative_type | Enum |
0=Image or HTML5 |
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 |
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 .
|
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. |