Skip to content
Book a demo

Connect documentation

All documentation
Documentation

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.

FieldAdverity UI nameType
accessibilityTextDimension

Accessible names that are labels given to HTML elements for assistive technologies like screen readers.

adChoicesPositionDimension

The position where the AdChoices icon is displayed on the ad creative, e.g., 'BOTTOM_LEFT', 'TOP_RIGHT'.

adCreativeCategoriesDimension

A list of categories that describe the content or nature of the ad creative.

adCreativeFormatProperties.adCopyDimension

The ad copy details, including its type and value, used in the creative.

adCreativeFormatProperties.adCopy.typeDimension

The type of ad copy, such as 'BODY' for the main text content.

adCreativeFormatProperties.adCopy.valueDimension

The actual text content of the ad copy.

adCreativeFormatProperties.adCreativeFormatTypeDimension

The format type of the ad creative, e.g., 'DISPLAY', 'VIDEO', 'AUDIO', 'THIRD_PARTY', or 'COMPONENT'.

adCreativeFormatProperties.additionalAttributesDimension

Additional attributes and settings specific to the ad creative's format.

adCreativeFormatProperties.additionalAttributes.allowCbcDriveTrafficToVideoDimension

A flag that indicates whether Cost-Based Campaigns (CBC) are permitted to drive traffic to video content within the ad creative.

adCreativeFormatProperties.additionalAttributes.allowThirdPartySellersDimension

Indicates whether third-party sellers are allowed for the ad creative.

adCreativeFormatProperties.additionalAttributes.allowedRetailFormatsDimension

Specifies the retail formats permitted for the ad creative.

adCreativeFormatProperties.additionalAttributes.creativeContentTypeDimension

The content type of the ad creative.

adCreativeFormatProperties.additionalAttributes.optimizationGoalDimension

The optimization goal set for the ad creative, influencing how it is delivered for performance.

adCreativeFormatProperties.additionalAttributes.renderOptimizationsDimension

Additional attributes related to how the ad creative is rendered to optimize its display.

adCreativeFormatProperties.additionalAttributes.targetPlacementsDimension

Specifies the intended placements for the ad creative, such as above or below the fold, or in-feed.

adCreativeFormatProperties.assetsDimension

A collection of assets, such as images or videos, used in the ad creative.

adCreativeFormatProperties.assets.applyBorderDimension

Indicates whether a border should be applied to the creative asset.

adCreativeFormatProperties.assets.assetCroppingCoordinatesDimension

The coordinates used to define how an asset (like an image) within the ad creative should be cropped.

adCreativeFormatProperties.assets.assetIdDimension

The unique identifier of the asset used in the ad creative.

adCreativeFormatProperties.assets.assetTypeDimension

The type of creative asset, such as 'IMAGE' or 'VIDEO'.

adCreativeFormatProperties.assets.assetVersionDimension

The version of the asset.

adCreativeFormatProperties.assets.associatedAdExperienceDimension

The ad experience associated with the asset.

adCreativeFormatProperties.assets.urlDimension

The URL of the asset used in the ad creative.

adCreativeFormatProperties.clickActionsDimension

Defines the actions that occur when the ad creative is clicked.

adCreativeFormatProperties.clickActions.associatedAdExperienceDimension

The ad experience associated with the click action.

adCreativeFormatProperties.clickActions.clickActionTypeDimension

The type of action performed on click, e.g., navigating to a URL.

adCreativeFormatProperties.clickActions.endCardDimension

Describes the properties of the end card displayed as part of the ad creative's click actions, typically appearing at the conclusion of an interactive ad experience.

adCreativeFormatProperties.clickActions.panelsDimension

Describes the properties of interactive panels or sections within the ad creative that respond to user clicks, defining their behavior and content.

adCreativeFormatProperties.clickActions.positionDimension

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.urlDestinationDimension

The URL to which the user is directed when the ad is clicked.

adCreativeFormatProperties.creativeSizesDimension

The dimensions and responsiveness settings for the ad creative.

adCreativeFormatProperties.creativeSizes.heightMetric

The height of the creative size in pixels.

adCreativeFormatProperties.creativeSizes.responsiveDimension

