Introduction

Datasources and destinations

Fields listing for The Trade Desk

EXPLORE YOUR DATA

Metrics & dimensions

Find the fields you need for your next report.

163 metrics527 dimensions

690 fields

All fields
FieldDetails
01 - Click Conversion
Field IDTTD01ClickConversion
MetricNUMBER
01 - Click Conversion Currency
Field IDTTD01ClickConversionCurrency
MetricNUMBER
01 - Click Conversion Revenue
Field IDTTD01ClickConversionRevenue
MetricNUMBER
01 - Conversion Touch
Field IDTTD01ConversionTouch
MetricNUMBER
01 - Conversion Touch Revenue
Field IDTTD01ConversionTouchRevenue
MetricNUMBER
01 - Time Weighted Decay Conversion
Field IDTTD01TimeWeightedDecayConversion
MetricNUMBER
01 - Time Weighted Decay Conversion Revenue
Field IDTTD01TimeWeightedDecayConversionRevenue
MetricNUMBER
01 - View Through Conversion
Field IDTTD01ViewThroughConversion
MetricNUMBER
01 - View Through Conversion Currency
Field IDTTD01ViewThroughConversionCurrency
MetricNUMBER
01 - View Through Conversion Revenue
Field IDTTD01ViewThroughConversionRevenue
MetricNUMBER
02 - Click Conversion
Field IDTTD02ClickConversion
MetricNUMBER
02 - Click Conversion Currency
Field IDTTD02ClickConversionCurrency
MetricNUMBER
02 - Click Conversion Revenue
Field IDTTD02ClickConversionRevenue
MetricNUMBER
02 - Conversion Touch
Field IDTTD02ConversionTouch
MetricNUMBER
02 - Conversion Touch Revenue
Field IDTTD02ConversionTouchRevenue
MetricNUMBER
02 - Time Weighted Decay Conversion
Field IDTTD02TimeWeightedDecayConversion
MetricNUMBER
02 - Time Weighted Decay Conversion Revenue
Field IDTTD02TimeWeightedDecayConversionRevenue
MetricNUMBER
02 - View Through Conversion
Field IDTTD02ViewThroughConversion
MetricNUMBER
02 - View Through Conversion Currency
Field IDTTD02ViewThroughConversionCurrency
MetricNUMBER
02 - View Through Conversion Revenue
Field IDTTD02ViewThroughConversionRevenue
MetricNUMBER
03 - Click Conversion
Field IDTTD03ClickConversion
MetricNUMBER
03 - Click Conversion Currency
Field IDTTD03ClickConversionCurrency
MetricNUMBER
03 - Click Conversion Revenue
Field IDTTD03ClickConversionRevenue
MetricNUMBER
03 - Conversion Touch
Field IDTTD03ConversionTouch
MetricNUMBER
03 - Conversion Touch Revenue
Field IDTTD03ConversionTouchRevenue
MetricNUMBER
03 - Time Weighted Decay Conversion
Field IDTTD03TimeWeightedDecayConversion
MetricNUMBER
03 - Time Weighted Decay Conversion Revenue
Field IDTTD03TimeWeightedDecayConversionRevenue
MetricNUMBER
03 - View Through Conversion
Field IDTTD03ViewThroughConversion
MetricNUMBER
03 - View Through Conversion Currency
Field IDTTD03ViewThroughConversionCurrency
MetricNUMBER
03 - View Through Conversion Revenue
Field IDTTD03ViewThroughConversionRevenue
MetricNUMBER
04 - Click Conversion
Field IDTTD04ClickConversion
MetricNUMBER
04 - Click Conversion Currency
Field IDTTD04ClickConversionCurrency
MetricNUMBER
04 - Click Conversion Revenue
Field IDTTD04ClickConversionRevenue
MetricNUMBER
04 - Conversion Touch
Field IDTTD04ConversionTouch
MetricNUMBER
04 - Conversion Touch Revenue
Field IDTTD04ConversionTouchRevenue
MetricNUMBER
04 - Time Weighted Decay Conversion
Field IDTTD04TimeWeightedDecayConversion
MetricNUMBER
04 - Time Weighted Decay Conversion Revenue
Field IDTTD04TimeWeightedDecayConversionRevenue
MetricNUMBER
04 - View Through Conversion
Field IDTTD04ViewThroughConversion
MetricNUMBER
04 - View Through Conversion Currency
Field IDTTD04ViewThroughConversionCurrency
MetricNUMBER
04 - View Through Conversion Revenue
Field IDTTD04ViewThroughConversionRevenue
MetricNUMBER
05 - Click Conversion
Field IDTTD05ClickConversion
MetricNUMBER
05 - Click Conversion Currency
Field IDTTD05ClickConversionCurrency
MetricNUMBER
05 - Click Conversion Revenue
Field IDTTD05ClickConversionRevenue
MetricNUMBER
05 - Conversion Touch
Field IDTTD05ConversionTouch
MetricNUMBER
05 - Conversion Touch Revenue
Field IDTTD05ConversionTouchRevenue
MetricNUMBER
05 - Time Weighted Decay Conversion
Field IDTTD05TimeWeightedDecayConversion
MetricNUMBER
05 - Time Weighted Decay Conversion Revenue
Field IDTTD05TimeWeightedDecayConversionRevenue
MetricNUMBER
05 - View Through Conversion
Field IDTTD05ViewThroughConversion
MetricNUMBER
05 - View Through Conversion Currency
Field IDTTD05ViewThroughConversionCurrency
MetricNUMBER
05 - View Through Conversion Revenue
Field IDTTD05ViewThroughConversionRevenue
MetricNUMBER
06 - Click Conversion
Field IDTTD06ClickConversion
MetricNUMBER
06 - Click Conversion Currency
Field IDTTD06ClickConversionCurrency
MetricNUMBER
06 - Click Conversion Revenue
Field IDTTD06ClickConversionRevenue
MetricNUMBER
06 - Conversion Touch
Field IDTTD06ConversionTouch
MetricNUMBER
06 - Conversion Touch Revenue
Field IDTTD06ConversionTouchRevenue
MetricNUMBER
06 - Time Weighted Decay Conversion
Field IDTTD06TimeWeightedDecayConversion
MetricNUMBER
06 - Time Weighted Decay Conversion Revenue
Field IDTTD06TimeWeightedDecayConversionRevenue
MetricNUMBER
06 - View Through Conversion
Field IDTTD06ViewThroughConversion
MetricNUMBER
06 - View Through Conversion Currency
Field IDTTD06ViewThroughConversionCurrency
MetricNUMBER
06 - View Through Conversion Revenue
Field IDTTD06ViewThroughConversionRevenue
MetricNUMBER
Ad Groups Audience Created At
The date and time in UTC the audience was created.
Field IDadGroups.audience.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Audience Id
Field IDadGroups.audience.id
DimensionTEXT
Ad Groups Audience Is Auto Generated
Indicates if this audience was automatically generated by The Trade Desk platform.
Field IDadGroups.audience.isAutoGenerated
DimensionBOOLEAN
Ad Groups Audience Last Updated At
Indicates the time when this audience was last updated (UTC).
Field IDadGroups.audience.lastUpdatedAt
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Audience Name
The name of the audience.
Field IDadGroups.audience.name
DimensionTEXT
Ad Groups Audience Settings Recency Exclusion Window In Minutes
This is the amount of time to exclude users who are in the Excluded Data Groups of the Audience. For example, if your product is purchased at regular intervals by your customers, you may not want to immediately target somebody who just converted, but you may not want to exclude them forever either. So if your Audience excludes "Converted Users" but you know those users are likely to convert again after, say, 7 days, you may want to set your exclusion window to 6 days so you begin showing them ads leading up to their likely 7th-day conversion. This is simply a contrived example and the specific setting will depend on your use case. If you're not sure how to configure this window, 129600 (90 days) is a reasonable default you may want to start with. It's also the default value used if this is not specified on create.
Field IDadGroups.audienceSettings.recencyExclusionWindowInMinutes
DimensionNUMBER
Ad Groups Audience Settings Strategy
Get the Audience Strategy configured for the ad group.
Field IDadGroups.audienceSettings.strategy
DimensionTEXT
Ad Groups Audience Target Everyone
If set to true, indicates that it is a TargetEveryone audience.
Field IDadGroups.audience.targetEveryone
DimensionBOOLEAN
Ad Groups Auto Optimization Settings Is Use Clicks As Conversions Enabled
Controls whether clicks may be counted as primary conversions when conversion data is sparse for optimizing toward conversion-based goals.
Field IDadGroups.autoOptimizationSettings.isUseClicksAsConversionsEnabled
DimensionBOOLEAN
Ad Groups Auto Optimization Settings Is Use Secondary Conversions Enabled
Controls whether secondary conversions may be counted as primary conversions when conversion data is sparse for optimizing toward conversion-based goals.
Field IDadGroups.autoOptimizationSettings.isUseSecondaryConversionsEnabled
DimensionBOOLEAN
Ad Groups Base Bid CPM In Advertiser Currency
Field IDadGroups.baseBidCPMInAdvertiserCurrency
DimensionNUMBER
Ad Groups Bid Settings Distribution For Similar Ad Groups Is Confident
IsConfident is a way of marking that the returned data is not "perfect". If this flag is set to false see the `ConfidenceIssue` field.
Field IDadGroups.bidSettingsDistributionForSimilarAdGroups.isConfident
DimensionBOOLEAN
Ad Groups Bid Settings Distribution For Similar Ad Groups Max Cpm Of Dual Histogram In Target Currency
MaxCpmOfDualHistogramInTargetCurrency describes the max value of the dual histograms so that they can be adjusted for non USD CPMs
Field IDadGroups.bidSettingsDistributionForSimilarAdGroups.maxCpmOfDualHistogramInTargetCurrency
DimensionNUMBER
Ad Groups Budget Current Flight Budget
The budget of the AdGroup's current or next upcoming flight.
Field IDadGroups.budget.currentFlightBudget
DimensionNUMBER
Ad Groups Budget In Advertiser Currency
Field IDadGroups.budgetInAdvertiserCurrency
DimensionNUMBER
Ad Groups Budget In Impressions
The maximum amount of impressions the adGroup should buy.
Field IDadGroups.budgetInImpressions
DimensionNUMBER
Ad Groups Budget Is Fluid
Indicates the ad group's spend in the current flight is fully system optimized, without any manual intervention.
Field IDadGroups.budget.isFluid
DimensionBOOLEAN
Ad Groups Budget Spend Priority
Spend priority controls how the platform allocates value-driven (also known as fluid or unreserved) budget across ad groups within a campaign. Here's what you need to know: - This must be a value between 1 and 10, or `null`. - If set to `null`, the system automatically prioritizes spend for the ad group based on value. - Fixed budgets are always honored, regardless of priority. Priority only influences how the remaining fluid budget is distributed if there is any. - By default, in Kokai, priority acts as a value weight, not a strict order of spend. - Ad groups with a higher priority (lower number) are more likely to receive a larger share of the fluid budget, assuming similar performance and scale. However, this doesn’t mean they spend first; rather, they receive more consideration during allocation.
Field IDadGroups.budget.spendPriority
DimensionNUMBER
Ad Groups Budget Total
The Ad group's total budget in Advertiser currency.
Field IDadGroups.budget.total
DimensionNUMBER
Ad Groups Budget Version
The version of the budgeting experience for the campaign of the ad group.
Field IDadGroups.budget.version
DimensionTEXT
Ad Groups Campaign Active Ad Group Count
The total number of AdGroups owned by the Campaign that are both visible and enabled.
Field IDadGroups.campaign.activeAdGroupCount
DimensionNUMBER
Ad Groups Campaign Auto Allocator Enabled
Field IDadGroups.campaign.autoAllocatorEnabled
DimensionBOOLEAN
Ad Groups Campaign Auto Campaign Cap Enabled
Field IDadGroups.campaign.autoCampaignCapEnabled
DimensionBOOLEAN
Ad Groups Campaign Auto Prioritization Enabled
If set to `true`, enables the platform to automatically direct your budget to the better-performing ad groups first and then allocate the remaining budget to lower-performing ad groups. Requires the `autoAllocatorEnabled` property value to be set to true. The default value for this property is `false`. When you clone a campaign, this value is copied over.
Field IDadGroups.campaign.autoPrioritizationEnabled
DimensionBOOLEAN
Ad Groups Campaign Budget In Impressions
The maximum amount of impressions the campaign should buy. For campaigns with multiple flights, this value is determined using specified flight values and may not be modified.
Field IDadGroups.campaign.budgetInImpressions
DimensionNUMBER
Ad Groups Campaign Channel Type
Field IDadGroups.campaign.channelType
DimensionTEXT
Ad Groups Campaign Created At
The time in UTC the campaign was created. This field is read-only.
Field IDadGroups.campaign.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Campaign Created At Utc
The time in UTC the campaign was created. This field is read-only.
Field IDadGroups.campaign.createdAtUtc
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Campaign Custom CPA Click Weight
Weight to assign to click-through pixels when calculating custom CPA.
Field IDadGroups.campaign.customCPAClickWeight
DimensionNUMBER
Ad Groups Campaign Custom CPA Type
The custom CPA to use to use for the CPA calculation for the campaign.
Field IDadGroups.campaign.customCPAType
DimensionTEXT
Ad Groups Campaign Custom CPA Viewthrough Weight
Weight to assign to view pixels when calculating custom CPA.
Field IDadGroups.campaign.customCPAViewthroughWeight
DimensionNUMBER
Ad Groups Campaign Custom ROAS Type
The custom ROAS calculation for the campaign's Return on Advertiser Spend value.
Field IDadGroups.campaign.customROASType
DimensionTEXT
Ad Groups Campaign Description
An optional description of the campaign.
Field IDadGroups.campaign.description
DimensionTEXT
Ad Groups Campaign End Date
The date and time (in UTC) when the campaign stops spending if it has not yet exhausted its budget. For campaigns with multiple multiple flights, this value is determined using specified flight values and may not be modified.
Field IDadGroups.campaign.endDate
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Campaign Funnel Location Count
The number of distinct Funnel Locations for all visible AdGroups owned by the Campaign.
Field IDadGroups.campaign.funnelLocationCount
DimensionNUMBER
Ad Groups Campaign Id
The ID of the campaign.
Field IDadGroups.campaign.id
DimensionTEXT
Ad Groups Campaign Impressions Only Budgeting CPM
Field IDadGroups.campaign.impressionsOnlyBudgetingCPM
DimensionNUMBER
Ad Groups Campaign Io Contract Id
IO assigned to each campaign for IO clients to manage its spend.
Field IDadGroups.campaign.ioContractId
DimensionNUMBER
Ad Groups Campaign Is Archived
Field IDadGroups.campaign.isArchived
DimensionBOOLEAN
Ad Groups Campaign Is I Spot Enabled
If set to `true`, indicates that ISpot incremental reach KPI has been added. The default value is `false`.
Field IDadGroups.campaign.isISpotEnabled
DimensionBOOLEAN
Ad Groups Campaign Is Managed By TTD
A property to indicate this campaign is managed by The Trade Desk.
Field IDadGroups.campaign.isManagedByTTD
DimensionBOOLEAN
Ad Groups Campaign Is Migrated To Kokai
The campaign has been migrated from a previous version to Kokai.
Field IDadGroups.campaign.isMigratedToKokai
DimensionBOOLEAN
Ad Groups Campaign Is Programmatic Guaranteed
Field IDadGroups.campaign.isProgrammaticGuaranteed
DimensionBOOLEAN
Ad Groups Campaign Is Template
Field IDadGroups.campaign.isTemplate
DimensionBOOLEAN
Ad Groups Campaign Is Tv Squared Enabled
If set to `true`, indicates that TvSquared incremental reach KPI has been added. The default value is `false`.
Field IDadGroups.campaign.isTvSquaredEnabled
DimensionBOOLEAN
Ad Groups Campaign Last Touch Attribution Measured By The Trade Desk
The Trade Desk measure last-touch attribution (recommended for troubleshooting purposes).
Field IDadGroups.campaign.lastTouchAttributionMeasuredByTheTradeDesk
DimensionBOOLEAN
Ad Groups Campaign Last Updated
The time in UTC the campaign was last updated. This field is read-only.
Field IDadGroups.campaign.lastUpdated
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Campaign Last Updated At Utc
The time in UTC the campaign was last updated. This field is read-only.
Field IDadGroups.campaign.lastUpdatedAtUtc
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Campaign Minimum Ad Group Spend In Advertiser Currency
The daily minimum spend amount that you want the platform to allocate to all ad groups in a campaign that has `autoAllocatorEnabled` and `autoPrioritizationEnabled` set to true. Requires the `autoAllocatorEnabled` and `autoPrioritizationEnabled` property values to be set to true. The default value for this property is `0`. This value must always be positive. The platform allocates the minimum amount to ad groups daily only while there is enough potential spend and budget to allocate. When you clone a campaign, this minimum spend value is carried over.
Field IDadGroups.campaign.minimumAdGroupSpendInAdvertiserCurrency
DimensionNUMBER
Ad Groups Campaign Name
The name of the campaign.
Field IDadGroups.campaign.name
DimensionTEXT
Ad Groups Campaign Objective
The campaign objective.
Field IDadGroups.campaign.objective
DimensionTEXT
Ad Groups Campaign Pacing Mode
The pacing mode for the Campaign.
Field IDadGroups.campaign.pacingMode
DimensionTEXT
Ad Groups Campaign Pacing To End Of Flight Daily Rate
Field IDadGroups.campaign.pacingToEndOfFlightDailyRate
DimensionNUMBER
Ad Groups Campaign Partner Cost Percentage Fee
The partner fee for the campaign as a percentage of the budget after The Trade Desk fee is calculated. For details, contact your Account Manager.
Field IDadGroups.campaign.partnerCostPercentageFee
DimensionNUMBER
Ad Groups Campaign Purchase Order Number
A property that you can use for internal reference. For example, a purchase order number.
Field IDadGroups.campaign.purchaseOrderNumber
DimensionTEXT
Ad Groups Campaign Share Type
A property to indicate what level of access this campaign has.
Field IDadGroups.campaign.shareType
DimensionTEXT
Ad Groups Campaign Site Url
Field IDadGroups.campaign.siteUrl
DimensionTEXT
Ad Groups Campaign Stack Rank
Field IDadGroups.campaignStackRank
DimensionNUMBER
Ad Groups Campaign Start Date
The date and time (in UTC) when the campaign starts spending. For campaigns with multiple flights, this value is determined using specified flight values and may not be modified. Otherwise, it must be specified at creation time.
Field IDadGroups.campaign.startDate
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Campaign Status
Campaign status.
Field IDadGroups.campaign.status
DimensionTEXT
Ad Groups Campaign Time Zone
The Windows time zone ID of the campaign.
Field IDadGroups.campaign.timeZone
DimensionTEXT
Ad Groups Campaign Time Zone IANA
The IANA/Olson time zone ID of the campaign.
Field IDadGroups.campaign.timeZoneIANA
DimensionTEXT
Ad Groups Campaign Total Ad Group Count
The total number of visible AdGroups owned by the Campaign.
Field IDadGroups.campaign.totalAdGroupCount
DimensionNUMBER
Ad Groups Campaign Trading Mode
The mode that the pacing and bidding system runs on to better achieve customized goals. Only applies to Kokai campaigns.
Field IDadGroups.campaign.tradingMode
DimensionTEXT
Ad Groups Campaign Type
Field IDadGroups.campaign.type
DimensionTEXT
Ad Groups Campaign Version
The name of The Trade Desk platform experience in which the campaign was created. If not specified, indicates that the campaign was created in a platform experience prior to Kokai.
Field IDadGroups.campaign.version
DimensionTEXT
Ad Groups Channel
Field IDadGroups.channel
DimensionTEXT
Ad Groups Contract Floor Price As Base Bid Adjustment
Contract floor price as base-bid adjustment.
Field IDadGroups.contractFloorPriceAsBaseBidAdjustment
DimensionNUMBER
Ad Groups Created At
The time in UTC the adGroup was created. This field is read-only.
Field IDadGroups.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Cross Device Vendor Adjust Bids On Confidence
If set to true, bids for cross-device impressions are adjusted based on the confidence level of matches.
Field IDadGroups.crossDeviceVendor.adjustBidsOnConfidence
DimensionBOOLEAN
Ad Groups Cross Device Vendor Id
The identifier for this cross-device vendor. Use this ID when enabling cross-device targeting on ad groups.
Field IDadGroups.crossDeviceVendor.id
DimensionTEXT
Ad Groups Cross Device Vendor Name
The friendly name of the cross-device vendor.
Field IDadGroups.crossDeviceVendor.name
DimensionTEXT
Ad Groups Current Flight Ad Group Id
Field IDadGroups.currentFlight.adGroupId
DimensionTEXT
Ad Groups Current Flight Allocation In Advertiser Currency
The amount of the campaign flight's budget that's allocated for an ad group.
Field IDadGroups.currentFlight.allocationInAdvertiserCurrency
DimensionNUMBER
Ad Groups Current Flight Allocation Type
How the ad group allocation is treated. See `AdGroupBudgetAllocationType` for the different types.
Field IDadGroups.currentFlight.allocationType
DimensionTEXT
Ad Groups Current Flight Budget In Advertiser Currency
Field IDadGroups.currentFlight.budgetInAdvertiserCurrency
DimensionNUMBER
Ad Groups Current Flight Budget In Impressions
Field IDadGroups.currentFlight.budgetInImpressions
DimensionNUMBER
Ad Groups Current Flight Campaign Flight Id
Field IDadGroups.currentFlight.campaignFlightId
DimensionNUMBER
Ad Groups Current Flight Daily Target In Advertiser Currency
Field IDadGroups.currentFlight.dailyTargetInAdvertiserCurrency
DimensionNUMBER
Ad Groups Current Flight Daily Target In Impressions
Field IDadGroups.currentFlight.dailyTargetInImpressions
DimensionNUMBER
Ad Groups Current Flight Minimum Spend In Advertiser Currency
Field IDadGroups.currentFlight.minimumSpendInAdvertiserCurrency
DimensionNUMBER
Ad Groups Current Flight Target Partner Cpm
An optional control on the bidding price for impression-budgeted flight. If null, the base bid CPM is applied by default.
Field IDadGroups.currentFlight.targetPartnerCpm
DimensionNUMBER
Ad Groups Current Or Next Flight Ad Group Id
Field IDadGroups.currentOrNextFlight.adGroupId
DimensionTEXT
Ad Groups Current Or Next Flight Allocation In Advertiser Currency
The amount of the campaign flight's budget that's allocated for an ad group.
Field IDadGroups.currentOrNextFlight.allocationInAdvertiserCurrency
DimensionNUMBER
Ad Groups Current Or Next Flight Allocation Type
How the ad group allocation is treated. See `AdGroupBudgetAllocationType` for the different types.
Field IDadGroups.currentOrNextFlight.allocationType
DimensionTEXT
Ad Groups Current Or Next Flight Budget In Advertiser Currency
Field IDadGroups.currentOrNextFlight.budgetInAdvertiserCurrency
DimensionNUMBER
Ad Groups Current Or Next Flight Budget In Impressions
Field IDadGroups.currentOrNextFlight.budgetInImpressions
DimensionNUMBER
Ad Groups Current Or Next Flight Campaign Flight Id
Field IDadGroups.currentOrNextFlight.campaignFlightId
DimensionNUMBER
Ad Groups Current Or Next Flight Daily Target In Advertiser Currency
Field IDadGroups.currentOrNextFlight.dailyTargetInAdvertiserCurrency
DimensionNUMBER
Ad Groups Current Or Next Flight Daily Target In Impressions
Field IDadGroups.currentOrNextFlight.dailyTargetInImpressions
DimensionNUMBER
Ad Groups Current Or Next Flight Minimum Spend In Advertiser Currency
Field IDadGroups.currentOrNextFlight.minimumSpendInAdvertiserCurrency
DimensionNUMBER
Ad Groups Current Or Next Flight Target Partner Cpm
An optional control on the bidding price for impression-budgeted flight. If null, the base bid CPM is applied by default.
Field IDadGroups.currentOrNextFlight.targetPartnerCpm
DimensionNUMBER
Ad Groups Deals Present
Returns true if the ad group is targeting deals.
Field IDadGroups.dealsPresent
DimensionBOOLEAN
Ad Groups Description
An optional description of the ad group.
Field IDadGroups.description
DimensionTEXT
Ad Groups Display Viewability Standard Integral
The display viewability standard of the ad group.
Field IDadGroups.displayViewabilityStandardIntegral
DimensionTEXT
Ad Groups Expressiveness Bid Factors
Total number of unique bids capped at 10 per dimension.
Field IDadGroups.expressiveness.bidFactors
DimensionNUMBER
Ad Groups Expressiveness Dimensions
Number of dimensions.
Field IDadGroups.expressiveness.dimensions
DimensionNUMBER
Ad Groups Expressiveness Score
Expressiveness score.
Field IDadGroups.expressiveness.score
DimensionNUMBER
Ad Groups Funnel Location
The funnel location of the ad group.
Field IDadGroups.funnelLocation
DimensionTEXT
Ad Groups Goal Average Value
The average Goal value.
Field IDadGroups.goal.averageValue
DimensionNUMBER
Ad Groups Goal Is Custom
Whether the goal is custom or not.
Field IDadGroups.goal.isCustom
DimensionBOOLEAN
Ad Groups Goal Meeting Percentage
The percentage of the Goal being met, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to 4 digits after decimal point.
Field IDadGroups.goal.meetingPercentage
DimensionNUMBER
Ad Groups Goal Short Name
The short version of goal type's name.
Field IDadGroups.goal.shortName
DimensionTEXT
Ad Groups Goal Target
The target Goal value.
Field IDadGroups.goal.target
DimensionNUMBER
Ad Groups Goal Type
The type of Goal.
Field IDadGroups.goal.type
DimensionTEXT
Ad Groups Goal Unit
The unit of measurement for the Goal data.
Field IDadGroups.goal.unit
DimensionTEXT
Ad Groups Id
The ID of the ad group.
Field IDadGroups.id
DimensionTEXT
Ad Groups Industry Category Id
The category's ID.
Field IDadGroups.industryCategory.id
DimensionTEXT
Ad Groups Industry Category Is Default
Is this category the default, inherited from the Advertiser.
Field IDadGroups.industryCategory.isDefault
DimensionBOOLEAN
Ad Groups Industry Category Is Sensitive
Is the category sensitive or not.
Field IDadGroups.industryCategory.isSensitive
DimensionBOOLEAN
Ad Groups Industry Category Name
The name of the category.
Field IDadGroups.industryCategory.name
DimensionTEXT
Ad Groups Industry Category Parent Category Id
The ID of the category's parent (if present).
Field IDadGroups.industryCategory.parentCategoryId
DimensionTEXT
Ad Groups Industry Sub Category Id
The category's ID.
Field IDadGroups.industrySubCategory.id
DimensionTEXT
Ad Groups Industry Sub Category Is Default
Is this category the default, inherited from the Advertiser.
Field IDadGroups.industrySubCategory.isDefault
DimensionBOOLEAN
Ad Groups Industry Sub Category Is Sensitive
Is the category sensitive or not.
Field IDadGroups.industrySubCategory.isSensitive
DimensionBOOLEAN
Ad Groups Industry Sub Category Name
The name of the category.
Field IDadGroups.industrySubCategory.name
DimensionTEXT
Ad Groups Industry Sub Category Parent Category Id
The ID of the category's parent (if present).
Field IDadGroups.industrySubCategory.parentCategoryId
DimensionTEXT
Ad Groups Is Archived
Field IDadGroups.isArchived
DimensionBOOLEAN
Ad Groups Is Dimensional Bidding Mode
Field IDadGroups.isDimensionalBiddingMode
DimensionBOOLEAN
Ad Groups Is Enabled
If set to `true`, indicates that the ad group is enabled to spend. The default value is `false`. If not set to `true`, the ad group will be disabled and will not spend.
Field IDadGroups.isEnabled
DimensionBOOLEAN
Ad Groups Is High Fill Rate
Indicates whether the ad group is a high-fill rate ad group. High-fill rate ad groups may target only programmatic guaranteed high-fill rate contracts and allow for a limited set of attributes to be set in the `RTBAttributes` object. IMPORTANT: You can set this property only on create; it may not be updated thereafter.
Field IDadGroups.isHighFillRate
DimensionBOOLEAN
Ad Groups Is News Navigator Enabled
Prioritize reliable and objective news as scored by our News Rating Partners.
Field IDadGroups.isNewsNavigatorEnabled
DimensionBOOLEAN
Ad Groups Is Non Decisioned
Indicates whether the ad group is targeting commitment deals.
Field IDadGroups.isNonDecisioned
DimensionBOOLEAN
Ad Groups Is Programmatic Guaranteed
Indicates whether the ad group is a high-fill rate ad group. High-fill rate ad groups may target only programmatic guaranteed high-fill rate contracts and allow for a limited set of attributes to be set in the `RTBAttributes` object. IMPORTANT: You can set this property only on create; it may not be updated thereafter.
Field IDadGroups.isProgrammaticGuaranteed
DimensionBOOLEAN
Ad Groups Is Quality Alliance Suite Enabled
Set to true to search for ad groups that have Quality Alliance targeting enabled.
Field IDadGroups.isQualityAllianceSuiteEnabled
DimensionBOOLEAN
Ad Groups Is Targeting Default On Deals
Indicates whether the ad group is targeting all default on deals.
Field IDadGroups.isTargetingDefaultOnDeals
DimensionBOOLEAN
Ad Groups Is Targeting Default On Endeavors
Indicates whether the ad group is targeting all default on deals.
Field IDadGroups.isTargetingDefaultOnEndeavors
DimensionBOOLEAN
Ad Groups Is Targeting Deprecated Library Deals
If set to true, indicates that the ad group is targeting deprecated library deals
Field IDadGroups.isTargetingDeprecatedLibraryDeals
DimensionBOOLEAN
Ad Groups Is Template
Field IDadGroups.isTemplate
DimensionBOOLEAN
Ad Groups Is Using Live Event Schedule
Indicates if an ad group is pacing using a Live Event schedule.
Field IDadGroups.isUsingLiveEventSchedule
DimensionBOOLEAN
Ad Groups Koa Settings Are Future Features Enabled
Set to `true` to enable future Koa features for the AdGroup automatically.
Field IDadGroups.koaSettings.areFutureFeaturesEnabled
DimensionBOOLEAN
Ad Groups Koa Settings Are Future Features Enabled For Partner
Are future features enabled for the AdGroup's Partner automatically.
Field IDadGroups.koaSettings.areFutureFeaturesEnabledForPartner
DimensionBOOLEAN
Ad Groups Koa Settings Are Koa Creative Weights Enabled
Whether the ad group is using Koa optimized creative weights to maximize the ad group's primary KPI performance
Field IDadGroups.koaSettings.areKoaCreativeWeightsEnabled
DimensionBOOLEAN
Ad Groups Koa Settings Minor Version
The minor version of the KOA optimizations for this AdGroup.
Field IDadGroups.koaSettings.minorVersion
DimensionTEXT
Ad Groups Koa Settings Optimizations Version
The version of the KOA optimizations for this AdGroup.
Field IDadGroups.koaSettings.optimizationsVersion
DimensionTEXT
Ad Groups Koa Settings Predictive Clearing Enabled
Set to `true` to enable Koa to analyze historical clearing prices to find a lower, optimal bid for each impression served in a first-price auction.
Field IDadGroups.koaSettings.predictiveClearingEnabled
DimensionBOOLEAN
Ad Groups Last Updated
The time in UTC the adGroup was last updated. This field is read-only.
Field IDadGroups.lastUpdated
DimensionYEAR_MONTH_DAY_SECOND
Ad Groups Market Type
Returns the market the AdGroup is currently targeting.
Field IDadGroups.marketType
DimensionTEXT
Ad Groups Marketplace Id
Marketplace ID
Field IDadGroups.marketplace.id
DimensionTEXT
Ad Groups Marketplace Marketplace Status
Status of the given marketplace.
Field IDadGroups.marketplace.marketplaceStatus
DimensionTEXT
Ad Groups Marketplace Name
Marketplace name.
Field IDadGroups.marketplace.name
DimensionTEXT
Ad Groups Marketplace Owner
Marketplace owner type.
Field IDadGroups.marketplace.owner
DimensionTEXT
Ad Groups Marketplace Short Name
Marketplace short name.
Field IDadGroups.marketplace.shortName
DimensionTEXT
Ad Groups Max Bid CPM In Advertiser Currency
Field IDadGroups.maxBidCPMInAdvertiserCurrency
DimensionNUMBER
Ad Groups Name
The name of the ad group.
Field IDadGroups.name
DimensionTEXT
Ad Groups Next Flight Ad Group Id
Field IDadGroups.nextFlight.adGroupId
DimensionTEXT
Ad Groups Next Flight Allocation In Advertiser Currency
The amount of the campaign flight's budget that's allocated for an ad group.
Field IDadGroups.nextFlight.allocationInAdvertiserCurrency
DimensionNUMBER
Ad Groups Next Flight Allocation Type
How the ad group allocation is treated. See `AdGroupBudgetAllocationType` for the different types.
Field IDadGroups.nextFlight.allocationType
DimensionTEXT
Ad Groups Next Flight Budget In Advertiser Currency
Field IDadGroups.nextFlight.budgetInAdvertiserCurrency
DimensionNUMBER
Ad Groups Next Flight Budget In Impressions
Field IDadGroups.nextFlight.budgetInImpressions
DimensionNUMBER
Ad Groups Next Flight Campaign Flight Id
Field IDadGroups.nextFlight.campaignFlightId
DimensionNUMBER
Ad Groups Next Flight Daily Target In Advertiser Currency
Field IDadGroups.nextFlight.dailyTargetInAdvertiserCurrency
DimensionNUMBER
Ad Groups Next Flight Daily Target In Impressions
Field IDadGroups.nextFlight.dailyTargetInImpressions
DimensionNUMBER
Ad Groups Next Flight Minimum Spend In Advertiser Currency
Field IDadGroups.nextFlight.minimumSpendInAdvertiserCurrency
DimensionNUMBER
Ad Groups Next Flight Target Partner Cpm
An optional control on the bidding price for impression-budgeted flight. If null, the base bid CPM is applied by default.
Field IDadGroups.nextFlight.targetPartnerCpm
DimensionNUMBER
Ad Groups Nielsen Tracking Attributes End Age
The end age being targeted for Nielsen analytics.
Field IDadGroups.nielsenTrackingAttributes.endAge
DimensionTEXT
Ad Groups Nielsen Tracking Attributes Enhanced Nielsen Reporting Options
Enhanced Nielsen reporting option setting.
Field IDadGroups.nielsenTrackingAttributes.enhancedNielsenReportingOptions
DimensionTEXT
Ad Groups Nielsen Tracking Attributes Gender
The gender being targeted for Nielsen analytics.
Field IDadGroups.nielsenTrackingAttributes.gender
DimensionTEXT
Ad Groups Nielsen Tracking Attributes Start Age
The start age being targeted for Nielsen analytics.
Field IDadGroups.nielsenTrackingAttributes.startAge
DimensionTEXT
Ad Groups Pacing Grain Id
Field IDadGroups.pacingGrainId
DimensionNUMBER
Ad Groups Partner China MSA Signed
Field IDadGroups.partner.chinaMSASigned
DimensionBOOLEAN
Ad Groups Partner Credit Limit In USD
Current credit limit assigned
Field IDadGroups.partner.creditLimitInUSD
DimensionNUMBER
Ad Groups Partner Daily Spend Cap In USD
Daily spend cap
Field IDadGroups.partner.dailySpendCapInUSD
DimensionNUMBER
Ad Groups Partner Default Recency Bucket List Id
Field IDadGroups.partner.defaultRecencyBucketListId
DimensionTEXT
Ad Groups Partner Id
The ID of the partner.
Field IDadGroups.partner.id
DimensionTEXT
Ad Groups Partner Id Integer
The integer ID of the partner. This ID is typically used as a buyer or seat ID in the Easy Proposal Activation API. This is a read-only property.
Field IDadGroups.partner.idInteger
DimensionNUMBER
Ad Groups Partner Is Purchase Order Number Required
Indicates if partner is billed by PO#, requiring campaigns to populate this field.
Field IDadGroups.partner.isPurchaseOrderNumberRequired
DimensionBOOLEAN
Ad Groups Partner Is Spend Disabled
Flag signifying whether the spend on this partner is disabled
Field IDadGroups.partner.isSpendDisabled
DimensionBOOLEAN
Ad Groups Partner Must Vet Advertisers
Field IDadGroups.partner.mustVetAdvertisers
DimensionBOOLEAN
Ad Groups Partner Name
The name of the partner.
Field IDadGroups.partner.name
DimensionTEXT
Ad Groups Private Contract Default Adjustment
Field IDadGroups.privateContractDefaultAdjustment
DimensionNUMBER
Ad Groups Quality Alliance Viewability Profile
Viewability profile used for Quality Alliance viewability targeting.
Field IDadGroups.qualityAllianceViewabilityProfile
DimensionTEXT
Ad Groups Roi Goal Average Value
The average Goal value.
Field IDadGroups.roiGoal.averageValue
DimensionNUMBER
Ad Groups Roi Goal Is Custom
Whether the goal is custom or not.
Field IDadGroups.roiGoal.isCustom
DimensionBOOLEAN
Ad Groups Roi Goal Meeting Percentage
The percentage of the Goal being met, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to 4 digits after decimal point.
Field IDadGroups.roiGoal.meetingPercentage
DimensionNUMBER
Ad Groups Roi Goal Short Name
The short version of goal type's name.
Field IDadGroups.roiGoal.shortName
DimensionTEXT
Ad Groups Roi Goal Target
The target Goal value.
Field IDadGroups.roiGoal.target
DimensionNUMBER
Ad Groups Roi Goal Type
The type of Goal.
Field IDadGroups.roiGoal.type
DimensionTEXT
Ad Groups Roi Goal Unit
The unit of measurement for the Goal data.
Field IDadGroups.roiGoal.unit
DimensionTEXT
Ad Groups Spend Risk Level
The AdGroup's spend risk level.
Field IDadGroups.spend.riskLevel
DimensionTEXT
Ad Groups Spend Spend
The AdGroup's current spend in Advertiser currency.
Field IDadGroups.spend.spend
DimensionNUMBER
Ad Groups Status
Ad group status.
Field IDadGroups.status
DimensionTEXT
Ad Groups Use Multiple Cross Device Vendors
If set to true, indicates that multiple cross-device vendors are used.
Field IDadGroups.useMultipleCrossDeviceVendors
DimensionBOOLEAN
Ad Groups Video Viewability Standard Integral
The display viewability standard of the ad group.
Field IDadGroups.videoViewabilityStandardIntegral
DimensionTEXT
Ad Groups Viewability Profile
Coalesces the viewability profile from Campaign, Advertiser, or Partner, in that order of precedence.
Field IDadGroups.viewabilityProfile
DimensionTEXT
Ad Plays
The total number of auctions won. An ad play is counted when an ad is placed on a page and has the potential to be viewed, regardless of whether it is clicked.
Field IDadPlays
MetricNUMBER
Ad Server Creative Placement ID
Field IDadServerCreativePlacementID
MetricNUMBER
Ad Server Name
Field IDadServerName
MetricNUMBER
Advertiser Attribution Click Interval
The unit of time to apply to click interval attributions.
Field IDadvertiser.attribution.clickInterval
DimensionTEXT
Advertiser Attribution Click Lookback Window
When The Trade Desk performs click attribution for the Advertiser’s conversions, this is the amount of time that will be considered for attribution. Unit of time is in ClickInterval.
Field IDadvertiser.attribution.clickLookbackWindow
DimensionNUMBER
Advertiser Attribution Impression Interval
The unit of time to apply to impression interval attributions.
Field IDadvertiser.attribution.impressionInterval
DimensionTEXT
Advertiser Attribution Impression Lookback Window
When The Trade Desk performs impression attribution for the Advertiser’s conversions, this is the amount of time that will be considered for attribution. Unit of time is in ImpressionInterval.
Field IDadvertiser.attribution.impressionLookbackWindow
DimensionNUMBER
Advertiser Audience Settings Is Audience Booster Enabled
To enable the platform to add highly relevant segments to your audience when there is confidence they will improve your targeting and boost performance, continue using the `RTBAttributes.AudienceTargeting.AudienceBoosterEnabled` property in the [ad group](/v3/portal/api/area/Ad%20Group) workflows.
Field IDadvertiser.audienceSettings.isAudienceBoosterEnabled
DimensionBOOLEAN
Advertiser Audience Settings Is Audience Excluder Enabled
Now renamed Prism, it’s been enhanced to focus on the most valuable impressions by excluding irrelevant user-based and non-user-based signals that are unlikely to benefit a campaign.
Field IDadvertiser.audienceSettings.isAudienceExcluderEnabled
DimensionBOOLEAN
Advertiser Brand Owner
The owner of the brands assigned to the Advertiser.
Field IDadvertiser.brandOwner
DimensionTEXT
Advertiser Channel Count
The number of unique primary channels belonging to live Campaigns under the Advertiser.
Field IDadvertiser.channelCount
DimensionNUMBER
Advertiser Click Dedupe Window In Seconds
When The Trade Desk performs click attribution for your conversions, similar clicks will be considered duplicates if they are within this window. Set to zero to disable click de-duplication.
Field IDadvertiser.clickDedupeWindowInSeconds
DimensionNUMBER
Advertiser Conversion De Dupe Window In Seconds
When The Trade Desk performs impression attribution for your conversions, similar conversions will be considered duplicates if they are within this window. Set to zero to disable conversion de-duplication.
Field IDadvertiser.conversionDeDupeWindowInSeconds
DimensionNUMBER
Advertiser Cost (Adv Currency)
Field IDadvertiserCostAdvCurrency
MetricNUMBER
Advertiser Cost (Partner Currency)
Field IDadvertiserCostPartnerCurrency
MetricNUMBER
Advertiser Cost (USD)
Field IDadvertiserCostUSD
MetricNUMBER
Advertiser Country Id
Field IDadvertiser.country.id
DimensionTEXT
Advertiser Country Long Name
Field IDadvertiser.country.longName
DimensionTEXT
Advertiser Country Short Name
Field IDadvertiser.country.shortName
DimensionTEXT
Advertiser Currency Decimal Places
Field IDadvertiser.currency.decimalPlaces
DimensionTEXT
Advertiser Currency Id
Field IDadvertiser.currency.id
DimensionTEXT
Advertiser Currency Is Visible
Field IDadvertiser.currency.isVisible
DimensionBOOLEAN
Advertiser Currency Name
Field IDadvertiser.currency.name
DimensionTEXT
Advertiser Currency Name Plural
Field IDadvertiser.currency.namePlural
DimensionTEXT
Advertiser Currency Should Prefix Currency Symbol
Field IDadvertiser.currency.shouldPrefixCurrencySymbol
DimensionBOOLEAN
Advertiser Currency Symbol
Field IDadvertiser.currency.symbol
DimensionTEXT
Advertiser Default Partner Viewability Settings Display Sampling Rate
The display sampling rate of the provider.
Field IDadvertiser.defaultPartnerViewabilitySettings.displaySamplingRate
DimensionNUMBER
Advertiser Default Partner Viewability Settings Profile Display Name
The display name of the provider.
Field IDadvertiser.defaultPartnerViewabilitySettings.profileDisplayName
DimensionTEXT
Advertiser Default Partner Viewability Settings Provider Id
The provider ID.
Field IDadvertiser.defaultPartnerViewabilitySettings.providerId
DimensionTEXT
Advertiser Default Partner Viewability Settings Video Sampling Rate
The video sampling rate of the provider.
Field IDadvertiser.defaultPartnerViewabilitySettings.videoSamplingRate
DimensionNUMBER
Advertiser Default Right Media Offer Id
The offer type's ID.
Field IDadvertiser.defaultRightMediaOffer.id
DimensionTEXT
Advertiser Default Right Media Offer Name
The name of the offer type.
Field IDadvertiser.defaultRightMediaOffer.name
DimensionTEXT
Advertiser Default Seed Active Ids
Active id count in the seed.
Field IDadvertiser.defaultSeed.activeIds
DimensionNUMBER
Advertiser Default Seed Created At
Date and time of the seed creation.
Field IDadvertiser.defaultSeed.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Advertiser Default Seed Id
ID of the seed.
Field IDadvertiser.defaultSeed.id
DimensionTEXT
Advertiser Default Seed Is Default
Indicates whether the seed is set as the default for the advertiser.
Field IDadvertiser.defaultSeed.isDefault
DimensionBOOLEAN
Advertiser Default Seed Last Updated At
Date and time of last seed update.
Field IDadvertiser.defaultSeed.lastUpdatedAt
DimensionYEAR_MONTH_DAY_SECOND
Advertiser Default Seed Name
Name of the seed
Field IDadvertiser.defaultSeed.name
DimensionTEXT
Advertiser Default Seed Quality
Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`.
Field IDadvertiser.defaultSeed.quality
DimensionTEXT
Advertiser Default Seed Quality Reason
Represents the reason for seed definition quality.
Field IDadvertiser.defaultSeed.qualityReason
DimensionTEXT
Advertiser Default Seed Status
Seed materialization status.
Field IDadvertiser.defaultSeed.status
DimensionTEXT
Advertiser Default Seed Unique Households
Unique house hold ids associated with the seed.
Field IDadvertiser.defaultSeed.uniqueHouseholds
DimensionNUMBER
Advertiser Description
An optional description of the advertiser.
Field IDadvertiser.description
DimensionTEXT
Advertiser Domain Address
The primary domain of the advertiser.
Field IDadvertiser.domainAddress
DimensionTEXT
Advertiser Funnel Location Count
The number of unique Funnel Locations belonging to visible AdGroups for live Campaigns under the Advertiser.
Field IDadvertiser.funnelLocationCount
DimensionNUMBER
Advertiser Has Available Seed Pixels
Whether or not there any Seed Pixels available to the Advertiser.
Field IDadvertiser.hasAvailableSeedPixels
DimensionBOOLEAN
Advertiser Id
The ID of the advertiser.
Field IDadvertiser.id
DimensionTEXT
Advertiser Ignore Referral Url In Conversion
When The Trade Desk performs impression attribution for your conversions, if enabled, conversions with deduplication key different only in referral url are considered duplicates.
Field IDadvertiser.ignoreReferralUrlInConversion
DimensionBOOLEAN
Advertiser Industry Category Id
The category's ID.
Field IDadvertiser.industryCategory.id
DimensionTEXT
Advertiser Industry Category Is Default
Is this category the default, inherited from the Advertiser.
Field IDadvertiser.industryCategory.isDefault
DimensionBOOLEAN
Advertiser Industry Category Is Sensitive
Is the category sensitive or not.
Field IDadvertiser.industryCategory.isSensitive
DimensionBOOLEAN
Advertiser Industry Category Name
The name of the category.
Field IDadvertiser.industryCategory.name
DimensionTEXT
Advertiser Industry Category Parent Category Id
The ID of the category's parent (if present).
Field IDadvertiser.industryCategory.parentCategoryId
DimensionTEXT
Advertiser Industry Sub Category Id
The category's ID.
Field IDadvertiser.industrySubCategory.id
DimensionTEXT
Advertiser Industry Sub Category Is Default
Is this category the default, inherited from the Advertiser.
Field IDadvertiser.industrySubCategory.isDefault
DimensionBOOLEAN
Advertiser Industry Sub Category Is Sensitive
Is the category sensitive or not.
Field IDadvertiser.industrySubCategory.isSensitive
DimensionBOOLEAN
Advertiser Industry Sub Category Name
The name of the category.
Field IDadvertiser.industrySubCategory.name
DimensionTEXT
Advertiser Industry Sub Category Parent Category Id
The ID of the category's parent (if present).
Field IDadvertiser.industrySubCategory.parentCategoryId
DimensionTEXT
Advertiser Is Archived
Field IDadvertiser.isArchived
DimensionBOOLEAN
Advertiser Is Blocked From Hh Solution
Is the Advertiser blocked from HH Solution.
Field IDadvertiser.isBlockedFromHhSolution
DimensionBOOLEAN
Advertiser Is Favorite For User
Returns `true` if advertiser was marked as favorite by current user.
Field IDadvertiser.isFavoriteForUser
DimensionBOOLEAN
Advertiser Is Hcp Eligible
Indicates whether the advertiser is eligible for HCP advertising.
Field IDadvertiser.isHcpEligible
DimensionBOOLEAN
Advertiser Is Hec Auto Exempt
An HEC (Housing, Employment, Credit) exemption will exclude an HEC applicable advertiser from microtargeting restrictions.
Field IDadvertiser.isHecAutoExempt
DimensionBOOLEAN
Advertiser Is Marketplace Enabled By Default
Defines if marketplace will be preselected when creating a new adgroup in this advertiser
Field IDadvertiser.isMarketplaceEnabledByDefault
DimensionBOOLEAN
Advertiser Is Restricted For Distributed Algos
Field IDadvertiser.isRestrictedForDistributedAlgos
DimensionBOOLEAN
Advertiser Is With Campaigns At Risk
Does the Advertiser have one or more Campaigns at risk, pacing behind.
Field IDadvertiser.isWithCampaignsAtRisk
DimensionBOOLEAN
Advertiser Is With Live Campaigns
Does this Advertiser have Campaigns that are active.
Field IDadvertiser.isWithLiveCampaigns
DimensionBOOLEAN
Advertiser Logo
The URL for the advertiser's logo or brand image.
Field IDadvertiser.logo
DimensionTEXT
Advertiser Marketplace Id
Marketplace ID
Field IDadvertiser.marketplace.id
DimensionTEXT
Advertiser Marketplace Marketplace Status
Status of the given marketplace.
Field IDadvertiser.marketplace.marketplaceStatus
DimensionTEXT
Advertiser Marketplace Name
Marketplace name.
Field IDadvertiser.marketplace.name
DimensionTEXT
Advertiser Marketplace Owner
Marketplace owner type.
Field IDadvertiser.marketplace.owner
DimensionTEXT
Advertiser Marketplace Short Name
Marketplace short name.
Field IDadvertiser.marketplace.shortName
DimensionTEXT
Advertiser Most Used Seed Active Ids
Active id count in the seed.
Field IDadvertiser.mostUsedSeed.activeIds
DimensionNUMBER
Advertiser Most Used Seed Created At
Date and time of the seed creation.
Field IDadvertiser.mostUsedSeed.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Advertiser Most Used Seed Id
ID of the seed.
Field IDadvertiser.mostUsedSeed.id
DimensionTEXT
Advertiser Most Used Seed Is Default
Indicates whether the seed is set as the default for the advertiser.
Field IDadvertiser.mostUsedSeed.isDefault
DimensionBOOLEAN
Advertiser Most Used Seed Last Updated At
Date and time of last seed update.
Field IDadvertiser.mostUsedSeed.lastUpdatedAt
DimensionYEAR_MONTH_DAY_SECOND
Advertiser Most Used Seed Name
Name of the seed
Field IDadvertiser.mostUsedSeed.name
DimensionTEXT
Advertiser Most Used Seed Quality
Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`.
Field IDadvertiser.mostUsedSeed.quality
DimensionTEXT
Advertiser Most Used Seed Quality Reason
Represents the reason for seed definition quality.
Field IDadvertiser.mostUsedSeed.qualityReason
DimensionTEXT
Advertiser Most Used Seed Status
Seed materialization status.
Field IDadvertiser.mostUsedSeed.status
DimensionTEXT
Advertiser Most Used Seed Unique Households
Unique house hold ids associated with the seed.
Field IDadvertiser.mostUsedSeed.uniqueHouseholds
DimensionNUMBER
Advertiser Name
The name of the advertiser.
Field IDadvertiser.name
DimensionTEXT
Advertiser Name DSA
The name of the advertiser to be displayed for campaigns targeting individuals established or located in the European Union (EU).
Field IDadvertiser.nameDSA
DimensionTEXT
Advertiser Onboarding Data Advertiser Id
Field IDadvertiser.onboardingData.advertiserId
DimensionTEXT
Advertiser Onboarding Data Created At
Field IDadvertiser.onboardingData.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Advertiser Onboarding Data Created By User Id
Field IDadvertiser.onboardingData.createdByUserId
DimensionTEXT
Advertiser Onboarding Data Id
Field IDadvertiser.onboardingData.id
DimensionTEXT
Advertiser Onboarding Data Last Updated At
Field IDadvertiser.onboardingData.lastUpdatedAt
DimensionYEAR_MONTH_DAY_SECOND
Advertiser Onboarding Data Last Updated By User Id
Field IDadvertiser.onboardingData.lastUpdatedByUserId
DimensionTEXT
Advertiser Partner Basic Info Id
The ID of the partner.
Field IDadvertiser.partnerBasicInfo.id
DimensionTEXT
Advertiser Partner Basic Info Name
The name of the partner.
Field IDadvertiser.partnerBasicInfo.name
DimensionTEXT
Advertiser Partner China MSA Signed
Field IDadvertiser.partner.chinaMSASigned
DimensionBOOLEAN
Advertiser Partner Credit Limit In USD
Current credit limit assigned
Field IDadvertiser.partner.creditLimitInUSD
DimensionNUMBER
Advertiser Partner Daily Spend Cap In USD
Daily spend cap
Field IDadvertiser.partner.dailySpendCapInUSD
DimensionNUMBER
Advertiser Partner Default Recency Bucket List Id
Field IDadvertiser.partner.defaultRecencyBucketListId
DimensionTEXT
Advertiser Partner Id
The ID of the partner.
Field IDadvertiser.partner.id
DimensionTEXT
Advertiser Partner Id Integer
The integer ID of the partner. This ID is typically used as a buyer or seat ID in the Easy Proposal Activation API. This is a read-only property.
Field IDadvertiser.partner.idInteger
DimensionNUMBER
Advertiser Partner Is Purchase Order Number Required
Indicates if partner is billed by PO#, requiring campaigns to populate this field.
Field IDadvertiser.partner.isPurchaseOrderNumberRequired
DimensionBOOLEAN
Advertiser Partner Is Spend Disabled
Flag signifying whether the spend on this partner is disabled
Field IDadvertiser.partner.isSpendDisabled
DimensionBOOLEAN
Advertiser Partner Must Vet Advertisers
Field IDadvertiser.partner.mustVetAdvertisers
DimensionBOOLEAN
Advertiser Partner Name
The name of the partner.
Field IDadvertiser.partner.name
DimensionTEXT
Advertiser Payer Name DSA
The name of the entity paying for this advertiser's campaigns. The Digital Services Act (DSA) requires online platforms to declare the natural or legal person paying for the ad, if different from the advertiser.
Field IDadvertiser.payerNameDSA
DimensionTEXT
Advertiser Political Candidate Count
The number of political candidates.
Field IDadvertiser.political.candidateCount
DimensionNUMBER
Advertiser Political Is Ballot Measure
If set to `true`, indicates that this advertiser is running political advertising campaigns for a state or local ballot measure election. Here's what you need to know: - The default value for this property is false. - Required only for political advertisers for state or local ballot measure elections.
Field IDadvertiser.political.isBallotMeasure
DimensionBOOLEAN
Advertiser Political Is Candidate Election
If set to `true`, indicates that this advertiser is running political advertising campaigns for a state, local, or federal election candidate and must include a candidate profile for each candidate. Here's what you need to know: - The default value for this property is `false`. - Required only for political advertisers for federal, state, or local, candidate elections.
Field IDadvertiser.political.isCandidateElection
DimensionBOOLEAN
Advertiser Secret Key
The Advertiser's secret key (inherited from Partner).
Field IDadvertiser.secretKey
DimensionTEXT
Advertiser Seed Permission Can Have Seed
Indicates whether the advertiser is permitted to have seed.
Field IDadvertiser.seedPermission.canHaveSeed
DimensionBOOLEAN
Advertiser Special Platform Features Campaign Flight Custom Labels In Ui
Indicates whether campaign flight custom label is available in UI.
Field IDadvertiser.specialPlatformFeatures.campaignFlightCustomLabelsInUi
DimensionBOOLEAN
Advertiser Special Platform Features Hide Dooh Channel Buying In Ui
Flag indicating that TTD will hide DOOH channel buying in the UI.
Field IDadvertiser.specialPlatformFeatures.hideDoohChannelBuyingInUi
DimensionBOOLEAN
Advertiser Special Platform Features Impression Budget Access
Indicates whether this partner has access to impression budgets in the UI and are enabled to edit impression budgets in the API.
Field IDadvertiser.specialPlatformFeatures.impressionBudgetAccess
DimensionBOOLEAN
Advertiser Special Platform Features Legacy Quality Alliance Thresholds In Ui
Indicates whether legacy Quality Alliance thresholds are available in the UI.
Field IDadvertiser.specialPlatformFeatures.legacyQualityAllianceThresholdsInUi
DimensionBOOLEAN
Advertiser Special Platform Features Show TTD Pharmaceutical Standard Categores In Ui
Indicates whether TTD Pharmaceutical Standard Categories are available in the UI.
Field IDadvertiser.specialPlatformFeatures.showTTDPharmaceuticalStandardCategoresInUi
DimensionBOOLEAN
Advertiser Special Platform Features Show TTD Standard Embedding Categories In Ui
Indicates whether TTD Standard Embedding Categories are available in the UI.
Field IDadvertiser.specialPlatformFeatures.showTTDStandardEmbeddingCategoriesInUi
DimensionBOOLEAN
Advertiser Special Platform Features Walmart First Party Seeds In Ui
Indicates whether advertiser is allowed to add their 1PD to seeds in Walmart.
Field IDadvertiser.specialPlatformFeatures.walmartFirstPartySeedsInUi
DimensionBOOLEAN
Advertiser Total Campaign Channel Count
The total number of possible Campaign Channels.
Field IDadvertiser.totalCampaignChannelCount
DimensionNUMBER
Advertiser Total Funnel Location Count
The total number of possible Funnel Locations.
Field IDadvertiser.totalFunnelLocationCount
DimensionNUMBER
Advertiser Use Impressions Only Budgeting
Field IDadvertiser.useImpressionsOnlyBudgeting
DimensionBOOLEAN
Advertiser Use Media Cost Basis For Campaign Fees
Field IDadvertiser.useMediaCostBasisForCampaignFees
DimensionBOOLEAN
Advertiser Vetting Status
Vetting status of the advertiser. This field is read-only.
Field IDadvertiser.vettingStatus
DimensionTEXT
Advertiser Viewability Selected Provider Id
Field IDadvertiser.viewability.selectedProviderId
DimensionTEXT
Base Bid Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDbaseBid.advertiserCurrency
MetricNUMBER
Base Bid Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDbaseBid.partnerCurrency
MetricNUMBER
Base Bid Usd
The amount specified in US dollars.
Field IDbaseBid.usd
MetricNUMBER
Bid Cpm Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDbidCpm.advertiserCurrency
MetricNUMBER
Bid Cpm Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDbidCpm.partnerCurrency
MetricNUMBER
Bid Cpm Usd
The amount specified in US dollars.
Field IDbidCpm.usd
MetricNUMBER
Bids
The total number of times an offer was made in an auction for an impression.
Field IDbids
MetricNUMBER
Browser
Field IDbrowser
DimensionTEXT
Budget Spent Percent
The percent of budget spent expressed as a decimal. For example, a value of 0.12 represents 12%. Calculated by dividing the budget spent to date by the flight budget . Currently only supported for campaign flights and ad group flights.
Field IDbudgetSpentPercent
MetricNUMBER
Campaigns Active Ad Group Count
The total number of AdGroups owned by the Campaign that are both visible and enabled.
Field IDcampaigns.activeAdGroupCount
DimensionNUMBER
Campaigns Audience Created At
The date and time in UTC the audience was created.
Field IDcampaigns.audience.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Audience Id
Field IDcampaigns.audience.id
DimensionTEXT
Campaigns Audience Is Auto Generated
Indicates if this audience was automatically generated by The Trade Desk platform.
Field IDcampaigns.audience.isAutoGenerated
DimensionBOOLEAN
Campaigns Audience Last Updated At
Indicates the time when this audience was last updated (UTC).
Field IDcampaigns.audience.lastUpdatedAt
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Audience Name
The name of the audience.
Field IDcampaigns.audience.name
DimensionTEXT
Campaigns Audience Target Everyone
If set to true, indicates that it is a TargetEveryone audience.
Field IDcampaigns.audience.targetEveryone
DimensionBOOLEAN
Campaigns Auto Allocator Enabled
Field IDcampaigns.autoAllocatorEnabled
DimensionBOOLEAN
Campaigns Auto Campaign Cap Enabled
Field IDcampaigns.autoCampaignCapEnabled
DimensionBOOLEAN
Campaigns Auto Prioritization Enabled
If set to `true`, enables the platform to automatically direct your budget to the better-performing ad groups first and then allocate the remaining budget to lower-performing ad groups. Requires the `autoAllocatorEnabled` property value to be set to true. The default value for this property is `false`. When you clone a campaign, this value is copied over.
Field IDcampaigns.autoPrioritizationEnabled
DimensionBOOLEAN
Campaigns Budget Ad Group Spend Prioritization Type
The ad group spend prioritization type. It determines how the system prioritizes budget allocation among its ad groups.
Field IDcampaigns.budget.adGroupSpendPrioritizationType
DimensionTEXT
Campaigns Budget Allocation Mode
The campaign's budget allocation mode, which considers the budget distribution across all current and future flights, or the last past flight if no current or future flights exist. For details on the budget allocation modes, see the CampaignBudgetAllocationMode field.
Field IDcampaigns.budget.allocationMode
DimensionTEXT
Campaigns Budget Current Or Up Coming
The budget of the campaign's current or next upcoming flight.
Field IDcampaigns.budget.currentOrUpComing
DimensionNUMBER
Campaigns Budget In Impressions
The maximum amount of impressions the campaign should buy. For campaigns with multiple flights, this value is determined using specified flight values and may not be modified.
Field IDcampaigns.budgetInImpressions
DimensionNUMBER
Campaigns Budget Migration Reports Allocation Mode
Field IDcampaigns.budgetMigrationReports.allocationMode
DimensionTEXT
Campaigns Budget Migration Reports Budgeting Version
Field IDcampaigns.budgetMigrationReports.budgetingVersion
DimensionTEXT
Campaigns Budget Migration Reports Has Impressions
Indicates whether the campaign and any of its adGroups have impression budgets.
Field IDcampaigns.budgetMigrationReports.hasImpressions
DimensionBOOLEAN
Campaigns Budget Migration Reports Has Live Events
Whether this campaign has unarchived live event ad groups.
Field IDcampaigns.budgetMigrationReports.hasLiveEvents
DimensionBOOLEAN
Campaigns Budget Migration Reports Is Mixed Pacing
Whether the ad groups of this campaign have different pacing modes.
Field IDcampaigns.budgetMigrationReports.isMixedPacing
DimensionBOOLEAN
Campaigns Budget Migration Reports Pacing Mode
The current pacing mode on the campaign, depending on whether it uses Solimar or Kokai budgeting.
Field IDcampaigns.budgetMigrationReports.pacingMode
DimensionTEXT
Campaigns Budget Migration Reports Unified Pacing Mode
The pacing mode in Kokai that unifies campaign and its adGroups' pacing mode.
Field IDcampaigns.budgetMigrationReports.unifiedPacingMode
DimensionTEXT
Campaigns Budget Migration Status Current Budgeting Version
The current budgeting version.
Field IDcampaigns.budgetMigrationStatus.currentBudgetingVersion
DimensionTEXT
Campaigns Budget Migration Status Is Compatible
Whether the current budget settings is compatible with the settings in the target budgeting version.
Field IDcampaigns.budgetMigrationStatus.isCompatible
DimensionBOOLEAN
Campaigns Budget Pacing Mode
The campaign pacing mode that determines how slowly or quickly the campaign spends the budget during its flights.
Field IDcampaigns.budget.pacingMode
DimensionTEXT
Campaigns Budget Spend Mode
The spend mode that determines how the system allocates the campaign budget to its ad groups.
Field IDcampaigns.budget.spendMode
DimensionTEXT
Campaigns Budget Total
The total budget of the campaign, in the advertiser's currency.
Field IDcampaigns.budget.total
DimensionNUMBER
Campaigns Budget Total In Impressions
The maximum number of impressions the campaign should buy. For campaigns with multiple flights, this value is determined using specified flight values and may not be modified.
Field IDcampaigns.budget.totalInImpressions
DimensionNUMBER
Campaigns Budget Uses Impression Budgets
Indicates whether any of the campaign’s current or future flights have impression budgets manually set. If no current or future flights exist, the last past flight is considered.
Field IDcampaigns.budget.usesImpressionBudgets
DimensionBOOLEAN
Campaigns Budget Version
The version of the budgeting experience for the campaign.
Field IDcampaigns.budget.version
DimensionTEXT
Campaigns Campaign Group Current Flights End Date Exclusive
The latest end date of all the current campaign flights in this campaign group
Field IDcampaigns.campaignGroup.currentFlightsEndDateExclusive
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Campaign Group Current Flights Start Date Inclusive
The earliest start date of all the current campaign flights in this campaign group
Field IDcampaigns.campaignGroup.currentFlightsStartDateInclusive
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Campaign Group Flight Budget
Total budget across all current flights in the non-archived campaigns in the group.
Field IDcampaigns.campaignGroup.flightBudget
DimensionNUMBER
Campaigns Campaign Group Id
The ID of the campaign group.
Field IDcampaigns.campaignGroup.id
DimensionTEXT
Campaigns Campaign Group Is Archived
`true` if the campaign group is archived, `false` otherwise.
Field IDcampaigns.campaignGroup.isArchived
DimensionBOOLEAN
Campaigns Campaign Group Last Updated
The time in UTC the campaign campaign was last updated.
Field IDcampaigns.campaignGroup.lastUpdated
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Campaign Group Name
Name of the campaign group.
Field IDcampaigns.campaignGroup.name
DimensionTEXT
Campaigns Campaign Group Num Channels
The number of unique channels in the non-archived campaigns in the group that have current flights
Field IDcampaigns.campaignGroup.numChannels
DimensionNUMBER
Campaigns Campaign Group Total Budget
Total budget across all campaigns in the non-archived campaigns in the group.
Field IDcampaigns.campaignGroup.totalBudget
DimensionNUMBER
Campaigns Campaign Pacing Settings Is Value Pacing
Field IDcampaigns.campaignPacingSettings.isValuePacing
DimensionBOOLEAN
Campaigns Channel Type
Field IDcampaigns.channelType
DimensionTEXT
Campaigns Created At
The time in UTC the campaign was created. This field is read-only.
Field IDcampaigns.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Created At Utc
The time in UTC the campaign was created. This field is read-only.
Field IDcampaigns.createdAtUtc
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Current Flight Budget Allocation Mode
Whether the budget allocation on this campaign flight is fluid, fixed, or mixed. See CampaignBudgetAllocationMode.
Field IDcampaigns.currentFlight.budgetAllocationMode
DimensionTEXT
Campaigns Current Flight Budget In Advertiser Currency
The maximum amount the campaign flight may spend. This must be in the currency of the advertiser that owns the campaign.
Field IDcampaigns.currentFlight.budgetInAdvertiserCurrency
DimensionNUMBER
Campaigns Current Flight Budget In Impressions
The maximum amount of impressions the campaign flight should buy.
Field IDcampaigns.currentFlight.budgetInImpressions
DimensionNUMBER
Campaigns Current Flight Daily Target In Advertiser Currency
The total amount the campaign flight should spend in a single day, if possible. Value is in the currency of the advertiser that owns the campaign.
Field IDcampaigns.currentFlight.dailyTargetInAdvertiserCurrency
DimensionNUMBER
Campaigns Current Flight Daily Target In Impressions
The total number of impressions the campaign flight should buy in a single day, if possible.
Field IDcampaigns.currentFlight.dailyTargetInImpressions
DimensionNUMBER
Campaigns Current Flight Days Remaining
Field IDcampaigns.currentFlight.daysRemaining
DimensionNUMBER
Campaigns Current Flight End Date Exclusive UTC
The date and time (in UTC) when the campaign flight is to stop spending if it has not yet exhausted its budget.
Field IDcampaigns.currentFlight.endDateExclusiveUTC
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Current Flight Flight Elapsed Percent
The percentage of the flight duration that has elapsed, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to four decimal places
Field IDcampaigns.currentFlight.flightElapsedPercent
DimensionNUMBER
Campaigns Current Flight Id
Field IDcampaigns.currentFlight.id
DimensionTEXT
Campaigns Current Flight Is Active For At Least A Day
Field IDcampaigns.currentFlight.isActiveForAtLeastADay
DimensionBOOLEAN
Campaigns Current Flight Is Current
Field IDcampaigns.currentFlight.isCurrent
DimensionBOOLEAN
Campaigns Current Flight Is Deleted
Field IDcampaigns.currentFlight.isDeleted
DimensionBOOLEAN
Campaigns Current Flight Is Fixed Impression Budget Allocation
Whether the impression budget allocation on this campaign flight is manually set as fixed.
Field IDcampaigns.currentFlight.isFixedImpressionBudgetAllocation
DimensionBOOLEAN
Campaigns Current Flight Start Date Inclusive UTC
The date and time (in UTC) when the campaign flight is to start spending.
Field IDcampaigns.currentFlight.startDateInclusiveUTC
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Current Flight Uses Impression Budgets
Whether the campaign flight has impression budgets manually set.
Field IDcampaigns.currentFlight.usesImpressionBudgets
DimensionBOOLEAN
Campaigns Current Or Next Flight Budget Allocation Mode
Whether the budget allocation on this campaign flight is fluid, fixed, or mixed. See CampaignBudgetAllocationMode.
Field IDcampaigns.currentOrNextFlight.budgetAllocationMode
DimensionTEXT
Campaigns Current Or Next Flight Budget In Advertiser Currency
The maximum amount the campaign flight may spend. This must be in the currency of the advertiser that owns the campaign.
Field IDcampaigns.currentOrNextFlight.budgetInAdvertiserCurrency
DimensionNUMBER
Campaigns Current Or Next Flight Budget In Impressions
The maximum amount of impressions the campaign flight should buy.
Field IDcampaigns.currentOrNextFlight.budgetInImpressions
DimensionNUMBER
Campaigns Current Or Next Flight Daily Target In Advertiser Currency
The total amount the campaign flight should spend in a single day, if possible. Value is in the currency of the advertiser that owns the campaign.
Field IDcampaigns.currentOrNextFlight.dailyTargetInAdvertiserCurrency
DimensionNUMBER
Campaigns Current Or Next Flight Daily Target In Impressions
The total number of impressions the campaign flight should buy in a single day, if possible.
Field IDcampaigns.currentOrNextFlight.dailyTargetInImpressions
DimensionNUMBER
Campaigns Current Or Next Flight Days Remaining
Field IDcampaigns.currentOrNextFlight.daysRemaining
DimensionNUMBER
Campaigns Current Or Next Flight End Date Exclusive UTC
The date and time (in UTC) when the campaign flight is to stop spending if it has not yet exhausted its budget.
Field IDcampaigns.currentOrNextFlight.endDateExclusiveUTC
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Current Or Next Flight Flight Elapsed Percent
The percentage of the flight duration that has elapsed, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to four decimal places
Field IDcampaigns.currentOrNextFlight.flightElapsedPercent
DimensionNUMBER
Campaigns Current Or Next Flight Id
Field IDcampaigns.currentOrNextFlight.id
DimensionTEXT
Campaigns Current Or Next Flight Is Active For At Least A Day
Field IDcampaigns.currentOrNextFlight.isActiveForAtLeastADay
DimensionBOOLEAN
Campaigns Current Or Next Flight Is Current
Field IDcampaigns.currentOrNextFlight.isCurrent
DimensionBOOLEAN
Campaigns Current Or Next Flight Is Deleted
Field IDcampaigns.currentOrNextFlight.isDeleted
DimensionBOOLEAN
Campaigns Current Or Next Flight Is Fixed Impression Budget Allocation
Whether the impression budget allocation on this campaign flight is manually set as fixed.
Field IDcampaigns.currentOrNextFlight.isFixedImpressionBudgetAllocation
DimensionBOOLEAN
Campaigns Current Or Next Flight Start Date Inclusive UTC
The date and time (in UTC) when the campaign flight is to start spending.
Field IDcampaigns.currentOrNextFlight.startDateInclusiveUTC
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Current Or Next Flight Uses Impression Budgets
Whether the campaign flight has impression budgets manually set.
Field IDcampaigns.currentOrNextFlight.usesImpressionBudgets
DimensionBOOLEAN
Campaigns Custom CPA Click Weight
Weight to assign to click-through pixels when calculating custom CPA.
Field IDcampaigns.customCPAClickWeight
DimensionNUMBER
Campaigns Custom CPA Type
The custom CPA to use to use for the CPA calculation for the campaign.
Field IDcampaigns.customCPAType
DimensionTEXT
Campaigns Custom CPA Viewthrough Weight
Weight to assign to view pixels when calculating custom CPA.
Field IDcampaigns.customCPAViewthroughWeight
DimensionNUMBER
Campaigns Custom ROAS Type
The custom ROAS calculation for the campaign's Return on Advertiser Spend value.
Field IDcampaigns.customROASType
DimensionTEXT
Campaigns Description
An optional description of the campaign.
Field IDcampaigns.description
DimensionTEXT
Campaigns End Date
The date and time (in UTC) when the campaign stops spending if it has not yet exhausted its budget. For campaigns with multiple multiple flights, this value is determined using specified flight values and may not be modified.
Field IDcampaigns.endDate
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Frequency Settings Frequency Cap
The maximum number of impressions to serve to a specific user within the FrequencyPeriodInMinutes. Applies to the entire campaign.
Field IDcampaigns.frequencySettings.frequencyCap
DimensionNUMBER
Campaigns Frequency Settings Frequency Period In Minutes
The period of time after which a specific user's Frequency Cap is reset.
Field IDcampaigns.frequencySettings.frequencyPeriodInMinutes
DimensionNUMBER
Campaigns Frequency Settings Lifetime Frequency Cap
The maximum number of impressions to serve to a specific user over the lifetime of the campaign.
Field IDcampaigns.frequencySettings.lifetimeFrequencyCap
DimensionNUMBER
Campaigns Funnel Location Count
The number of distinct Funnel Locations for all visible AdGroups owned by the Campaign.
Field IDcampaigns.funnelLocationCount
DimensionNUMBER
Campaigns Goal Average Value
The average Goal value.
Field IDcampaigns.goal.averageValue
DimensionNUMBER
Campaigns Goal Is Custom
Whether the goal is custom or not.
Field IDcampaigns.goal.isCustom
DimensionBOOLEAN
Campaigns Goal Meeting Percentage
The percentage of the Goal being met, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to 4 digits after decimal point.
Field IDcampaigns.goal.meetingPercentage
DimensionNUMBER
Campaigns Goal Short Name
The short version of goal type's name.
Field IDcampaigns.goal.shortName
DimensionTEXT
Campaigns Goal Target
The target Goal value.
Field IDcampaigns.goal.target
DimensionNUMBER
Campaigns Goal Type
The type of Goal.
Field IDcampaigns.goal.type
DimensionTEXT
Campaigns Goal Unit
The unit of measurement for the Goal data.
Field IDcampaigns.goal.unit
DimensionTEXT
Campaigns Id
The ID of the campaign.
Field IDcampaigns.id
DimensionTEXT
Campaigns Impressions Only Budgeting CPM
Field IDcampaigns.impressionsOnlyBudgetingCPM
DimensionNUMBER
Campaigns Io Contract Id
IO assigned to each campaign for IO clients to manage its spend.
Field IDcampaigns.ioContractId
DimensionNUMBER
Campaigns Is Archived
Field IDcampaigns.isArchived
DimensionBOOLEAN
Campaigns Is I Spot Enabled
If set to `true`, indicates that ISpot incremental reach KPI has been added. The default value is `false`.
Field IDcampaigns.isISpotEnabled
DimensionBOOLEAN
Campaigns Is Managed By TTD
A property to indicate this campaign is managed by The Trade Desk.
Field IDcampaigns.isManagedByTTD
DimensionBOOLEAN
Campaigns Is Migrated To Kokai
The campaign has been migrated from a previous version to Kokai.
Field IDcampaigns.isMigratedToKokai
DimensionBOOLEAN
Campaigns Is Programmatic Guaranteed
Field IDcampaigns.isProgrammaticGuaranteed
DimensionBOOLEAN
Campaigns Is Template
Field IDcampaigns.isTemplate
DimensionBOOLEAN
Campaigns Is Tv Squared Enabled
If set to `true`, indicates that TvSquared incremental reach KPI has been added. The default value is `false`.
Field IDcampaigns.isTvSquaredEnabled
DimensionBOOLEAN
Campaigns Last Touch Attribution Measured By The Trade Desk
The Trade Desk measure last-touch attribution (recommended for troubleshooting purposes).
Field IDcampaigns.lastTouchAttributionMeasuredByTheTradeDesk
DimensionBOOLEAN
Campaigns Last Updated
The time in UTC the campaign was last updated. This field is read-only.
Field IDcampaigns.lastUpdated
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Last Updated At Utc
The time in UTC the campaign was last updated. This field is read-only.
Field IDcampaigns.lastUpdatedAtUtc
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Minimum Ad Group Spend In Advertiser Currency
The daily minimum spend amount that you want the platform to allocate to all ad groups in a campaign that has `autoAllocatorEnabled` and `autoPrioritizationEnabled` set to true. Requires the `autoAllocatorEnabled` and `autoPrioritizationEnabled` property values to be set to true. The default value for this property is `0`. This value must always be positive. The platform allocates the minimum amount to ad groups daily only while there is enough potential spend and budget to allocate. When you clone a campaign, this minimum spend value is carried over.
Field IDcampaigns.minimumAdGroupSpendInAdvertiserCurrency
DimensionNUMBER
Campaigns Name
The name of the campaign.
Field IDcampaigns.name
DimensionTEXT
Campaigns Next Flight Budget Allocation Mode
Whether the budget allocation on this campaign flight is fluid, fixed, or mixed. See CampaignBudgetAllocationMode.
Field IDcampaigns.nextFlight.budgetAllocationMode
DimensionTEXT
Campaigns Next Flight Budget In Advertiser Currency
The maximum amount the campaign flight may spend. This must be in the currency of the advertiser that owns the campaign.
Field IDcampaigns.nextFlight.budgetInAdvertiserCurrency
DimensionNUMBER
Campaigns Next Flight Budget In Impressions
The maximum amount of impressions the campaign flight should buy.
Field IDcampaigns.nextFlight.budgetInImpressions
DimensionNUMBER
Campaigns Next Flight Daily Target In Advertiser Currency
The total amount the campaign flight should spend in a single day, if possible. Value is in the currency of the advertiser that owns the campaign.
Field IDcampaigns.nextFlight.dailyTargetInAdvertiserCurrency
DimensionNUMBER
Campaigns Next Flight Daily Target In Impressions
The total number of impressions the campaign flight should buy in a single day, if possible.
Field IDcampaigns.nextFlight.dailyTargetInImpressions
DimensionNUMBER
Campaigns Next Flight Days Remaining
Field IDcampaigns.nextFlight.daysRemaining
DimensionNUMBER
Campaigns Next Flight End Date Exclusive UTC
The date and time (in UTC) when the campaign flight is to stop spending if it has not yet exhausted its budget.
Field IDcampaigns.nextFlight.endDateExclusiveUTC
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Next Flight Flight Elapsed Percent
The percentage of the flight duration that has elapsed, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to four decimal places
Field IDcampaigns.nextFlight.flightElapsedPercent
DimensionNUMBER
Campaigns Next Flight Id
Field IDcampaigns.nextFlight.id
DimensionTEXT
Campaigns Next Flight Is Active For At Least A Day
Field IDcampaigns.nextFlight.isActiveForAtLeastADay
DimensionBOOLEAN
Campaigns Next Flight Is Current
Field IDcampaigns.nextFlight.isCurrent
DimensionBOOLEAN
Campaigns Next Flight Is Deleted
Field IDcampaigns.nextFlight.isDeleted
DimensionBOOLEAN
Campaigns Next Flight Is Fixed Impression Budget Allocation
Whether the impression budget allocation on this campaign flight is manually set as fixed.
Field IDcampaigns.nextFlight.isFixedImpressionBudgetAllocation
DimensionBOOLEAN
Campaigns Next Flight Start Date Inclusive UTC
The date and time (in UTC) when the campaign flight is to start spending.
Field IDcampaigns.nextFlight.startDateInclusiveUTC
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Next Flight Uses Impression Budgets
Whether the campaign flight has impression budgets manually set.
Field IDcampaigns.nextFlight.usesImpressionBudgets
DimensionBOOLEAN
Campaigns Objective
The campaign objective.
Field IDcampaigns.objective
DimensionTEXT
Campaigns Pacing Mode
The pacing mode for the Campaign.
Field IDcampaigns.pacingMode
DimensionTEXT
Campaigns Pacing To End Of Flight Daily Rate
Field IDcampaigns.pacingToEndOfFlightDailyRate
DimensionNUMBER
Campaigns Partner China MSA Signed
Field IDcampaigns.partner.chinaMSASigned
DimensionBOOLEAN
Campaigns Partner Cost Percentage Fee
The partner fee for the campaign as a percentage of the budget after The Trade Desk fee is calculated. For details, contact your Account Manager.
Field IDcampaigns.partnerCostPercentageFee
DimensionNUMBER
Campaigns Partner Credit Limit In USD
Current credit limit assigned
Field IDcampaigns.partner.creditLimitInUSD
DimensionNUMBER
Campaigns Partner Daily Spend Cap In USD
Daily spend cap
Field IDcampaigns.partner.dailySpendCapInUSD
DimensionNUMBER
Campaigns Partner Default Recency Bucket List Id
Field IDcampaigns.partner.defaultRecencyBucketListId
DimensionTEXT
Campaigns Partner Id
The ID of the partner.
Field IDcampaigns.partner.id
DimensionTEXT
Campaigns Partner Id Integer
The integer ID of the partner. This ID is typically used as a buyer or seat ID in the Easy Proposal Activation API. This is a read-only property.
Field IDcampaigns.partner.idInteger
DimensionNUMBER
Campaigns Partner Is Purchase Order Number Required
Indicates if partner is billed by PO#, requiring campaigns to populate this field.
Field IDcampaigns.partner.isPurchaseOrderNumberRequired
DimensionBOOLEAN
Campaigns Partner Is Spend Disabled
Flag signifying whether the spend on this partner is disabled
Field IDcampaigns.partner.isSpendDisabled
DimensionBOOLEAN
Campaigns Partner Must Vet Advertisers
Field IDcampaigns.partner.mustVetAdvertisers
DimensionBOOLEAN
Campaigns Partner Name
The name of the partner.
Field IDcampaigns.partner.name
DimensionTEXT
Campaigns Primary Goal Average Value
The average Goal value.
Field IDcampaigns.primaryGoal.averageValue
DimensionNUMBER
Campaigns Primary Goal Is Custom
Whether the goal is custom or not.
Field IDcampaigns.primaryGoal.isCustom
DimensionBOOLEAN
Campaigns Primary Goal Meeting Percentage
The percentage of the Goal being met, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to 4 digits after decimal point.
Field IDcampaigns.primaryGoal.meetingPercentage
DimensionNUMBER
Campaigns Primary Goal Short Name
The short version of goal type's name.
Field IDcampaigns.primaryGoal.shortName
DimensionTEXT
Campaigns Primary Goal Target
The target Goal value.
Field IDcampaigns.primaryGoal.target
DimensionNUMBER
Campaigns Primary Goal Type
The type of Goal.
Field IDcampaigns.primaryGoal.type
DimensionTEXT
Campaigns Primary Goal Unit
The unit of measurement for the Goal data.
Field IDcampaigns.primaryGoal.unit
DimensionTEXT
Campaigns Purchase Order Number
A property that you can use for internal reference. For example, a purchase order number.
Field IDcampaigns.purchaseOrderNumber
DimensionTEXT
Campaigns Reporting Lifetime Impressions
The campaign's total spend in the advertiser's currency over its lifetime. NOTE: This feature is in Beta and subject to change.
Field IDcampaigns.reporting.lifetimeImpressions
DimensionNUMBER
Campaigns Reporting Lifetime Spend In Advertiser Currency
The campaign's total impression count in the advertiser's currency over its lifetime. NOTE: This feature is in Beta and subject to change.
Field IDcampaigns.reporting.lifetimeSpendInAdvertiserCurrency
DimensionNUMBER
Campaigns Secondary Goal Average Value
The average Goal value.
Field IDcampaigns.secondaryGoal.averageValue
DimensionNUMBER
Campaigns Secondary Goal Is Custom
Whether the goal is custom or not.
Field IDcampaigns.secondaryGoal.isCustom
DimensionBOOLEAN
Campaigns Secondary Goal Meeting Percentage
The percentage of the Goal being met, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to 4 digits after decimal point.
Field IDcampaigns.secondaryGoal.meetingPercentage
DimensionNUMBER
Campaigns Secondary Goal Short Name
The short version of goal type's name.
Field IDcampaigns.secondaryGoal.shortName
DimensionTEXT
Campaigns Secondary Goal Target
The target Goal value.
Field IDcampaigns.secondaryGoal.target
DimensionNUMBER
Campaigns Secondary Goal Type
The type of Goal.
Field IDcampaigns.secondaryGoal.type
DimensionTEXT
Campaigns Secondary Goal Unit
The unit of measurement for the Goal data.
Field IDcampaigns.secondaryGoal.unit
DimensionTEXT
Campaigns Seed Active Ids
Active id count in the seed.
Field IDcampaigns.seed.activeIds
DimensionNUMBER
Campaigns Seed Created At
Date and time of the seed creation.
Field IDcampaigns.seed.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Seed Id
ID of the seed.
Field IDcampaigns.seed.id
DimensionTEXT
Campaigns Seed Is Default
Indicates whether the seed is set as the default for the advertiser.
Field IDcampaigns.seed.isDefault
DimensionBOOLEAN
Campaigns Seed Last Updated At
Date and time of last seed update.
Field IDcampaigns.seed.lastUpdatedAt
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Seed Name
Name of the seed
Field IDcampaigns.seed.name
DimensionTEXT
Campaigns Seed Quality
Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`.
Field IDcampaigns.seed.quality
DimensionTEXT
Campaigns Seed Quality Reason
Represents the reason for seed definition quality.
Field IDcampaigns.seed.qualityReason
DimensionTEXT
Campaigns Seed Status
Seed materialization status.
Field IDcampaigns.seed.status
DimensionTEXT
Campaigns Seed Unique Households
Unique house hold ids associated with the seed.
Field IDcampaigns.seed.uniqueHouseholds
DimensionNUMBER
Campaigns Share Type
A property to indicate what level of access this campaign has.
Field IDcampaigns.shareType
DimensionTEXT
Campaigns Site Url
Field IDcampaigns.siteUrl
DimensionTEXT
Campaigns Spend Current
Field IDcampaigns.spend.current
DimensionNUMBER
Campaigns Spend Risk Level
Field IDcampaigns.spend.riskLevel
DimensionTEXT
Campaigns Start Date
The date and time (in UTC) when the campaign starts spending. For campaigns with multiple flights, this value is determined using specified flight values and may not be modified. Otherwise, it must be specified at creation time.
Field IDcampaigns.startDate
DimensionYEAR_MONTH_DAY_SECOND
Campaigns Status
Campaign status.
Field IDcampaigns.status
DimensionTEXT
Campaigns Tertiary Goal Average Value
The average Goal value.
Field IDcampaigns.tertiaryGoal.averageValue
DimensionNUMBER
Campaigns Tertiary Goal Is Custom
Whether the goal is custom or not.
Field IDcampaigns.tertiaryGoal.isCustom
DimensionBOOLEAN
Campaigns Tertiary Goal Meeting Percentage
The percentage of the Goal being met, expressed as a decimal. For example, a value of 0.12 represents 12%. Rounded to 4 digits after decimal point.
Field IDcampaigns.tertiaryGoal.meetingPercentage
DimensionNUMBER
Campaigns Tertiary Goal Short Name
The short version of goal type's name.
Field IDcampaigns.tertiaryGoal.shortName
DimensionTEXT
Campaigns Tertiary Goal Target
The target Goal value.
Field IDcampaigns.tertiaryGoal.target
DimensionNUMBER
Campaigns Tertiary Goal Type
The type of Goal.
Field IDcampaigns.tertiaryGoal.type
DimensionTEXT
Campaigns Tertiary Goal Unit
The unit of measurement for the Goal data.
Field IDcampaigns.tertiaryGoal.unit
DimensionTEXT
Campaigns Time Zone
The Windows time zone ID of the campaign.
Field IDcampaigns.timeZone
DimensionTEXT
Campaigns Time Zone IANA
The IANA/Olson time zone ID of the campaign.
Field IDcampaigns.timeZoneIANA
DimensionTEXT
Campaigns Total Ad Group Count
The total number of visible AdGroups owned by the Campaign.
Field IDcampaigns.totalAdGroupCount
DimensionNUMBER
Campaigns Trading Mode
The mode that the pacing and bidding system runs on to better achieve customized goals. Only applies to Kokai campaigns.
Field IDcampaigns.tradingMode
DimensionTEXT
Campaigns Type
Field IDcampaigns.type
DimensionTEXT
Campaigns Version
The name of The Trade Desk platform experience in which the campaign was created. If not specified, indicates that the campaign was created in a platform experience prior to Kokai.
Field IDcampaigns.version
DimensionTEXT
Channel Overlap Rate Households
Percentage of households reached on more than one channel.
Field IDchannelOverlapRateHouseholds
MetricNUMBER
Channel Overlap Rate Persons
Percentage of people reached on more than one channel.
Field IDchannelOverlapRatePersons
MetricNUMBER
Clicks
The number of times a user interacted with an ad by clicking it.
Field IDclicks
MetricNUMBER
Completion Rate
The proportion of ads that are fully viewed, played, or heard out of the total number of ads served.
Field IDcompletionRate
MetricNUMBER
Conversions
The number of times a user engaged with an ad and completed an action.
Field IDconversions
MetricNUMBER
Cpa Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDcpa.advertiserCurrency
MetricNUMBER
Cpa In Advertiser Currency
Cost per acquisition (CPA) in advertiser currency.
Field IDcpaInAdvertiserCurrency
MetricNUMBER
Cpa Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDcpa.partnerCurrency
MetricNUMBER
Cpa Usd
The amount specified in US dollars.
Field IDcpa.usd
MetricNUMBER
Cpc Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDcpc.advertiserCurrency
MetricNUMBER
Cpc Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDcpc.partnerCurrency
MetricNUMBER
Cpc Usd
The amount specified in US dollars.
Field IDcpc.usd
MetricNUMBER
Cpcv Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDcpcv.advertiserCurrency
MetricNUMBER
Cpcv Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDcpcv.partnerCurrency
MetricNUMBER
Cpcv Usd
The amount specified in US dollars.
Field IDcpcv.usd
MetricNUMBER
Cpm Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDcpm.advertiserCurrency
MetricNUMBER
Cpm In Advertiser Currency
Cost per mille (CPM) in advertiser currency.
Field IDcpmInAdvertiserCurrency
MetricNUMBER
Cpm Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDcpm.partnerCurrency
MetricNUMBER
Cpm Usd
The amount specified in US dollars.
Field IDcpm.usd
MetricNUMBER
Creative Ad Server Creative Id
Field IDcreatives.adServerCreativeId
DimensionTEXT
Creative Ad Server Name
Field IDcreatives.adServerName
DimensionTEXT
Creative Approved By
Field IDcreatives.approvedBy
DimensionTEXT
Creative Created At
The UTC time when the creative was created.
Field IDcreatives.createdAt
DimensionYEAR_MONTH_DAY_SECOND
Creative Description
An optional description of the creative. The maximum character length is 512.
Field IDcreatives.description
DimensionTEXT
Creative Flight End
The flight end date and time for the creative.
Field IDcreatives.flightEnd
DimensionYEAR_MONTH_DAY_SECOND
Creative Flight End Date UTC
Field IDcreatives.flightEndDateUTC
DimensionYEAR_MONTH_DAY_SECOND
Creative Flight Start
The flight start date and time for the creative.
Field IDcreatives.flightStart
DimensionYEAR_MONTH_DAY_SECOND
Creative Flight Start Date UTC
Field IDcreatives.flightStartDateUTC
DimensionYEAR_MONTH_DAY_SECOND
Creative Flight Time Zone
Timezone for the creative flight dates. Defaults to "UTC" when not explicitly set.
Field IDcreatives.flightTimeZone
DimensionTEXT
Creative Flight Time Zone IANA
The IANA/Olson time zone ID of the creative flight. The default value is "Etc/UTC".
Field IDcreatives.flightTimeZoneIANA
DimensionTEXT
Creative Id
The unique identifier of the creative.
Field IDcreatives.id
DimensionTEXT
Creative Id Integer
Field IDcreatives.idInteger
DimensionNUMBER
Creative Interstitial Support Id
Field IDcreatives.interstitialSupportId
DimensionNUMBER
Creative Is Archived
Field IDcreatives.isArchived
DimensionBOOLEAN
Creative Is Click Tracking Successful
Indicates whether click tracking verification was successful. Returns true if the click tracking process has been verified successfully, otherwise false.
Field IDcreatives.isClickTrackingSuccessful
DimensionBOOLEAN
Creative Last Updated At
The UTC time when the creative was last updated.
Field IDcreatives.lastUpdatedAt
DimensionYEAR_MONTH_DAY_SECOND
Creative Malware Scan Is Scan Pending
Completion status of the malware scan.
Field IDcreatives.malwareScan.isScanPending
DimensionBOOLEAN
Creative Name
The name of the creative. The value must not contain any of the following special characters: <>;^\r\n. The maximum character length is 256.
Field IDcreatives.name
DimensionTEXT
Creative Political Ad Icon Candidate Name
Political Candidate
Field IDcreatives.politicalAdIcon.candidateName
DimensionTEXT
Creative Political Ad Icon Id
Field IDcreatives.politicalAdIcon.id
DimensionTEXT
Creative Political Ad Icon Political Data Id
Field IDcreatives.politicalAdIcon.politicalDataId
DimensionTEXT
Creative Share Link
Link to a preview of this creative. Anybody with the link can see the creative, visiting it does not require authentication.
Field IDcreatives.shareLink
DimensionTEXT
Creative Tag Type
Field IDcreatives.tagType
DimensionNUMBER
Creative Tag Type Enum
Field IDcreatives.tagTypeEnum
DimensionTEXT
Creative Third Party Click Tracking Url
Field IDcreatives.thirdPartyClickTrackingUrl
DimensionTEXT
Creative Tmt Malware Scan Is Scan Pending
Completion status of the malware scan.
Field IDcreatives.tmtMalwareScan.isScanPending
DimensionBOOLEAN
Creative Type
Enum matching the type of the creative. This value will allow for sorting and filtering.
Field IDcreatives.type
DimensionTEXT
Ctr
Click-through rate (percentage of impressions that resulted in clicks).
Field IDctr
MetricNUMBER
Custom Cpa Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDcustomCpa.advertiserCurrency
MetricNUMBER
Custom Cpa Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDcustomCpa.partnerCurrency
MetricNUMBER
Custom Cpa Usd
The amount specified in US dollars.
Field IDcustomCpa.usd
MetricNUMBER
Custom Roas Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDcustomRoas.advertiserCurrency
MetricNUMBER
Custom Roas Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDcustomRoas.partnerCurrency
MetricNUMBER
Custom Roas Usd
The amount specified in US dollars.
Field IDcustomRoas.usd
MetricNUMBER
Date
Year Month Day such as 20240401.
Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH_DAY
DimensionYEAR_MONTH_DAY
Day of the week
Day of the week
Field ID_NORMALIZED_DATE_FIELD_DAY_OF_WEEK
DimensionDAY_OF_WEEK
Day of the year
Day of the year
Field ID_NORMALIZED_DATE_FIELD_DAY
DimensionDAY
Deal ID
Field IDdealID
MetricNUMBER
Device Type
Field IDdeviceType
DimensionTEXT
Hour of the day
Hour of the day
Field ID_NORMALIZED_DATE_FIELD_HOUR
DimensionHOUR
Impressions
The number of times an ad was served and had the potential to be viewed.
Field IDimpressions
MetricNUMBER
Impressions Served Percent
The percent of impressions served expressed as a decimal rounded to 4 decimal points. For example, a value of 0.12 represents 12%. Calculated by dividing the impressions served to date by the flight impression budget. Currently only supported for campaign flights and ad group flights.
Field IDimpressionsServedPercent
MetricNUMBER
In View Rate
The proportion of impressions where an ad was in view for a certain period of time.
Field IDinViewRate
MetricNUMBER
Matched Household Impressions
Impressions which matched with a Household Id in Graph.
Field IDmatchedHouseholdImpressions
MetricNUMBER
Matched Person Impressions
Impressions which matched with a Person Id in Graph.
Field IDmatchedPersonImpressions
MetricNUMBER
Media Cost Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDmediaCost.advertiserCurrency
MetricNUMBER
Media Cost Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDmediaCost.partnerCurrency
MetricNUMBER
Media Cost Usd
The amount specified in US dollars.
Field IDmediaCost.usd
MetricNUMBER
Media Cpm Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDmediaCpm.advertiserCurrency
MetricNUMBER
Media Cpm Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDmediaCpm.partnerCurrency
MetricNUMBER
Media Cpm Usd
The amount specified in US dollars.
Field IDmediaCpm.usd
MetricNUMBER
Month and day
Month and day
Field ID_NORMALIZED_DATE_FIELD_MONTH_DAY
DimensionMONTH_DAY
Month of the year
Month of the year
Field ID_NORMALIZED_DATE_FIELD_MONTH
DimensionMONTH
Nielsen Otp
The Nielsen On-Target percentage. Currently not supported for campaign flights or ad group flights.
Field IDnielsenOtp
MetricNUMBER
Normalized Week of the year
Week of the year
Field ID_NORMALIZED_DATE_FIELD_WEEK
DimensionWEEK
Operating System
Field IDoperatingSystem
DimensionTEXT
Operating System Family
Field IDoperatingSystemFamily
DimensionTEXT
Partner Cost (Adv Currency)
Field IDpartnerCostAdvCurrency
MetricNUMBER
Partner Cost (Partner Currency)
Field IDpartnerCostPartnerCurrency
MetricNUMBER
Partner Cost (USD)
Field IDpartnerCostUSD
MetricNUMBER
Player 25% Complete
Field IDplayer25Complete
MetricNUMBER
Player 50% Complete
Field IDplayer50Complete
MetricNUMBER
Player 75% Complete
Field IDplayer75Complete
MetricNUMBER
Player Close
Field IDplayerClose
MetricNUMBER
Player Collapse
Field IDplayerCollapse
MetricNUMBER
Player Completed Views
Field IDplayerCompletedViews
MetricNUMBER
Player Engaged Views
Field IDplayerEngagedViews
MetricNUMBER
Player Errors
Field IDplayerErrors
MetricNUMBER
Player Expansion
Field IDplayerExpansion
MetricNUMBER
Player Full Screen
Field IDplayerFullScreen
MetricNUMBER
Player Invitation Accept
Field IDplayerInvitationAccept
MetricNUMBER
Player Mute
Field IDplayerMute
MetricNUMBER
Player Pause
Field IDplayerPause
MetricNUMBER
Player Resume
Field IDplayerResume
MetricNUMBER
Player Rewind
Field IDplayerRewind
MetricNUMBER
Player Skip
Field IDplayerSkip
MetricNUMBER
Player Starts
Field IDplayerStarts
MetricNUMBER
Player Unmute
Field IDplayerUnmute
MetricNUMBER
Player Views
Field IDplayerViews
MetricNUMBER
Quarter of the year
Quarter of the year
Field ID_NORMALIZED_DATE_FIELD_QUARTER
DimensionQUARTER
Revenue
Total revenue generated.
Field IDrevenue
MetricNUMBER
Roas Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDroas.advertiserCurrency
MetricNUMBER
Roas Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDroas.partnerCurrency
MetricNUMBER
Roas Usd
The amount specified in US dollars.
Field IDroas.usd
MetricNUMBER
Sampled Tracked Impressions
Field IDsampledTrackedImpressions
MetricNUMBER
Sampled Viewed Impressions
Field IDsampledViewedImpressions
MetricNUMBER
Spend Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDspend.advertiserCurrency
MetricNUMBER
Spend In Advertiser Currency
Spend in advertiser currency.
Field IDspendInAdvertiserCurrency
MetricNUMBER
Spend Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDspend.partnerCurrency
MetricNUMBER
Spend Usd
The amount specified in US dollars.
Field IDspend.usd
MetricNUMBER
Total Bid Amount (Adv Currency)
Field IDtotalBidAmountAdvCurrency
MetricNUMBER
Total Bid Amount (Partner Currency)
Field IDtotalBidAmountPartnerCurrency
MetricNUMBER
Total Bid Amount (USD)
Field IDtotalBidAmountUSD
MetricNUMBER
TTD Cost (Adv Currency)
Field IDTTDcostAdvCurrency
MetricNUMBER
TTD Cost (Partner Currency)
Field IDTTDcostPartnerCurrency
MetricNUMBER
TTD Cost (USD)
Field IDTTDcostUSD
MetricNUMBER
Tv Quality Cpm Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDtvQualityCpm.advertiserCurrency
MetricNUMBER
Tv Quality Cpm Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDtvQualityCpm.partnerCurrency
MetricNUMBER
Tv Quality Cpm Usd
The amount specified in US dollars.
Field IDtvQualityCpm.usd
MetricNUMBER
Tv Quality Index
The quality of inventory run, on a scale of 1 - 100. TVQI is an aggregate of the weighted scores for eight criteria (content, addressability, playback type, device type, content duration, production quality, content signal transparency, and market type) across three pillars of quality (content, ad experience, and signals).
Field IDtvQualityIndex
MetricNUMBER
Unique Households
Unique houseHold count.
Field IDuniqueHouseholds
MetricNUMBER
Unique Persons
Unique person count.
Field IDuniquePersons
MetricNUMBER
V Cpm Advertiser Currency
The amount specified in the advertiser's currency, which is selected during the advertiser setup process.
Field IDvCpm.advertiserCurrency
MetricNUMBER
V Cpm Partner Currency
The amount specified in the partner's currency, which is selected during the partner setup process.
Field IDvCpm.partnerCurrency
MetricNUMBER
V Cpm Usd
The amount specified in US dollars.
Field IDvCpm.usd
MetricNUMBER
Video Completion Rate
The proportion of ads that are fully viewed, played, or heard out of the total number of ads served, expressed as a decimal. For example, a value of `0.65` represents 65% (65 full views per 100 ads served).
Field IDvideoCompletionRate
MetricNUMBER
Viewability
The percentage of ads that were viewable.
Field IDviewability
MetricNUMBER
Week of the year
Week of the year
Field IDweek
DimensionWEEK
Week of the year (start Sunday)
Week of the year
Field ID_NORMALIZED_DATE_FIELD_WEEK_START_SUNDAY
DimensionWEEK
Win Rate
The percentage of auctions that were won.
Field IDwinRate
MetricNUMBER
Year
Year such as 2017.
Field ID_NORMALIZED_DATE_FIELD_YEAR
DimensionYEAR
Year month
Year and month.
Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH
DimensionYEAR_MONTH
Year month day hour
Year, month, day, and hour.
Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH_DAY_HOUR
DimensionYEAR_MONTH_DAY_HOUR
Year Quarter
Year and quarter.
Field ID_NORMALIZED_DATE_FIELD_YEAR_QUARTER
DimensionYEAR_QUARTER
Year week
Year and week.
Field ID_NORMALIZED_DATE_FIELD_YEAR_WEEK
DimensionYEAR_WEEK

Explore destinations for your data

AI

Claude

Ask Claude about your Marketing data.
AI

ChatGPT

Ask ChatGPT about your Marketing data.
Spreadsheet

Excel

Easily track, report, and analyze your marketing KPIs in Excel.‍
Data lake

Azure Blob Storage

Quickly export your marketing data to Azure Blob Storage for secure storage and analysis, streamlining workflows and enhancing insights.
Data lake

Google Cloud Storage

Effortlessly export marketing data to Google Cloud Storage for secure, scalable storage and streamlined insights.
Data lake

Amazon S3

Unlock effortless data storage and management for your marketing team with seamless transfers to Amazon S3, simplifying workflows and accelerating insights.
Data warehousing

Snowflake

Effortlessly integrates your data in Snowflake, providing a seamless solution for storage, analysis, and real-time insights.
Data warehousing

Amazon Redshift

Access advanced analytics and insights by effortlessly connecting your marketing data to Amazon Redshift.
Data warehousing

Azure SQL

Effortlessly connect your marketing data to Azure SQL for immediate access to valuable insights.
Data warehousing

PostgreSQL

Effortlessly send data from multiple Marketing platforms to your PostgreSQL database with Catchr for seamless integration, storage, and management.
Data warehousing

MySQL

Seamlessly integrate your marketing data with MySQL to access valuable analytics and insights.
Visualization

Tableau

Empower your marketing teams with seamless data transfer to Tableau.
Visualization

Power BI

Whether it's social media analytics, email marketing results, or PPC campaign data, Catchr bridges the gap. Export your data to Power BI.
Data warehousing

Big Query

Unlock advanced analytics and insights by easily connecting your marketing data to BigQuery.
Visualization

Data Studio (formerly Looker Studio)

Catchr makes it super easy to visualize your marketing data into Data Studio (formerly Looker Studio).
Spreadsheet

Google Sheets

Effortlessly report, monitor, and analyze your marketing KPIs in Google Sheets.