Find the fields you need for your next report.
690 fields
| Field | Details |
|---|---|
01 - Click Conversion | Field IDTTD01ClickConversion |
01 - Click Conversion Currency | Field IDTTD01ClickConversionCurrency |
01 - Click Conversion Revenue | Field IDTTD01ClickConversionRevenue |
01 - Conversion Touch | Field IDTTD01ConversionTouch |
01 - Conversion Touch Revenue | Field IDTTD01ConversionTouchRevenue |
01 - Time Weighted Decay Conversion | Field IDTTD01TimeWeightedDecayConversion |
01 - Time Weighted Decay Conversion Revenue | Field IDTTD01TimeWeightedDecayConversionRevenue |
01 - View Through Conversion | Field IDTTD01ViewThroughConversion |
01 - View Through Conversion Currency | Field IDTTD01ViewThroughConversionCurrency |
01 - View Through Conversion Revenue | Field IDTTD01ViewThroughConversionRevenue |
02 - Click Conversion | Field IDTTD02ClickConversion |
02 - Click Conversion Currency | Field IDTTD02ClickConversionCurrency |
02 - Click Conversion Revenue | Field IDTTD02ClickConversionRevenue |
02 - Conversion Touch | Field IDTTD02ConversionTouch |
02 - Conversion Touch Revenue | Field IDTTD02ConversionTouchRevenue |
02 - Time Weighted Decay Conversion | Field IDTTD02TimeWeightedDecayConversion |
02 - Time Weighted Decay Conversion Revenue | Field IDTTD02TimeWeightedDecayConversionRevenue |
02 - View Through Conversion | Field IDTTD02ViewThroughConversion |
02 - View Through Conversion Currency | Field IDTTD02ViewThroughConversionCurrency |
02 - View Through Conversion Revenue | Field IDTTD02ViewThroughConversionRevenue |
03 - Click Conversion | Field IDTTD03ClickConversion |
03 - Click Conversion Currency | Field IDTTD03ClickConversionCurrency |
03 - Click Conversion Revenue | Field IDTTD03ClickConversionRevenue |
03 - Conversion Touch | Field IDTTD03ConversionTouch |
03 - Conversion Touch Revenue | Field IDTTD03ConversionTouchRevenue |
03 - Time Weighted Decay Conversion | Field IDTTD03TimeWeightedDecayConversion |
03 - Time Weighted Decay Conversion Revenue | Field IDTTD03TimeWeightedDecayConversionRevenue |
03 - View Through Conversion | Field IDTTD03ViewThroughConversion |
03 - View Through Conversion Currency | Field IDTTD03ViewThroughConversionCurrency |
03 - View Through Conversion Revenue | Field IDTTD03ViewThroughConversionRevenue |
04 - Click Conversion | Field IDTTD04ClickConversion |
04 - Click Conversion Currency | Field IDTTD04ClickConversionCurrency |
04 - Click Conversion Revenue | Field IDTTD04ClickConversionRevenue |
04 - Conversion Touch | Field IDTTD04ConversionTouch |
04 - Conversion Touch Revenue | Field IDTTD04ConversionTouchRevenue |
04 - Time Weighted Decay Conversion | Field IDTTD04TimeWeightedDecayConversion |
04 - Time Weighted Decay Conversion Revenue | Field IDTTD04TimeWeightedDecayConversionRevenue |
04 - View Through Conversion | Field IDTTD04ViewThroughConversion |
04 - View Through Conversion Currency | Field IDTTD04ViewThroughConversionCurrency |
04 - View Through Conversion Revenue | Field IDTTD04ViewThroughConversionRevenue |
05 - Click Conversion | Field IDTTD05ClickConversion |
05 - Click Conversion Currency | Field IDTTD05ClickConversionCurrency |
05 - Click Conversion Revenue | Field IDTTD05ClickConversionRevenue |
05 - Conversion Touch | Field IDTTD05ConversionTouch |
05 - Conversion Touch Revenue | Field IDTTD05ConversionTouchRevenue |
05 - Time Weighted Decay Conversion | Field IDTTD05TimeWeightedDecayConversion |
05 - Time Weighted Decay Conversion Revenue | Field IDTTD05TimeWeightedDecayConversionRevenue |
05 - View Through Conversion | Field IDTTD05ViewThroughConversion |
05 - View Through Conversion Currency | Field IDTTD05ViewThroughConversionCurrency |
05 - View Through Conversion Revenue | Field IDTTD05ViewThroughConversionRevenue |
06 - Click Conversion | Field IDTTD06ClickConversion |
06 - Click Conversion Currency | Field IDTTD06ClickConversionCurrency |
06 - Click Conversion Revenue | Field IDTTD06ClickConversionRevenue |
06 - Conversion Touch | Field IDTTD06ConversionTouch |
06 - Conversion Touch Revenue | Field IDTTD06ConversionTouchRevenue |
06 - Time Weighted Decay Conversion | Field IDTTD06TimeWeightedDecayConversion |
06 - Time Weighted Decay Conversion Revenue | Field IDTTD06TimeWeightedDecayConversionRevenue |
06 - View Through Conversion | Field IDTTD06ViewThroughConversion |
06 - View Through Conversion Currency | Field IDTTD06ViewThroughConversionCurrency |
06 - View Through Conversion Revenue | Field IDTTD06ViewThroughConversionRevenue |
Ad Groups Audience Created At The date and time in UTC the audience was created. | Field IDadGroups.audience.createdAt |
Ad Groups Audience Id | Field IDadGroups.audience.id |
Ad Groups Audience Is Auto Generated Indicates if this audience was automatically generated by The Trade Desk platform. | Field IDadGroups.audience.isAutoGenerated |
Ad Groups Audience Last Updated At Indicates the time when this audience was last updated (UTC). | Field IDadGroups.audience.lastUpdatedAt |
Ad Groups Audience Name The name of the audience. | Field IDadGroups.audience.name |
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 |
Ad Groups Audience Settings Strategy Get the Audience Strategy configured for the ad group. | Field IDadGroups.audienceSettings.strategy |
Ad Groups Audience Target Everyone If set to true, indicates that it is a TargetEveryone audience. | Field IDadGroups.audience.targetEveryone |
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 |
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 |
Ad Groups Base Bid CPM In Advertiser Currency | Field IDadGroups.baseBidCPMInAdvertiserCurrency |
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 |
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 |
Ad Groups Budget Current Flight Budget The budget of the AdGroup's current or next upcoming flight. | Field IDadGroups.budget.currentFlightBudget |
Ad Groups Budget In Advertiser Currency | Field IDadGroups.budgetInAdvertiserCurrency |
Ad Groups Budget In Impressions The maximum amount of impressions the adGroup should buy. | Field IDadGroups.budgetInImpressions |
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 |
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 |
Ad Groups Budget Total The Ad group's total budget in Advertiser currency. | Field IDadGroups.budget.total |
Ad Groups Budget Version The version of the budgeting experience for the campaign of the ad group. | Field IDadGroups.budget.version |
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 |
Ad Groups Campaign Auto Allocator Enabled | Field IDadGroups.campaign.autoAllocatorEnabled |
Ad Groups Campaign Auto Campaign Cap Enabled | Field IDadGroups.campaign.autoCampaignCapEnabled |
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 |
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 |
Ad Groups Campaign Channel Type | Field IDadGroups.campaign.channelType |
Ad Groups Campaign Created At The time in UTC the campaign was created. This field is read-only. | Field IDadGroups.campaign.createdAt |
Ad Groups Campaign Created At Utc The time in UTC the campaign was created. This field is read-only. | Field IDadGroups.campaign.createdAtUtc |
Ad Groups Campaign Custom CPA Click Weight Weight to assign to click-through pixels when calculating custom CPA. | Field IDadGroups.campaign.customCPAClickWeight |
Ad Groups Campaign Custom CPA Type The custom CPA to use to use for the CPA calculation for the campaign. | Field IDadGroups.campaign.customCPAType |
Ad Groups Campaign Custom CPA Viewthrough Weight Weight to assign to view pixels when calculating custom CPA. | Field IDadGroups.campaign.customCPAViewthroughWeight |
Ad Groups Campaign Custom ROAS Type The custom ROAS calculation for the campaign's Return on Advertiser Spend value. | Field IDadGroups.campaign.customROASType |
Ad Groups Campaign Description An optional description of the campaign. | Field IDadGroups.campaign.description |
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 |
Ad Groups Campaign Funnel Location Count The number of distinct Funnel Locations for all visible AdGroups owned by the Campaign. | Field IDadGroups.campaign.funnelLocationCount |
Ad Groups Campaign Id The ID of the campaign. | Field IDadGroups.campaign.id |
Ad Groups Campaign Impressions Only Budgeting CPM | Field IDadGroups.campaign.impressionsOnlyBudgetingCPM |
Ad Groups Campaign Io Contract Id IO assigned to each campaign for IO clients to manage its spend. | Field IDadGroups.campaign.ioContractId |
Ad Groups Campaign Is Archived | Field IDadGroups.campaign.isArchived |
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 |
Ad Groups Campaign Is Managed By TTD A property to indicate this campaign is managed by The Trade Desk. | Field IDadGroups.campaign.isManagedByTTD |
Ad Groups Campaign Is Migrated To Kokai The campaign has been migrated from a previous version to Kokai. | Field IDadGroups.campaign.isMigratedToKokai |
Ad Groups Campaign Is Programmatic Guaranteed | Field IDadGroups.campaign.isProgrammaticGuaranteed |
Ad Groups Campaign Is Template | Field IDadGroups.campaign.isTemplate |
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 |
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 |
Ad Groups Campaign Last Updated The time in UTC the campaign was last updated. This field is read-only. | Field IDadGroups.campaign.lastUpdated |
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 |
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 |
Ad Groups Campaign Name The name of the campaign. | Field IDadGroups.campaign.name |
Ad Groups Campaign Objective The campaign objective. | Field IDadGroups.campaign.objective |
Ad Groups Campaign Pacing Mode The pacing mode for the Campaign. | Field IDadGroups.campaign.pacingMode |
Ad Groups Campaign Pacing To End Of Flight Daily Rate | Field IDadGroups.campaign.pacingToEndOfFlightDailyRate |
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 |
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 |
Ad Groups Campaign Share Type A property to indicate what level of access this campaign has. | Field IDadGroups.campaign.shareType |
Ad Groups Campaign Site Url | Field IDadGroups.campaign.siteUrl |
Ad Groups Campaign Stack Rank | Field IDadGroups.campaignStackRank |
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 |
Ad Groups Campaign Status Campaign status. | Field IDadGroups.campaign.status |
Ad Groups Campaign Time Zone The Windows time zone ID of the campaign. | Field IDadGroups.campaign.timeZone |
Ad Groups Campaign Time Zone IANA The IANA/Olson time zone ID of the campaign. | Field IDadGroups.campaign.timeZoneIANA |
Ad Groups Campaign Total Ad Group Count The total number of visible AdGroups owned by the Campaign. | Field IDadGroups.campaign.totalAdGroupCount |
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 |
Ad Groups Campaign Type | Field IDadGroups.campaign.type |
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 |
Ad Groups Channel | Field IDadGroups.channel |
Ad Groups Contract Floor Price As Base Bid Adjustment Contract floor price as base-bid adjustment. | Field IDadGroups.contractFloorPriceAsBaseBidAdjustment |
Ad Groups Created At The time in UTC the adGroup was created. This field is read-only. | Field IDadGroups.createdAt |
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 |
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 |
Ad Groups Cross Device Vendor Name The friendly name of the cross-device vendor. | Field IDadGroups.crossDeviceVendor.name |
Ad Groups Current Flight Ad Group Id | Field IDadGroups.currentFlight.adGroupId |
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 |
Ad Groups Current Flight Allocation Type How the ad group allocation is treated. See `AdGroupBudgetAllocationType` for the different types. | Field IDadGroups.currentFlight.allocationType |
Ad Groups Current Flight Budget In Advertiser Currency | Field IDadGroups.currentFlight.budgetInAdvertiserCurrency |
Ad Groups Current Flight Budget In Impressions | Field IDadGroups.currentFlight.budgetInImpressions |
Ad Groups Current Flight Campaign Flight Id | Field IDadGroups.currentFlight.campaignFlightId |
Ad Groups Current Flight Daily Target In Advertiser Currency | Field IDadGroups.currentFlight.dailyTargetInAdvertiserCurrency |
Ad Groups Current Flight Daily Target In Impressions | Field IDadGroups.currentFlight.dailyTargetInImpressions |
Ad Groups Current Flight Minimum Spend In Advertiser Currency | Field IDadGroups.currentFlight.minimumSpendInAdvertiserCurrency |
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 |
Ad Groups Current Or Next Flight Ad Group Id | Field IDadGroups.currentOrNextFlight.adGroupId |
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 |
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 |
Ad Groups Current Or Next Flight Budget In Advertiser Currency | Field IDadGroups.currentOrNextFlight.budgetInAdvertiserCurrency |
Ad Groups Current Or Next Flight Budget In Impressions | Field IDadGroups.currentOrNextFlight.budgetInImpressions |
Ad Groups Current Or Next Flight Campaign Flight Id | Field IDadGroups.currentOrNextFlight.campaignFlightId |
Ad Groups Current Or Next Flight Daily Target In Advertiser Currency | Field IDadGroups.currentOrNextFlight.dailyTargetInAdvertiserCurrency |
Ad Groups Current Or Next Flight Daily Target In Impressions | Field IDadGroups.currentOrNextFlight.dailyTargetInImpressions |
Ad Groups Current Or Next Flight Minimum Spend In Advertiser Currency | Field IDadGroups.currentOrNextFlight.minimumSpendInAdvertiserCurrency |
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 |
Ad Groups Deals Present Returns true if the ad group is targeting deals. | Field IDadGroups.dealsPresent |
Ad Groups Description An optional description of the ad group. | Field IDadGroups.description |
Ad Groups Display Viewability Standard Integral The display viewability standard of the ad group. | Field IDadGroups.displayViewabilityStandardIntegral |
Ad Groups Expressiveness Bid Factors Total number of unique bids capped at 10 per dimension. | Field IDadGroups.expressiveness.bidFactors |
Ad Groups Expressiveness Dimensions Number of dimensions. | Field IDadGroups.expressiveness.dimensions |
Ad Groups Expressiveness Score Expressiveness score. | Field IDadGroups.expressiveness.score |
Ad Groups Funnel Location The funnel location of the ad group. | Field IDadGroups.funnelLocation |
Ad Groups Goal Average Value The average Goal value. | Field IDadGroups.goal.averageValue |
Ad Groups Goal Is Custom Whether the goal is custom or not. | Field IDadGroups.goal.isCustom |
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 |
Ad Groups Goal Short Name The short version of goal type's name. | Field IDadGroups.goal.shortName |
Ad Groups Goal Target The target Goal value. | Field IDadGroups.goal.target |
Ad Groups Goal Type The type of Goal. | Field IDadGroups.goal.type |
Ad Groups Goal Unit The unit of measurement for the Goal data. | Field IDadGroups.goal.unit |
Ad Groups Id The ID of the ad group. | Field IDadGroups.id |
Ad Groups Industry Category Id The category's ID. | Field IDadGroups.industryCategory.id |
Ad Groups Industry Category Is Default Is this category the default, inherited from the Advertiser. | Field IDadGroups.industryCategory.isDefault |
Ad Groups Industry Category Is Sensitive Is the category sensitive or not. | Field IDadGroups.industryCategory.isSensitive |
Ad Groups Industry Category Name The name of the category. | Field IDadGroups.industryCategory.name |
Ad Groups Industry Category Parent Category Id The ID of the category's parent (if present). | Field IDadGroups.industryCategory.parentCategoryId |
Ad Groups Industry Sub Category Id The category's ID. | Field IDadGroups.industrySubCategory.id |
Ad Groups Industry Sub Category Is Default Is this category the default, inherited from the Advertiser. | Field IDadGroups.industrySubCategory.isDefault |
Ad Groups Industry Sub Category Is Sensitive Is the category sensitive or not. | Field IDadGroups.industrySubCategory.isSensitive |
Ad Groups Industry Sub Category Name The name of the category. | Field IDadGroups.industrySubCategory.name |
Ad Groups Industry Sub Category Parent Category Id The ID of the category's parent (if present). | Field IDadGroups.industrySubCategory.parentCategoryId |
Ad Groups Is Archived | Field IDadGroups.isArchived |
Ad Groups Is Dimensional Bidding Mode | Field IDadGroups.isDimensionalBiddingMode |
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 |
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 |
Ad Groups Is News Navigator Enabled Prioritize reliable and objective news as scored by our News Rating Partners. | Field IDadGroups.isNewsNavigatorEnabled |
Ad Groups Is Non Decisioned Indicates whether the ad group is targeting commitment deals. | Field IDadGroups.isNonDecisioned |
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 |
Ad Groups Is Quality Alliance Suite Enabled Set to true to search for ad groups that have Quality Alliance targeting enabled. | Field IDadGroups.isQualityAllianceSuiteEnabled |
Ad Groups Is Targeting Default On Deals Indicates whether the ad group is targeting all default on deals. | Field IDadGroups.isTargetingDefaultOnDeals |
Ad Groups Is Targeting Default On Endeavors Indicates whether the ad group is targeting all default on deals. | Field IDadGroups.isTargetingDefaultOnEndeavors |
Ad Groups Is Targeting Deprecated Library Deals If set to true, indicates that the ad group is targeting deprecated library deals | Field IDadGroups.isTargetingDeprecatedLibraryDeals |
Ad Groups Is Template | Field IDadGroups.isTemplate |
Ad Groups Is Using Live Event Schedule Indicates if an ad group is pacing using a Live Event schedule. | Field IDadGroups.isUsingLiveEventSchedule |
Ad Groups Koa Settings Are Future Features Enabled Set to `true` to enable future Koa features for the AdGroup automatically. | Field IDadGroups.koaSettings.areFutureFeaturesEnabled |
Ad Groups Koa Settings Are Future Features Enabled For Partner Are future features enabled for the AdGroup's Partner automatically. | Field IDadGroups.koaSettings.areFutureFeaturesEnabledForPartner |
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 |
Ad Groups Koa Settings Minor Version The minor version of the KOA optimizations for this AdGroup. | Field IDadGroups.koaSettings.minorVersion |
Ad Groups Koa Settings Optimizations Version The version of the KOA optimizations for this AdGroup. | Field IDadGroups.koaSettings.optimizationsVersion |
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 |
Ad Groups Last Updated The time in UTC the adGroup was last updated. This field is read-only. | Field IDadGroups.lastUpdated |
Ad Groups Market Type Returns the market the AdGroup is currently targeting. | Field IDadGroups.marketType |
Ad Groups Marketplace Id Marketplace ID | Field IDadGroups.marketplace.id |
Ad Groups Marketplace Marketplace Status Status of the given marketplace. | Field IDadGroups.marketplace.marketplaceStatus |
Ad Groups Marketplace Name Marketplace name. | Field IDadGroups.marketplace.name |
Ad Groups Marketplace Owner Marketplace owner type. | Field IDadGroups.marketplace.owner |
Ad Groups Marketplace Short Name Marketplace short name. | Field IDadGroups.marketplace.shortName |
Ad Groups Max Bid CPM In Advertiser Currency | Field IDadGroups.maxBidCPMInAdvertiserCurrency |
Ad Groups Name The name of the ad group. | Field IDadGroups.name |
Ad Groups Next Flight Ad Group Id | Field IDadGroups.nextFlight.adGroupId |
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 |
Ad Groups Next Flight Allocation Type How the ad group allocation is treated. See `AdGroupBudgetAllocationType` for the different types. | Field IDadGroups.nextFlight.allocationType |
Ad Groups Next Flight Budget In Advertiser Currency | Field IDadGroups.nextFlight.budgetInAdvertiserCurrency |
Ad Groups Next Flight Budget In Impressions | Field IDadGroups.nextFlight.budgetInImpressions |
Ad Groups Next Flight Campaign Flight Id | Field IDadGroups.nextFlight.campaignFlightId |
Ad Groups Next Flight Daily Target In Advertiser Currency | Field IDadGroups.nextFlight.dailyTargetInAdvertiserCurrency |
Ad Groups Next Flight Daily Target In Impressions | Field IDadGroups.nextFlight.dailyTargetInImpressions |
Ad Groups Next Flight Minimum Spend In Advertiser Currency | Field IDadGroups.nextFlight.minimumSpendInAdvertiserCurrency |
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 |
Ad Groups Nielsen Tracking Attributes End Age The end age being targeted for Nielsen analytics. | Field IDadGroups.nielsenTrackingAttributes.endAge |
Ad Groups Nielsen Tracking Attributes Enhanced Nielsen Reporting Options Enhanced Nielsen reporting option setting. | Field IDadGroups.nielsenTrackingAttributes.enhancedNielsenReportingOptions |
Ad Groups Nielsen Tracking Attributes Gender The gender being targeted for Nielsen analytics. | Field IDadGroups.nielsenTrackingAttributes.gender |
Ad Groups Nielsen Tracking Attributes Start Age The start age being targeted for Nielsen analytics. | Field IDadGroups.nielsenTrackingAttributes.startAge |
Ad Groups Pacing Grain Id | Field IDadGroups.pacingGrainId |
Ad Groups Partner China MSA Signed | Field IDadGroups.partner.chinaMSASigned |
Ad Groups Partner Credit Limit In USD Current credit limit assigned | Field IDadGroups.partner.creditLimitInUSD |
Ad Groups Partner Daily Spend Cap In USD Daily spend cap | Field IDadGroups.partner.dailySpendCapInUSD |
Ad Groups Partner Default Recency Bucket List Id | Field IDadGroups.partner.defaultRecencyBucketListId |
Ad Groups Partner Id The ID of the partner. | Field IDadGroups.partner.id |
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 |
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 |
Ad Groups Partner Is Spend Disabled Flag signifying whether the spend on this partner is disabled | Field IDadGroups.partner.isSpendDisabled |
Ad Groups Partner Must Vet Advertisers | Field IDadGroups.partner.mustVetAdvertisers |
Ad Groups Partner Name The name of the partner. | Field IDadGroups.partner.name |
Ad Groups Private Contract Default Adjustment | Field IDadGroups.privateContractDefaultAdjustment |
Ad Groups Quality Alliance Viewability Profile Viewability profile used for Quality Alliance viewability targeting. | Field IDadGroups.qualityAllianceViewabilityProfile |
Ad Groups Roi Goal Average Value The average Goal value. | Field IDadGroups.roiGoal.averageValue |
Ad Groups Roi Goal Is Custom Whether the goal is custom or not. | Field IDadGroups.roiGoal.isCustom |
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 |
Ad Groups Roi Goal Short Name The short version of goal type's name. | Field IDadGroups.roiGoal.shortName |
Ad Groups Roi Goal Target The target Goal value. | Field IDadGroups.roiGoal.target |
Ad Groups Roi Goal Type The type of Goal. | Field IDadGroups.roiGoal.type |
Ad Groups Roi Goal Unit The unit of measurement for the Goal data. | Field IDadGroups.roiGoal.unit |
Ad Groups Spend Risk Level The AdGroup's spend risk level. | Field IDadGroups.spend.riskLevel |
Ad Groups Spend Spend The AdGroup's current spend in Advertiser currency. | Field IDadGroups.spend.spend |
Ad Groups Status Ad group status. | Field IDadGroups.status |
Ad Groups Use Multiple Cross Device Vendors If set to true, indicates that multiple cross-device vendors are used. | Field IDadGroups.useMultipleCrossDeviceVendors |
Ad Groups Video Viewability Standard Integral The display viewability standard of the ad group. | Field IDadGroups.videoViewabilityStandardIntegral |
Ad Groups Viewability Profile Coalesces the viewability profile from Campaign, Advertiser, or Partner, in that order of precedence. | Field IDadGroups.viewabilityProfile |
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 |
Ad Server Creative Placement ID | Field IDadServerCreativePlacementID |
Ad Server Name | Field IDadServerName |
Advertiser Attribution Click Interval The unit of time to apply to click interval attributions. | Field IDadvertiser.attribution.clickInterval |
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 |
Advertiser Attribution Impression Interval The unit of time to apply to impression interval attributions. | Field IDadvertiser.attribution.impressionInterval |
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 |
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 |
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 |
Advertiser Brand Owner The owner of the brands assigned to the Advertiser. | Field IDadvertiser.brandOwner |
Advertiser Channel Count The number of unique primary channels belonging to live Campaigns under the Advertiser. | Field IDadvertiser.channelCount |
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 |
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 |
Advertiser Cost (Adv Currency) | Field IDadvertiserCostAdvCurrency |
Advertiser Cost (Partner Currency) | Field IDadvertiserCostPartnerCurrency |
Advertiser Cost (USD) | Field IDadvertiserCostUSD |
Advertiser Country Id | Field IDadvertiser.country.id |
Advertiser Country Long Name | Field IDadvertiser.country.longName |
Advertiser Country Short Name | Field IDadvertiser.country.shortName |
Advertiser Currency Decimal Places | Field IDadvertiser.currency.decimalPlaces |
Advertiser Currency Id | Field IDadvertiser.currency.id |
Advertiser Currency Is Visible | Field IDadvertiser.currency.isVisible |
Advertiser Currency Name | Field IDadvertiser.currency.name |
Advertiser Currency Name Plural | Field IDadvertiser.currency.namePlural |
Advertiser Currency Should Prefix Currency Symbol | Field IDadvertiser.currency.shouldPrefixCurrencySymbol |
Advertiser Currency Symbol | Field IDadvertiser.currency.symbol |
Advertiser Default Partner Viewability Settings Display Sampling Rate The display sampling rate of the provider. | Field IDadvertiser.defaultPartnerViewabilitySettings.displaySamplingRate |
Advertiser Default Partner Viewability Settings Profile Display Name The display name of the provider. | Field IDadvertiser.defaultPartnerViewabilitySettings.profileDisplayName |
Advertiser Default Partner Viewability Settings Provider Id The provider ID. | Field IDadvertiser.defaultPartnerViewabilitySettings.providerId |
Advertiser Default Partner Viewability Settings Video Sampling Rate The video sampling rate of the provider. | Field IDadvertiser.defaultPartnerViewabilitySettings.videoSamplingRate |
Advertiser Default Right Media Offer Id The offer type's ID. | Field IDadvertiser.defaultRightMediaOffer.id |
Advertiser Default Right Media Offer Name The name of the offer type. | Field IDadvertiser.defaultRightMediaOffer.name |
Advertiser Default Seed Active Ids Active id count in the seed. | Field IDadvertiser.defaultSeed.activeIds |
Advertiser Default Seed Created At Date and time of the seed creation. | Field IDadvertiser.defaultSeed.createdAt |
Advertiser Default Seed Id ID of the seed. | Field IDadvertiser.defaultSeed.id |
Advertiser Default Seed Is Default Indicates whether the seed is set as the default for the advertiser. | Field IDadvertiser.defaultSeed.isDefault |
Advertiser Default Seed Last Updated At Date and time of last seed update. | Field IDadvertiser.defaultSeed.lastUpdatedAt |
Advertiser Default Seed Name Name of the seed | Field IDadvertiser.defaultSeed.name |
Advertiser Default Seed Quality Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`. | Field IDadvertiser.defaultSeed.quality |
Advertiser Default Seed Quality Reason Represents the reason for seed definition quality. | Field IDadvertiser.defaultSeed.qualityReason |
Advertiser Default Seed Status Seed materialization status. | Field IDadvertiser.defaultSeed.status |
Advertiser Default Seed Unique Households Unique house hold ids associated with the seed. | Field IDadvertiser.defaultSeed.uniqueHouseholds |
Advertiser Description An optional description of the advertiser. | Field IDadvertiser.description |
Advertiser Domain Address The primary domain of the advertiser. | Field IDadvertiser.domainAddress |
Advertiser Funnel Location Count The number of unique Funnel Locations belonging to visible AdGroups for live Campaigns under the Advertiser. | Field IDadvertiser.funnelLocationCount |
Advertiser Has Available Seed Pixels Whether or not there any Seed Pixels available to the Advertiser. | Field IDadvertiser.hasAvailableSeedPixels |
Advertiser Id The ID of the advertiser. | Field IDadvertiser.id |
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 |
Advertiser Industry Category Id The category's ID. | Field IDadvertiser.industryCategory.id |
Advertiser Industry Category Is Default Is this category the default, inherited from the Advertiser. | Field IDadvertiser.industryCategory.isDefault |
Advertiser Industry Category Is Sensitive Is the category sensitive or not. | Field IDadvertiser.industryCategory.isSensitive |
Advertiser Industry Category Name The name of the category. | Field IDadvertiser.industryCategory.name |
Advertiser Industry Category Parent Category Id The ID of the category's parent (if present). | Field IDadvertiser.industryCategory.parentCategoryId |
Advertiser Industry Sub Category Id The category's ID. | Field IDadvertiser.industrySubCategory.id |
Advertiser Industry Sub Category Is Default Is this category the default, inherited from the Advertiser. | Field IDadvertiser.industrySubCategory.isDefault |
Advertiser Industry Sub Category Is Sensitive Is the category sensitive or not. | Field IDadvertiser.industrySubCategory.isSensitive |
Advertiser Industry Sub Category Name The name of the category. | Field IDadvertiser.industrySubCategory.name |
Advertiser Industry Sub Category Parent Category Id The ID of the category's parent (if present). | Field IDadvertiser.industrySubCategory.parentCategoryId |
Advertiser Is Archived | Field IDadvertiser.isArchived |
Advertiser Is Blocked From Hh Solution Is the Advertiser blocked from HH Solution. | Field IDadvertiser.isBlockedFromHhSolution |
Advertiser Is Favorite For User Returns `true` if advertiser was marked as favorite by current user. | Field IDadvertiser.isFavoriteForUser |
Advertiser Is Hcp Eligible Indicates whether the advertiser is eligible for HCP advertising. | Field IDadvertiser.isHcpEligible |
Advertiser Is Hec Auto Exempt An HEC (Housing, Employment, Credit) exemption will exclude an HEC applicable advertiser from microtargeting restrictions. | Field IDadvertiser.isHecAutoExempt |
Advertiser Is Marketplace Enabled By Default Defines if marketplace will be preselected when creating a new adgroup in this advertiser | Field IDadvertiser.isMarketplaceEnabledByDefault |
Advertiser Is Restricted For Distributed Algos | Field IDadvertiser.isRestrictedForDistributedAlgos |
Advertiser Is With Campaigns At Risk Does the Advertiser have one or more Campaigns at risk, pacing behind. | Field IDadvertiser.isWithCampaignsAtRisk |
Advertiser Is With Live Campaigns Does this Advertiser have Campaigns that are active. | Field IDadvertiser.isWithLiveCampaigns |
Advertiser Logo The URL for the advertiser's logo or brand image. | Field IDadvertiser.logo |
Advertiser Marketplace Id Marketplace ID | Field IDadvertiser.marketplace.id |
Advertiser Marketplace Marketplace Status Status of the given marketplace. | Field IDadvertiser.marketplace.marketplaceStatus |
Advertiser Marketplace Name Marketplace name. | Field IDadvertiser.marketplace.name |
Advertiser Marketplace Owner Marketplace owner type. | Field IDadvertiser.marketplace.owner |
Advertiser Marketplace Short Name Marketplace short name. | Field IDadvertiser.marketplace.shortName |
Advertiser Most Used Seed Active Ids Active id count in the seed. | Field IDadvertiser.mostUsedSeed.activeIds |
Advertiser Most Used Seed Created At Date and time of the seed creation. | Field IDadvertiser.mostUsedSeed.createdAt |
Advertiser Most Used Seed Id ID of the seed. | Field IDadvertiser.mostUsedSeed.id |
Advertiser Most Used Seed Is Default Indicates whether the seed is set as the default for the advertiser. | Field IDadvertiser.mostUsedSeed.isDefault |
Advertiser Most Used Seed Last Updated At Date and time of last seed update. | Field IDadvertiser.mostUsedSeed.lastUpdatedAt |
Advertiser Most Used Seed Name Name of the seed | Field IDadvertiser.mostUsedSeed.name |
Advertiser Most Used Seed Quality Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`. | Field IDadvertiser.mostUsedSeed.quality |
Advertiser Most Used Seed Quality Reason Represents the reason for seed definition quality. | Field IDadvertiser.mostUsedSeed.qualityReason |
Advertiser Most Used Seed Status Seed materialization status. | Field IDadvertiser.mostUsedSeed.status |
Advertiser Most Used Seed Unique Households Unique house hold ids associated with the seed. | Field IDadvertiser.mostUsedSeed.uniqueHouseholds |
Advertiser Name The name of the advertiser. | Field IDadvertiser.name |
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 |
Advertiser Onboarding Data Advertiser Id | Field IDadvertiser.onboardingData.advertiserId |
Advertiser Onboarding Data Created At | Field IDadvertiser.onboardingData.createdAt |
Advertiser Onboarding Data Created By User Id | Field IDadvertiser.onboardingData.createdByUserId |
Advertiser Onboarding Data Id | Field IDadvertiser.onboardingData.id |
Advertiser Onboarding Data Last Updated At | Field IDadvertiser.onboardingData.lastUpdatedAt |
Advertiser Onboarding Data Last Updated By User Id | Field IDadvertiser.onboardingData.lastUpdatedByUserId |
Advertiser Partner Basic Info Id The ID of the partner. | Field IDadvertiser.partnerBasicInfo.id |
Advertiser Partner Basic Info Name The name of the partner. | Field IDadvertiser.partnerBasicInfo.name |
Advertiser Partner China MSA Signed | Field IDadvertiser.partner.chinaMSASigned |
Advertiser Partner Credit Limit In USD Current credit limit assigned | Field IDadvertiser.partner.creditLimitInUSD |
Advertiser Partner Daily Spend Cap In USD Daily spend cap | Field IDadvertiser.partner.dailySpendCapInUSD |
Advertiser Partner Default Recency Bucket List Id | Field IDadvertiser.partner.defaultRecencyBucketListId |
Advertiser Partner Id The ID of the partner. | Field IDadvertiser.partner.id |
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 |
Advertiser Partner Is Purchase Order Number Required Indicates if partner is billed by PO#, requiring campaigns to populate this field. | Field IDadvertiser.partner.isPurchaseOrderNumberRequired |
Advertiser Partner Is Spend Disabled Flag signifying whether the spend on this partner is disabled | Field IDadvertiser.partner.isSpendDisabled |
Advertiser Partner Must Vet Advertisers | Field IDadvertiser.partner.mustVetAdvertisers |
Advertiser Partner Name The name of the partner. | Field IDadvertiser.partner.name |
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 |
Advertiser Political Candidate Count The number of political candidates. | Field IDadvertiser.political.candidateCount |
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 |
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 |
Advertiser Secret Key The Advertiser's secret key (inherited from Partner). | Field IDadvertiser.secretKey |
Advertiser Seed Permission Can Have Seed Indicates whether the advertiser is permitted to have seed. | Field IDadvertiser.seedPermission.canHaveSeed |
Advertiser Special Platform Features Campaign Flight Custom Labels In Ui Indicates whether campaign flight custom label is available in UI. | Field IDadvertiser.specialPlatformFeatures.campaignFlightCustomLabelsInUi |
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 |
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 |
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 |
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 |
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 |
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 |
Advertiser Total Campaign Channel Count The total number of possible Campaign Channels. | Field IDadvertiser.totalCampaignChannelCount |
Advertiser Total Funnel Location Count The total number of possible Funnel Locations. | Field IDadvertiser.totalFunnelLocationCount |
Advertiser Use Impressions Only Budgeting | Field IDadvertiser.useImpressionsOnlyBudgeting |
Advertiser Use Media Cost Basis For Campaign Fees | Field IDadvertiser.useMediaCostBasisForCampaignFees |
Advertiser Vetting Status Vetting status of the advertiser. This field is read-only. | Field IDadvertiser.vettingStatus |
Advertiser Viewability Selected Provider Id | Field IDadvertiser.viewability.selectedProviderId |
Base Bid Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDbaseBid.advertiserCurrency |
Base Bid Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDbaseBid.partnerCurrency |
Base Bid Usd The amount specified in US dollars. | Field IDbaseBid.usd |
Bid Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDbidCpm.advertiserCurrency |
Bid Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDbidCpm.partnerCurrency |
Bid Cpm Usd The amount specified in US dollars. | Field IDbidCpm.usd |
Bids The total number of times an offer was made in an auction for an impression. | Field IDbids |
Browser | Field IDbrowser |
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 |
Campaigns Active Ad Group Count The total number of AdGroups owned by the Campaign that are both visible and enabled. | Field IDcampaigns.activeAdGroupCount |
Campaigns Audience Created At The date and time in UTC the audience was created. | Field IDcampaigns.audience.createdAt |
Campaigns Audience Id | Field IDcampaigns.audience.id |
Campaigns Audience Is Auto Generated Indicates if this audience was automatically generated by The Trade Desk platform. | Field IDcampaigns.audience.isAutoGenerated |
Campaigns Audience Last Updated At Indicates the time when this audience was last updated (UTC). | Field IDcampaigns.audience.lastUpdatedAt |
Campaigns Audience Name The name of the audience. | Field IDcampaigns.audience.name |
Campaigns Audience Target Everyone If set to true, indicates that it is a TargetEveryone audience. | Field IDcampaigns.audience.targetEveryone |
Campaigns Auto Allocator Enabled | Field IDcampaigns.autoAllocatorEnabled |
Campaigns Auto Campaign Cap Enabled | Field IDcampaigns.autoCampaignCapEnabled |
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 |
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 |
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 |
Campaigns Budget Current Or Up Coming The budget of the campaign's current or next upcoming flight. | Field IDcampaigns.budget.currentOrUpComing |
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 |
Campaigns Budget Migration Reports Allocation Mode | Field IDcampaigns.budgetMigrationReports.allocationMode |
Campaigns Budget Migration Reports Budgeting Version | Field IDcampaigns.budgetMigrationReports.budgetingVersion |
Campaigns Budget Migration Reports Has Impressions Indicates whether the campaign and any of its adGroups have impression budgets. | Field IDcampaigns.budgetMigrationReports.hasImpressions |
Campaigns Budget Migration Reports Has Live Events Whether this campaign has unarchived live event ad groups. | Field IDcampaigns.budgetMigrationReports.hasLiveEvents |
Campaigns Budget Migration Reports Is Mixed Pacing Whether the ad groups of this campaign have different pacing modes. | Field IDcampaigns.budgetMigrationReports.isMixedPacing |
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 |
Campaigns Budget Migration Reports Unified Pacing Mode The pacing mode in Kokai that unifies campaign and its adGroups' pacing mode. | Field IDcampaigns.budgetMigrationReports.unifiedPacingMode |
Campaigns Budget Migration Status Current Budgeting Version The current budgeting version. | Field IDcampaigns.budgetMigrationStatus.currentBudgetingVersion |
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 |
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 |
Campaigns Budget Spend Mode The spend mode that determines how the system allocates the campaign budget to its ad groups. | Field IDcampaigns.budget.spendMode |
Campaigns Budget Total The total budget of the campaign, in the advertiser's currency. | Field IDcampaigns.budget.total |
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 |
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 |
Campaigns Budget Version The version of the budgeting experience for the campaign. | Field IDcampaigns.budget.version |
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 |
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 |
Campaigns Campaign Group Flight Budget Total budget across all current flights in the non-archived campaigns in the group. | Field IDcampaigns.campaignGroup.flightBudget |
Campaigns Campaign Group Id The ID of the campaign group. | Field IDcampaigns.campaignGroup.id |
Campaigns Campaign Group Is Archived `true` if the campaign group is archived, `false` otherwise. | Field IDcampaigns.campaignGroup.isArchived |
Campaigns Campaign Group Last Updated The time in UTC the campaign campaign was last updated. | Field IDcampaigns.campaignGroup.lastUpdated |
Campaigns Campaign Group Name Name of the campaign group. | Field IDcampaigns.campaignGroup.name |
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 |
Campaigns Campaign Group Total Budget Total budget across all campaigns in the non-archived campaigns in the group. | Field IDcampaigns.campaignGroup.totalBudget |
Campaigns Campaign Pacing Settings Is Value Pacing | Field IDcampaigns.campaignPacingSettings.isValuePacing |
Campaigns Channel Type | Field IDcampaigns.channelType |
Campaigns Created At The time in UTC the campaign was created. This field is read-only. | Field IDcampaigns.createdAt |
Campaigns Created At Utc The time in UTC the campaign was created. This field is read-only. | Field IDcampaigns.createdAtUtc |
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 |
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 |
Campaigns Current Flight Budget In Impressions The maximum amount of impressions the campaign flight should buy. | Field IDcampaigns.currentFlight.budgetInImpressions |
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 |
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 |
Campaigns Current Flight Days Remaining | Field IDcampaigns.currentFlight.daysRemaining |
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 |
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 |
Campaigns Current Flight Id | Field IDcampaigns.currentFlight.id |
Campaigns Current Flight Is Active For At Least A Day | Field IDcampaigns.currentFlight.isActiveForAtLeastADay |
Campaigns Current Flight Is Current | Field IDcampaigns.currentFlight.isCurrent |
Campaigns Current Flight Is Deleted | Field IDcampaigns.currentFlight.isDeleted |
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 |
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 |
Campaigns Current Flight Uses Impression Budgets Whether the campaign flight has impression budgets manually set. | Field IDcampaigns.currentFlight.usesImpressionBudgets |
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 |
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 |
Campaigns Current Or Next Flight Budget In Impressions The maximum amount of impressions the campaign flight should buy. | Field IDcampaigns.currentOrNextFlight.budgetInImpressions |
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 |
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 |
Campaigns Current Or Next Flight Days Remaining | Field IDcampaigns.currentOrNextFlight.daysRemaining |
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 |
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 |
Campaigns Current Or Next Flight Id | Field IDcampaigns.currentOrNextFlight.id |
Campaigns Current Or Next Flight Is Active For At Least A Day | Field IDcampaigns.currentOrNextFlight.isActiveForAtLeastADay |
Campaigns Current Or Next Flight Is Current | Field IDcampaigns.currentOrNextFlight.isCurrent |
Campaigns Current Or Next Flight Is Deleted | Field IDcampaigns.currentOrNextFlight.isDeleted |
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 |
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 |
Campaigns Current Or Next Flight Uses Impression Budgets Whether the campaign flight has impression budgets manually set. | Field IDcampaigns.currentOrNextFlight.usesImpressionBudgets |
Campaigns Custom CPA Click Weight Weight to assign to click-through pixels when calculating custom CPA. | Field IDcampaigns.customCPAClickWeight |
Campaigns Custom CPA Type The custom CPA to use to use for the CPA calculation for the campaign. | Field IDcampaigns.customCPAType |
Campaigns Custom CPA Viewthrough Weight Weight to assign to view pixels when calculating custom CPA. | Field IDcampaigns.customCPAViewthroughWeight |
Campaigns Custom ROAS Type The custom ROAS calculation for the campaign's Return on Advertiser Spend value. | Field IDcampaigns.customROASType |
Campaigns Description An optional description of the campaign. | Field IDcampaigns.description |
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 |
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 |
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 |
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 |
Campaigns Funnel Location Count The number of distinct Funnel Locations for all visible AdGroups owned by the Campaign. | Field IDcampaigns.funnelLocationCount |
Campaigns Goal Average Value The average Goal value. | Field IDcampaigns.goal.averageValue |
Campaigns Goal Is Custom Whether the goal is custom or not. | Field IDcampaigns.goal.isCustom |
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 |
Campaigns Goal Short Name The short version of goal type's name. | Field IDcampaigns.goal.shortName |
Campaigns Goal Target The target Goal value. | Field IDcampaigns.goal.target |
Campaigns Goal Type The type of Goal. | Field IDcampaigns.goal.type |
Campaigns Goal Unit The unit of measurement for the Goal data. | Field IDcampaigns.goal.unit |
Campaigns Id The ID of the campaign. | Field IDcampaigns.id |
Campaigns Impressions Only Budgeting CPM | Field IDcampaigns.impressionsOnlyBudgetingCPM |
Campaigns Io Contract Id IO assigned to each campaign for IO clients to manage its spend. | Field IDcampaigns.ioContractId |
Campaigns Is Archived | Field IDcampaigns.isArchived |
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 |
Campaigns Is Managed By TTD A property to indicate this campaign is managed by The Trade Desk. | Field IDcampaigns.isManagedByTTD |
Campaigns Is Migrated To Kokai The campaign has been migrated from a previous version to Kokai. | Field IDcampaigns.isMigratedToKokai |
Campaigns Is Programmatic Guaranteed | Field IDcampaigns.isProgrammaticGuaranteed |
Campaigns Is Template | Field IDcampaigns.isTemplate |
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 |
Campaigns Last Touch Attribution Measured By The Trade Desk The Trade Desk measure last-touch attribution (recommended for troubleshooting purposes). | Field IDcampaigns.lastTouchAttributionMeasuredByTheTradeDesk |
Campaigns Last Updated The time in UTC the campaign was last updated. This field is read-only. | Field IDcampaigns.lastUpdated |
Campaigns Last Updated At Utc The time in UTC the campaign was last updated. This field is read-only. | Field IDcampaigns.lastUpdatedAtUtc |
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 |
Campaigns Name The name of the campaign. | Field IDcampaigns.name |
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 |
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 |
Campaigns Next Flight Budget In Impressions The maximum amount of impressions the campaign flight should buy. | Field IDcampaigns.nextFlight.budgetInImpressions |
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 |
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 |
Campaigns Next Flight Days Remaining | Field IDcampaigns.nextFlight.daysRemaining |
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 |
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 |
Campaigns Next Flight Id | Field IDcampaigns.nextFlight.id |
Campaigns Next Flight Is Active For At Least A Day | Field IDcampaigns.nextFlight.isActiveForAtLeastADay |
Campaigns Next Flight Is Current | Field IDcampaigns.nextFlight.isCurrent |
Campaigns Next Flight Is Deleted | Field IDcampaigns.nextFlight.isDeleted |
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 |
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 |
Campaigns Next Flight Uses Impression Budgets Whether the campaign flight has impression budgets manually set. | Field IDcampaigns.nextFlight.usesImpressionBudgets |
Campaigns Objective The campaign objective. | Field IDcampaigns.objective |
Campaigns Pacing Mode The pacing mode for the Campaign. | Field IDcampaigns.pacingMode |
Campaigns Pacing To End Of Flight Daily Rate | Field IDcampaigns.pacingToEndOfFlightDailyRate |
Campaigns Partner China MSA Signed | Field IDcampaigns.partner.chinaMSASigned |
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 |
Campaigns Partner Credit Limit In USD Current credit limit assigned | Field IDcampaigns.partner.creditLimitInUSD |
Campaigns Partner Daily Spend Cap In USD Daily spend cap | Field IDcampaigns.partner.dailySpendCapInUSD |
Campaigns Partner Default Recency Bucket List Id | Field IDcampaigns.partner.defaultRecencyBucketListId |
Campaigns Partner Id The ID of the partner. | Field IDcampaigns.partner.id |
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 |
Campaigns Partner Is Purchase Order Number Required Indicates if partner is billed by PO#, requiring campaigns to populate this field. | Field IDcampaigns.partner.isPurchaseOrderNumberRequired |
Campaigns Partner Is Spend Disabled Flag signifying whether the spend on this partner is disabled | Field IDcampaigns.partner.isSpendDisabled |
Campaigns Partner Must Vet Advertisers | Field IDcampaigns.partner.mustVetAdvertisers |
Campaigns Partner Name The name of the partner. | Field IDcampaigns.partner.name |
Campaigns Primary Goal Average Value The average Goal value. | Field IDcampaigns.primaryGoal.averageValue |
Campaigns Primary Goal Is Custom Whether the goal is custom or not. | Field IDcampaigns.primaryGoal.isCustom |
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 |
Campaigns Primary Goal Short Name The short version of goal type's name. | Field IDcampaigns.primaryGoal.shortName |
Campaigns Primary Goal Target The target Goal value. | Field IDcampaigns.primaryGoal.target |
Campaigns Primary Goal Type The type of Goal. | Field IDcampaigns.primaryGoal.type |
Campaigns Primary Goal Unit The unit of measurement for the Goal data. | Field IDcampaigns.primaryGoal.unit |
Campaigns Purchase Order Number A property that you can use for internal reference. For example, a purchase order number. | Field IDcampaigns.purchaseOrderNumber |
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 |
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 |
Campaigns Secondary Goal Average Value The average Goal value. | Field IDcampaigns.secondaryGoal.averageValue |
Campaigns Secondary Goal Is Custom Whether the goal is custom or not. | Field IDcampaigns.secondaryGoal.isCustom |
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 |
Campaigns Secondary Goal Short Name The short version of goal type's name. | Field IDcampaigns.secondaryGoal.shortName |
Campaigns Secondary Goal Target The target Goal value. | Field IDcampaigns.secondaryGoal.target |
Campaigns Secondary Goal Type The type of Goal. | Field IDcampaigns.secondaryGoal.type |
Campaigns Secondary Goal Unit The unit of measurement for the Goal data. | Field IDcampaigns.secondaryGoal.unit |
Campaigns Seed Active Ids Active id count in the seed. | Field IDcampaigns.seed.activeIds |
Campaigns Seed Created At Date and time of the seed creation. | Field IDcampaigns.seed.createdAt |
Campaigns Seed Id ID of the seed. | Field IDcampaigns.seed.id |
Campaigns Seed Is Default Indicates whether the seed is set as the default for the advertiser. | Field IDcampaigns.seed.isDefault |
Campaigns Seed Last Updated At Date and time of last seed update. | Field IDcampaigns.seed.lastUpdatedAt |
Campaigns Seed Name Name of the seed | Field IDcampaigns.seed.name |
Campaigns Seed Quality Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`. | Field IDcampaigns.seed.quality |
Campaigns Seed Quality Reason Represents the reason for seed definition quality. | Field IDcampaigns.seed.qualityReason |
Campaigns Seed Status Seed materialization status. | Field IDcampaigns.seed.status |
Campaigns Seed Unique Households Unique house hold ids associated with the seed. | Field IDcampaigns.seed.uniqueHouseholds |
Campaigns Share Type A property to indicate what level of access this campaign has. | Field IDcampaigns.shareType |
Campaigns Site Url | Field IDcampaigns.siteUrl |
Campaigns Spend Current | Field IDcampaigns.spend.current |
Campaigns Spend Risk Level | Field IDcampaigns.spend.riskLevel |
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 |
Campaigns Status Campaign status. | Field IDcampaigns.status |
Campaigns Tertiary Goal Average Value The average Goal value. | Field IDcampaigns.tertiaryGoal.averageValue |
Campaigns Tertiary Goal Is Custom Whether the goal is custom or not. | Field IDcampaigns.tertiaryGoal.isCustom |
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 |
Campaigns Tertiary Goal Short Name The short version of goal type's name. | Field IDcampaigns.tertiaryGoal.shortName |
Campaigns Tertiary Goal Target The target Goal value. | Field IDcampaigns.tertiaryGoal.target |
Campaigns Tertiary Goal Type The type of Goal. | Field IDcampaigns.tertiaryGoal.type |
Campaigns Tertiary Goal Unit The unit of measurement for the Goal data. | Field IDcampaigns.tertiaryGoal.unit |
Campaigns Time Zone The Windows time zone ID of the campaign. | Field IDcampaigns.timeZone |
Campaigns Time Zone IANA The IANA/Olson time zone ID of the campaign. | Field IDcampaigns.timeZoneIANA |
Campaigns Total Ad Group Count The total number of visible AdGroups owned by the Campaign. | Field IDcampaigns.totalAdGroupCount |
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 |
Campaigns Type | Field IDcampaigns.type |
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 |
Channel Overlap Rate Households Percentage of households reached on more than one channel. | Field IDchannelOverlapRateHouseholds |
Channel Overlap Rate Persons Percentage of people reached on more than one channel. | Field IDchannelOverlapRatePersons |
Clicks The number of times a user interacted with an ad by clicking it. | Field IDclicks |
Completion Rate The proportion of ads that are fully viewed, played, or heard out of the total number of ads served. | Field IDcompletionRate |
Conversions The number of times a user engaged with an ad and completed an action. | Field IDconversions |
Cpa Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDcpa.advertiserCurrency |
Cpa In Advertiser Currency Cost per acquisition (CPA) in advertiser currency. | Field IDcpaInAdvertiserCurrency |
Cpa Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDcpa.partnerCurrency |
Cpa Usd The amount specified in US dollars. | Field IDcpa.usd |
Cpc Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDcpc.advertiserCurrency |
Cpc Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDcpc.partnerCurrency |
Cpc Usd The amount specified in US dollars. | Field IDcpc.usd |
Cpcv Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDcpcv.advertiserCurrency |
Cpcv Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDcpcv.partnerCurrency |
Cpcv Usd The amount specified in US dollars. | Field IDcpcv.usd |
Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDcpm.advertiserCurrency |
Cpm In Advertiser Currency Cost per mille (CPM) in advertiser currency. | Field IDcpmInAdvertiserCurrency |
Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDcpm.partnerCurrency |
Cpm Usd The amount specified in US dollars. | Field IDcpm.usd |
Creative Ad Server Creative Id | Field IDcreatives.adServerCreativeId |
Creative Ad Server Name | Field IDcreatives.adServerName |
Creative Approved By | Field IDcreatives.approvedBy |
Creative Created At The UTC time when the creative was created. | Field IDcreatives.createdAt |
Creative Description An optional description of the creative. The maximum character length is 512. | Field IDcreatives.description |
Creative Flight End The flight end date and time for the creative. | Field IDcreatives.flightEnd |
Creative Flight End Date UTC | Field IDcreatives.flightEndDateUTC |
Creative Flight Start The flight start date and time for the creative. | Field IDcreatives.flightStart |
Creative Flight Start Date UTC | Field IDcreatives.flightStartDateUTC |
Creative Flight Time Zone Timezone for the creative flight dates. Defaults to "UTC" when not explicitly set. | Field IDcreatives.flightTimeZone |
Creative Flight Time Zone IANA The IANA/Olson time zone ID of the creative flight. The default value is "Etc/UTC". | Field IDcreatives.flightTimeZoneIANA |
Creative Id The unique identifier of the creative. | Field IDcreatives.id |
Creative Id Integer | Field IDcreatives.idInteger |
Creative Interstitial Support Id | Field IDcreatives.interstitialSupportId |
Creative Is Archived | Field IDcreatives.isArchived |
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 |
Creative Last Updated At The UTC time when the creative was last updated. | Field IDcreatives.lastUpdatedAt |
Creative Malware Scan Is Scan Pending Completion status of the malware scan. | Field IDcreatives.malwareScan.isScanPending |
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 |
Creative Political Ad Icon Candidate Name Political Candidate | Field IDcreatives.politicalAdIcon.candidateName |
Creative Political Ad Icon Id | Field IDcreatives.politicalAdIcon.id |
Creative Political Ad Icon Political Data Id | Field IDcreatives.politicalAdIcon.politicalDataId |
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 |
Creative Tag Type | Field IDcreatives.tagType |
Creative Tag Type Enum | Field IDcreatives.tagTypeEnum |
Creative Third Party Click Tracking Url | Field IDcreatives.thirdPartyClickTrackingUrl |
Creative Tmt Malware Scan Is Scan Pending Completion status of the malware scan. | Field IDcreatives.tmtMalwareScan.isScanPending |
Creative Type Enum matching the type of the creative. This value will allow for sorting and filtering. | Field IDcreatives.type |
Ctr Click-through rate (percentage of impressions that resulted in clicks). | Field IDctr |
Custom Cpa Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDcustomCpa.advertiserCurrency |
Custom Cpa Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDcustomCpa.partnerCurrency |
Custom Cpa Usd The amount specified in US dollars. | Field IDcustomCpa.usd |
Custom Roas Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDcustomRoas.advertiserCurrency |
Custom Roas Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDcustomRoas.partnerCurrency |
Custom Roas Usd The amount specified in US dollars. | Field IDcustomRoas.usd |
Date Year Month Day such as 20240401. | Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH_DAY |
Day of the week Day of the week | Field ID_NORMALIZED_DATE_FIELD_DAY_OF_WEEK |
Day of the year Day of the year | Field ID_NORMALIZED_DATE_FIELD_DAY |
Deal ID | Field IDdealID |
Device Type | Field IDdeviceType |
Hour of the day Hour of the day | Field ID_NORMALIZED_DATE_FIELD_HOUR |
Impressions The number of times an ad was served and had the potential to be viewed. | Field IDimpressions |
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 |
In View Rate The proportion of impressions where an ad was in view for a certain period of time. | Field IDinViewRate |
Matched Household Impressions Impressions which matched with a Household Id in Graph. | Field IDmatchedHouseholdImpressions |
Matched Person Impressions Impressions which matched with a Person Id in Graph. | Field IDmatchedPersonImpressions |
Media Cost Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDmediaCost.advertiserCurrency |
Media Cost Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDmediaCost.partnerCurrency |
Media Cost Usd The amount specified in US dollars. | Field IDmediaCost.usd |
Media Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDmediaCpm.advertiserCurrency |
Media Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDmediaCpm.partnerCurrency |
Media Cpm Usd The amount specified in US dollars. | Field IDmediaCpm.usd |
Month and day Month and day | Field ID_NORMALIZED_DATE_FIELD_MONTH_DAY |
Month of the year Month of the year | Field ID_NORMALIZED_DATE_FIELD_MONTH |
Nielsen Otp The Nielsen On-Target percentage. Currently not supported for campaign flights or ad group flights. | Field IDnielsenOtp |
Normalized Week of the year Week of the year | Field ID_NORMALIZED_DATE_FIELD_WEEK |
Operating System | Field IDoperatingSystem |
Operating System Family | Field IDoperatingSystemFamily |
Partner Cost (Adv Currency) | Field IDpartnerCostAdvCurrency |
Partner Cost (Partner Currency) | Field IDpartnerCostPartnerCurrency |
Partner Cost (USD) | Field IDpartnerCostUSD |
Player 25% Complete | Field IDplayer25Complete |
Player 50% Complete | Field IDplayer50Complete |
Player 75% Complete | Field IDplayer75Complete |
Player Close | Field IDplayerClose |
Player Collapse | Field IDplayerCollapse |
Player Completed Views | Field IDplayerCompletedViews |
Player Engaged Views | Field IDplayerEngagedViews |
Player Errors | Field IDplayerErrors |
Player Expansion | Field IDplayerExpansion |
Player Full Screen | Field IDplayerFullScreen |
Player Invitation Accept | Field IDplayerInvitationAccept |
Player Mute | Field IDplayerMute |
Player Pause | Field IDplayerPause |
Player Resume | Field IDplayerResume |
Player Rewind | Field IDplayerRewind |
Player Skip | Field IDplayerSkip |
Player Starts | Field IDplayerStarts |
Player Unmute | Field IDplayerUnmute |
Player Views | Field IDplayerViews |
Quarter of the year Quarter of the year | Field ID_NORMALIZED_DATE_FIELD_QUARTER |
Revenue Total revenue generated. | Field IDrevenue |
Roas Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDroas.advertiserCurrency |
Roas Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDroas.partnerCurrency |
Roas Usd The amount specified in US dollars. | Field IDroas.usd |
Sampled Tracked Impressions | Field IDsampledTrackedImpressions |
Sampled Viewed Impressions | Field IDsampledViewedImpressions |
Spend Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDspend.advertiserCurrency |
Spend In Advertiser Currency Spend in advertiser currency. | Field IDspendInAdvertiserCurrency |
Spend Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDspend.partnerCurrency |
Spend Usd The amount specified in US dollars. | Field IDspend.usd |
Total Bid Amount (Adv Currency) | Field IDtotalBidAmountAdvCurrency |
Total Bid Amount (Partner Currency) | Field IDtotalBidAmountPartnerCurrency |
Total Bid Amount (USD) | Field IDtotalBidAmountUSD |
TTD Cost (Adv Currency) | Field IDTTDcostAdvCurrency |
TTD Cost (Partner Currency) | Field IDTTDcostPartnerCurrency |
TTD Cost (USD) | Field IDTTDcostUSD |
Tv Quality Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDtvQualityCpm.advertiserCurrency |
Tv Quality Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDtvQualityCpm.partnerCurrency |
Tv Quality Cpm Usd The amount specified in US dollars. | Field IDtvQualityCpm.usd |
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 |
Unique Households Unique houseHold count. | Field IDuniqueHouseholds |
Unique Persons Unique person count. | Field IDuniquePersons |
V Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. | Field IDvCpm.advertiserCurrency |
V Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. | Field IDvCpm.partnerCurrency |
V Cpm Usd The amount specified in US dollars. | Field IDvCpm.usd |
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 |
Viewability The percentage of ads that were viewable. | Field IDviewability |
Week of the year Week of the year | Field IDweek |
Week of the year (start Sunday) Week of the year | Field ID_NORMALIZED_DATE_FIELD_WEEK_START_SUNDAY |
Win Rate The percentage of auctions that were won. | Field IDwinRate |
Year Year such as 2017. | Field ID_NORMALIZED_DATE_FIELD_YEAR |
Year month Year and month. | Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH |
Year month day hour Year, month, day, and hour. | Field ID_NORMALIZED_DATE_FIELD_YEAR_MONTH_DAY_HOUR |
Year Quarter Year and quarter. | Field ID_NORMALIZED_DATE_FIELD_YEAR_QUARTER |
Year week Year and week. | Field ID_NORMALIZED_DATE_FIELD_YEAR_WEEK |
Try another search or reset your filters.