Indicates whether the creative size is responsive.

adCreativeFormatProperties.creativeSizes.widthMetric

The width of the creative size in pixels.

adCreativeFormatProperties.interactivityDimension

Contains properties related to interactive elements within the ad creative, enabling user engagement beyond simple clicks.

adCreativeFormatProperties.interactivity.interactivityTypeDimension

Specifies the type of interactive experience offered by the ad creative, such as polls, quizzes, or expandable content.

adCreativeFormatProperties.interactivity.positionDimension

Indicates the placement or coordinates of the interactive element within the ad creative's display area.

adCreativeFormatProperties.interactivity.urlDestinationDimension

The URL where the user is directed upon interacting with the interactive element of the ad creative.

adCreativeFormatProperties.optimizationConfigurationDimension

Configures settings for optimizing the ad creative's performance, such as dynamic creative optimization rules or asset rotation strategies.

adCreativeFormatProperties.optimizationConfiguration.enableRenderOptimizationsDimension

A boolean flag indicating whether render optimizations are enabled for the ad creative, influencing how the creative is displayed for improved performance.

adCreativeFormatProperties.productsDimension

A list of products associated with the ad creative, including their details.

adCreativeFormatProperties.products.productIdDimension

The unique identifier of the product associated with the ad creative.

adCreativeFormatProperties.products.productTitleDimension

The title of the product associated with the ad creative.

adCreativeFormatProperties.products.productTypeDimension

The type of product, e.g., 'ASIN'.

adCreativeFormatProperties.products.reviewTextDimension

The review text for the product associated with the ad creative.

adCreativeFormatProperties.products.reviewUrlDimension

The URL for the product review associated with the ad creative.

adCreativeFormatProperties.skippabilitySettingsDimension

Settings that define whether an ad creative can be skipped by the viewer.

adCreativeFormatProperties.skippabilitySettings.skippableTypeDimension

The specific type of skippability for an ad creative, defining if and how a user can skip the ad.

adCreativeFormatProperties.thirdPartyTagDimension

Details for third-party ad tags used in the creative.

adCreativeFormatProperties.thirdPartyTag.destinationOnAmazonDimension

Indicates whether the third-party tag links to an Amazon site (AMAZON) or an external site (OTHER).

adCreativeFormatProperties.thirdPartyTag.tagSourceDimension

The URL or content of the third-party creative tag, such as a VAST tag URL.

adCreativeFormatProperties.thirdPartyTag.tagTypeDimension

The type of third-party tag used in the ad creative, for example, VAST_VPAID.

adCreativeFormatProperties.trackingUrlsDimension

A list of tracking URLs used for monitoring ad performance.

adCreativeFormatProperties.trackingUrls.associatedAdExperienceDimension

The ad experience associated with the tracking URL.

adCreativeFormatProperties.trackingUrls.typeDimension

The type of tracking URL, such as 'CLICK' for click-through tracking.

adCreativeFormatProperties.trackingUrls.urlDimension

The URL used for tracking ad events.

adCreativeFormatProperties.universalAdIdsDimension

Universal identifiers associated with the ad creative, used for consistent identification across various platforms and systems.

adCreativeIdMetric

The unique identifier for the ad creative.

adCreativeNameDimension

The name of the ad creative.

adExperiencesDimension

A collection of ad experiences, representing rendered views of a creative for specific contexts.

adExperiences.adExperienceDimension

The specific ad experience, representing a rendered view of the creative.

adExperiences.associationModerationStatusDimension

The moderation status of the ad experience association.

adGroupIdDimension

The unique identifier for the ad group.

adProductDimension

The advertising product associated with the entity, e.g., 'AMAZON_DSP'.

additionalHtmlDimension

Additional HTML content to be added to the creative for surveys or other supplemental purposes.

advertisedProductCategoryIdsDimension

A list of identifiers for the product categories being advertised in the campaign, used to determine inventory eligibility.

advertiserIdDimension

The unique identifier for the advertiser account.

bid.baseBidMetric

The ideal amount, expressed in the campaign's currency, that you aim to pay per thousand impressions for your ad inventory.

bid.currencyCodeDimension

