Amazon DSP Metadata: Most-used fields#
The table below gives information about most-used fields that you can import from Amazon DSP Metadata. Other fields might also be available in Adverity.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.
accessibilityText Dimension
Accessible names that are labels given to HTML elements for assistive technologies like screen readers.
adChoicesPosition Dimension
The position where the AdChoices icon is displayed on the ad creative, e.g., 'BOTTOM_LEFT', 'TOP_RIGHT'.
adCreativeCategories Dimension
A list of categories that describe the content or nature of the ad creative.
adCreativeFormatProperties.adCopy Dimension
The ad copy details, including its type and value, used in the creative.
adCreativeFormatProperties.adCopy.type Dimension
The type of ad copy, such as 'BODY' for the main text content.
adCreativeFormatProperties.adCopy.value Dimension
The actual text content of the ad copy.
adCreativeFormatProperties.adCreativeFormatType Dimension
The format type of the ad creative, e.g., 'DISPLAY', 'VIDEO', 'AUDIO', 'THIRD_PARTY', or 'COMPONENT'.
adCreativeFormatProperties.additionalAttributes Dimension
Additional attributes and settings specific to the ad creative's format.
adCreativeFormatProperties.additionalAttributes.allowThirdPartySellers Dimension
Indicates whether third-party sellers are allowed for the ad creative.
adCreativeFormatProperties.additionalAttributes.allowedRetailFormats Dimension
Specifies the retail formats permitted for the ad creative.
adCreativeFormatProperties.additionalAttributes.creativeContentType Dimension
The content type of the ad creative.
adCreativeFormatProperties.additionalAttributes.optimizationGoal Dimension
The optimization goal set for the ad creative, influencing how it is delivered for performance.
adCreativeFormatProperties.additionalAttributes.renderOptimizations Dimension
Additional attributes related to how the ad creative is rendered to optimize its display.
adCreativeFormatProperties.additionalAttributes.targetPlacements Dimension
Specifies the intended placements for the ad creative, such as above or below the fold, or in-feed.
adCreativeFormatProperties.assets Dimension
A collection of assets, such as images or videos, used in the ad creative.
adCreativeFormatProperties.assets.applyBorder Dimension
Indicates whether a border should be applied to the creative asset.
adCreativeFormatProperties.assets.assetId Dimension
The unique identifier of the asset used in the ad creative.
adCreativeFormatProperties.assets.assetType Dimension
The type of creative asset, such as 'IMAGE' or 'VIDEO'.
adCreativeFormatProperties.assets.assetVersion Dimension
The version of the asset.
adCreativeFormatProperties.assets.associatedAdExperience Dimension
The ad experience associated with the asset.
adCreativeFormatProperties.assets.url Dimension
The URL of the asset used in the ad creative.
adCreativeFormatProperties.clickActions Dimension
Defines the actions that occur when the ad creative is clicked.
adCreativeFormatProperties.clickActions.associatedAdExperience Dimension
The ad experience associated with the click action.
adCreativeFormatProperties.clickActions.clickActionType Dimension
The type of action performed on click, e.g., navigating to a URL.
adCreativeFormatProperties.clickActions.position Dimension
The position of an AdChoices icon or other clickable elements on the ad creative. For instance, 'TOP_RIGHT' indicates the AdChoices icon is displayed in the top right corner of the ad.
adCreativeFormatProperties.clickActions.urlDestination Dimension
The URL to which the user is directed when the ad is clicked.
adCreativeFormatProperties.creativeSizes Dimension
The dimensions and responsiveness settings for the ad creative.
adCreativeFormatProperties.creativeSizes.height Metric
The height of the creative size in pixels.
adCreativeFormatProperties.creativeSizes.responsive Dimension
Indicates whether the creative size is responsive.
adCreativeFormatProperties.creativeSizes.width Metric
The width of the creative size in pixels.
adCreativeFormatProperties.products Dimension
A list of products associated with the ad creative, including their details.
adCreativeFormatProperties.products.productId Dimension
The unique identifier of the product associated with the ad creative.
adCreativeFormatProperties.products.productTitle Dimension
The title of the product associated with the ad creative.
adCreativeFormatProperties.products.productType Dimension
The type of product, e.g., 'ASIN'.
adCreativeFormatProperties.products.reviewText Dimension
The review text for the product associated with the ad creative.
adCreativeFormatProperties.products.reviewUrl Dimension
The URL for the product review associated with the ad creative.
adCreativeFormatProperties.skippabilitySettings Dimension
Settings that define whether an ad creative can be skipped by the viewer.
adCreativeFormatProperties.skippabilitySettings.skippableType Dimension
The specific type of skippability for an ad creative, defining if and how a user can skip the ad.
adCreativeFormatProperties.thirdPartyTag Dimension
Details for third-party ad tags used in the creative.
adCreativeFormatProperties.thirdPartyTag.destinationOnAmazon Dimension
Indicates whether the third-party tag links to an Amazon site (AMAZON) or an external site (OTHER).
adCreativeFormatProperties.thirdPartyTag.tagSource Dimension
The URL or content of the third-party creative tag, such as a VAST tag URL.
adCreativeFormatProperties.thirdPartyTag.tagType Dimension
The type of third-party tag used in the ad creative, for example, VAST_VPAID.
adCreativeFormatProperties.trackingUrls Dimension
A list of tracking URLs used for monitoring ad performance.
adCreativeFormatProperties.trackingUrls.associatedAdExperience Dimension
The ad experience associated with the tracking URL.
adCreativeFormatProperties.trackingUrls.type Dimension
The type of tracking URL, such as 'CLICK' for click-through tracking.
adCreativeFormatProperties.trackingUrls.url Dimension
The URL used for tracking ad events.
adCreativeFormatProperties.universalAdIds Dimension
Universal identifiers associated with the ad creative, used for consistent identification across various platforms and systems.
adCreativeId Dimension
The unique identifier for the ad creative.
adCreativeName Dimension
The name of the ad creative.
adExperiences Dimension
A collection of ad experiences, representing rendered views of a creative for specific contexts.
adExperiences.adExperience Dimension
The specific ad experience, representing a rendered view of the creative.
adExperiences.associationModerationStatus Dimension
The moderation status of the ad experience association.
adGroupId Dimension
The unique identifier for the ad group.
adProduct Dimension
The advertising product associated with the entity, e.g., 'AMAZON_DSP'.
additionalHtml Dimension
Additional HTML content to be added to the creative for surveys or other supplemental purposes.
advertisedProductCategoryIds Dimension
A list of identifiers for the product categories being advertised in the campaign, used to determine inventory eligibility.
advertiserId Dimension
The unique identifier for the advertiser account.
bid.baseBid Metric
The ideal amount, expressed in the campaign's currency, that you aim to pay per thousand impressions for your ad inventory.
bid.currencyCode Dimension
The currency code used for the bid amount at the ad group level.
bid.maxAverageCPM Metric
The maximum average Cost Per Mille (CPM) that the system optimizes towards for ad delivery over the campaign duration.
brandId Dimension
A unique identifier for the brand associated with the campaign or advertiser account.
budgetAmount Metric
The numerical value representing the budget allocated for a campaign flight or ad group.
budgetCaps Dimension
Container for budget limitation settings applied to a campaign or ad group, including amount, currency, and recurrence.
budgetCaps.amount Metric
The numerical value of the budget cap, which sets a daily or monthly spending limit for a campaign or ad group.
budgetCaps.currencyCode Dimension
The currency code for the budget cap amount.
budgetCaps.recurrenceTimePeriod Dimension
The time period for which the budget cap recurs, such as daily or monthly.
campaignId Dimension
A unique identifier for the Amazon DSP campaign.
country Dimension
The country associated with the campaign or creative, in ISO 3166-1 alpha-2 format.
createdDateTime Dimension
The date and time when the entity was created.
creationDate Dimension
The date when the campaign, ad group, or creative was initially created.
creationDateTime Dimension
The date and time when the entity was created.
creativeAssociationStatus Dimension
The overall moderation status of the creative association.
creativeRotationType Dimension
Determines how creatives are rotated within an ad group, such as randomly or weighted.
currency Dimension
The currency used for the advertiser's account or campaign.
deliveryStatus Dimension
The current status of the campaign or ad group's delivery, for example, 'ACTIVE', 'PAUSED', or 'ENABLED'.
endDate Dimension
The end date of the association or flight.
endDateTime Dimension
The date and time when the campaign or flight is scheduled to end.
fees Dimension
Fees represent various charges associated with advertising campaigns on Amazon DSP, including agency fees, Amazon audience fees, demand-side fees, third-party service fees, and managed services fees. These can be percentage-based or flat rates applied to the total budget.
fees.currencyCode Dimension
The currency code in which the fees are expressed.
fees.feeType Dimension
The type of fee applied, such as Amazon audience fees or third-party fees.
fees.feeValue Metric
The value of the fee, which can be a percentage or a flat amount.
fees.feeValueType Dimension
The type of value used for the fee, such as percentage or flat.
fees.thirdPartyProvider Dimension
The third-party provider associated with a specific fee.
flights Dimension
Defines the schedule for a campaign's delivery, including start and end dates, and associated budget.
flights.budgetAmount Metric
The budget allocated for a specific flight within a campaign.
flights.currencyCode Dimension
The currency code (e.g., 'USD', 'EUR') for the budget associated with a campaign flight.
flights.endDate Dimension
The end date of a specific flight within a campaign.
flights.endDateTime Dimension
The end date and time of a specific flight within a campaign.
flights.flightId Metric
A unique identifier for a specific flight within a campaign.
flights.name Dimension
The name or identifier for a specific flight period within a campaign.
flights.startDate Dimension
The start date of a specific flight within a campaign.
flights.startDateTime Dimension
The start date and time of a specific flight within a campaign.
frequencies.frequencyType Dimension
frequencyType defines how frequency capping is applied to an ad campaign or ad group. It indicates whether there is a limit on the number of times an ad is shown to a user or household (capped) or if there is no such limit (uncapped).
frequencies.levelType Dimension
The type of frequency cap applied, such as uncapped or custom.
frequencies.maxImpressions Metric
The maximum number of times an ad impression will be served to a single user within the defined time unit.
frequencies.timeUnit Dimension
The unit of time used for frequency capping, such as days or hours.
frequencies.timeUnitCount Metric
The number of time units for the frequency cap.
hostedType Dimension
Indicates whether the ad creative is hosted by Amazon or a third party.
inventoryType Dimension
The type of inventory where ads will be served, such as Display, Streaming TV, or Online Video.
language Dimension
The language used in the creative, in ISO_639-1 standard.
lastUpdatedDate Dimension
The date and time when the entity was last updated.
lastUpdatedDateTime Dimension
The date and time when the entity was last updated.
marketplaceId Metric
The identifier of the Amazon marketplace where the campaign is running (e.g., ATVPDKIKX0DER for Amazon.com).
name Dimension
The name of the campaign, ad group, or creative.
optimization.automateBidAllocation Dimension
Indicates whether bid allocation is automatically managed by Amazon DSP to optimize campaign performance.
optimization.automateBudgetAllocation Dimension
Indicates whether budget allocation is automatically managed by Amazon DSP to optimize campaign performance.
optimization.bidStrategy Dimension
The strategy employed for bidding within the campaign to achieve specific advertising goals.
optimization.flightBudgetRolloverSetting Dimension
This setting defines how any leftover budget from completed flights is handled, such as rolling over to the next flight or not.
optimization.flightBudgetRolloverSetting.rolloverStrategy Dimension
rolloverStrategy specifies how any unused budget from a completed flight is handled and allocated to subsequent flights within a campaign. Available strategies include not rolling over unused budget, rolling over unused budget from the most recently completed flight, or rolling over cumulative unused budget from all previous flights.
optimization.goalSetting.currencyCode Dimension
The currency code used for the goal setting of the campaign.
optimization.goalSetting.goal Dimension
The primary objective or goal set for the campaign (e.g., driving sales, increasing brand awareness).
optimization.goalSetting.kpi Dimension
The Key Performance Indicator (KPI) used to measure the success of the campaign's goal.
optimization.goalSetting.targetKpi Metric
The target Key Performance Indicator (KPI) value set for campaign optimization.
optimization.primaryInventoryTypes Dimension
The main types of inventory (e.g., display, video, audio) prioritized for campaign optimization.
pacing.catchUpBoostPercentage Metric
A deprecated field that previously allowed advertisers to increase ad delivery aggressiveness under 'Even' pacing, but is now ignored in ad delivery and replaced by Dynamic Catchup.
pacing.deliveryProfile Dimension
Determines how the system distributes budget and delivers impressions over the duration of the ad group's flight, with options like evenly, front-loaded, or ASAP.
profileId Metric
The identifier of the profile associated with the advertiser account.
startDate Dimension
The start date of the association or flight.
startDateTime Dimension
The date and time when the campaign or flight is scheduled to start.
state Dimension
The current state of the entity, e.g., 'ACTIVE', 'PAUSED', 'ENABLED'.
targetDetails.adInitiationTarget Dimension
Targeting settings related to the initiation of an ad.
targetDetails.adInitiationTarget.targetType Dimension
The specific type of target related to the initiation of an ad, used to define when or how an ad should start playing or displaying.
targetDetails.adInitiationTarget.videoInitiationType Dimension
Specifies the type of video ad initiation for targeting purposes, such as pre-roll, mid-roll, or post-roll.
targetDetails.adPlayerSizeTarget Dimension
Targeting settings based on the size of the ad player.
targetDetails.adPlayerSizeTarget.adPlayerSize Dimension
The size of the ad player for targeting purposes.
targetDetails.adPlayerSizeTarget.targetType Dimension
The type of targeting, specifically for ad player size.
targetDetails.appTarget Dimension
Targeting settings related to specific mobile applications.
targetDetails.audienceTarget Dimension
Defines targets based on specific audiences, which can be Amazon-created, custom-built, or from a third-party data provider.
targetDetails.audienceTarget.acrossGroupOperator Dimension
The operator used to join audience groups, such as ALL (AND logic).
targetDetails.audienceTarget.audienceId Metric
The unique identifier for an audience in audience targeting.
targetDetails.audienceTarget.groupId Metric
The group ID for an audience within audience targeting.
targetDetails.audienceTarget.inGroupOperator Dimension
The operator used to join audiences within a group, such as ANY (OR logic) or ALL (AND logic).
targetDetails.audienceTarget.targetType Dimension
The type of audience target, specifically AUDIENCE.
targetDetails.autoTarget Dimension
Configuration for automatically generated targeting expressions for an ad group.
targetDetails.autoTarget.matchType Dimension
The match type for auto-targeting, such as 'KEYWORDS_CLOSE_MATCH'.
targetDetails.autoTarget.targetType Dimension
The type of auto-targeting applied, often represented as 'THEME' for automatically generated targets.
targetDetails.contentGenreTarget Dimension
Targeting settings based on the genre of the content.
targetDetails.contentInstreamPositionTarget Dimension
Defines targeting for ads placed within video content streams (in-stream), specifying criteria for their position relative to the main video content.
targetDetails.contentOutstreamPositionTarget Dimension
Defines targeting for ads placed outside of video content streams (out-stream), specifying criteria for their position within general web content.
targetDetails.contentOutstreamPositionTarget.targetType Dimension
This field specifies the type of targeting applied to the content outstream position. Content outstream position targeting allows advertisers to control where their ads appear within video content outside of a video player, for instance, in articles or interstitial spaces.
targetDetails.contentRatingTarget Dimension
Specifies content rating criteria for targeting, allowing ads to appear on or avoid content based on its rating.
targetDetails.dayPartTarget Dimension
Targeting settings based on specific days of the week and times of the day.
targetDetails.dayPartTarget.dayOfWeek Dimension
The specific day of the week included in the day part targeting for the ad group.
targetDetails.dayPartTarget.hourSlot Dimension
The specific hour slot included in the day part targeting for the ad group.
targetDetails.dayPartTarget.targetType Dimension
The type of day part target being applied.
targetDetails.deviceTarget Dimension
Targeting settings based on device types or operating systems.
targetDetails.domainTarget Dimension
Defines targets based on specific site domains for inclusion or exclusion.
targetDetails.domainTarget.domainTargetDetails Dimension
Details for domain-based targeting, including specific domain names for inclusion or exclusion.
targetDetails.domainTarget.targetType Dimension
The type of domain targeting being applied, which is 'DOMAIN'.
targetDetails.iabCategoryTarget Dimension
Targets ads based on Interactive Advertising Bureau (IAB) content categories, which classify the content of web pages.
targetDetails.inventorySourceTarget Dimension
Targeting that specifies the inventory sources or exchanges where ads should be shown. By default, all eligible inventory sources are included.
targetDetails.inventorySourceTarget.inventorySourceId Metric
The unique identifier for an inventory source used in targeting, defining where ad placements are sourced.
targetDetails.inventorySourceTarget.inventorySourceType Dimension
The type or category of the inventory source used in targeting, such as an ad exchange or a specific publisher.
targetDetails.inventorySourceTarget.targetType Dimension
The specific type of targeting applied to an inventory source, categorizing the nature of the inventory being included or excluded.
targetDetails.keywordTarget Dimension
Targeting settings based on specific keywords.
targetDetails.locationTarget Dimension
This field specifies geographical targeting criteria, allowing advertisers to reach audiences in particular countries, states, postal codes, Designated Market Areas (DMAs), or cities.
targetDetails.nativeContentPositionTarget Dimension
This field defines targeting based on the position of an ad within native content, influencing where ads appear in a native advertising context.
targetDetails.onScreenPositionTarget Dimension
Targets ads based on their on-screen position, such as above or below the fold.
targetDetails.productCategoryTarget Dimension
A type of contextual targeting using ASIN categories.
targetDetails.productCategoryTarget.asinCategory Metric
A specific Amazon Standard Identification Number (ASIN) category or browse node used for contextual targeting. This allows advertisers to target ads based on Amazon's retail product taxonomy.
targetDetails.productCategoryTarget.targetType Dimension
The type of targeting being applied to the ad group. When using product category targeting, this field indicates that the ad group is targeting a product category.
targetDetails.productTarget Dimension
This field specifies targeting criteria based on specific Amazon products (ASINs) or product categories (Browse Nodes), allowing ads to be shown alongside or in relation to particular product content.
targetDetails.productTarget.asin Dimension
The Amazon Standard Identification Number (ASIN) of the product to be targeted in Amazon DSP campaigns. Advertisers use ASINs to precisely target individual products for ad delivery.
targetDetails.productTarget.matchType Dimension
This field specifies the matching criteria for product targeting, defining whether the ad targets the exact ASIN specified or also includes similar products like substitutes or complements.
targetDetails.productTarget.targetType Dimension
This field indicates the specific type of targeting being used within the targetDetails object. For product targeting, its value would identify the target as product-based, differentiating it from other target types like audience or location.
targetDetails.thirdPartyTarget Dimension
Targeting based on segments provided by third-party data vendors.
targetDetails.thirdPartyTarget.targetType Dimension
The specific type of third-party target being used.
targetDetails.thirdPartyTarget.thirdPartyTargetDetails Dimension
Specific details for the third-party target segment.
targetDetails.videoAdFormatTarget Dimension
Defines targets based on video ad formats.
targetDetails.videoAdFormatTarget.targetType Dimension
The type of targeting, specifically for video ad format.
targetDetails.videoAdFormatTarget.videoAdFormat Dimension
The specific video ad format for targeting purposes.
targetId Dimension
This field represents the unique identifier assigned to a specific target within the Amazon DSP API, used for managing (creating, reading, updating, or deleting) targeting configurations.
targetingSettings.amazonViewability.includeUnmeasurableImpressions Dimension
Indicates whether to include impressions that cannot be measured for viewability.
targetingSettings.amazonViewability.viewabilityTier Dimension
The Amazon viewability tier used for targeting.
targetingSettings.automatedTargetingTactic Dimension
The automated targeting tactic applied, such as remarketing, to optimize ad delivery.
targetingSettings.enableLanguageTargeting Dimension
A boolean indicator to enable or disable language-based targeting for an ad group.
targetingSettings.siteLanguage Dimension
This setting specifies the language of the content where ads will be served.
targetingSettings.tacticsConvertersExclusionType Dimension
The criteria used to exclude audiences based on past purchases, varying by tactic and conversion type.
targetingSettings.timeZoneType Dimension
Specifies the time zone used for ad group delivery, such as the viewer's time zone or the advertiser's region.
targetingSettings.userLocation Dimension
The geographical location type of users targeted by the ad group.
targetingSettings.userLocationSignal Dimension
The type of signal utilized to determine the user's geographical location for targeting purposes.
targetsAmazonDeal Dimension
Indicates whether the campaign or ad group targets specific Amazon advertising deals, such as programmatic guaranteed deals, to place ads through the Amazon DSP platform.
timezone Dimension
The timezone associated with the advertiser account or for reporting purposes.
url Dimension
The URL associated with the advertiser's website or the ad creative's click-through destination.