Introduction
Datasources and destinations
- Find all the data sources available at www.catchr.io/connectors
- Find all the destinations available at www.catchr.io/destinations
01 - Click Conversion |
| ||||||
01 - Click Conversion Currency |
| ||||||
01 - Click Conversion Revenue |
| ||||||
01 - Conversion Touch |
| ||||||
01 - Conversion Touch Revenue |
| ||||||
01 - Time Weighted Decay Conversion |
| ||||||
01 - Time Weighted Decay Conversion Revenue |
| ||||||
01 - View Through Conversion |
| ||||||
01 - View Through Conversion Currency |
| ||||||
01 - View Through Conversion Revenue |
| ||||||
02 - Click Conversion |
| ||||||
02 - Click Conversion Currency |
| ||||||
02 - Click Conversion Revenue |
| ||||||
02 - Conversion Touch |
| ||||||
02 - Conversion Touch Revenue |
| ||||||
02 - Time Weighted Decay Conversion |
| ||||||
02 - Time Weighted Decay Conversion Revenue |
| ||||||
02 - View Through Conversion |
| ||||||
02 - View Through Conversion Currency |
| ||||||
02 - View Through Conversion Revenue |
| ||||||
03 - Click Conversion |
| ||||||
03 - Click Conversion Currency |
| ||||||
03 - Click Conversion Revenue |
| ||||||
03 - Conversion Touch |
| ||||||
03 - Conversion Touch Revenue |
| ||||||
03 - Time Weighted Decay Conversion |
| ||||||
03 - Time Weighted Decay Conversion Revenue |
| ||||||
03 - View Through Conversion |
| ||||||
03 - View Through Conversion Currency |
| ||||||
03 - View Through Conversion Revenue |
| ||||||
04 - Click Conversion |
| ||||||
04 - Click Conversion Currency |
| ||||||
04 - Click Conversion Revenue |
| ||||||
04 - Conversion Touch |
| ||||||
04 - Conversion Touch Revenue |
| ||||||
04 - Time Weighted Decay Conversion |
| ||||||
04 - Time Weighted Decay Conversion Revenue |
| ||||||
04 - View Through Conversion |
| ||||||
04 - View Through Conversion Currency |
| ||||||
04 - View Through Conversion Revenue |
| ||||||
05 - Click Conversion |
| ||||||
05 - Click Conversion Currency |
| ||||||
05 - Click Conversion Revenue |
| ||||||
05 - Conversion Touch |
| ||||||
05 - Conversion Touch Revenue |
| ||||||
05 - Time Weighted Decay Conversion |
| ||||||
05 - Time Weighted Decay Conversion Revenue |
| ||||||
05 - View Through Conversion |
| ||||||
05 - View Through Conversion Currency |
| ||||||
05 - View Through Conversion Revenue |
| ||||||
06 - Click Conversion |
| ||||||
06 - Click Conversion Currency |
| ||||||
06 - Click Conversion Revenue |
| ||||||
06 - Conversion Touch |
| ||||||
06 - Conversion Touch Revenue |
| ||||||
06 - Time Weighted Decay Conversion |
| ||||||
06 - Time Weighted Decay Conversion Revenue |
| ||||||
06 - View Through Conversion |
| ||||||
06 - View Through Conversion Currency |
| ||||||
06 - View Through Conversion Revenue |
| ||||||
TTD Cost (Adv Currency) |
| ||||||
TTD Cost (Partner Currency) |
| ||||||
TTD Cost (USD) |
| ||||||
Day of the year Day of the year |
| ||||||
Day of the week Day of the week |
| ||||||
Hour of the day Hour of the day |
| ||||||
Month of the year Month of the year |
| ||||||
Month and day Month and day |
| ||||||
Quarter of the year Quarter of the year |
| ||||||
Normalized Week of the year Week of the year |
| ||||||
Week of the year (start Sunday) Week of the year |
| ||||||
Year Year such as 2017. |
| ||||||
Year month Year and month. |
| ||||||
Date Year Month Day such as 20240401. |
| ||||||
Year month day hour Year, month, day, and hour. |
| ||||||
Year Quarter Year and quarter. |
| ||||||
Year week Year and week. |
| ||||||
Ad Groups Audience Created At The date and time in UTC the audience was created. |
| ||||||
Ad Groups Audience Id |
| ||||||
Ad Groups Audience Is Auto Generated Indicates if this audience was automatically generated by The Trade Desk platform. |
| ||||||
Ad Groups Audience Last Updated At Indicates the time when this audience was last updated (UTC). |
| ||||||
Ad Groups Audience Name The name of the audience. |
| ||||||
Ad Groups Audience Target Everyone If set to true, indicates that it is a TargetEveryone audience. |
| ||||||
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. |
| ||||||
Ad Groups Audience Settings Strategy Get the Audience Strategy configured for the ad group. |
| ||||||
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. |
| ||||||
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. |
| ||||||
Ad Groups Base Bid CPM In Advertiser Currency |
| ||||||
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. |
| ||||||
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 |
| ||||||
Ad Groups Budget Current Flight Budget The budget of the AdGroup's current or next upcoming flight. |
| ||||||
Ad Groups Budget Is Fluid Indicates the ad group's spend in the current flight is fully system optimized, without any manual intervention. |
| ||||||
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. |
| ||||||
Ad Groups Budget Total The Ad group's total budget in Advertiser currency. |
| ||||||
Ad Groups Budget Version The version of the budgeting experience for the campaign of the ad group. |
| ||||||
Ad Groups Budget In Advertiser Currency |
| ||||||
Ad Groups Budget In Impressions The maximum amount of impressions the adGroup should buy. |
| ||||||
Ad Groups Campaign Active Ad Group Count The total number of AdGroups owned by the Campaign that are both visible and enabled. |
| ||||||
Ad Groups Campaign Auto Allocator Enabled |
| ||||||
Ad Groups Campaign Auto Campaign Cap Enabled |
| ||||||
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. |
| ||||||
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. |
| ||||||
Ad Groups Campaign Channel Type |
| ||||||
Ad Groups Campaign Created At The time in UTC the campaign was created. This field is read-only. |
| ||||||
Ad Groups Campaign Created At Utc The time in UTC the campaign was created. This field is read-only. |
| ||||||
Ad Groups Campaign Custom CPA Click Weight Weight to assign to click-through pixels when calculating custom CPA. |
| ||||||
Ad Groups Campaign Custom CPA Type The custom CPA to use to use for the CPA calculation for the campaign. |
| ||||||
Ad Groups Campaign Custom CPA Viewthrough Weight Weight to assign to view pixels when calculating custom CPA. |
| ||||||
Ad Groups Campaign Custom ROAS Type The custom ROAS calculation for the campaign's Return on Advertiser Spend value. |
| ||||||
Ad Groups Campaign Description An optional description of the campaign. |
| ||||||
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. |
| ||||||
Ad Groups Campaign Funnel Location Count The number of distinct Funnel Locations for all visible AdGroups owned by the Campaign. |
| ||||||
Ad Groups Campaign Id The ID of the campaign. |
| ||||||
Ad Groups Campaign Impressions Only Budgeting CPM |
| ||||||
Ad Groups Campaign Io Contract Id IO assigned to each campaign for IO clients to manage its spend. |
| ||||||
Ad Groups Campaign Is Archived |
| ||||||
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`. |
| ||||||
Ad Groups Campaign Is Managed By TTD A property to indicate this campaign is managed by The Trade Desk. |
| ||||||
Ad Groups Campaign Is Migrated To Kokai The campaign has been migrated from a previous version to Kokai. |
| ||||||
Ad Groups Campaign Is Programmatic Guaranteed |
| ||||||
Ad Groups Campaign Is Template |
| ||||||
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`. |
| ||||||
Ad Groups Campaign Last Touch Attribution Measured By The Trade Desk The Trade Desk measure last-touch attribution (recommended for troubleshooting purposes). |
| ||||||
Ad Groups Campaign Last Updated The time in UTC the campaign was last updated. This field is read-only. |
| ||||||
Ad Groups Campaign Last Updated At Utc The time in UTC the campaign was last updated. This field is read-only. |
| ||||||
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. |
| ||||||
Ad Groups Campaign Name The name of the campaign. |
| ||||||
Ad Groups Campaign Objective The campaign objective. |
| ||||||
Ad Groups Campaign Pacing Mode The pacing mode for the Campaign. |
| ||||||
Ad Groups Campaign Pacing To End Of Flight Daily Rate |
| ||||||
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. |
| ||||||
Ad Groups Campaign Purchase Order Number A property that you can use for internal reference. For example, a purchase order number. |
| ||||||
Ad Groups Campaign Share Type A property to indicate what level of access this campaign has. |
| ||||||
Ad Groups Campaign Site Url |
| ||||||
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. |
| ||||||
Ad Groups Campaign Status Campaign status. |
| ||||||
Ad Groups Campaign Time Zone The Windows time zone ID of the campaign. |
| ||||||
Ad Groups Campaign Time Zone IANA The IANA/Olson time zone ID of the campaign. |
| ||||||
Ad Groups Campaign Total Ad Group Count The total number of visible AdGroups owned by the Campaign. |
| ||||||
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. |
| ||||||
Ad Groups 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. |
| ||||||
Ad Groups Campaign Stack Rank |
| ||||||
Ad Groups Channel |
| ||||||
Ad Groups Contract Floor Price As Base Bid Adjustment Contract floor price as base-bid adjustment. |
| ||||||
Ad Groups Created At The time in UTC the adGroup was created. This field is read-only. |
| ||||||
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. |
| ||||||
Ad Groups Cross Device Vendor Id The identifier for this cross-device vendor. Use this ID when enabling cross-device targeting on ad groups. |
| ||||||
Ad Groups Cross Device Vendor Name The friendly name of the cross-device vendor. |
| ||||||
Ad Groups Current Flight Ad Group Id |
| ||||||
Ad Groups Current Flight Allocation In Advertiser Currency The amount of the campaign flight's budget that's allocated for an ad group. |
| ||||||
Ad Groups Current Flight Allocation Type How the ad group allocation is treated. See `AdGroupBudgetAllocationType` for the different types. |
| ||||||
Ad Groups Current Flight Budget In Advertiser Currency |
| ||||||
Ad Groups Current Flight Budget In Impressions |
| ||||||
Ad Groups Current Flight Campaign Flight Id |
| ||||||
Ad Groups Current Flight Daily Target In Advertiser Currency |
| ||||||
Ad Groups Current Flight Daily Target In Impressions |
| ||||||
Ad Groups Current Flight Minimum Spend In Advertiser Currency |
| ||||||
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. |
| ||||||
Ad Groups Current Or Next Flight Ad Group Id |
| ||||||
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. |
| ||||||
Ad Groups Current Or Next Flight Allocation Type How the ad group allocation is treated. See `AdGroupBudgetAllocationType` for the different types. |
| ||||||
Ad Groups Current Or Next Flight Budget In Advertiser Currency |
| ||||||
Ad Groups Current Or Next Flight Budget In Impressions |
| ||||||
Ad Groups Current Or Next Flight Campaign Flight Id |
| ||||||
Ad Groups Current Or Next Flight Daily Target In Advertiser Currency |
| ||||||
Ad Groups Current Or Next Flight Daily Target In Impressions |
| ||||||
Ad Groups Current Or Next Flight Minimum Spend In Advertiser Currency |
| ||||||
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. |
| ||||||
Ad Groups Deals Present Returns true if the ad group is targeting deals. |
| ||||||
Ad Groups Description An optional description of the ad group. |
| ||||||
Ad Groups Display Viewability Standard Integral The display viewability standard of the ad group. |
| ||||||
Ad Groups Expressiveness Bid Factors Total number of unique bids capped at 10 per dimension. |
| ||||||
Ad Groups Expressiveness Dimensions Number of dimensions. |
| ||||||
Ad Groups Expressiveness Score Expressiveness score. |
| ||||||
Ad Groups Funnel Location The funnel location of the ad group. |
| ||||||
Ad Groups Goal Average Value The average Goal value. |
| ||||||
Ad Groups Goal Is Custom Whether the goal is custom or not. |
| ||||||
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. |
| ||||||
Ad Groups Goal Short Name The short version of goal type's name. |
| ||||||
Ad Groups Goal Target The target Goal value. |
| ||||||
Ad Groups Goal Type The type of Goal. |
| ||||||
Ad Groups Goal Unit The unit of measurement for the Goal data. |
| ||||||
Ad Groups Id The ID of the ad group. |
| ||||||
Ad Groups Industry Category Id The category's ID. |
| ||||||
Ad Groups Industry Category Is Default Is this category the default, inherited from the Advertiser. |
| ||||||
Ad Groups Industry Category Is Sensitive Is the category sensitive or not. |
| ||||||
Ad Groups Industry Category Name The name of the category. |
| ||||||
Ad Groups Industry Category Parent Category Id The ID of the category's parent (if present). |
| ||||||
Ad Groups Industry Sub Category Id The category's ID. |
| ||||||
Ad Groups Industry Sub Category Is Default Is this category the default, inherited from the Advertiser. |
| ||||||
Ad Groups Industry Sub Category Is Sensitive Is the category sensitive or not. |
| ||||||
Ad Groups Industry Sub Category Name The name of the category. |
| ||||||
Ad Groups Industry Sub Category Parent Category Id The ID of the category's parent (if present). |
| ||||||
Ad Groups Is Archived |
| ||||||
Ad Groups Is Dimensional Bidding Mode |
| ||||||
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. |
| ||||||
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. |
| ||||||
Ad Groups Is News Navigator Enabled Prioritize reliable and objective news as scored by our News Rating Partners. |
| ||||||
Ad Groups Is Non Decisioned Indicates whether the ad group is targeting commitment deals. |
| ||||||
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. |
| ||||||
Ad Groups Is Quality Alliance Suite Enabled Set to true to search for ad groups that have Quality Alliance targeting enabled. |
| ||||||
Ad Groups Is Targeting Default On Deals Indicates whether the ad group is targeting all default on deals. |
| ||||||
Ad Groups Is Targeting Default On Endeavors Indicates whether the ad group is targeting all default on deals. |
| ||||||
Ad Groups Is Targeting Deprecated Library Deals If set to true, indicates that the ad group is targeting deprecated library deals |
| ||||||
Ad Groups Is Template |
| ||||||
Ad Groups Is Using Live Event Schedule Indicates if an ad group is pacing using a Live Event schedule. |
| ||||||
Ad Groups Koa Settings Are Future Features Enabled Set to `true` to enable future Koa features for the AdGroup automatically. |
| ||||||
Ad Groups Koa Settings Are Future Features Enabled For Partner Are future features enabled for the AdGroup's Partner automatically. |
| ||||||
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 |
| ||||||
Ad Groups Koa Settings Minor Version The minor version of the KOA optimizations for this AdGroup. |
| ||||||
Ad Groups Koa Settings Optimizations Version The version of the KOA optimizations for this AdGroup. |
| ||||||
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. |
| ||||||
Ad Groups Last Updated The time in UTC the adGroup was last updated. This field is read-only. |
| ||||||
Ad Groups Market Type Returns the market the AdGroup is currently targeting. |
| ||||||
Ad Groups Marketplace Id Marketplace ID |
| ||||||
Ad Groups Marketplace Marketplace Status Status of the given marketplace. |
| ||||||
Ad Groups Marketplace Name Marketplace name. |
| ||||||
Ad Groups Marketplace Owner Marketplace owner type. |
| ||||||
Ad Groups Marketplace Short Name Marketplace short name. |
| ||||||
Ad Groups Max Bid CPM In Advertiser Currency |
| ||||||
Ad Groups Name The name of the ad group. |
| ||||||
Ad Groups Next Flight Ad Group Id |
| ||||||
Ad Groups Next Flight Allocation In Advertiser Currency The amount of the campaign flight's budget that's allocated for an ad group. |
| ||||||
Ad Groups Next Flight Allocation Type How the ad group allocation is treated. See `AdGroupBudgetAllocationType` for the different types. |
| ||||||
Ad Groups Next Flight Budget In Advertiser Currency |
| ||||||
Ad Groups Next Flight Budget In Impressions |
| ||||||
Ad Groups Next Flight Campaign Flight Id |
| ||||||
Ad Groups Next Flight Daily Target In Advertiser Currency |
| ||||||
Ad Groups Next Flight Daily Target In Impressions |
| ||||||
Ad Groups Next Flight Minimum Spend In Advertiser Currency |
| ||||||
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. |
| ||||||
Ad Groups Nielsen Tracking Attributes End Age The end age being targeted for Nielsen analytics. |
| ||||||
Ad Groups Nielsen Tracking Attributes Enhanced Nielsen Reporting Options Enhanced Nielsen reporting option setting. |
| ||||||
Ad Groups Nielsen Tracking Attributes Gender The gender being targeted for Nielsen analytics. |
| ||||||
Ad Groups Nielsen Tracking Attributes Start Age The start age being targeted for Nielsen analytics. |
| ||||||
Ad Groups Pacing Grain Id |
| ||||||
Ad Groups Partner China MSA Signed |
| ||||||
Ad Groups Partner Credit Limit In USD Current credit limit assigned |
| ||||||
Ad Groups Partner Daily Spend Cap In USD Daily spend cap |
| ||||||
Ad Groups Partner Default Recency Bucket List Id |
| ||||||
Ad Groups Partner Id The ID of the partner. |
| ||||||
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. |
| ||||||
Ad Groups Partner Is Purchase Order Number Required Indicates if partner is billed by PO#, requiring campaigns to populate this field. |
| ||||||
Ad Groups Partner Is Spend Disabled Flag signifying whether the spend on this partner is disabled |
| ||||||
Ad Groups Partner Must Vet Advertisers |
| ||||||
Ad Groups Partner Name The name of the partner. |
| ||||||
Ad Groups Private Contract Default Adjustment |
| ||||||
Ad Groups Quality Alliance Viewability Profile Viewability profile used for Quality Alliance viewability targeting. |
| ||||||
Ad Groups Roi Goal Average Value The average Goal value. |
| ||||||
Ad Groups Roi Goal Is Custom Whether the goal is custom or not. |
| ||||||
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. |
| ||||||
Ad Groups Roi Goal Short Name The short version of goal type's name. |
| ||||||
Ad Groups Roi Goal Target The target Goal value. |
| ||||||
Ad Groups Roi Goal Type The type of Goal. |
| ||||||
Ad Groups Roi Goal Unit The unit of measurement for the Goal data. |
| ||||||
Ad Groups Spend Risk Level The AdGroup's spend risk level. |
| ||||||
Ad Groups Spend Spend The AdGroup's current spend in Advertiser currency. |
| ||||||
Ad Groups Status Ad group status. |
| ||||||
Ad Groups Use Multiple Cross Device Vendors If set to true, indicates that multiple cross-device vendors are used. |
| ||||||
Ad Groups Video Viewability Standard Integral The display viewability standard of the ad group. |
| ||||||
Ad Groups Viewability Profile Coalesces the viewability profile from Campaign, Advertiser, or Partner, in that order of precedence. |
| ||||||
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. |
| ||||||
Ad Server Creative Placement ID |
| ||||||
Ad Server Name |
| ||||||
Advertiser Attribution Click Interval The unit of time to apply to click interval attributions. |
| ||||||
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. |
| ||||||
Advertiser Attribution Impression Interval The unit of time to apply to impression interval attributions. |
| ||||||
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. |
| ||||||
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. |
| ||||||
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. |
| ||||||
Advertiser Brand Owner The owner of the brands assigned to the Advertiser. |
| ||||||
Advertiser Channel Count The number of unique primary channels belonging to live Campaigns under the Advertiser. |
| ||||||
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. |
| ||||||
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. |
| ||||||
Advertiser Country Id |
| ||||||
Advertiser Country Long Name |
| ||||||
Advertiser Country Short Name |
| ||||||
Advertiser Currency Decimal Places |
| ||||||
Advertiser Currency Id |
| ||||||
Advertiser Currency Is Visible |
| ||||||
Advertiser Currency Name |
| ||||||
Advertiser Currency Name Plural |
| ||||||
Advertiser Currency Should Prefix Currency Symbol |
| ||||||
Advertiser Currency Symbol |
| ||||||
Advertiser Default Partner Viewability Settings Display Sampling Rate The display sampling rate of the provider. |
| ||||||
Advertiser Default Partner Viewability Settings Profile Display Name The display name of the provider. |
| ||||||
Advertiser Default Partner Viewability Settings Provider Id The provider ID. |
| ||||||
Advertiser Default Partner Viewability Settings Video Sampling Rate The video sampling rate of the provider. |
| ||||||
Advertiser Default Right Media Offer Id The offer type's ID. |
| ||||||
Advertiser Default Right Media Offer Name The name of the offer type. |
| ||||||
Advertiser Default Seed Active Ids Active id count in the seed. |
| ||||||
Advertiser Default Seed Created At Date and time of the seed creation. |
| ||||||
Advertiser Default Seed Id ID of the seed. |
| ||||||
Advertiser Default Seed Is Default Indicates whether the seed is set as the default for the advertiser. |
| ||||||
Advertiser Default Seed Last Updated At Date and time of last seed update. |
| ||||||
Advertiser Default Seed Name Name of the seed |
| ||||||
Advertiser Default Seed Quality Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`. |
| ||||||
Advertiser Default Seed Quality Reason Represents the reason for seed definition quality. |
| ||||||
Advertiser Default Seed Status Seed materialization status. |
| ||||||
Advertiser Default Seed Unique Households Unique house hold ids associated with the seed. |
| ||||||
Advertiser Description An optional description of the advertiser. |
| ||||||
Advertiser Domain Address The primary domain of the advertiser. |
| ||||||
Advertiser Funnel Location Count The number of unique Funnel Locations belonging to visible AdGroups for live Campaigns under the Advertiser. |
| ||||||
Advertiser Has Available Seed Pixels Whether or not there any Seed Pixels available to the Advertiser. |
| ||||||
Advertiser Id The ID of the advertiser. |
| ||||||
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. |
| ||||||
Advertiser Industry Category Id The category's ID. |
| ||||||
Advertiser Industry Category Is Default Is this category the default, inherited from the Advertiser. |
| ||||||
Advertiser Industry Category Is Sensitive Is the category sensitive or not. |
| ||||||
Advertiser Industry Category Name The name of the category. |
| ||||||
Advertiser Industry Category Parent Category Id The ID of the category's parent (if present). |
| ||||||
Advertiser Industry Sub Category Id The category's ID. |
| ||||||
Advertiser Industry Sub Category Is Default Is this category the default, inherited from the Advertiser. |
| ||||||
Advertiser Industry Sub Category Is Sensitive Is the category sensitive or not. |
| ||||||
Advertiser Industry Sub Category Name The name of the category. |
| ||||||
Advertiser Industry Sub Category Parent Category Id The ID of the category's parent (if present). |
| ||||||
Advertiser Is Archived |
| ||||||
Advertiser Is Blocked From Hh Solution Is the Advertiser blocked from HH Solution. |
| ||||||
Advertiser Is Favorite For User Returns `true` if advertiser was marked as favorite by current user. |
| ||||||
Advertiser Is Hcp Eligible Indicates whether the advertiser is eligible for HCP advertising. |
| ||||||
Advertiser Is Hec Auto Exempt An HEC (Housing, Employment, Credit) exemption will exclude an HEC applicable advertiser from microtargeting restrictions. |
| ||||||
Advertiser Is Marketplace Enabled By Default Defines if marketplace will be preselected when creating a new adgroup in this advertiser |
| ||||||
Advertiser Is Restricted For Distributed Algos |
| ||||||
Advertiser Is With Campaigns At Risk Does the Advertiser have one or more Campaigns at risk, pacing behind. |
| ||||||
Advertiser Is With Live Campaigns Does this Advertiser have Campaigns that are active. |
| ||||||
Advertiser Logo The URL for the advertiser's logo or brand image. |
| ||||||
Advertiser Marketplace Id Marketplace ID |
| ||||||
Advertiser Marketplace Marketplace Status Status of the given marketplace. |
| ||||||
Advertiser Marketplace Name Marketplace name. |
| ||||||
Advertiser Marketplace Owner Marketplace owner type. |
| ||||||
Advertiser Marketplace Short Name Marketplace short name. |
| ||||||
Advertiser Most Used Seed Active Ids Active id count in the seed. |
| ||||||
Advertiser Most Used Seed Created At Date and time of the seed creation. |
| ||||||
Advertiser Most Used Seed Id ID of the seed. |
| ||||||
Advertiser Most Used Seed Is Default Indicates whether the seed is set as the default for the advertiser. |
| ||||||
Advertiser Most Used Seed Last Updated At Date and time of last seed update. |
| ||||||
Advertiser Most Used Seed Name Name of the seed |
| ||||||
Advertiser Most Used Seed Quality Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`. |
| ||||||
Advertiser Most Used Seed Quality Reason Represents the reason for seed definition quality. |
| ||||||
Advertiser Most Used Seed Status Seed materialization status. |
| ||||||
Advertiser Most Used Seed Unique Households Unique house hold ids associated with the seed. |
| ||||||
Advertiser Name The name of the advertiser. |
| ||||||
Advertiser Name DSA The name of the advertiser to be displayed for campaigns targeting individuals established or located in the European Union (EU). |
| ||||||
Advertiser Onboarding Data Advertiser Id |
| ||||||
Advertiser Onboarding Data Created At |
| ||||||
Advertiser Onboarding Data Created By User Id |
| ||||||
Advertiser Onboarding Data Id |
| ||||||
Advertiser Onboarding Data Last Updated At |
| ||||||
Advertiser Onboarding Data Last Updated By User Id |
| ||||||
Advertiser Partner China MSA Signed |
| ||||||
Advertiser Partner Credit Limit In USD Current credit limit assigned |
| ||||||
Advertiser Partner Daily Spend Cap In USD Daily spend cap |
| ||||||
Advertiser Partner Default Recency Bucket List Id |
| ||||||
Advertiser Partner Id The ID of the partner. |
| ||||||
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. |
| ||||||
Advertiser Partner Is Purchase Order Number Required Indicates if partner is billed by PO#, requiring campaigns to populate this field. |
| ||||||
Advertiser Partner Is Spend Disabled Flag signifying whether the spend on this partner is disabled |
| ||||||
Advertiser Partner Must Vet Advertisers |
| ||||||
Advertiser Partner Name The name of the partner. |
| ||||||
Advertiser Partner Basic Info Id The ID of the partner. |
| ||||||
Advertiser Partner Basic Info Name The name of the partner. |
| ||||||
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. |
| ||||||
Advertiser Political Candidate Count The number of political candidates. |
| ||||||
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. |
| ||||||
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. |
| ||||||
Advertiser Secret Key The Advertiser's secret key (inherited from Partner). |
| ||||||
Advertiser Seed Permission Can Have Seed Indicates whether the advertiser is permitted to have seed. |
| ||||||
Advertiser Special Platform Features Campaign Flight Custom Labels In Ui Indicates whether campaign flight custom label is available in UI. |
| ||||||
Advertiser Special Platform Features Hide Dooh Channel Buying In Ui Flag indicating that TTD will hide DOOH channel buying in the UI. |
| ||||||
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. |
| ||||||
Advertiser Special Platform Features Legacy Quality Alliance Thresholds In Ui Indicates whether legacy Quality Alliance thresholds are available in the UI. |
| ||||||
Advertiser Special Platform Features Show TTD Pharmaceutical Standard Categores In Ui Indicates whether TTD Pharmaceutical Standard Categories are available in the UI. |
| ||||||
Advertiser Special Platform Features Show TTD Standard Embedding Categories In Ui Indicates whether TTD Standard Embedding Categories are available in the UI. |
| ||||||
Advertiser Special Platform Features Walmart First Party Seeds In Ui Indicates whether advertiser is allowed to add their 1PD to seeds in Walmart. |
| ||||||
Advertiser Total Campaign Channel Count The total number of possible Campaign Channels. |
| ||||||
Advertiser Total Funnel Location Count The total number of possible Funnel Locations. |
| ||||||
Advertiser Use Impressions Only Budgeting |
| ||||||
Advertiser Use Media Cost Basis For Campaign Fees |
| ||||||
Advertiser Vetting Status Vetting status of the advertiser. This field is read-only. |
| ||||||
Advertiser Viewability Selected Provider Id |
| ||||||
Advertiser Cost (Adv Currency) |
| ||||||
Advertiser Cost (Partner Currency) |
| ||||||
Advertiser Cost (USD) |
| ||||||
Base Bid Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Base Bid Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Base Bid Usd The amount specified in US dollars. |
| ||||||
Bid Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Bid Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Bid Cpm Usd The amount specified in US dollars. |
| ||||||
Bids The total number of times an offer was made in an auction for an impression. |
| ||||||
Browser |
| ||||||
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. |
| ||||||
Campaigns Active Ad Group Count The total number of AdGroups owned by the Campaign that are both visible and enabled. |
| ||||||
Campaigns Audience Created At The date and time in UTC the audience was created. |
| ||||||
Campaigns Audience Id |
| ||||||
Campaigns Audience Is Auto Generated Indicates if this audience was automatically generated by The Trade Desk platform. |
| ||||||
Campaigns Audience Last Updated At Indicates the time when this audience was last updated (UTC). |
| ||||||
Campaigns Audience Name The name of the audience. |
| ||||||
Campaigns Audience Target Everyone If set to true, indicates that it is a TargetEveryone audience. |
| ||||||
Campaigns Auto Allocator Enabled |
| ||||||
Campaigns Auto Campaign Cap Enabled |
| ||||||
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. |
| ||||||
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. |
| ||||||
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. |
| ||||||
Campaigns Budget Current Or Up Coming The budget of the campaign's current or next upcoming flight. |
| ||||||
Campaigns Budget Pacing Mode The campaign pacing mode that determines how slowly or quickly the campaign spends the budget during its flights. |
| ||||||
Campaigns Budget Spend Mode The spend mode that determines how the system allocates the campaign budget to its ad groups. |
| ||||||
Campaigns Budget Total The total budget of the campaign, in the advertiser's currency. |
| ||||||
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. |
| ||||||
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. |
| ||||||
Campaigns Budget Version The version of the budgeting experience for the campaign. |
| ||||||
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. |
| ||||||
Campaigns Budget Migration Reports Allocation Mode |
| ||||||
Campaigns Budget Migration Reports Budgeting Version |
| ||||||
Campaigns Budget Migration Reports Has Impressions Indicates whether the campaign and any of its adGroups have impression budgets. |
| ||||||
Campaigns Budget Migration Reports Has Live Events Whether this campaign has unarchived live event ad groups. |
| ||||||
Campaigns Budget Migration Reports Is Mixed Pacing Whether the ad groups of this campaign have different pacing modes. |
| ||||||
Campaigns Budget Migration Reports Pacing Mode The current pacing mode on the campaign, depending on whether it uses Solimar or Kokai budgeting. |
| ||||||
Campaigns Budget Migration Reports Unified Pacing Mode The pacing mode in Kokai that unifies campaign and its adGroups' pacing mode. |
| ||||||
Campaigns Budget Migration Status Current Budgeting Version The current budgeting version. |
| ||||||
Campaigns Budget Migration Status Is Compatible Whether the current budget settings is compatible with the settings in the target budgeting version. |
| ||||||
Campaigns Campaign Group Current Flights End Date Exclusive The latest end date of all the current campaign flights in this campaign group |
| ||||||
Campaigns Campaign Group Current Flights Start Date Inclusive The earliest start date of all the current campaign flights in this campaign group |
| ||||||
Campaigns Campaign Group Flight Budget Total budget across all current flights in the non-archived campaigns in the group. |
| ||||||
Campaigns Campaign Group Id The ID of the campaign group. |
| ||||||
Campaigns Campaign Group Is Archived `true` if the campaign group is archived, `false` otherwise. |
| ||||||
Campaigns Campaign Group Last Updated The time in UTC the campaign campaign was last updated. |
| ||||||
Campaigns Campaign Group Name Name of the campaign group. |
| ||||||
Campaigns Campaign Group Num Channels The number of unique channels in the non-archived campaigns in the group that have current flights |
| ||||||
Campaigns Campaign Group Total Budget Total budget across all campaigns in the non-archived campaigns in the group. |
| ||||||
Campaigns Campaign Pacing Settings Is Value Pacing |
| ||||||
Campaigns Channel Type |
| ||||||
Campaigns Created At The time in UTC the campaign was created. This field is read-only. |
| ||||||
Campaigns Created At Utc The time in UTC the campaign was created. This field is read-only. |
| ||||||
Campaigns Current Flight Budget Allocation Mode Whether the budget allocation on this campaign flight is fluid, fixed, or mixed. See CampaignBudgetAllocationMode. |
| ||||||
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. |
| ||||||
Campaigns Current Flight Budget In Impressions The maximum amount of impressions the campaign flight should buy. |
| ||||||
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. |
| ||||||
Campaigns Current Flight Daily Target In Impressions The total number of impressions the campaign flight should buy in a single day, if possible. |
| ||||||
Campaigns Current Flight Days Remaining |
| ||||||
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. |
| ||||||
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 |
| ||||||
Campaigns Current Flight Id |
| ||||||
Campaigns Current Flight Is Active For At Least A Day |
| ||||||
Campaigns Current Flight Is Current |
| ||||||
Campaigns Current Flight Is Deleted |
| ||||||
Campaigns Current Flight Is Fixed Impression Budget Allocation Whether the impression budget allocation on this campaign flight is manually set as fixed. |
| ||||||
Campaigns Current Flight Start Date Inclusive UTC The date and time (in UTC) when the campaign flight is to start spending. |
| ||||||
Campaigns Current Flight Uses Impression Budgets Whether the campaign flight has impression budgets manually set. |
| ||||||
Campaigns Current Or Next Flight Budget Allocation Mode Whether the budget allocation on this campaign flight is fluid, fixed, or mixed. See CampaignBudgetAllocationMode. |
| ||||||
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. |
| ||||||
Campaigns Current Or Next Flight Budget In Impressions The maximum amount of impressions the campaign flight should buy. |
| ||||||
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. |
| ||||||
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. |
| ||||||
Campaigns Current Or Next Flight Days Remaining |
| ||||||
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. |
| ||||||
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 |
| ||||||
Campaigns Current Or Next Flight Id |
| ||||||
Campaigns Current Or Next Flight Is Active For At Least A Day |
| ||||||
Campaigns Current Or Next Flight Is Current |
| ||||||
Campaigns Current Or Next Flight Is Deleted |
| ||||||
Campaigns Current Or Next Flight Is Fixed Impression Budget Allocation Whether the impression budget allocation on this campaign flight is manually set as fixed. |
| ||||||
Campaigns Current Or Next Flight Start Date Inclusive UTC The date and time (in UTC) when the campaign flight is to start spending. |
| ||||||
Campaigns Current Or Next Flight Uses Impression Budgets Whether the campaign flight has impression budgets manually set. |
| ||||||
Campaigns Custom CPA Click Weight Weight to assign to click-through pixels when calculating custom CPA. |
| ||||||
Campaigns Custom CPA Type The custom CPA to use to use for the CPA calculation for the campaign. |
| ||||||
Campaigns Custom CPA Viewthrough Weight Weight to assign to view pixels when calculating custom CPA. |
| ||||||
Campaigns Custom ROAS Type The custom ROAS calculation for the campaign's Return on Advertiser Spend value. |
| ||||||
Campaigns Description An optional description of the campaign. |
| ||||||
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. |
| ||||||
Campaigns Frequency Settings Frequency Cap The maximum number of impressions to serve to a specific user within the FrequencyPeriodInMinutes. Applies to the entire campaign. |
| ||||||
Campaigns Frequency Settings Frequency Period In Minutes The period of time after which a specific user's Frequency Cap is reset. |
| ||||||
Campaigns Frequency Settings Lifetime Frequency Cap The maximum number of impressions to serve to a specific user over the lifetime of the campaign. |
| ||||||
Campaigns Funnel Location Count The number of distinct Funnel Locations for all visible AdGroups owned by the Campaign. |
| ||||||
Campaigns Goal Average Value The average Goal value. |
| ||||||
Campaigns Goal Is Custom Whether the goal is custom or not. |
| ||||||
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. |
| ||||||
Campaigns Goal Short Name The short version of goal type's name. |
| ||||||
Campaigns Goal Target The target Goal value. |
| ||||||
Campaigns Goal Type The type of Goal. |
| ||||||
Campaigns Goal Unit The unit of measurement for the Goal data. |
| ||||||
Campaigns Id The ID of the campaign. |
| ||||||
Campaigns Impressions Only Budgeting CPM |
| ||||||
Campaigns Io Contract Id IO assigned to each campaign for IO clients to manage its spend. |
| ||||||
Campaigns Is Archived |
| ||||||
Campaigns Is I Spot Enabled If set to `true`, indicates that ISpot incremental reach KPI has been added. The default value is `false`. |
| ||||||
Campaigns Is Managed By TTD A property to indicate this campaign is managed by The Trade Desk. |
| ||||||
Campaigns Is Migrated To Kokai The campaign has been migrated from a previous version to Kokai. |
| ||||||
Campaigns Is Programmatic Guaranteed |
| ||||||
Campaigns Is Template |
| ||||||
Campaigns Is Tv Squared Enabled If set to `true`, indicates that TvSquared incremental reach KPI has been added. The default value is `false`. |
| ||||||
Campaigns Last Touch Attribution Measured By The Trade Desk The Trade Desk measure last-touch attribution (recommended for troubleshooting purposes). |
| ||||||
Campaigns Last Updated The time in UTC the campaign was last updated. This field is read-only. |
| ||||||
Campaigns Last Updated At Utc The time in UTC the campaign was last updated. This field is read-only. |
| ||||||
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. |
| ||||||
Campaigns Name The name of the campaign. |
| ||||||
Campaigns Next Flight Budget Allocation Mode Whether the budget allocation on this campaign flight is fluid, fixed, or mixed. See CampaignBudgetAllocationMode. |
| ||||||
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. |
| ||||||
Campaigns Next Flight Budget In Impressions The maximum amount of impressions the campaign flight should buy. |
| ||||||
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. |
| ||||||
Campaigns Next Flight Daily Target In Impressions The total number of impressions the campaign flight should buy in a single day, if possible. |
| ||||||
Campaigns Next Flight Days Remaining |
| ||||||
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. |
| ||||||
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 |
| ||||||
Campaigns Next Flight Id |
| ||||||
Campaigns Next Flight Is Active For At Least A Day |
| ||||||
Campaigns Next Flight Is Current |
| ||||||
Campaigns Next Flight Is Deleted |
| ||||||
Campaigns Next Flight Is Fixed Impression Budget Allocation Whether the impression budget allocation on this campaign flight is manually set as fixed. |
| ||||||
Campaigns Next Flight Start Date Inclusive UTC The date and time (in UTC) when the campaign flight is to start spending. |
| ||||||
Campaigns Next Flight Uses Impression Budgets Whether the campaign flight has impression budgets manually set. |
| ||||||
Campaigns Objective The campaign objective. |
| ||||||
Campaigns Pacing Mode The pacing mode for the Campaign. |
| ||||||
Campaigns Pacing To End Of Flight Daily Rate |
| ||||||
Campaigns Partner China MSA Signed |
| ||||||
Campaigns Partner Credit Limit In USD Current credit limit assigned |
| ||||||
Campaigns Partner Daily Spend Cap In USD Daily spend cap |
| ||||||
Campaigns Partner Default Recency Bucket List Id |
| ||||||
Campaigns Partner Id The ID of the partner. |
| ||||||
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. |
| ||||||
Campaigns Partner Is Purchase Order Number Required Indicates if partner is billed by PO#, requiring campaigns to populate this field. |
| ||||||
Campaigns Partner Is Spend Disabled Flag signifying whether the spend on this partner is disabled |
| ||||||
Campaigns Partner Must Vet Advertisers |
| ||||||
Campaigns Partner Name The name of the partner. |
| ||||||
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. |
| ||||||
Campaigns Primary Goal Average Value The average Goal value. |
| ||||||
Campaigns Primary Goal Is Custom Whether the goal is custom or not. |
| ||||||
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. |
| ||||||
Campaigns Primary Goal Short Name The short version of goal type's name. |
| ||||||
Campaigns Primary Goal Target The target Goal value. |
| ||||||
Campaigns Primary Goal Type The type of Goal. |
| ||||||
Campaigns Primary Goal Unit The unit of measurement for the Goal data. |
| ||||||
Campaigns Purchase Order Number A property that you can use for internal reference. For example, a purchase order number. |
| ||||||
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. |
| ||||||
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. |
| ||||||
Campaigns Secondary Goal Average Value The average Goal value. |
| ||||||
Campaigns Secondary Goal Is Custom Whether the goal is custom or not. |
| ||||||
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. |
| ||||||
Campaigns Secondary Goal Short Name The short version of goal type's name. |
| ||||||
Campaigns Secondary Goal Target The target Goal value. |
| ||||||
Campaigns Secondary Goal Type The type of Goal. |
| ||||||
Campaigns Secondary Goal Unit The unit of measurement for the Goal data. |
| ||||||
Campaigns Seed Active Ids Active id count in the seed. |
| ||||||
Campaigns Seed Created At Date and time of the seed creation. |
| ||||||
Campaigns Seed Id ID of the seed. |
| ||||||
Campaigns Seed Is Default Indicates whether the seed is set as the default for the advertiser. |
| ||||||
Campaigns Seed Last Updated At Date and time of last seed update. |
| ||||||
Campaigns Seed Name Name of the seed |
| ||||||
Campaigns Seed Quality Represents the quality of the seed. Currently, this field is available only via `advertiser.seeds`. |
| ||||||
Campaigns Seed Quality Reason Represents the reason for seed definition quality. |
| ||||||
Campaigns Seed Status Seed materialization status. |
| ||||||
Campaigns Seed Unique Households Unique house hold ids associated with the seed. |
| ||||||
Campaigns Share Type A property to indicate what level of access this campaign has. |
| ||||||
Campaigns Site Url |
| ||||||
Campaigns Spend Current |
| ||||||
Campaigns Spend Risk Level |
| ||||||
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. |
| ||||||
Campaigns Status Campaign status. |
| ||||||
Campaigns Tertiary Goal Average Value The average Goal value. |
| ||||||
Campaigns Tertiary Goal Is Custom Whether the goal is custom or not. |
| ||||||
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. |
| ||||||
Campaigns Tertiary Goal Short Name The short version of goal type's name. |
| ||||||
Campaigns Tertiary Goal Target The target Goal value. |
| ||||||
Campaigns Tertiary Goal Type The type of Goal. |
| ||||||
Campaigns Tertiary Goal Unit The unit of measurement for the Goal data. |
| ||||||
Campaigns Time Zone The Windows time zone ID of the campaign. |
| ||||||
Campaigns Time Zone IANA The IANA/Olson time zone ID of the campaign. |
| ||||||
Campaigns Total Ad Group Count The total number of visible AdGroups owned by the Campaign. |
| ||||||
Campaigns Trading Mode The mode that the pacing and bidding system runs on to better achieve customized goals. Only applies to Kokai campaigns. |
| ||||||
Campaigns 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. |
| ||||||
Channel Overlap Rate Households Percentage of households reached on more than one channel. |
| ||||||
Channel Overlap Rate Persons Percentage of people reached on more than one channel. |
| ||||||
Clicks The number of times a user interacted with an ad by clicking it. |
| ||||||
Completion Rate The proportion of ads that are fully viewed, played, or heard out of the total number of ads served. |
| ||||||
Conversions The number of times a user engaged with an ad and completed an action. |
| ||||||
Cpa Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Cpa Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Cpa Usd The amount specified in US dollars. |
| ||||||
Cpa In Advertiser Currency Cost per acquisition (CPA) in advertiser currency. |
| ||||||
Cpc Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Cpc Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Cpc Usd The amount specified in US dollars. |
| ||||||
Cpcv Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Cpcv Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Cpcv Usd The amount specified in US dollars. |
| ||||||
Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Cpm Usd The amount specified in US dollars. |
| ||||||
Cpm In Advertiser Currency Cost per mille (CPM) in advertiser currency. |
| ||||||
Creative Ad Server Creative Id |
| ||||||
Creative Ad Server Name |
| ||||||
Creative Approved By |
| ||||||
Creative Created At The UTC time when the creative was created. |
| ||||||
Creative Description An optional description of the creative. The maximum character length is 512. |
| ||||||
Creative Flight End The flight end date and time for the creative. |
| ||||||
Creative Flight End Date UTC |
| ||||||
Creative Flight Start The flight start date and time for the creative. |
| ||||||
Creative Flight Start Date UTC |
| ||||||
Creative Flight Time Zone Timezone for the creative flight dates. Defaults to "UTC" when not explicitly set. |
| ||||||
Creative Flight Time Zone IANA The IANA/Olson time zone ID of the creative flight. The default value is "Etc/UTC". |
| ||||||
Creative Id The unique identifier of the creative. |
| ||||||
Creative Id Integer |
| ||||||
Creative Interstitial Support Id |
| ||||||
Creative Is Archived |
| ||||||
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. |
| ||||||
Creative Last Updated At The UTC time when the creative was last updated. |
| ||||||
Creative Malware Scan Is Scan Pending Completion status of the malware scan. |
| ||||||
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. |
| ||||||
Creative Political Ad Icon Candidate Name Political Candidate |
| ||||||
Creative Political Ad Icon Id |
| ||||||
Creative Political Ad Icon Political Data Id |
| ||||||
Creative Share Link Link to a preview of this creative. Anybody with the link can see the creative, visiting it does not require authentication. |
| ||||||
Creative Tag Type |
| ||||||
Creative Tag Type Enum |
| ||||||
Creative Third Party Click Tracking Url |
| ||||||
Creative Tmt Malware Scan Is Scan Pending Completion status of the malware scan. |
| ||||||
Creative Type Enum matching the type of the creative. This value will allow for sorting and filtering. |
| ||||||
Ctr Click-through rate (percentage of impressions that resulted in clicks). |
| ||||||
Custom Cpa Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Custom Cpa Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Custom Cpa Usd The amount specified in US dollars. |
| ||||||
Custom Roas Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Custom Roas Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Custom Roas Usd The amount specified in US dollars. |
| ||||||
Deal ID |
| ||||||
Device Type |
| ||||||
Impressions The number of times an ad was served and had the potential to be viewed. |
| ||||||
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. |
| ||||||
In View Rate The proportion of impressions where an ad was in view for a certain period of time. |
| ||||||
Matched Household Impressions Impressions which matched with a Household Id in Graph. |
| ||||||
Matched Person Impressions Impressions which matched with a Person Id in Graph. |
| ||||||
Media Cost Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Media Cost Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Media Cost Usd The amount specified in US dollars. |
| ||||||
Media Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Media Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Media Cpm Usd The amount specified in US dollars. |
| ||||||
Nielsen Otp The Nielsen On-Target percentage. Currently not supported for campaign flights or ad group flights. |
| ||||||
Operating System |
| ||||||
Operating System Family |
| ||||||
Partner Cost (Adv Currency) |
| ||||||
Partner Cost (Partner Currency) |
| ||||||
Partner Cost (USD) |
| ||||||
Player 25% Complete |
| ||||||
Player 50% Complete |
| ||||||
Player 75% Complete |
| ||||||
Player Close |
| ||||||
Player Collapse |
| ||||||
Player Completed Views |
| ||||||
Player Engaged Views |
| ||||||
Player Errors |
| ||||||
Player Expansion |
| ||||||
Player Full Screen |
| ||||||
Player Invitation Accept |
| ||||||
Player Mute |
| ||||||
Player Pause |
| ||||||
Player Resume |
| ||||||
Player Rewind |
| ||||||
Player Skip |
| ||||||
Player Starts |
| ||||||
Player Unmute |
| ||||||
Player Views |
| ||||||
Revenue Total revenue generated. |
| ||||||
Roas Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Roas Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Roas Usd The amount specified in US dollars. |
| ||||||
Sampled Tracked Impressions |
| ||||||
Sampled Viewed Impressions |
| ||||||
Spend Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Spend Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Spend Usd The amount specified in US dollars. |
| ||||||
Spend In Advertiser Currency Spend in advertiser currency. |
| ||||||
Total Bid Amount (Adv Currency) |
| ||||||
Total Bid Amount (Partner Currency) |
| ||||||
Total Bid Amount (USD) |
| ||||||
Tv Quality Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
Tv Quality Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
Tv Quality Cpm Usd The amount specified in US dollars. |
| ||||||
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). |
| ||||||
Unique Households Unique houseHold count. |
| ||||||
Unique Persons Unique person count. |
| ||||||
V Cpm Advertiser Currency The amount specified in the advertiser's currency, which is selected during the advertiser setup process. |
| ||||||
V Cpm Partner Currency The amount specified in the partner's currency, which is selected during the partner setup process. |
| ||||||
V Cpm Usd The amount specified in US dollars. |
| ||||||
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). |
| ||||||
Viewability The percentage of ads that were viewable. |
| ||||||
Week of the year Week of the year |
| ||||||
Win Rate The percentage of auctions that were won. |
|
.svg){kind=logo}