The currency code used for the bid amount at the ad group level.

bid.maxAverageCPMMetric

The maximum average Cost Per Mille (CPM) that the system optimizes towards for ad delivery over the campaign duration.

brandIdDimension

A unique identifier for the brand associated with the campaign or advertiser account.

budgetAmountMetric

The numerical value representing the budget allocated for a campaign flight or ad group.

budgetCapsDimension

Container for budget limitation settings applied to a campaign or ad group, including amount, currency, and recurrence.

budgetCaps.amountMetric

The numerical value of the budget cap, which sets a daily or monthly spending limit for a campaign or ad group.

budgetCaps.currencyCodeDimension

The currency code for the budget cap amount.

budgetCaps.recurrenceTimePeriodDimension

The time period for which the budget cap recurs, such as daily or monthly.

campaignIdDimension

A unique identifier for the Amazon DSP campaign.

countryDimension

The country associated with the campaign or creative, in ISO 3166-1 alpha-2 format.

createdDateTimeDimension

The date and time when the entity was created.

creationDateDimension

The date when the campaign, ad group, or creative was initially created.

creationDateTimeDimension

The date and time when the entity was created.

creativeAssociationStatusDimension

The overall moderation status of the creative association.

creativeRotationTypeDimension

Determines how creatives are rotated within an ad group, such as randomly or weighted.

currencyDimension

The currency used for the advertiser's account or campaign.

deliveryStatusDimension

The current status of the campaign or ad group's delivery, for example, 'ACTIVE', 'PAUSED', or 'ENABLED'.

endDateDimension

The end date of the association or flight.

endDateTimeDimension

The date and time when the campaign or flight is scheduled to end.

feesDimension

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.addToBudgetSpentAmountDimension

The monetary amount of a specific fee that is added to the total budget spent for an ad group.

fees.currencyCodeDimension

The currency code in which the fees are expressed.

fees.feeTypeDimension

The type of fee applied, such as Amazon audience fees or third-party fees.

fees.feeValueMetric

The monetary value associated with a specific fee.

fees.feeValueTypeDimension

The type of value used for the fee, such as a percentage or a flat amount.

fees.thirdPartyProviderDimension

The third-party provider associated with a specific fee.

flightsDimension

Defines the schedule for a campaign's delivery, including start and end dates, and associated budget.

flights.budgetAmountMetric

The budget allocated for a specific flight within a campaign.

flights.currencyCodeDimension

The currency code (e.g., 'USD', 'EUR') for the budget associated with a campaign flight.

flights.endDateDimension

The end date of a specific flight within a campaign.

flights.endDateTimeDimension

The end date and time of a specific flight within a campaign.

flights.flightIdMetric

A unique identifier for a specific flight within a campaign.

flights.nameDimension

The name or identifier for a specific flight period within a campaign.

flights.startDateDimension

The start date of a specific flight within a campaign.

flights.startDateTimeDimension

The start date and time of a specific flight within a campaign.

frequencies.frequencyTypeDimension

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.levelTypeDimension

The type of frequency cap applied, such as uncapped or custom.

frequencies.maxImpressionsMetric

The maximum number of times an ad impression will be served to a single user within the defined time unit.

frequencies.timeUnitDimension

The unit of time used for frequency capping, such as days or hours.

frequencies.timeUnitCountMetric

The number of time units for the frequency cap.

hostedTypeDimension

Indicates whether the ad creative is hosted by Amazon or a third party.

inventoryTypeDimension

The type of inventory where ads will be served, such as Display, Streaming TV, or Online Video.

languageDimension

The language used in the creative, in ISO_639-1 standard.

lastUpdatedDateDimension

The date and time when the entity was last updated.

lastUpdatedDateTimeDimension

The date and time when the entity was last updated.

marketplaceIdMetric

The identifier of the Amazon marketplace where the campaign is running (e.g., ATVPDKIKX0DER for Amazon.com).

nameDimension

The name of the campaign, ad group, or creative.

optimization.automateBidAllocationDimension

Indicates whether bid allocation is automatically managed by Amazon DSP to optimize campaign performance.

optimization.automateBudgetAllocationDimension

