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.

API name	Adverity UI name	Description	Use in Adverity
accessibilityText	accessibilityText	Accessible names that are labels given to HTML elements for assistive technologies like screen readers.	dimension
adChoicesPosition	adChoicesPosition	The position where the AdChoices icon is displayed on the ad creative, e.g., ‘BOTTOM_LEFT’, ‘TOP_RIGHT’.	dimension
adCreativeCategories	adCreativeCategories	A list of categories that describe the content or nature of the ad creative.	dimension
adCreativeFormatProperties.adCopy	adCreativeFormatProperties.adCopy	The ad copy details, including its type and value, used in the creative.	dimension
adCreativeFormatProperties.adCopy.type	adCreativeFormatProperties.adCopy.type	The type of ad copy, such as ‘BODY’ for the main text content.	dimension
adCreativeFormatProperties.adCopy.value	adCreativeFormatProperties.adCopy.value	The actual text content of the ad copy.	dimension
adCreativeFormatProperties.adCreativeFormatType	adCreativeFormatProperties.adCreativeFormatType	The format type of the ad creative, e.g., ‘DISPLAY’, ‘VIDEO’, ‘AUDIO’, ‘THIRD_PARTY’, or ‘COMPONENT’.	dimension
adCreativeFormatProperties.additionalAttributes	adCreativeFormatProperties.additionalAttributes	Additional attributes and settings specific to the ad creative’s format.	dimension
adCreativeFormatProperties.additionalAttributes.allowThirdPartySellers	adCreativeFormatProperties.additionalAttributes.allowThirdPartySellers		dimension
adCreativeFormatProperties.additionalAttributes.allowedRetailFormats	adCreativeFormatProperties.additionalAttributes.allowedRetailFormats		dimension
adCreativeFormatProperties.additionalAttributes.creativeContentType	adCreativeFormatProperties.additionalAttributes.creativeContentType		dimension
adCreativeFormatProperties.additionalAttributes.optimizationGoal	adCreativeFormatProperties.additionalAttributes.optimizationGoal		dimension
adCreativeFormatProperties.additionalAttributes.renderOptimizations	adCreativeFormatProperties.additionalAttributes.renderOptimizations		dimension
adCreativeFormatProperties.additionalAttributes.targetPlacements	adCreativeFormatProperties.additionalAttributes.targetPlacements		dimension
adCreativeFormatProperties.assets	adCreativeFormatProperties.assets	A collection of assets, such as images or videos, used in the ad creative.	dimension
adCreativeFormatProperties.assets.applyBorder	adCreativeFormatProperties.assets.applyBorder	Indicates whether a border should be applied to the creative asset.	dimension
adCreativeFormatProperties.assets.assetId	adCreativeFormatProperties.assets.assetId	The unique identifier of the asset used in the ad creative.	dimension
adCreativeFormatProperties.assets.assetType	adCreativeFormatProperties.assets.assetType		dimension
adCreativeFormatProperties.assets.assetVersion	adCreativeFormatProperties.assets.assetVersion	The version of the asset.	dimension
adCreativeFormatProperties.assets.associatedAdExperience	adCreativeFormatProperties.assets.associatedAdExperience	The ad experience associated with the asset.	dimension
adCreativeFormatProperties.assets.url	adCreativeFormatProperties.assets.url	The URL of the asset used in the ad creative.	dimension
adCreativeFormatProperties.clickActions	adCreativeFormatProperties.clickActions	Defines the actions that occur when the ad creative is clicked.	dimension
adCreativeFormatProperties.clickActions.associatedAdExperience	adCreativeFormatProperties.clickActions.associatedAdExperience	The ad experience associated with the click action.	dimension
adCreativeFormatProperties.clickActions.clickActionType	adCreativeFormatProperties.clickActions.clickActionType	The type of action performed on click, e.g., navigating to a URL.	dimension
adCreativeFormatProperties.clickActions.position	adCreativeFormatProperties.clickActions.position		dimension
adCreativeFormatProperties.clickActions.urlDestination	adCreativeFormatProperties.clickActions.urlDestination	The URL to which the user is directed when the ad is clicked.	dimension
adCreativeFormatProperties.creativeSizes	adCreativeFormatProperties.creativeSizes	The dimensions and responsiveness settings for the ad creative.	dimension
adCreativeFormatProperties.creativeSizes.height	adCreativeFormatProperties.creativeSizes.height	The height of the creative size in pixels.	metric
adCreativeFormatProperties.creativeSizes.responsive	adCreativeFormatProperties.creativeSizes.responsive	Indicates whether the creative size is responsive.	dimension
adCreativeFormatProperties.creativeSizes.width	adCreativeFormatProperties.creativeSizes.width	The width of the creative size in pixels.	metric
adCreativeFormatProperties.products	adCreativeFormatProperties.products	A list of products associated with the ad creative, including their details.	dimension
adCreativeFormatProperties.products.productId	adCreativeFormatProperties.products.productId	The unique identifier of the product associated with the ad creative.	dimension
adCreativeFormatProperties.products.productTitle	adCreativeFormatProperties.products.productTitle	The title of the product associated with the ad creative.	dimension
adCreativeFormatProperties.products.productType	adCreativeFormatProperties.products.productType	The type of product, e.g., ‘ASIN’.	dimension
adCreativeFormatProperties.products.reviewText	adCreativeFormatProperties.products.reviewText	The review text for the product associated with the ad creative.	dimension
adCreativeFormatProperties.products.reviewUrl	adCreativeFormatProperties.products.reviewUrl	The URL for the product review associated with the ad creative.	dimension
adCreativeFormatProperties.skippabilitySettings	adCreativeFormatProperties.skippabilitySettings		dimension
adCreativeFormatProperties.skippabilitySettings.skippableType	adCreativeFormatProperties.skippabilitySettings.skippableType		dimension
adCreativeFormatProperties.thirdPartyTag	adCreativeFormatProperties.thirdPartyTag	Details for third-party ad tags used in the creative.	dimension
adCreativeFormatProperties.thirdPartyTag.destinationOnAmazon	adCreativeFormatProperties.thirdPartyTag.destinationOnAmazon		dimension
adCreativeFormatProperties.thirdPartyTag.tagSource	adCreativeFormatProperties.thirdPartyTag.tagSource		dimension
adCreativeFormatProperties.thirdPartyTag.tagType	adCreativeFormatProperties.thirdPartyTag.tagType		dimension
adCreativeFormatProperties.trackingUrls	adCreativeFormatProperties.trackingUrls	A list of tracking URLs used for monitoring ad performance.	dimension
adCreativeFormatProperties.trackingUrls.associatedAdExperience	adCreativeFormatProperties.trackingUrls.associatedAdExperience	The ad experience associated with the tracking URL.	dimension
adCreativeFormatProperties.trackingUrls.type	adCreativeFormatProperties.trackingUrls.type	The type of tracking URL, such as ‘CLICK’ for click-through tracking.	dimension
adCreativeFormatProperties.trackingUrls.url	adCreativeFormatProperties.trackingUrls.url	The URL used for tracking ad events.	dimension
adCreativeFormatProperties.universalAdIds	adCreativeFormatProperties.universalAdIds		dimension
adCreativeId	adCreativeId	The unique identifier for the ad creative.	metric
adCreativeName	adCreativeName	The name of the ad creative.	dimension
adExperiences	adExperiences	A collection of ad experiences, representing rendered views of a creative for specific contexts.	dimension
adExperiences.adExperience	adExperiences.adExperience	The specific ad experience, representing a rendered view of the creative.	dimension
adExperiences.associationModerationStatus	adExperiences.associationModerationStatus	The moderation status of the ad experience association.	dimension
adGroupId	adGroupId	The unique identifier for the ad group.	metric
adProduct	adProduct	The advertising product associated with the entity, e.g., ‘AMAZON_DSP’.	dimension
ad_choices_position	ad_choices_position	The position where the AdChoices icon is displayed on the ad creative, e.g., ‘BOTTOM_LEFT’, ‘TOP_RIGHT’.	dimension
ad_creative_asset_id	ad_creative_asset_id	The unique identifier of the asset used in the ad creative.	dimension
ad_creative_asset_version	ad_creative_asset_version	The version of the asset used in the ad creative.	dimension
ad_creative_assets	ad_creative_assets	A collection of assets used in the ad creative, such as images or videos.	dimension
ad_creative_assets_apply_border	ad_creative_assets_apply_border	Indicates whether a border should be applied to the creative asset.	dimension
ad_creative_attributes	ad_creative_attributes	A list of attributes describing the ad creative’s characteristics or capabilities.	dimension
ad_creative_click_action_type	ad_creative_click_action_type	The type of action performed on click for the ad creative, e.g., navigating to a URL.	dimension
ad_creative_click_actions	ad_creative_click_actions	Defines the actions that occur when the ad creative is clicked.	dimension
ad_creative_click_actions_associated_ad_experience	ad_creative_click_actions_associated_ad_experience	The ad experience associated with the ad creative’s click action.	dimension
ad_creative_click_actions_url_destination	ad_creative_click_actions_url_destination	The URL destination for the ad creative’s click action.	dimension
ad_creative_creative_sizes	ad_creative_creative_sizes	The dimensions and responsiveness settings for the ad creative.	dimension
ad_creative_creative_sizes_height	ad_creative_creative_sizes_height	The height of the ad creative size in pixels.	metric
ad_creative_creative_sizes_responsive	ad_creative_creative_sizes_responsive	Indicates whether the ad creative size is responsive.	dimension
ad_creative_creative_sizes_width	ad_creative_creative_sizes_width	The width of the ad creative size in pixels.	metric
ad_creative_format_type	ad_creative_format_type	The format type of the ad creative, e.g., ‘DISPLAY’, ‘VIDEO’.	dimension
ad_creative_id	ad_creative_id	The unique identifier for the ad creative.	dimension
ad_creative_skippability_settings	ad_creative_skippability_settings		dimension
ad_creative_skippable_type	ad_creative_skippable_type		dimension
ad_creative_third_party_tag	ad_creative_third_party_tag	Details for third-party ad tags used in the creative.	dimension
ad_creative_third_party_tag_destination_on_amazon	ad_creative_third_party_tag_destination_on_amazon		dimension
ad_creative_third_party_tag_tag_source	ad_creative_third_party_tag_tag_source		dimension
ad_creative_third_party_tag_tag_type	ad_creative_third_party_tag_tag_type		dimension
ad_creative_tracking_urls	ad_creative_tracking_urls	A list of tracking URLs used for monitoring ad creative performance.	dimension
ad_creative_tracking_urls_associated_ad_experience	ad_creative_tracking_urls_associated_ad_experience	The ad experience associated with the tracking URL for the ad creative.	dimension
ad_creative_tracking_urls_type	ad_creative_tracking_urls_type	The type of tracking URL for the ad creative, such as ‘CLICK’.	dimension
ad_creative_tracking_urls_url	ad_creative_tracking_urls_url	The URL used for tracking ad creative events.	dimension
additionalHtml	additionalHtml	Additional HTML content to be added to the creative for surveys or other supplemental purposes.	dimension
advertisedProductCategoryIds	advertisedProductCategoryIds	A list of identifiers for the product categories being advertised in the ad group.	dimension
advertiserId	advertiserId	The unique identifier for the advertiser account.	metric
advertiser_id	advertiser_id	The unique identifier for the advertiser account.	dimension
bid.baseBid	bid.baseBid	The base bid amount for the ad group.	metric
bid.currencyCode	bid.currencyCode	The currency code for the bid amount, e.g., ‘USD’, ‘EUR’.	dimension
bid.maxAverageCPM	bid.maxAverageCPM	The maximum average cost per mille (CPM) for the ad group.	metric
budgetAmount	budgetAmount	The total budget amount allocated.	metric
budgetCaps	budgetCaps	A list of budget caps with their amounts, recurrence periods, and currency codes.	dimension
budgetCaps.amount	budgetCaps.amount	The amount of the budget cap.	metric
budgetCaps.currencyCode	budgetCaps.currencyCode	The currency code for the budget cap amount.	dimension
budgetCaps.recurrenceTimePeriod	budgetCaps.recurrenceTimePeriod	The time period for the budget cap’s recurrence, e.g., ‘DAILY’.	dimension
campaignId	campaignId	The unique identifier for the campaign.	metric
country	country	The country associated with the campaign or creative, in ISO 3166-1 alpha-2 format.	dimension
createdDateTime	createdDateTime	The date and time when the entity was created.	dimension
created_datetime	created_datetime	The date and time when the entity was created.	dimension
creationDate	creationDate		dimension
creationDateTime	creationDateTime	The date and time when the entity was created.	dimension
creativeAssociationStatus	creativeAssociationStatus	The overall moderation status of the creative association.	dimension
creativeRotationType	creativeRotationType	The method used to rotate ad creatives within an ad group, e.g., ‘RANDOM’.	dimension
deliveryStatus	deliveryStatus	The current delivery status of the campaign or ad group.	dimension
endDate	endDate	The end date of the association or flight.	dimension
endDateTime	endDateTime	The date and time when the campaign, ad group, or flight is scheduled to end.	dimension
fees.addToBudgetSpentAmount	fees.addToBudgetSpentAmount	Indicates whether the fee amount should be added to the budget spent amount.	dimension
fees.currencyCode	fees.currencyCode	The currency code for the fee amount.	dimension
fees.feeType	fees.feeType	The type of fee, e.g., ‘THIRD_PARTY_APPLIED_FEE’ or ‘AMAZON_AUDIENCE_FEE’.	dimension
fees.feeValue	fees.feeValue	The value of the fee.	metric
fees.feeValueType	fees.feeValueType	The type of value for the fee, e.g., ‘FIXED_CPM’.	dimension
fees.thirdPartyProvider	fees.thirdPartyProvider	The third-party provider associated with the fee, e.g., ‘COM_SCORE’.	dimension
frequencies.frequencyType	frequencies.frequencyType	The type of frequency capping applied, e.g., ‘UNCAPPED’ or ‘CUSTOM’.	dimension
frequencies.levelType	frequencies.levelType	The level at which frequency capping is applied, e.g., ‘HOUSEHOLD’.	dimension
frequencies.maxImpressions	frequencies.maxImpressions	The maximum number of impressions allowed within the specified time unit.	metric
frequencies.timeUnit	frequencies.timeUnit	The unit of time for the frequency cap, e.g., ‘DAYS’.	dimension
frequencies.timeUnitCount	frequencies.timeUnitCount	The number of time units for the frequency cap.	metric
hostedType	hostedType	Indicates whether the ad creative is hosted by Amazon or a third party.	dimension
inventoryType	inventoryType	The type of inventory where the ad will be served, e.g., ‘DISPLAY’, ‘STREAMING_TV’, ‘ONLINE_VIDEO’.	dimension
language	language	The language used in the creative, in ISO_639-1 standard.	dimension
lastUpdatedDate	lastUpdatedDate		dimension
lastUpdatedDateTime	lastUpdatedDateTime	The date and time when the entity was last updated.	dimension
last_updated_date	last_updated_date		dimension
last_updated_datetime	last_updated_datetime	The date and time when the entity was last updated.	dimension
name	name	The name of the campaign, ad group, or creative.	dimension
optimization.automateBudgetAllocation	optimization.automateBudgetAllocation	Indicates whether budget allocation is automated by the system.	dimension
optimization.bidStrategy	optimization.bidStrategy	The bidding strategy used for optimization, e.g., ‘SPEND_BUDGET_IN_FULL’ or ‘PRIORITIZE_KPI_TARGET’.	dimension
pacing.catchUpBoostPercentage	pacing.catchUpBoostPercentage	The percentage to boost ad delivery to catch up on pacing targets, if behind schedule.	metric
pacing.deliveryProfile	pacing.deliveryProfile	The delivery profile for pacing ad spend, e.g., ‘EVEN’ for even distribution or ‘ASAP’ for accelerated delivery.	dimension
profileId	profileId	The identifier of the profile associated with the advertiser account.	metric
profile_id	profile_id	The identifier of the profile associated with the advertiser account.	dimension
startDate	startDate	The start date of the association or flight.	dimension
startDateTime	startDateTime	The date and time when the campaign, ad group, or flight is scheduled to start.	dimension
state	state	The current state of the entity, e.g., ‘ACTIVE’, ‘PAUSED’, ‘ENABLED’.	dimension
targetDetails.adInitiationTarget	targetDetails.adInitiationTarget	Targeting settings related to the initiation of an ad.	dimension
targetDetails.adPlayerSizeTarget	targetDetails.adPlayerSizeTarget	Targeting settings based on the size of the ad player.	dimension
targetDetails.adPlayerSizeTarget.adPlayerSize	targetDetails.adPlayerSizeTarget.adPlayerSize	The size of the ad player for targeting purposes.	dimension
targetDetails.adPlayerSizeTarget.targetType	targetDetails.adPlayerSizeTarget.targetType	The type of targeting, specifically for ad player size.	dimension
targetDetails.appTarget	targetDetails.appTarget	Targeting settings related to specific mobile applications.	dimension
targetDetails.audienceTarget	targetDetails.audienceTarget	Defines targets based on specific audiences, which can be Amazon-created, custom-built, or from a third-party data provider.	dimension
targetDetails.audienceTarget.acrossGroupOperator	targetDetails.audienceTarget.acrossGroupOperator	The operator used to join audience groups, such as ALL (AND logic).	dimension
targetDetails.audienceTarget.audienceId	targetDetails.audienceTarget.audienceId	The unique identifier for an audience in audience targeting.	metric
targetDetails.audienceTarget.groupId	targetDetails.audienceTarget.groupId	The group ID for an audience within audience targeting.	metric
targetDetails.audienceTarget.inGroupOperator	targetDetails.audienceTarget.inGroupOperator	The operator used to join audiences within a group, such as ANY (OR logic) or ALL (AND logic).	dimension
targetDetails.audienceTarget.targetType	targetDetails.audienceTarget.targetType	The type of audience target, specifically AUDIENCE.	dimension
targetDetails.autoTarget	targetDetails.autoTarget		dimension
targetDetails.autoTarget.matchType	targetDetails.autoTarget.matchType		dimension
targetDetails.autoTarget.targetType	targetDetails.autoTarget.targetType		dimension
targetDetails.contentGenreTarget	targetDetails.contentGenreTarget	Targeting settings based on the genre of the content.	dimension
targetDetails.contentInstreamPositionTarget	targetDetails.contentInstreamPositionTarget	Defines targeting for ads placed within video content streams (in-stream), specifying criteria for their position relative to the main video content.	dimension
targetDetails.contentOutstreamPositionTarget	targetDetails.contentOutstreamPositionTarget	Defines targeting for ads placed outside of video content streams (out-stream), specifying criteria for their position within general web content.	dimension
targetDetails.contentRatingTarget	targetDetails.contentRatingTarget	Specifies content rating criteria for targeting, allowing ads to appear on or avoid content based on its rating.	dimension
targetDetails.dayPartTarget	targetDetails.dayPartTarget	Targeting settings based on specific days of the week and times of the day.	dimension
targetDetails.deviceTarget	targetDetails.deviceTarget	Targeting settings based on device types or operating systems.	dimension
targetDetails.domainTarget	targetDetails.domainTarget	Defines targets based on specific site domains for inclusion or exclusion.	dimension
targetDetails.domainTarget.domainTargetDetails	targetDetails.domainTarget.domainTargetDetails	Details for domain-based targeting, including specific domain names for inclusion or exclusion.	dimension
targetDetails.domainTarget.targetType	targetDetails.domainTarget.targetType	The type of domain targeting being applied, which is ‘DOMAIN’.	dimension
targetDetails.iabCategoryTarget	targetDetails.iabCategoryTarget	Targeting settings based on Interactive Advertising Bureau (IAB) content categories.	dimension
targetDetails.inventorySourceTarget	targetDetails.inventorySourceTarget	Targeting that specifies the inventory sources or exchanges where ads should be shown. By default, all eligible inventory sources are included.	dimension
targetDetails.keywordTarget	targetDetails.keywordTarget	Targeting settings based on specific keywords.	dimension
targetDetails.locationTarget	targetDetails.locationTarget	This field specifies geographical targeting criteria, allowing advertisers to reach audiences in particular countries, states, postal codes, Designated Market Areas (DMAs), or cities.	dimension
targetDetails.nativeContentPositionTarget	targetDetails.nativeContentPositionTarget	This field defines targeting based on the position of an ad within native content, influencing where ads appear in a native advertising context.	dimension
targetDetails.onScreenPositionTarget	targetDetails.onScreenPositionTarget	This field enables targeting based on the ad’s position on the screen, such as above or below the fold. It influences whether an ad is immediately visible to the user without scrolling.	dimension
targetDetails.productCategoryTarget	targetDetails.productCategoryTarget	A type of contextual targeting using ASIN categories.	dimension
targetDetails.productCategoryTarget.asinCategory	targetDetails.productCategoryTarget.asinCategory	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.	metric
targetDetails.productCategoryTarget.targetType	targetDetails.productCategoryTarget.targetType	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.	dimension
targetDetails.productTarget	targetDetails.productTarget	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.	dimension
targetDetails.thirdPartyTarget	targetDetails.thirdPartyTarget	Targeting based on segments provided by third-party data vendors.	dimension
targetDetails.thirdPartyTarget.targetType	targetDetails.thirdPartyTarget.targetType	The specific type of third-party target being used.	dimension
targetDetails.thirdPartyTarget.thirdPartyTargetDetails	targetDetails.thirdPartyTarget.thirdPartyTargetDetails	Specific details for the third-party target segment.	dimension
targetDetails.videoAdFormatTarget	targetDetails.videoAdFormatTarget	Defines targets based on video ad formats.	dimension
targetDetails.videoAdFormatTarget.targetType	targetDetails.videoAdFormatTarget.targetType	The type of targeting, specifically for video ad format.	dimension
targetDetails.videoAdFormatTarget.videoAdFormat	targetDetails.videoAdFormatTarget.videoAdFormat	The specific video ad format for targeting purposes.	dimension
targetId	targetId	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.	dimension
targetingSettings.amazonViewability.includeUnmeasurableImpressions	targetingSettings.amazonViewability.includeUnmeasurableImpressions	Indicates whether unmeasurable impressions are included in Amazon Viewability targeting.	dimension
targetingSettings.amazonViewability.viewabilityTier	targetingSettings.amazonViewability.viewabilityTier	The viewability tier for Amazon Viewability targeting, e.g., ‘ALL_TIERS’.	dimension
targetingSettings.automatedTargetingTactic	targetingSettings.automatedTargetingTactic	The automated targeting tactic applied to the ad group, e.g., ‘AWARENESS’.	dimension
targetingSettings.defaultAudienceTargetingMatchType	targetingSettings.defaultAudienceTargetingMatchType	The default match type for audience targeting, e.g., ‘EXACT’.	dimension
targetingSettings.enableLanguageTargeting	targetingSettings.enableLanguageTargeting	Indicates whether language targeting is enabled.	dimension
targetingSettings.tacticsConvertersExclusionType	targetingSettings.tacticsConvertersExclusionType	The type of exclusion applied to tactics converters, e.g., ‘NO_EXCLUSION’.	dimension
targetingSettings.timeZoneType	targetingSettings.timeZoneType	The time zone type used for targeting, e.g., ‘VIEWER’ or ‘ADVERTISER_REGION’.	dimension
targetingSettings.userLocation	targetingSettings.userLocation	The geographical location of the user being targeted.	dimension
targetingSettings.userLocationSignal	targetingSettings.userLocationSignal	The signal used to determine the user’s location for targeting, e.g., ‘CURRENT’.	dimension
targetingSettings.videoCompletionTier	targetingSettings.videoCompletionTier	The video completion tier for targeting, e.g., ‘ALL_TIERS’.	dimension