Indicates whether budget allocation is automatically managed by Amazon DSP to optimize campaign performance.

optimization.bidStrategyDimension

The strategy employed for bidding within the campaign to achieve specific advertising goals.

optimization.flightBudgetRolloverSettingDimension

This setting defines how any leftover budget from completed flights is handled, such as rolling over to the next flight or not.

optimization.flightBudgetRolloverSetting.rolloverStrategyDimension

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.currencyCodeDimension

The currency code used for the goal setting of the campaign.

optimization.goalSetting.goalDimension

The primary objective or goal set for the campaign (e.g., driving sales, increasing brand awareness).

optimization.goalSetting.kpiDimension

The Key Performance Indicator (KPI) used to measure the success of the campaign's goal.

optimization.goalSetting.targetKpiMetric

The target Key Performance Indicator (KPI) value set for campaign optimization.

optimization.primaryInventoryTypesDimension

The main types of inventory (e.g., display, video, audio) prioritized for campaign optimization.

pacing.catchUpBoostPercentageMetric

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.deliveryProfileDimension

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.

profileIdDimension

The identifier of the profile associated with the advertiser account.

startDateDimension

The start date of the association or flight.

startDateTimeDimension

The date and time when the campaign or flight is scheduled to start.

stateDimension

The current state of the entity, e.g., 'ACTIVE', 'PAUSED', 'ENABLED'.

targetDetails.adInitiationTargetDimension

Targeting settings related to the initiation of an ad.

targetDetails.adInitiationTarget.targetTypeDimension

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.videoInitiationTypeDimension

Specifies the type of video ad initiation for targeting purposes, such as pre-roll, mid-roll, or post-roll.

targetDetails.adPlayerSizeTargetDimension

Targeting settings based on the size of the ad player.

targetDetails.adPlayerSizeTarget.adPlayerSizeDimension

The size of the ad player for targeting purposes.

targetDetails.adPlayerSizeTarget.targetTypeDimension

The type of targeting, specifically for ad player size.

targetDetails.appTargetDimension

Targeting settings related to specific mobile applications.

targetDetails.audienceTargetDimension

Defines targets based on specific audiences, which can be Amazon-created, custom-built, or from a third-party data provider.

targetDetails.audienceTarget.acrossGroupOperatorDimension

The operator used to join audience groups, such as ALL (AND logic).

targetDetails.audienceTarget.audienceIdMetric

The unique identifier for an audience in audience targeting.

targetDetails.audienceTarget.groupIdMetric

The group ID for an audience within audience targeting.

targetDetails.audienceTarget.inGroupOperatorDimension

The operator used to join audiences within a group, such as ANY (OR logic) or ALL (AND logic).

targetDetails.audienceTarget.targetTypeDimension

The type of audience target, specifically AUDIENCE.

targetDetails.autoTargetDimension

Configuration for automatically generated targeting expressions for an ad group.

targetDetails.autoTarget.matchTypeDimension

The match type for auto-targeting, such as 'KEYWORDS_CLOSE_MATCH'.

targetDetails.autoTarget.targetTypeDimension

The type of auto-targeting applied, often represented as 'THEME' for automatically generated targets.

targetDetails.contentGenreTargetDimension

Targeting settings based on the genre of the content.

targetDetails.contentInstreamPositionTargetDimension

Defines targeting for ads placed within video content streams (in-stream), specifying criteria for their position relative to the main video content.

targetDetails.contentOutstreamPositionTargetDimension

Defines targeting for ads placed outside of video content streams (out-stream), specifying criteria for their position within general web content.

targetDetails.contentOutstreamPositionTarget.targetTypeDimension

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.contentRatingTargetDimension

Specifies content rating criteria for targeting, allowing ads to appear on or avoid content based on its rating.

targetDetails.dayPartTargetDimension

Targeting settings based on specific days of the week and times of the day.

targetDetails.dayPartTarget.dayOfWeekDimension

The specific day of the week included in the day part targeting for the ad group.

targetDetails.dayPartTarget.hourSlotDimension

The specific hour slot included in the day part targeting for the ad group.

targetDetails.dayPartTarget.targetTypeDimension

The type of day part target being applied.

targetDetails.deviceTargetDimension

Targeting settings based on device types or operating systems.

targetDetails.domainTargetDimension

Defines targets based on specific site domains for inclusion or exclusion.

targetDetails.domainTarget.domainTargetDetailsDimension

Details for domain-based targeting, including specific domain names for inclusion or exclusion.

targetDetails.domainTarget.targetTypeDimension

The type of domain targeting being applied, which is 'DOMAIN'.

targetDetails.iabCategoryTargetDimension

Targets ads based on Interactive Advertising Bureau (IAB) content categories, which classify the content of web pages.

targetDetails.inventorySourceTargetDimension

Targeting that specifies the inventory sources or exchanges where ads should be shown. By default, all eligible inventory sources are included.

targetDetails.inventorySourceTarget.inventorySourceIdMetric

The unique identifier for an inventory source used in targeting, defining where ad placements are sourced.

targetDetails.inventorySourceTarget.inventorySourceTypeDimension

The type or category of the inventory source used in targeting, such as an ad exchange or a specific publisher.

targetDetails.inventorySourceTarget.targetTypeDimension

The specific type of targeting applied to an inventory source, categorizing the nature of the inventory being included or excluded.

targetDetails.keywordTargetDimension

Targeting settings based on specific keywords.

targetDetails.locationTargetDimension

This field specifies geographical targeting criteria, allowing advertisers to reach audiences in particular countries, states, postal codes, Designated Market Areas (DMAs), or cities.

targetDetails.nativeContentPositionTargetDimension

This field defines targeting based on the position of an ad within native content, influencing where ads appear in a native advertising context.

targetDetails.onScreenPositionTargetDimension

Targets ads based on their on-screen position, such as above or below the fold.

targetDetails.productCategoryTargetDimension

A type of contextual targeting using ASIN categories.

targetDetails.productCategoryTarget.asinCategoryMetric

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.targetTypeDimension

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.productTargetDimension

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.asinDimension

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.matchTypeDimension

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.targetTypeDimension

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.thirdPartyTargetDimension

Targeting based on segments provided by third-party data vendors.

targetDetails.thirdPartyTarget.targetTypeDimension

The specific type of third-party target being used.

targetDetails.thirdPartyTarget.thirdPartyTargetDetailsDimension

Specific details for the third-party target segment.

targetDetails.videoAdFormatTargetDimension

Defines targets based on video ad formats.

targetDetails.videoAdFormatTarget.targetTypeDimension

The type of targeting, specifically for video ad format.

targetDetails.videoAdFormatTarget.videoAdFormatDimension

The specific video ad format for targeting purposes.

targetIdDimension

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.includeUnmeasurableImpressionsDimension

Indicates whether to include impressions that cannot be measured for viewability.

targetingSettings.amazonViewability.viewabilityTierDimension

The Amazon viewability tier used for targeting.

targetingSettings.automatedTargetingTacticDimension

The automated targeting tactic applied, such as remarketing, to optimize ad delivery.

targetingSettings.defaultAudienceTargetingMatchTypeDimension

The default match type applied to audience targeting within an ad group, such as 'EXACT' match.

targetingSettings.enableLanguageTargetingDimension

A boolean indicator to enable or disable language-based targeting for an ad group.

targetingSettings.tacticsConvertersExclusionTypeDimension

The criteria used to exclude audiences based on past purchases, varying by tactic and conversion type.

targetingSettings.timeZoneTypeDimension

Specifies the time zone used for ad group delivery, such as the viewer's time zone or the advertiser's region.

targetingSettings.userLocationDimension

The geographical location type of users targeted by the ad group.

targetingSettings.userLocationSignalDimension

The type of signal utilized to determine the user's geographical location for targeting purposes.

targetingSettings.videoCompletionTierDimension

The video completion tier specifies a targeting setting for video ads, indicating the minimum percentage of video playback that needs to be completed for an impression to count.

targetsAmazonDealDimension

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.

timezoneDimension

The timezone associated with the advertiser account or for reporting purposes.

urlDimension

The URL associated with the advertiser's website or the ad creative's click-through destination.